Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 5.19 KB

README.md

File metadata and controls

84 lines (57 loc) · 5.19 KB
Raw

Mirror Core Contracts

This monorepository contains the source code for the core smart contracts implementing Mirror Protocol on the Terra blockchain.

You can find information about the architecture, usage, and function of the smart contracts on the official Mirror documentation site.

Dependencies

Mirror depends on Terraswap and uses its implementation of the CW20 token specification.

Contracts

Contract Reference Description
mirror_collector doc Gathers protocol fees incurred from CDP withdrawals and liquidations and sends to Gov
mirror_community doc Manages the commuinty pool fund
mirror_factory doc Central directory that organizes the various component contracts of Mirror
mirror_gov doc Allows other Mirror contracts to be controlled by decentralized governance, distributes MIR received from Collector to MIR stakers
mirror_mint doc Handles CDP creation, management and liquidation
mirror_oracle doc Provides interface for oracle feeders to post prices for mAssets
mirror_staking doc Distributes MIR rewards from block reward to LP stakers
mirror_lock doc Locks the UST obtained from selling mAssets on shorting positions
mirror_collateral_oracle doc Directory of whitelisted collateral assets, acts as a proxy to different price sources on the Terra ecosystem
mirror_limit_order doc Provides a limit order intrface for bidders and arbitrage opportunities for market makers
mirror_short_reward doc Implements the calculations to obtain the reward portion given to sLP stakers

Development

Environment Setup

  • Rust v1.44.1+
  • wasm32-unknown-unknown target
  • Docker

  1. Install rustup via https://rustup.rs/

  2. Run the following:

rustup default stable
rustup target add wasm32-unknown-unknown
  1. Make sure Docker is installed

Unit / Integration Tests

Each contract contains Rust unit tests embedded within the contract source directories. You can run:

cargo unit-test

Compiling

After making sure tests pass, you can compile each contract with the following:

RUSTFLAGS='-C link-arg=-s' cargo wasm
cp ../../target/wasm32-unknown-unknown/release/cw1_subkeys.wasm .
ls -l cw1_subkeys.wasm
sha256sum cw1_subkeys.wasm

Production

For production builds, run the following:

docker run --rm -v "$(pwd)":/code \
  --mount type=volume,source="$(basename "$(pwd)")_cache",target=/code/target \
  --mount type=volume,source=registry_cache,target=/usr/local/cargo/registry \
  cosmwasm/workspace-optimizer:0.11.3

This performs several optimizations which can significantly reduce the final size of the contract binaries, which will be available inside the artifacts/ directory.

License

Copyright 2020 Mirror Protocol

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.