Skip to content

Latest commit

 

History

History
167 lines (130 loc) · 8.26 KB

README.md

File metadata and controls

167 lines (130 loc) · 8.26 KB
Raw

Yield Dex

L2 contracts for Yield Dex project.

Compilation

We are using Scarb to compile our contracts, you need to install it to be able to use it. For that, you can follow the steps here. Once Scarb is installed, you are able to compile the contracts. Run scarb build, it will build Sierra code of this package which will be written to the target/dev directory.

Test

You can find our tests under src/tests, these tests are written using snfoundry you can find more information here. Follow the installation documentation to be able to run our tests. To run the tests, just do snforge test.

Install dependencies

To install dependencies run the script ./install.sh

Create a test account

To create a test account run the script ./account.sh. Follow the instructions to deploy the account.

ENVs

Update the ENVs inside the .env file

STARKNET_NETWORK= network goerli ot mainnet
ACCOUNT_ADDRESS= account address
ACCOUNT_PK= account provate key

Declare With Starkli

For this, we used starkli, you need to install it to be able to declare and deploy the contracts. If you need to install starkli go to: https://book.starkli.rs/installation Once starkli is installed, you will need to set some environment variables. There is a file called .env.example that you should change to .evn (script does this for you). If you want to declare on goerli change the STARKNET_NETWORK=goerli (you can replace it to be STARKNET_NETWORK=mainnet or STARKNET_NETWORK=sepolia depending on the network you want to deploy to).

Singers and account creation

You will have to create a signers and account, just follow those documentation. Basically steps are as follows:

starkli signer keystore new ./nimbora_keystore

Deployment flow

Now that everything is set up, you are able to declare the contracts. For that, we will use starkli declare command, for more info check the documentation here. Run starkli declare ./target/dev/CONTRACT_NAME.contract_class.json --account PATH/account-store --network NETWORK. CONTRACT_NAME the name of the json file that can be found inside ./target/dev/ folder. PATH/account-store is the path to your account-store that has been previously created. NETWORK the name of the network you want to declare to (goerli, sepolia or mainnet). After running that, it will return to you the declared contract class hash.

Declare With Script

Create a .env and add ACCOUNT_ADDRESS and ACCOUNT_PK. Run npm i to install the package. The script is deploying the contract on goerli if you want to deploy on another network then go inside scripts/declareContracts and change const provider = new RpcProvider({ nodeUrl: constants.NetworkName.SN_MAIN }); with the correct network (ex: SN_GOERLI). To run the script just do npx ts-node scripts/declareContracts.ts --contract CONTRACT_NAME. CONTRACT_NAME must be replaced by :

  • PoolingManager
  • Factory
  • Token
  • TokenManager

Deploy and setup the contracts

Deploy Pooling manager and Factory

To deploy the factory and the pooling manager run the script ./deploy.sh

Setup the Pooling manager

To deploy the factory and the pooling manager run the script ./setupContracts.sh This will setup the pooling manager and deploy an sDAI strategy.

Only the owner of the contract will be able to set up the contract. You can do the setup through voyager or starkscan.

PoolingManager: Only Owner:

  • set_fees_recipient: Address of the fees recipient.
  • set_l1_pooling_manager: Address of the pooling manager on l1.
  • set_factory: Address of the Factory contract previously deployed.

Only Role, the owner has the correct role, but you can also give permission to other accounts:

  • register_underlying: Registers an underlying asset, its corresponding bridge contract and the corresponding address of the l1bridge

Factory: Only Owner:

  • deploy_strategy: Deploys a new strategy with specified parameters. Parameters are:
    • l1_strategy: The Ethereum address of the L1 strategy
    • underlying: The contract address of the underlying asset
    • token_name: The name for the new token
    • token_symbol: The symbol for the new token
    • performance_fees: The performance fees for the strategy (ex: 200000000000000000)
    • min_deposit: The minimum deposit limit (ex: 100000000000000000)
    • max_deposit: The maximum deposit limit (ex: 10000000000000000000)
    • min_withdrawal: The minimum withdrawal limit (ex: 200000000000000000)
    • max_withdrawal: The maximum withdrawal limit (ex: 2000000000000000000000000)
    • withdrawal_epoch_delay: The delay in epochs for withdrawals (ex: 2)
    • dust_limit: The dust limit for the strategy (ex: 1000000000000000000) Deploy_strategy will deploy a new contract called token_manager and return you the address inside the emitted event. We are going to use this contract to deposit some tokens.

You need to approve tokenManager to transfer some underlying token. If you are using DAI token, you will also need to give some approval to daiBridge. For that you can use the function:

  • set_allowance in our PoolingManager contract. Parameters are:
    • spender: The l2 bridge contract for this token.
    • token_address: The l2 token address.
    • amount: The amount you want to bridge.

Go to the Token Manager contract address and call the deposit function, This function can be called by any user :

TokenManager:

  • deposit: Allows a user to deposit assets into the contract. Parameters are:
    • assets: The amount of assets to deposit.
    • receiver: The address to receive the minted shares.
    • referral: The referral address for the deposit. Once users have deposited some assets, they can now request a withdrawal from the contract.
  • request_withdrawal: Allows a user to request a withdrawal from the contract Parameter is:
    • shares: The amount of shares to withdraw.

Now that user had deposit some assets, you can call go in our PoolingManager contract and call:

  • handle_mass_report: Handles a mass report of L1 strategy data, processing and updating L2 state accordingly. This function processes reports from L1, verifies data integrity, and performs necessary transfers and updates. Parameters are:
    • calldata: The span of StrategyReportL1 data received from L1 (for epoch 0 it is an empty array [])

Goerli Class Hash

You can declare a contract only once on each network. So if you don't do any modification into our current contract implementation you may face an error while declaring. Therefore here you can find the current class hash of each contract on Goerli.

POOLING_MANAGER_CLASS_HASH="0x05adb7661d0dcb3cc5fbe69380846fb7662c92f1943fcf609c51b756cae7d411"
TOKEN_MANAGER_CLASS_HASH="0x03be98338455134abae1d830802a162cd81b24ddb38a868ec9c6a4341ecd7210"
TOKEN_MOCK_CLASS_HASH="0x00da57dbb24ceb46a3901f148442e0d591528baba485ee84ed6d4948dedf12e5"
TOKEN_CLASS_HASH="0x0720f601c0432ab03e12df99c2b215e7ab9a9c12e1b4d8b0473e18bbb3213bea"
TOKEN_BRIDGE_CLASS_HASH="0x00de6d9bd84775dd221273e833dc44946da586483cf822e0021385de95964700"
FACTORY_CLASS_HASH="0x0581277daf0e409c2537979108b7eb4a5cec3624db552c35f8f6acc9a3ac937b"

​

Mainnet Class Hash

You can declare a contract only once on each network. So if you don't do any modification into our current contract implementation you may face an error while declaring. Therefore here you can find the current class hash of each contract on Mainnet.

POOLING_MANAGER_CLASS_HASH=0x05adb7661d0dcb3cc5fbe69380846fb7662c92f1943fcf609c51b756cae7d411
FACTORY_CLASS_HASH=0x581277daf0e409c2537979108b7eb4a5cec3624db552c35f8f6acc9a3ac937b
TOKEN_MANAGER_CLASS_HASH=0x3be98338455134abae1d830802a162cd81b24ddb38a868ec9c6a4341ecd7210
TOKEN_CLASS_HASH=0x720f601c0432ab03e12df99c2b215e7ab9a9c12e1b4d8b0473e18bbb3213bea

​

SEPOLIA CLASS HASH

POOLINGMANAGER_CLASS_HASH=0x298968754690f932b7c523250206de528774eb47d0af78bbdf5661ef0e1d253

FACTORY_CLASS_HASH=0x1a53538af7327153bdf67983f0cab458253f772e469182d7fd52e1d47a2bc5d

TOKENMANAGER_CLASS_HASH=0x4b205ff03efe65abce6f97e10e60c12c503fe4f0e144ecc8254900f0d9a77c7

TOKEN_CLASS_HASH=0x3dc679adb62ecba16b7de51ca1e8db49ef967640e428d1be9b11a1696cbce88