Skip to main content

Contracts

Requirements​

  • Node.js version 14 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.
  • Yarn version 1.16 or above

Setting Up The Steer Protocol Contracts​

Install the necessary dependencies:

yarn

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

Compile the contracts​

Compile the contracts by running the following yarn script:

yarn build

Run the tests​

Run all the protocol tests by using following yarn script:

yarn test

Make changes!​

All contracts are within ./contracts directory. You can modify them and run the tests to verify the changes.