Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 1.99 KB

README.md

File metadata and controls

95 lines (62 loc) · 1.99 KB

Yearn Stake the Bridge

Structure

alt text

Role Manager

  • Yearn governed contract to handle vault deployments and configuration

L1 Deployer

  • The L1 rollup admin will register their rollup with the L1 Deployer

    • registerRollup

      • rollupID
      • L1 EscrowManager
      • L2 Deployer

    • Deploys a new vault if not yet, does full setup.

    • Deploys L1 escrow and sends message to bridge to L2 escrow.

  • Allows anyone to add a new asset to any registered Rollup

    • newEscrow
      • rollupID
      • L1 Token

  • Allows for a Rollup Admin to add custom vaults for a specific asset.

    • newCustomVault
      • rollupID
      • L1 Token
      • Vault (Optional)

  • Allows for a Rollup Admin to update is EScrow Manager or L2 Deployer

L2 Deployer

  • Receives message from L1 Deployer when a new escrow was created for a new asset.
  • Deploys L2 Token, Escrow and convertor and completes setup
  • Owned by L2 Admin

L1 Yearn Escrow

  • Yearn specific L1 Escrow contract that handles bridge transactions.

  • Will deposit funds into a Yearn vault during a bridge if amounts are over any set minimumBuffer

  • If withdraws cannot be processed it will send shares to users when bridging back to L1.

  • Rollups Admin can update the minimumBuffer as well as the vault it uses.

  • Allows for permissionless rebalance's based on the minimumBuffer.

Foundry Documentation

https://book.getfoundry.sh/

Usage

Build

$ make build

Test

$ make tests

Trace

$ make trace

Gas Snapshots

$ make snapshot

Cast

$ cast <subcommand>

Help

$ forge --help
$ anvil --help
$ cast --help