Router v2
Contract info
Contract name: pancake::router Contract address: c7efb4076dbe143cbcd98cfaaa929ecfc8f299203dfff63b95ccb6bfe19850fa::router
Admin Multi Sig: b11ccaed0056a75472539c2b0d9511c82fc6a36622bec7578216af5fe550dd0d
Types
Name | Type | Description |
---|---|---|
X |
| The coin type address of token X in the pair. |
Y |
| The coin type address of token Y in the pair. |
Entry Functions
Create Pair
Create the pool pair for swap.
Params
Name | Type | Descripton |
---|---|---|
sender |
| The sender's signer when calling the function. |
Add Liquidity
Add liquidity to the pool.
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
amount_x_desired |
| The amount of tokenX you'd like to provide as liquidity. |
amount_y_desired | u64 | The amount of tokenY you'd like to provide as liquidity. |
amount_x_min | u64 | The minimum amount of tokenX to provide (slippage impact). |
amount_y_min | u64 | The minimum amount of tokenY to provide (slippage impact). |
Remove Liquidity
Remove liquidity from the pool.
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
liquidity |
| The amount of LP Tokens to remove. |
amount_x_min |
| The minimum amount of tokenX to remove (slippage impact). |
amount_y_min |
| The minimum amount of tokenY to remove (slippage impact). |
Swap Exact Input
Swap exact amount of tokenX to tokenY.
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
x_in |
| Payable amount of input tokenX. |
y_min_out |
| The minimum amount tokenY to receive. |
Swap Exact Output
Swap tokenX to exact amount of tokenY.
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
y_out |
| Payable amount of output tokenY. |
x_max_in |
| The maximum amount tokenX to input. |
Swap Exact Input Double Hop
Swap exact amount of tokenX to tokenZ using 2 pools (Pool XY and Pool YZ).
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
x_in |
| Payable amount of input tokenX. |
z_min_out |
| The minimum amount tokenZ to receive. |
Swap Exact Output Double Hop
Swap tokenX to exact amount of tokenZ using 2 pools (Pool XY and Pool YZ).
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
z_out |
| Payable amount of output tokenZ. |
x_max_in |
| The maximum amount tokenX to input. |
Swap Exact Input Triple Hop
Swap exact amount of tokenX to tokenA using 3 pools (Pool XY, Pool YZ and Pool ZA).
Params
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
x_in |
| Payable amount of input tokenX. |
a_min_out |
| The minimum amount tokenA to receive. |
Swap Exact Output Triple Hop
Swap tokenX to exact amount of tokenA using 3 pools (Pool XY, Pool YZ and Pool ZA).
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
a_out |
| Payable amount of output tokenA. |
x_max_in | u64 | The maximum amount tokenX to input. |
Swap Exact Input Quadruple Hop
Swap exact amount of tokenX to tokenB using 3 pools (Pool XY, Pool YZ, Pool ZA and Pool AB).
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
x_in |
| Payable amount of input tokenX. |
b_min_out |
| The minimum amount tokenB to receive. |
Swap Exact Output Quadruple Hop
Swap tokenX to exact amount of tokenB using 3 pools (Pool XY, Pool YZ, Pool ZA and Pool AB).
Name | Type | Description |
---|---|---|
sender |
| The sender's signer when calling the function. |
b_out |
| Payable amount of output tokenB. |
x_max_in | u64 | The maximum amount tokenX to input. |
Public Functions
Swap Exact X to Y
Swap exact amount of tokenX to tokenY.
Input Values
Name | Type | Description |
---|---|---|
x_in |
| The coin resource of tokenX that the user will swap. |
Return Values
Type | Description |
---|---|
| The coin resource of tokenY that the user will receive. |
Swap X to Exact Y
Swap tokenX to the exact amount of tokenY.
Input Values
Name | Type | Description |
---|---|---|
x_in |
| The coin resource of tokenX that the user will swap. |
y_out_amount |
| The expected amount of tokenY that user will receive. |
Return Values
Position | Type | Description |
---|---|---|
0 |
| The coin resource of tokenX that the user will swap. |
1 |
| The coin resource of tokenY that user will receive. |
Get Amount In
The amount required in order to the the output amount.
Input Values
Name | Type | Description |
---|---|---|
y_out_amount |
| The amount of tokenY that user will receive. |
Return Values
Type | |
---|---|
| The amount of tokenX required to get the amount of tokenY. |
Last updated