takertao2 / opium-contracts

Smart contracts of Opium Protocol

Opium contracts

Opium Protocol consist of Opium Main Smart Contracts set introduced in this repository alongside with Opium token standard smart contracts

Documentation

Protocol documentation can be found here https://docs.opium.network/

Generated documentation for code can be found here

Audit

Protocol was audited by:

• SmartDec and report can be found here
• MixBytes and report can be found here

Opium protocol is deployed on following addresses

Mainnet

• LibPosition was deployed at 0x56c54b408c44B12f6c9219C9c73Fcda4E783FC20
• Registry was deployed at 0x1cad268f540aa7e5c606b203e8443562332a3a35
• Core was deployed at 0xbe457663218c3527a82d4021b1dce5802997063b
• Match was deployed at 0x419aa1B768D1476305574a3cb61B7acBF6bD4308

• SwaprateMatch was deployed at 0x419aa1B768D1476305574a3cb61B7acBF6bD4308
• TokenSpender was deployed at 0x8bd75f96EfA089aEcf6Ac4CD0B671e2428f4B2af
• TokenMinter was deployed at 0x419aa1B768D1476305574a3cb61B7acBF6bD4308
• OracleAggregator was deployed at 0xB69890912E40A7849fCA058bb118Cfe7d70932c4
• SyntheticAggregator was deployed at 0x3a943C50Bcde3E357916ce6E109626213Fd36105

Rinkeby

• LibPosition was deployed at 0xecfb28f107de2bFB325E339293dE3A01C1CfFA74
• Registry was deployed at 0xE665EA43121674964bcd330F65D512e718b7A50b
• Core was deployed at 0xE995d8E9E0a01c938e6ae5B05720Af245953dC57
• Match was deployed at 0x00bC68b57dbEdcffe3007890f581f1BE0a2CddaE
• MatchPool was deployed at 0x30426CcfAcD4Ac7d552Cd0EAAaE1c0A80056aaa4
• SwaprateMatch was deployed at 0xC80B660E445d764B7741b59A33818d6526A830B2
• TokenSpender was deployed at 0xE39b9D5dC766102181D4C5Cd7df1691565B52032
• TokenMinter was deployed at 0xDEe1031c5D64788976E78d78c63C2fd6b411c4ee
• OracleAggregator was deployed at 0xe1Fd20231512611a5025Dec275464208070B985f
• SyntheticAggregator was deployed at 0x8Fb660ab5542D752047312443742f209C88E2170

High-level flow description of user behavior

1. Users approve their ERC20 tokens to TokenSpender
2. Users choose orders on relayer frontend, sign them and pass it to relayer
3. Relayer settles matched orders by sending them to Match or SwaprateMatch contracts depending on Order type
4. Matching contracts validate whether all conditions for orders are met, collect margin from buyer and seller, send it to Core with position creations command
5. Core validates derivative according to syntheticId logic, collects margin from Matching contracts and mints position tokens with TokenMinter
6. At execution time (maturity) users call core to burn their position tokens and receive payout from derivative

• All smart contracts get each others addresses using Registry contract
• Contracts in contracts/test folder are mocks and helpers for testing
• TokenMinter implements ERC721O

Documentation and tests status of Opium contracts (would be updated with additional documentation and tests)

Tests

Tests are running against ganache-cli

    npm run test

Because timeTravel is used in tests, each run should be running on new ganache-cli instance

LICENSE

Copyright © 2020 Blockeys BV. All rights reserved.