canalix-sdk

Table of contents

• Market
  • getMarketInfo
• Router
  • previewAddLiquidityDualSyPt
  • previewRemoveLiquidityDualSyPt
  • previewMintPyFromSy
  • previewRedeemPyToSy

Market

import { Market } from "canalix-sdk"
const market = new Market(url, chainId);

Information about markets in a chain

get information of markets

const marketInfo = await market.getMarketInfo(marketConfigList)

Params: EthAddress list of market
Return informations about total of pt, sy, lp, expiration date, fixed yield of all markets

Router

import { Router } from "canalix-sdk"
const router = new Router(url);

Preview trading results in a market

Preview adding liquidity

res = await routerClass.previewAddLiquidityDualSyPt(marketAddr, routerAddr, amount, amount);

Params:

• marketAddr: EthAddress
• routerAddr: EthAddress
• amount: string | null (amount of sy and pt respectively) Return preview result before adding liquidity

Preview removing liquidity

res = await routerClass.previewRemoveLiquidityDualSyPt(marketAddr, routerAddr, amount);

Params:

• marketAddr: EthAddress
• routerAddr: EthAddress
• amount: string (amount of lp to remove) Return preview result before removing liquidity

Preview minting

res = await routerClass.previewMintPyFromSy(ytAddr, amount);

Params:

• ytAddr: EthAddress
• amount: string (amount of sy used to mint) Return preview result before using sy to mint pt and yt

Preview redeeming

res = await routerClass.previewRedeemPyToSy(ytAddr, amount);

Params:

• ytAddr: EthAddress
• amount: string (amount of yt used to redeem) Return preview result before using yt and pt to redeem