This package contains a collection of smart contracts deployed on the Flare, Coston2 (test network for Flare), Songbird and Coston (test network for Songbird) networks.
The intention of this package is to provide a set of interfaces for easier integration and development of smart contracts on Flare based networks. Interfaces in the most recent version of this package are the same as the ones deployed on the networks. This package exposes all public and most of the internal interfaces but does not expose any of the implementations. If you want to access the implementations, you can use the official flare smart contracts repo.
The package functions similar to openzeppelin library packages and can easily be imported in nodejs based projects as well as directly in remix IDE.
Basic familiarity with the Flare network and EVM is assumed for use. For more information, please refer to the Flare documentation. If you want a guided tutorial on EVM development and Flare focused smart contract development with this package, please refer to the Flare developer blogpost series.
Each of the networks has its own folder and subfolders for interfaces of specific flare based technologies. The folder structure is as follows:
├─coston2/
│ ├─contracts/
│ ├─mockContracts/
│ └─stateConnector/
├─coston/
│ ├─contracts/
│ ├─mockContracts/
│ └─stateConnector/
├─songbird/
│ ├─contracts/
│ ├─mockContracts/
│ └─stateConnector/
└─flare/
├─contracts/
├─mockContracts/
└─stateConnector/
- contracts/: Contains the interfaces of the smart contracts for FTSO, Governance, WNAT deployed on the network.
- mockContracts/: Contains a set of mock contracts for testing purposes. This contracts are not deployed on the network and are not intended for production use. Their only purpose is to provide a set of contracts that can be used for quick tests. Any advanced testing should be done with project specific mocks and testing suites.
- stateConnector/: Contains the interfaces of the smart contracts for State Connector and Attestation client system deployed on the network.
TODO
Add example folder with a simple example of how to use the package.
You should use IFtsoRegistry (or IIFtsoRegistry) for simple price queries or
IFtso (or IIFtso) for more advanced queries.
The IFtsoRegistry interface is available in
contracts/userInterfaces/IFtsoRegistry.sol and the
IFtso interface is available in contracts/userInterfaces/IFtso.sol.
To use the interfaces deployed on Flare network, just import them in your contract source:
import { IPriceSubmitter } from "@flarenetwork/flare-periphery-contracts/flare/contracts/userInterfaces/IPriceSubmitter.sol";
import { IFtsoRegistry } from "@flarenetwork/flare-periphery-contracts/flare/contracts/userInterfaces/IFtsoRegistry.sol";An example usage of the FTSO system to dynamically price token in a contract is showcased in
/examples/DynamicTokenSongbird.sol with a more detailed explanation in the blogpost.
THIS IS TODO
TODO
You've got the tools, turn on your imagination and go, go and build something awesome
If you find any mistake or have any suggestions, please open an issue or contact us are directly.
Package is provided as is, without any warranty.