Installation
Hello fellow Odra user! This page will guide you through the installation process.
Prerequisites
To start working with Odra, you need to have the following installed on your machine:
We do not provide exact commands for installing these tools, as they are different for different operating systems. Please refer to the documentation of the tools themselves.
With Rust toolchain ready, you can add a new target:
rustup target add wasm32-unknown-unknown
wasm32-unknown-unknown is a target that will be used by Odra to compile your smart contracts to WASM files.
Installing Cargo Odra
Cargo Odra is a helpful tool that will help you to build and test your smart contracts. It is not required to use Odra, but the documentation will assume that you have it installed.
To install it, simply execute the following command:
cargo install cargo-odra --locked
To check if it was installed correctly and see available commands, type:
cargo odra --help
If everything went fine, we can proceed to the next step.
Creating a new Odra project
To create a new project, simply execute:
cargo odra new --name my-project && cd my_project
This will create a new folder called my_project and initialize Odra there. Cargo Odra
will create a sample contract for you in src directory. You can run the tests of this contract
by executing:
cargo odra test
This will run tests using Odra's internal OdraVM. You can run those tests against a real backend, let's use CasperVM:
cargo odra test -b casper
Congratulations! Now you are ready to create contracts using Odra framework! If you had any problems during the installation process, feel free to ask for help on our Discord.
What's next?
If you want to see the code that you just tested, continue to the description of Flipper example.