Skip to content

Latest commit

 

History

History
95 lines (81 loc) · 5.34 KB

README.md

File metadata and controls

95 lines (81 loc) · 5.34 KB
Raw
MultiSwap Overview
MultiSwap allows users to securely bridge any asset on network 1 for any asset on network 2 at transaction speed. Read the docs here: https://docs.ferrumnetwork.io/ferrum-network-ecosystem/v/multiswap-and-multichain-liquidity-pool-bridge/

MultiSwap

Getting Started

Install packages:

npm install

Add your private key in .env, and compile with:

hh compile

Run unit test:

hh test test/FiberRouter.test.ts

Run unit test and see coverage with:

hh coverage --testfiles "test/FiberRouter.test.ts"

The repo is currently undergoing a migration from ethers v5 to v6. The other (older) unit tests (and some scripts) will likely not work, but are kept for reference.

Deployment to a new network

Before deployment, the necessary configs must be added in constants/addresses.json. This includes specifying a router/dex which FiberRouter will call and its corresponding selectors:

  1. Fetch the ABI of the router/dex you wish to whitelist and paste in scripts/computeSelectors/main.ts
  2. Run the script with hh run scripts/computeSelectors/main.ts
  3. From the console output, manually add in the function selectors you wish to whitelist in constants/addresses.json (see existing networks for an example)
  4. Fill in other required addresses such as the WETH and foundry token address, chainID etc.
  5. Now add a network entry in hardhat.config.ts. The network names here and in constants/addresses.json must match

Contracts are now ready for deployment. Simply run:

hh run deploy/index.ts

This will deploy all MultiSwap contracts with all necessary configs. Contract addresses will print to console

ZkSync

ZkSync uses a different compiler with different node packages. After following the 4 steps above, first compile with:

hh compile --network zksync

Followed by deployment with:

hh deploy-zksync --network zksync

Note that running the compile command before deploying is necessary. Deployment artifacts (along with deployed contract addresses) can be found in deployments-zk

Overview

MultiSwap is divided into three major parts

  1. Fiber Engine: Controls everything
  2. Fiber Router: Everything flows through the router, to ensure that there is no external contract interaction with the Fund Manager contract where the majority of Foundry Assets are.
  3. Fund Manager Contract: This is where all the Foundry Assets are and also where the MultiSwap nodes will look to settle assets that need to be bridged across chains.

Fiber Engine:

There are following checks being performs for initiating a swap

  1. FACCheck: Foundery Asset Check, if source & target tokens are foundry assets (are bridgeable) then FACCheck is performed.
  2. RIACheck: Refinery & Ionic Asset Check, if source & target tokens are either Refinery or Ionic assets (are not bridge tokens) then RIACCheck is performed.

Flow of Foundry Swap

  1. Source Network: FAC check (Does this token exist in the Fund Manager?)
    • Answer: Yes -> Categorized as Foundry Asset
  2. Destination Network: FAC Check (Does the requested token exist on the destination network Fund Manager? If so, is there enough liquidity for this token in the Fund Manager to support the requested amount?)
    • Answer: Yes -> Categorized as Foundry Asset.

Flow of Refinery Swap

  1. Source Network: FAC check (Does the requested token exist on the Source network Fund Manager?)

    • Answer: No -> Initiates RIAC check
    • Source Network: Can I swap source token to a foundry asset in a single transaction through ecosystem DEX or aggregators?
      • Answer: Yes -> Categorized as Refinery Asset
    • Source Network: ABQC (Asset Best Quote Check) determines which ecosystem DEX or aggregator will give the best rate for this swap. -> Quote Received

  2. Destination Network: FAC Check (Does the requested token exist on the destination network Fund Manager? If so, is there enough liquidity for this token in the Fund Manager to support the requested amount?)

    • Answer: No -> Initiates RIAC check
    • Destination Network: Can I swap to a foundry asset in a single transaction through ecosystem DEX or aggregators?
      • Answer: Yes -> Categorized as Refinery Asset
    • Destination Network: ABQC (Asset Best Quote Check) determines which ecosystem DEX or aggregator will give the best rate for this swap -> Quote Received

Flow of Ionic Swap

  1. Source Network: FAC check (Does the requested token exist on the Source network Fund Manager?)
    • Answer: No -> Initiates RIAC check
    • Source Network: Can I swap to a foundry asset in a single transaction through ecosystem DEX or aggregators?
      • Answer: No -> Categorized as Ionic Asset
    • Source Network: ABQC (Asset Best Quote Check) determines which ecosystem DEX or aggregator will give the best rate for this swap. -> Quote Received
  2. Destination Network: FAC Check (Does the requested token exist on the destination network Fund Manager? If so, is there enough liquidity for this token in the Fund Manager to support the requested amount?)
    • Answer: No -> Initiates RIAC check
    • Destination Network: Can I swap to a foundry asset in a single transaction through ecosystem DEX or aggregators?
      • Answer: Yes -> Categorized as Ionic Asset
    • Destination Network: ABQC (Asset Best Quote Check) determines which ecosystem DEX or aggregator will give the best rate for this swap. -> Quote Received