Class: SdkPool

Classdesc

SDK class encapsulating stableswap pool functions.

Remarks

This class will either interact with internal StableSwapFacet pools or external StableSwap pools depending on which type of pool is being used for each asset. Note: SDK currently only supports internal StableSwapFacet pools.

Hierarchy

• »SdkShared

  ↳ SdkPool

Methods

addLiquidity

▸ addLiquidity(domainId, tokenAddress, amounts, minToMint?, deadline?): Promise<TransactionRequest>

Prepares the transaction request for adding liquidity to a pool.

Parameters

Name	Type	Default value	Description
domainId	string	undefined	The domain ID of the pool.
tokenAddress	string	undefined	The address of local or adopted token.
amounts	string[]	undefined	The amounts of the tokens to swap.
minToMint	string	"0"	(optional) The minimum acceptable amount of LP tokens to mint.
deadline	number	undefined	(optional) The deadline for the operation.

Returns

Promise<TransactionRequest>

providers.TransactionRequest object.

---

approveIfNeeded

▸ approveIfNeeded(domainId, assetId, amount, infiniteApprove?): Promise<undefined | TransactionRequest>

Returns the transaction request for an allowance approval.

Parameters

Name	Type	Default value	Description
domainId	string	undefined	The domain ID.
assetId	string	undefined	The address of the token.
amount	string	undefined	The amount of the token.
infiniteApprove	boolean	true	(optional) Whether to approve an infinite amount.

Returns

Promise<undefined | TransactionRequest>

providers.TransactionRequest object.

Inherited from

SdkShared.approveIfNeeded

---

calculateAddLiquidityPriceImpact

▸ calculateAddLiquidityPriceImpact(domainId, tokenAddress, amountX, amountY): Promise<undefined | BigNumber>

Calculates the price impact of adding liquidity to a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
amountX	string	The amount of token X (index 0 of the pool), in the token's native precision.
amountY	string	The amount of token Y (index 1 of the pool), in the token's native precision.

Returns

Promise<undefined | BigNumber>

Price impact for adding liquidity, in 1e18 precision.

---

calculateCanonicalKey

▸ calculateCanonicalKey(domainId, canonicalId): string

Returns the hash of the canonical ID + canonical domain.

Remarks

This key is used as the unique identifier for a canonical token, across all domains.

Parameters

Name	Type	Description
domainId	string	The canonical domain ID of the token.
canonicalId	string	The canonical ID of the token.

Returns

string

Inherited from

SdkShared.calculateCanonicalKey

---

calculatePriceImpact

▸ calculatePriceImpact(tokenInputAmount, tokenOutputAmount, virtualPrice?, isDeposit?): BigNumber

Calculates the price impact depending on whether liquidity is being deposited or withdrawn.

Parameters

Name	Type	Default value	Description
tokenInputAmount	BigNumber	undefined	The amount of inbound tokens (LP tokens for withdrawals, total tokens for deposits, dx for swaps), in 1e18 precision.
tokenOutputAmount	BigNumber	undefined	The amount of outbound tokens (total tokens for withdrawals, LP tokens for deposits, dy for swaps), in 1e18 precision.
virtualPrice	BigNumber	undefined	(optional) The current virtual price of the pool.
isDeposit	boolean	true	(optional) Whether this is a deposit or withdrawal.

Returns

BigNumber

The price impact.

---

calculateRemoveLiquidityPriceImpact

▸ calculateRemoveLiquidityPriceImpact(domainId, tokenAddress, amountX, amountY): Promise<undefined | BigNumber>

Returns the price impact of removing liquidity from a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
amountX	string	The amount of token X (index 0 of the pool), in the token's native precision.
amountY	string	The amount of token Y (index 1 of the pool), in the token's native precision.

Returns

Promise<undefined | BigNumber>

The price impact for removing liquidity, in 1e18 precision.

---

calculateRemoveSwapLiquidityOneToken

▸ calculateRemoveSwapLiquidity(domainId, tokenAddress, amount, index): Promise<BigNumber>

Calculates the amounts of underlying tokens returned.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
amount	string	The amount of the LP token to burn on withdrawal.
index	number	The index of the token to withdraw.

Returns

Promise<BigNumber>

Calculated amount of underlying token returned.

---

calculateRemoveSwapLiquidity

▸ calculateRemoveSwapLiquidity(domainId, tokenAddress, amount): Promise<BigNumber[]>

Calculates the amounts of underlying tokens returned.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
amount	string	The amount of the LP token to burn on withdrawal.

Returns

Promise<BigNumber[]>

Array containing amount of each underlying token returned, in correct index order.

---

calculateSwap

▸ calculateSwap(domainId, tokenAddress, tokenIndexFrom, tokenIndexTo, amount): Promise<BigNumber>

Calculates the amount of tokens received on a swap.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
tokenIndexFrom	number	The index of the token to sell.
tokenIndexTo	number	The index of the token to buy.
amount	BigNumberish	The number of tokens to sell, in the "From" token's native decimal precision.

Returns

Promise<BigNumber>

Minimum amount received, in the "To" token's native decimal precision.

---

calculateSwapPriceImpact

▸ calculateSwapPriceImpact(domainId, amountX, tokenX, tokenY): Promise<BigNumber>

Calculates the price impact of a swap.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
amountX	string	The amount of tokens to swap, in the token's native precision.
tokenX	string	The address of the token to swap from.
tokenY	string	The address of the token to swap to.

Returns

Promise<BigNumber>

The price impact for swapping, in 1e18 precision.

---

calculateTokenAmount

▸ calculateTokenAmount(domainId, tokenAddress, amounts, isDeposit?): Promise<BigNumber>

Calculates the minimum LP token amount from deposits or withdrawals.

Parameters

Name	Type	Default value	Description
domainId	string	undefined	The domain ID of the pool.
tokenAddress	string	undefined	The address of local or adopted token.
amounts	string[]	undefined	The amounts of the tokens to deposit/withdraw, in the correct index order and in each token's native precision.
isDeposit	boolean	true	(optional) Whether this is a deposit or withdrawal.

Returns

Promise<BigNumber>

Minimum LP tokens received, in 1e18 precision.

---

calculateYield

▸ calculateYield(feesEarned, principal, days): Object

Calculates apr and apy.

Parameters

Name	Type	Description
feesEarned	number	The total fees earned in the period.
principal	number	The principal amount at the start of the period.
days	number	The number of days to look back.

Returns

Object

Object containing apr and apy.

Name	Type
apr	number
apy	number

---

changeSignerAddress

▸ changeSignerAddress(signerAddress): Promise<void>

Switches the signer address in the SDK config.

Parameters

Name	Type	Description
signerAddress	string	The new signer address.

Returns

Promise<void>

Inherited from

SdkShared.changeSignerAddress

---

getAdopted

▸ getAdopted(domainId, tokenAddress): Promise<string>

Reads the adopted token.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.

Returns

Promise<string>

The adopted token.

---

getAssetsData

▸ getAssetsData(): Promise<AssetData[]>

Fetches the list of registered assets.

Returns

Promise<AssetData[]>

Array of objects containing assets registered to the network, in the form of:

Inherited from

SdkShared.getAssetsData

---

getAssetsDataByDomainAndKey

▸ getAssetsDataByDomainAndKey(domainId, key): Promise<undefined | AssetData>

Retrieve the asset data for a specific domain and key.

Parameters

Name	Type	Description
domainId	string	The domain ID.
key	string	The canonical hash of the canonical token.

Returns

Promise<undefined | AssetData>

The object containing asset data.

Inherited from

SdkShared.getAssetsDataByDomainAndKey

---

getCanonicalTokenId

▸ getCanonicalTokenId(domainId, tokenAddress): Promise<[string, string]>

Returns the canonical ID and canonical domain of a token.

Parameters

Name	Type	Description
domainId	string	The canonical domain ID of the token.
tokenAddress	string	The address of the token.

Returns

Promise<[string, string]>

Inherited from

SdkShared.getCanonicalTokenId

---

getDefaultDeadline

▸ getDefaultDeadline(): number

Set to 1 hour from current time.

Returns

number

The default deadline, in unix time.

---

getLPTokenAddress

▸ getLPTokenAddress(domainId, tokenAddress): Promise<string>

Reads the LP token address of a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.

Returns

Promise<string>

The LP token address.

---

getPoolTokenAddress

▸ getPoolTokenAddress(domainId, tokenAddress, index): Promise<string>

Reads the token address of a specified index in a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
index	number	The index of the token in the pool.

Returns

Promise<string>

The address of the specified token in the pool.

---

getPoolTokenBalance

▸ getPoolTokenBalance(domainId, tokenAddress, poolTokenAddress): Promise<BigNumber>

Reads the balance of a pool token.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
poolTokenAddress	string	The address of the pool token.

Returns

Promise<BigNumber>

The balance of the pool token.

---

getPoolTokenIndex

▸ getPoolTokenIndex(domainId, tokenAddress, poolTokenAddress): Promise<number>

Reads the index of a token in a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of the local or adopted token.
poolTokenAddress	string	The address of the token in the pool to get the index for.

Returns

Promise<number>

The index of the specified token in the pool or -1 if not found.

___

getPoolTokenDecimals

▸ getPoolTokenDecimals(domainId, tokenAddress, poolTokenAddress): Promise<number>

Reads the decimal precision of a token in a pool.

Parameters

Name	Type	Description
domainId	string	The domain id of the pool.
tokenAddress	string	The address of local or adopted token.
poolTokenAddress	string	The address of the token in the pool to get the precision for.

Returns

Promise<number>

The decimal precision of the specified token in the pool or -1 if not found.

---

getRepresentation

▸ getRepresentation(domainId, tokenAddress): Promise<string>

Reads the representation asset of the pool. The representation asset is the adopted asset on the canonical domain and local (nextAsset) otherwise.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.

Returns

Promise<string>

The representation (local or adopted) token.

---

getTokenPrice

▸ getTokenPrice(tokenSymbol): Promise<any>

Fetches the current price of a token.

Parameters

Name	Type	Description
tokenSymbol	string	The symbol for the token.

Returns

Promise<any>

The price of the token.

___

getTokenSupply

▸ getTokenSupply(domainId, tokenAddress): Promise<BigNumber>

Reads the ERC20 token supply.

Parameters

Name	Type	Description
domainId	string	The domain ID of the ERC20 token.
tokenAddress	string	The address of the ERC20 token.

Returns

Promise<BigNumber>

The balance of the address.

---

getTokenUserBalance

▸ getTokenUserBalance(domainId, tokenAddress, userAddress): Promise<BigNumber>

Reads the ERC20 token balance of an address.

Parameters

Name	Type	Description
domainId	string	The domain ID of the ERC20 token.
tokenAddress	string	The address of the ERC20 token.
userAddress	string	The address to get the balance of.

Returns

Promise<BigNumber>

The balance of the address.

---

getUserPools

▸ getUserPools(domainId, userAddress): Promise<{ info: Pool ; lpTokenBalance: BigNumber ; poolTokenBalances: BigNumber[] }[]>

Retrieves the Pools that a user has LP tokens for.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
userAddress	string	The address of the user to get the pools for.

Returns

Promise<{ info: Pool ; lpTokenBalance: BigNumber ; poolTokenBalances: BigNumber[] }[]>

Array of Pool objects.

---

getVirtualPrice

▸ getVirtualPrice(domainId, tokenAddress): Promise<BigNumber>

Reads the virtual price of a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.

Returns

Promise<BigNumber>

The virtual price, scaled to the pool's decimal precision (10^18).

---

getYieldStatsForDays

▸ getYieldStatsForDays(domainId, tokenAddress, unixTimestamp, days): Promise<undefined | { totalFeesFormatted: number ; totalLiquidityFormatted: number ; totalVolume: BigNumber ; totalVolumeFormatted: number }>

Calculates the fees, liquidity, and volume of a pool for the days prior to the specified unix time.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
unixTimestamp	number	The unix time to start the look back from.
days	number	The number of days to look back.

Returns

Promise<undefined | { totalFeesFormatted: number ; totalLiquidityFormatted: number ; totalVolume: BigNumber ; totalVolumeFormatted: number }>

Object containing fees, liquidity, and volume, in 1e18 precision.

---

getSupported

▸ getSupported(): Promise<ConnextSupport[]>

Fetches the list of supported networks and assets.

Returns

Promise<ConnextSupport[]>

Array of objects containing networks and assets supported by the protocol, in the form of:

{   
  "name": "arbitrum",   
  "chainId": 42161, 
  "domainId": "1634886255", 
  "assets": [   
    "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",   
    "0xff970a61a04b1ca14834a43f5de4533ebddb5cc8"    
  ] 
},  

Inherited from

SdkShared.getSupported

---

isNextAsset

▸ isNextAsset(tokenAddress): Promise<undefined | boolean>

Returns whether the specified token is a Connext-issued (local) token.

Parameters

Name	Type	Description
tokenAddress	string	The address of the token.

Returns

Promise<undefined | boolean>

Boolean or undefined if the specified token is not registered.

Inherited from

SdkShared.isNextAsset

---

parseConnextTransactionReceipt

▸ parseConnextTransactionReceipt(transactionReceipt): any

Parses a providers.TransactionReceipt for the logs.

Parameters

Name	Type	Description
transactionReceipt	TransactionReceipt	providers.TransactionReceipt object.

Returns

any

Array of providers.Log objects.

Inherited from

SdkShared.parseConnextTransactionReceipt

---

removeLiquidity

▸ removeLiquidity(domainId, tokenAddress, amount, minAmounts?, deadline?): Promise<TransactionRequest>

Returns the transaction request for removing liquidity from a pool.

Parameters

Name	Type	Description
domainId	string	The domain ID of the pool.
tokenAddress	string	The address of local or adopted token.
amount	string	The amount of LP tokens to burn.
minAmounts	string[]	(optional) The minimum amounts of each token to withdraw.
deadline	number	(optional) The deadline for the operation.

Returns

Promise<TransactionRequest>

providers.TransactionRequest object.

---

removeLiquidityOneToken

▸ removeLiquidityOneToken(domainId, tokenAddress, amount, minAmount?, deadline?): Promise<TransactionRequest>

Returns the transaction request for removing liquidity from a pool.

Parameters

Name	Type	Default value	Description
domainId	string	undefined	The domain ID of the pool.
tokenAddress	string	undefined	The address of local or adopted token.
withdrawTokenAddress	string	undefined	The address of the token to withdraw.
amount	string	undefined	The amount of LP tokens to burn.
minAmount	string	"0"	(optional) The minimum acceptable amount of the token to withdraw.
deadline	number	One hour from current time.	(optional) The deadline for the operation.

Returns

Promise<TransactionRequest>

providers.TransactionRequest object.

---

removeLiquidityImbalance

▸ removeLiquidityImbalance(domainId, tokenAddress, amounts, maxBurnAmount?, deadline?): Promise<TransactionRequest>

Returns the transaction request for removing liquidity from a pool.

Parameters

Name	Type	Default value	Description
domainId	string	undefined	The domain ID of the pool.
tokenAddress	string	undefined	The address of local or adopted token.
amounts	string[]	undefined	The amount of LP tokens to burn.
maxBurnAmount	string	"0" (Use total LP balance)	(optional) The max LP tokens the user is willing to burn.
deadline	number	One hour from current time.	(optional) The deadline for the operation.

Returns

Promise<TransactionRequest>

providers.TransactionRequest object.

---

swap

▸ swap(domainId, tokenAddress, from, to, amount, minDy?, deadline?): Promise<TransactionRequest>

Returns the transaction request for performing a swap in a pool.

Parameters

Name	Type	Default value	Description
domainId	string	undefined	The domain ID of the pool.
tokenAddress	string	undefined	The address of local or adopted token.
from	string	undefined	The address of the token to sell.
to	string	undefined	The address of the token to buy.
amount	string	undefined	The amount of the selling token to swap.
minDy	number	0	(optional) The minimum amount of the buying token to receive.
deadline	number	undefined	(optional) The deadline for the operation.

Returns

Promise<TransactionRequest>

providers.TransactionRequest object.

---

create

▸ Static create(_config): Promise<SdkPool>

Create a singleton instance of the SdkPool class.

Parameters

Name	Type	Default value	Description
_config	Object	undefined	SdkConfig object.
_config.chains	Record<string, { providers: string[] }>	undefined	Chain config, at minimum with providers for each chain.
_config.signerAddress	string	undefined	Signer address for transactions.
_config.logLevel	"fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent"	"info"	(optional) Logging severity level.
_config.network	"testnet" | "mainnet"	"mainnet"	(optional) Blockchain environment to interact with.

Returns

Promise<SdkPool>

providers.TransactionRequest object.

@example:

import { SdkPool } from "@connext/sdk";

const config = {
  signerAddress: "<wallet_address>",
  network: "mainnet",
  chains: {
    6648936: { // the domain ID for Ethereum Mainnet
      providers: ["https://rpc.ankr.com/eth"],
    },
    1869640809: { // the domain ID for Optimism
      providers: ["https://mainnet.optimism.io"]
    },
    1886350457: { // the domain ID for Polygon
      providers: ["https://polygon-rpc.com"]
    },
  },
}

const sdkPool = await SdkPool.create(config);

note

See the Supported Chains page for all domain IDs and the Deployments page for all asset addresses.

---

domainToChainName

▸ Static domainToChainName(domainId): string

Returns the chain name for a specified domain.

Parameters

Name	Type	Description
domainId	string	The domain ID.

Returns

string

The chain name.

Inherited from

SdkShared.domainToChainName

---

getBlockNumberFromUnixTimestamp

▸ Static getBlockNumberFromUnixTimestamp(domainId, unixTimestamp): Promise<number>

Parameters

Name	Type	Description
domainId	string	The domain ID.
unixTimestamp	number	The unix timestamp.

Returns

Promise<number>

Inherited from

SdkShared.getBlockNumberFromUnixTimestamp