Smart Contracts from this repository are deployed on 4 different chains. Per chain, contract versions are slightly different. Use the links below to view the deployed contracts source code and addresses.
- Flare branch, Flare Addresses
- Songbird branch, Songbird addresses
- Coston branch, Coston addresses
- Coston 2 branch, Coston 2 addresses
Contracts cover the following Flare network building blocks:
- Token contracts.
- FTSO (Flare time series oracle).
- FTSO Manager.
- Token pools for reward and distribution.
- Flare Daemon, a special system trigger contract.
- Flare Inflation tracking and allocation.
- Supply accounting system of FLR tokens.
Are used for wrapped native tokens (WNAT) and xAssets minted on Flare network. These tokens expose delegate API and query votePower API. Vote power is checkpointed, meaning votePower for previous blocks can be queried.
Enables price providers to supply USD prices for a list of assets. The FTSO determines the vote power (weight) of each address by calling vote power API on the token contract. Each asset price feed is handled by a separate FTSO contract. All FTSO contracts are managed by FTSO Manager contract. See further information for details here.
Enable claiming of native token rewards. Users will be eligible to claim tokens through the following methods:
- by supplying FTSO price feeds (FTSO Reward manager),
- Providing external chain data (data availability proofs)
Native token inflation will be distributed according to decisions made by governance. A large part of the inflation will flow to FTSO price providers who provide "good" price feeds. Inflation will be awarded per price epoch. Inflation will be minted on demand subject to preceeding approvals.
The supply accounting system monitors circulating native token supply. During the first period after launch, much of the native tokens will be locked in pools such as the incentive pool. Native token distribution is done in phases, and native tokens that have been earned are considered locked until they are distributed. The Supply keeps track of these amounts.
These contract(s) will handle both the process of minting and the redemption of assets, checking collateral levels and liquidating (auctioning) defaulting agents with lower collateral levels. Will be implemented in a separate repository.
The air dropped native tokens will be distributed gradually through a dedicated contract(s).
- Clone this repo.
- Run
yarn. - Compile the solidity code:
yarn c. - Run basic tests
yarn testHH.
Note: be sure to compile (yarn c) after any solidity code changes or if starting a clean project as Typescript stubs need to be generated as part of the compilation.
Then one can run different types of tests.
yarn testHH- all tests in hardhat environment (includes next three types of tests).yarn test_unit_hh- only unit tests in hardhat environment.yarn test_performance_hh- only performance tests in hardhat environment.test_integration_hh- only integration tests in hardhat environment.
Each of these calls can have additional parameters, namely paths to specific files with tests. Glob expressions can be used, but note that glob expressions are expanded in bash to a sequence of space separated paths. Keep in mind that glob expressions in bash containing /**/ do not by default expand to all files, so one can switch on full expansion by setting shopt -s globstar, and if needed, later switch it off with shopt -u globstar.
Some parts of the code can only be tested against a "real" Flare block chain which adds some special features on top of the regular EVM. Any test below that has HH in the script name will run against an auto-launched hardhat chain. Some tests can only run against a Flare chain.
A few options exist for running a Flare chain, with the simplest one described above.
To check test coverage run yarn cov.
For running tests against a local Flare chain.
- clone Flare repository
- choose one of the following launch scripts:
scdev1.sh- Recommended; smart contract dev chain, 1 validator node.scdev.sh- smart contract dev chain, 4 validator nodes.- others are less relevant.
see deployment