Skip to main content

Router

Table of contents

Functions

Functions

addLiquidity

addLiquidity(bs): StaticArray<u8>

Add liquidity while performing safety checks This function is compliant with fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing The liquidity parameters

Returns

StaticArray<u8>

  • Byte string containing:
  • liquidityMinted: Amounts of LBToken minted for each bin
  • depositIds: Bin ids where the liquidity was actually deposited

Defined in

assembly/contracts/Router.ts:99


addLiquidityMAS

addLiquidityMAS(bs): StaticArray<u8>

Add liquidity with MAS while performing safety checks This function is compliant with fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing - The liquidity parameters - The amount of MAS to send for storage fees

Returns

StaticArray<u8>

  • Byte string containing:
  • liquidityMinted: Amounts of LBToken minted for each bin
  • depositIds: Bin ids where the liquidity was actually deposited

Defined in

assembly/contracts/Router.ts:150


constructor

constructor(bs): void

Parameters

NameType
bsStaticArray<u8>

Returns

void

Defined in

assembly/contracts/Router.ts:42


createLBPair

createLBPair(bs): StaticArray<u8>

Create a liquidity bin LBPair for _tokenX and _tokenY using the factory

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - _tokenX: Address of the first token - _tokenY: Address of the second token4 - _activeId: The activeId of the pair - _binStep: The binStep of the pair

Returns

StaticArray<u8>

  • Byte string containing the address of the newly created LBPair

Defined in

assembly/contracts/Router.ts:72


getSwapIn

getSwapIn(bs): StaticArray<u8>

Simulate a swap in

Parameters

NameType
bsStaticArray<u8>

Returns

StaticArray<u8>

Defined in

assembly/contracts/Router.ts:1183


getSwapOut

getSwapOut(bs): StaticArray<u8>

Simulate a swap out

Parameters

NameType
bsStaticArray<u8>

Returns

StaticArray<u8>

Defined in

assembly/contracts/Router.ts:1198


receiveCoins

receiveCoins(_): void

Parameters

NameTypeDescription
_StaticArray<u8>unused

Returns

void

Notice

Function used by an SC to receive Massa coins

Defined in

assembly/contracts/Router.ts:1300


removeLiquidity

removeLiquidity(bs): StaticArray<u8>

Remove liquidity while performing safety checks This function is compliant with fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - _tokenX: Address of the first token - _tokenY: Address of the second token - _binStep: The binStep of the pair - _amountXMin: The minimum amount of tokenX to receive - _amountYMin: The minimum amount of tokenY to receive - _ids: The list of bin ids - _amounts: The list of amounts to remove - _to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing:
  • amountX: The amount of tokenX received
  • amountY: The amount of tokenY received

Defined in

assembly/contracts/Router.ts:235


removeLiquidityMAS

removeLiquidityMAS(bs): StaticArray<u8>

Remove liquidity with MAS while performing safety checks This function is compliant with fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - _tokenX: Address of the first token - _tokenY: Address of the second token - _binStep: The binStep of the pair - _amountXMin: The minimum amount of tokenX to receive - _amountYMin: The minimum amount of tokenY to receive - _ids: The list of bin ids - _amounts: The list of amounts to remove - _to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing:
  • amountX: The amount of tokenX received
  • amountY: The amount of tokenY received

Defined in

assembly/contracts/Router.ts:302


swapExactMASForTokens

swapExactMASForTokens(bs): StaticArray<u8>

Swaps exact MAS for tokens while performing safety checks

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountOutMin: The minimum amount of token to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp - masToSend: The amount of MAS to send for storage fees

Returns

StaticArray<u8>

  • Byte string containing Output amount of the swap

Defined in

assembly/contracts/Router.ts:464


swapExactMASForTokensSupportingFeeOnTransferTokens

swapExactMASForTokensSupportingFeeOnTransferTokens(bs): StaticArray<u8>

Swaps exact MAS for tokens while performing safety checks supporting for fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountOutMin: The min amount of token to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp - masToSend: The amount of MAS to send for storage fees

Returns

StaticArray<u8>

  • Byte string containing the output amount of the swap

Defined in

assembly/contracts/Router.ts:817


swapExactTokensForMAS

swapExactTokensForMAS(bs): StaticArray<u8>

Swaps exact tokens for MAS while performing safety checks

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountIn: The amount of token to swap - amountOutMinMAS: The minimum amount of MAS to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing Output amount of the swap

Defined in

assembly/contracts/Router.ts:403


swapExactTokensForMASSupportingFeeOnTransferTokens

swapExactTokensForMASSupportingFeeOnTransferTokens(bs): StaticArray<u8>

Swaps exact tokens for MAS while performing safety checks supporting for fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountIn: The amount of token to send - amountOutMinMAS: The min amount of MAS to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing the output amount of the swap

Defined in

assembly/contracts/Router.ts:753


swapExactTokensForTokens

swapExactTokensForTokens(bs): StaticArray<u8>

Swap tokens while performing safety checks

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountIn: The amount of token to swap - amountOutMin: The minimum amount of token to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing Output amount of the swap

Defined in

assembly/contracts/Router.ts:357


swapExactTokensForTokensSupportingFeeOnTransferTokens

swapExactTokensForTokensSupportingFeeOnTransferTokens(bs): StaticArray<u8>

Swaps exact tokens for tokens while performing safety checks supporting for fee on transfer tokens

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountIn: The amount of token to send - amountOutMin: The min amount of token to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing the output amount of the swap

Defined in

assembly/contracts/Router.ts:698


swapMASForExactTokens

swapMASForExactTokens(bs): StaticArray<u8>

Swaps MAS for exact tokens while performing safety checks

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountOut: The amount of token to receive - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp - masToSend: The amount of MAS to send for storage fees

Returns

StaticArray<u8>

  • Byte string containing the output amount of the swap

Defined in

assembly/contracts/Router.ts:634


swapTokensForExactMAS

swapTokensForExactMAS(bs): StaticArray<u8>

Swaps tokens for exact MAS while performing safety checks

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountOut: The amount of MAS to receive - amountInMax: The maximum amount of token to send - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing the output amount of the swap

Defined in

assembly/contracts/Router.ts:570


swapTokensForExactTokens

swapTokensForExactTokens(bs): StaticArray<u8>

Swaps tokens for exact tokens while performing safety checks

Parameters

NameTypeDescription
bsStaticArray<u8>Byte string containing: - amountOut: The amount of token to receive - amountInMax: The maximum amount of token to send - pairBinSteps: The bin steps of the pairs - tokenPath: The swap path using the bin steps following _pairBinSteps - to: The address of the recipient - deadline: The deadline timestamp

Returns

StaticArray<u8>

  • Byte string containing the output amount of the swap

Defined in

assembly/contracts/Router.ts:518


sweep

sweep(bs): void

Unstuck tokens that are sent to this contract by mistake

Parameters

NameType
bsStaticArray<u8>

Returns

void

Dev

Only callable by the factory owner

Defined in

assembly/contracts/Router.ts:877


sweepLBToken

sweepLBToken(bs): void

Unstuck LBTokens that are sent to this contract by mistake

Parameters

NameType
bsStaticArray<u8>

Returns

void

Dev

Only callable by the factory owner

Defined in

assembly/contracts/Router.ts:904