https://github.com/gammaswap/universal-router

Universal Router for GammaSwap protocol
https://github.com/gammaswap/universal-router

Last synced: about 1 month ago
JSON representation

Universal Router for GammaSwap protocol

• Host: GitHub
• URL: https://github.com/gammaswap/universal-router
• Owner: gammaswap
• License: gpl-3.0
• Created: 2024-09-30T17:33:56.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T08:41:50.000Z (about 2 months ago)
• Last Synced: 2024-11-12T09:29:51.553Z (about 2 months ago)
• Language: Solidity
• Size: 697 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

    

  



Universal Router

Universal router used to trade across multiple protocols (e.g. DeltaSwap, UniswapV3, Aerodrome, etc.).


## Path Definition

A path is passed to determine that pool sequence swaps will follow to convert an amount of tokenIn to an amount of tokenOut.

Each step in the path is defined as follows

-tokenIn (20 bytes)

-protocolId (2 bytes)

-fee (3 bytes)

-tokenOut (20 bytes)

E.g.

`path = 5991A2dF15A8F6A256D3Ec51E99254Cd3fb576A90006000bb82e234DAe75C793f67A35089C9d99245E1C58470b`

-tokenIn: 0x5991A2dF15A8F6A256D3Ec51E99254Cd3fb576A9

-protocolId: 0x0006

-fee: 0x000bb8

-tokenOut: 0x2e234DAe75C793f67A35089C9d99245E1C58470b

Paths can be appended to create multi pool paths across multiple protocols.

E.g.

`path = 5991A2dF15A8F6A256D3Ec51E99254Cd3fb576A900010000002e234DAe75C793f67A35089C9d99245E1C58470b0006000bb8F62849F9A0B5Bf2913b396098F7c7019b51A820a`

-tokenIn: 0x5991A2dF15A8F6A256D3Ec51E99254Cd3fb576A9

-protocolId: 0x0001

-fee: 0x000000

-tokenOut: 0x2e234DAe75C793f67A35089C9d99245E1C58470b

-protocolId: 0x0006

-fee: 0x000bb8

-tokenOut: 0xF62849F9A0B5Bf2913b396098F7c7019b51A820a

fee parameter is only needed when swapping with UniswapV3 or Aerodrome Concentrated Liquidity pools.

## Available Protocols

UniswapV2, SushiswapV2, DeltaSwap, UniswapV3, Aerodrome (stable & non-stable), Aerodrome Concentrated Liquidity.

## How to Add Another Protocol Route

Create a contract that implements IProtocolRoute and give it a unique protocolId that has not been used by the protocolRouter yet.

Then add it to the UniversalRouter by calling addProtocolRoute().