Mars Protocol

This repository contains the source code for the core smart contracts of Mars Protocol. Smart contracts are meant to be compiled to .wasm files and uploaded to the Terra blockchain.

Bug bounty

A bug bounty is currently open for these contracts. See details at: https://immunefi.com/bounty/marsprotocol/

Verify contracts

Follow these instructions to verify that the smart contracts that exist on chain correspond to a particular version of the contract's source code:

1. Find the code ID of the contract you wish to verify.

   This can be found on the smart contract's page on Terra Finder.

2. Get the SHA256 checksum of the code ID's wasm binary:

   • One way to do this is to get the checksum directly from the blockchain:

   curl "https://fcd.terra.dev/terra/wasm/v1beta1/codes/${CODE_ID}" \
     | jq ".code_info.code_hash" \
     | tr -d \" \
     | base64 -d \
     | hexdump -v -e '/1 "%02x"'
   

   • Alternatively, download the wasm byte code relating to the code ID from the blockchain and calculate its SHA256 checksum:

   curl "https://fcd.terra.dev/terra/wasm/v1beta1/codes/${CODE_ID}/byte_code" \
     | jq ".byte_code" \
     | tr -d \" \
     | base64 -d \
     | shasum -a 256
   

3. Get the SHA256 checksum of a smart contract's wasm binary built from source code. To do this, first clone this repo, checkout a particular release, compile the smart contracts using the same version of rust-optimizer listed in the releases, and verify the checksum written to artifacts/checksums.txt.

4. Finally, verify that the two checksums are identical.

Deploy scripts overview and set up

When the scripts run for the first time, it will upload code IDs for each contract, instantiate each contract, initialize assets, and run 4 tests (deposit, borrow, repay, withdraw). After the first run, the code will only run deposit, borrow, repay, and withdraw tests. To rerun everything, delete the osmo-test-4.json file in the artifacts folder to clear the storage.

Everything related to deployment must be ran from the scripts directory:

cd scripts

Set up yarn:

yarn install

Create the build folder:

yarn build

Compile all contracts:

yarn compile

This compiles and optimizes all contracts, storing them in /artifacts directory along with checksum.txt which contains sha256 hashes of each of the .wasm files (The script just uses CosmWasm's rust-optimizer).

Formating must be done before running lint:

yarn format

Linting:

yarn lint

Now you're ready to deploy for an outpost.

Deploying Outposts

Each outpost has a config file for its respective deployment and assets

For Osmosis:

yarn deploy:osmosis

Schemas

cargo make --makefile Makefile.toml generate-all-schemas

Creates JSON schema files for relevant contract calls, queries and query responses (See: cosmwams-schema).

Linting

rustfmt is used to format any Rust source code:

cargo fmt

clippy is used as a linting tool:

cargo +nightly clippy --tests --all-features -- -D warnings

Testing

Unit tests

# inside a package to run specific package tests
cargo unit-test

# in the root directory to run all tests
cargo test

Integration tests

Running a single integration test

cd scripts
node --loader ts-node/esm tests/<test>.ts

Running the main integration test suite

1. Get LocalTerra repo and set LOCAL_TERRA_REPO_PATH env variable to its path.
2. Run run_tests.sh from the scripts directory:

cd scripts
./run_tests.sh

Generating a whitelist.json

1. Create a .env file in the top level of the scripts directory if doesn't already exist
2. Add the env variable NETWORK=[network_to_generate_from_e.g._NETWORK=testnet]
3. Add the env variable REDBANK_ADDRESS=[your_deployed_red_bank_contract_address]
4. Run node --loader ts-node/esm whitelist.ts
5. Check the whitelists folder for [NETWORK].json output

License

Contents of this repository are open source under GNU General Public License v3 or later.