The amount of curve tokens staked in synthetix staking pool.
rewardsEarned
number
SNX tokens earned from synthetix staking pool.
yfiTokenBalance
number
FYI token balance.
Parameter
Type
Description
buyToken
string
The buy token symbol.
sellToken
string
The sell token address.
sellAmt
number
The amount of tokens to sell. Amount to be written in normal form eg - 1.1 ETH, 100 DAI.
slippage
number
The slippage in percent eg - 1 means 1%, 10 means 10%, etc.
Return Parameter
Type
Description
buyAmt
number/string
Expected buy token amount.
buyAmtRaw
number/string
Expected buy token amount in decimal form.
unitAmt
number/string
The unit amount is the minimum amount of curve token amount expected per token amount. It is calculated with the help of slippage. The parameter is passed directly in the curve connector.
virtualPrice
number/string
Virtual price of the curve token on yUSD pool.
Parameter
Type
Description
token
string
The deposit token symbol.
amount
number
The amount of tokens to deposit. This should be a decimal value.
slippage
number
The slippage to deposit in percent eg - 1 means 1%, 10 means 10%, etc.
Return Parameter
Type
Description
curveAmt
number/string
Expected deposit token amount.
curveAmtRaw
number/string
Expected deposit token amount in decimal form.
unitAmt
number/string
The unit amount is the minimum amount of curve token expected per token. It is calculated with the help of slippage. The parameter is passed directly in the curve connector.
virtualPrice
number/string
Virtual price of the curve token on yUSD pool.
Parameter
Type
Description
token
string
The withdraw token symbol.
amount
number
The amount of tokens to withdraw. This should be a decimal value.
slippage
number
The slippage to withdraw in percent eg - 1 means 1%, 10 means 10%, etc.
Return Parameter
Type
Description
curveAmt
number/string
Expected Curve token amount to redeem.
curveAmtRaw
number/string
Expected Curve token amount to redeem in decimal form.
unitAmt
number/string
The unit amount is the minimum amount of curve token expected per token. It is calculated with the help of slippage. The parameter is passed directly in the curve connector.
virtualPrice
number/string
Virtual price of the curve token on yUSD pool.
Parameter
Type
Description
token
string
The withdraw token symbol.
amount
number
The amount of Curve tokens to redeem. This should be a decimal value.
slippage
number
The slippage to withdraw in percent eg - 1 means 1%, 10 means 10%, etc.
Return Parameter
Type
Description
amt
number/string
Expected withdraw token amount.
amtRaw
number/string
Expected withdraw token amount in decimal form.
unitAmt
number/string
The unit amount is the minimum amount of curve token expected per token. It is calculated with the help of slippage. The parameter is passed directly in the curve connector.