Skip to main content

Creating an ink! Project

We are going to use the ink! CLI to generate the files we need for a Substrate smart contract project.

Make sure you are in your working directory, and then run:

cargo contract new flipper

This command will create a new project folder named flipper which we will explore:

cd flipper/

ink! Contract Project​

flipper
|
.
├── Cargo.toml
└── lib.rs

Contract Source Code​

The ink CLI automatically generates the source code for the "Flipper" contract, which is about the simplest "smart" contract you can build. You can take a sneak peak as to what will come by looking at the source code here:

Flipper Example Source Code

The Flipper contract is nothing more than a bool which gets flipped from true to false through the flip() function. We won't go so deep into the details of this source code because we will be walking you through the steps to build a more advanced contract!

Testing Your Contract​

You will see at the bottom of the source code there is a simple test which verifies the functionality of the contract. We can quickly test that this code is functioning as expected using the off-chain test environment that ink! provides.

In your project folder run:

cargo +nightly test

To which you should see a successful test completion:

$ cargo +nightly test
    running 2 tests
    test flipper::tests::default_works ... ok
    test flipper::tests::it_works ... ok

    test result: ok. 2 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out

Now that we are feeling confident things are working, we can actually compile this contract to Wasm.