This project is connected to some of its dependencies via Git submodules. This means that to get everything you need to get started, you need to clone this repo recursively:

git clone --recurse-submodules [email protected]:hackbg/sienna-secret-token.git

See the troubleshooting section if you forget to do that.

The file shell.nix contains a reproducible description of the development environment. To enter the development environment, run this in the project root:

nix-shell

This requires the Nix package manager, and contains Rust Nightly, Node.js, and PNPM. Alternatively, you are free to bring your own toolchain for your convenience (and this project's portability).

To install the dependencies of the management scripts, run this in the project root:

pnpm i

The smart contracts are written in Rust, targeting SecretNetwork's fork of cosmwasm-std 0.10.*.

TODO

To obtain a production build of Sienna Rewards:

pnpm dev build rewards

These tests cover the business logic of the contract in a mocked out environment. They run relatively quickly, and output any compilation errors, which makes them perfect for iterating on contracts.

TODO

In the case of Sienna Rewards, the unit tests are two-tiered: rewards_test.rs tests the contract through its public API, while rewards_test_2.rs tests the underlying business logic implementation by calling the internal methods directly. To run both:

./sienna rewards test

There is some support for resuming deployments that were interrupted halfway.

pnpm ops localnet-1.0 deploy all

TODO

After deployment the contracts should be transferred to the master multisig account. The CLI and API wrappers in this repo do not support generating multisig transactions. See hackbg/motika for a GUI-based multisig transaction signer.

• MGMT can be reconfigured by its admin after deployment as long as it hasn't been launched yet.
• RPT can be freely reconfigured by its admin as long as the budget adds up to the original amount (2500 SIENNA).

TODO

• A reward pool can be closed by sending it {"close_pool":{"message":"Here the admin should provide info on why the pool was closed."}}.
  • If upgrading a pool, please write the message in this format: Moved to secret1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx (because...).
  • A closed reward pool returns each user's LP tokens the next time the user interacts with the pool. No more locking is allowed, and time stops (this means liquidity shares will stop changing, even though sending more SIENNA to the pool will allocate more rewards according to current liquidity shares). Eligible users are able to claim rewards from a closed pool one last time. Afterwards, their LP tokens will be returned and their liquidity share reset to 0.

• To claim funds from MGMT, send it {"claim":{}}.
• To make RPT send funds to the reward pools, send it {"vest":{}}
• Swap: TODO
• Rewards: TODO

JS/TS modules for deploying and operating the contracts can be found in api/, ops/, and ops/amm-lib/. The ones in api/ and ops/ are based on Fadroma (Contract and Ensemble classes), while the ones in ops/amm-lib/ invoke SecretJS directly.

The API integration tests are based on Mocha.

Fadroma provides a "localnet" container - an ephemeral local blockchain that is set up and torn down between test cases.

To run the Sienna Rewards benchmark:

./sienna localnet reset
./sienna rewards benchmark

Located under api/SNIP20.js you'll find the wrapper for any snip20 contract that will expose all the required methods to call on the contract.

If you forget --recurse-submodules on initial checkout, or something goes wrong with your Git repo (both happen) you may see this error:

ERR_PNPM_NO_MATCHING_VERSION_INSIDE_WORKSPACE  In libraries/fadroma-next:
No matching version found for @hackbg/ganesha@* inside the workspace

To fetch the missing submodules, go to the root of the repo and do this:

git submodule init
git submodule update
cd libraries/fadroma-next
git submodule init
git submodule update