Class Pool

Hierarchy

  • Pool

Constructors

constructor

Properties

address algod ammClient appId apr asset1Id asset2Id assetDataClient balance1 balance2 currentTargetAsset1ToAsset2Ratio futureAmplificationFactor futureAmplificationFactorTime goalTargetAsset1ToAsset2Ratio indexer initialAmplificationFactor initialAmplificationFactorTime initialTargetAsset1ToAsset2Ratio logicSig lpAssetId lpCirculation managerAppId poolType ramp_amplification_factor swapFee targetRatioAdjustmentEndTime targetRatioAdjustmentStartTime transactions tvl

Methods

binarySearch getAPR getAmplificationFactor getBurnQuote getBurnTxns getCreatePoolTxns getEmptyPoolQuote getInitializePoolTxns getPoolQuote getPoolTxns getSwapExactForQuote getSwapForExactQuote getSwapTxns getTVL getTargetRatio getTransactionHistory getZapQuote getZapTxns isCreated isNanoPool loadState scaleAsset1 unscaleAsset1

Constructors

constructor

  • Parameters

    • algod: Algodv2
    • ammClient: default
    • poolConfig: default
    • tvl: number = 0
    • apr: number = 0

    Returns Pool

Properties

address

address: string

algod

algod: Algodv2

ammClient

ammClient: default

appId

appId: number

apr

apr: number

asset1Id

asset1Id: number

asset2Id

asset2Id: number

assetDataClient

assetDataClient: default

balance1

balance1: number

balance2

balance2: number

currentTargetAsset1ToAsset2Ratio

currentTargetAsset1ToAsset2Ratio: number

futureAmplificationFactor

futureAmplificationFactor: number

futureAmplificationFactorTime

futureAmplificationFactorTime: number

goalTargetAsset1ToAsset2Ratio

goalTargetAsset1ToAsset2Ratio: number

indexer

indexer: Indexer

initialAmplificationFactor

initialAmplificationFactor: number

initialAmplificationFactorTime

initialAmplificationFactorTime: number

initialTargetAsset1ToAsset2Ratio

initialTargetAsset1ToAsset2Ratio: number

logicSig

logicSig: LogicSigAccount

lpAssetId

lpAssetId: number

lpCirculation

lpCirculation: number

managerAppId

managerAppId: number

poolType

poolType: PoolType

ramp_amplification_factor

ramp_amplification_factor: number

swapFee

swapFee: number

targetRatioAdjustmentEndTime

targetRatioAdjustmentEndTime: number

targetRatioAdjustmentStartTime

targetRatioAdjustmentStartTime: number

transactions

transactions: default[]

tvl

tvl: number

Methods

binarySearch

  • Parameters

    • lower: any
    • upper: any
    • objective: any

    Returns any

getAPR

getAmplificationFactor

getBurnQuote

getBurnTxns

getCreatePoolTxns

getEmptyPoolQuote

  • Parameters

    • asset1PooledAmount: number
    • asset2PooledAmount: number

    Returns PoolQuote

getInitializePoolTxns

  • Parameters

    Returns Promise<Transaction[]>

getPoolQuote

getPoolTxns

  • Parameters

    • user: AlgofiUser
    • quote: PoolQuote
    • maximumSlippage: number
    • addToUserCollateral: boolean = false

    Returns Promise<Transaction[]>

getSwapExactForQuote

getSwapForExactQuote

  • Parameters

    • swapOutAssetId: number
    • swapOutAmount: number

    Returns PoolQuote

getSwapTxns

getTVL

getTargetRatio

getTransactionHistory

getZapQuote

  • Parameters

    • assetAID: number
    • assetAAmount: number
    • assetBAmount: number = 0

    Returns PoolQuote

getZapTxns

  • Parameters

    • user: AlgofiUser
    • quote: PoolQuote
    • maxSlippage: number = 0.005
    • addToUserCollateral: boolean = false

    Returns Promise<Transaction[]>

isCreated

isNanoPool

loadState

scaleAsset1

  • Parameters

    • input: number

    Returns number

unscaleAsset1

  • Parameters

    • input: number

    Returns number

Settings

Member Visibility

Theme

Generated using TypeDoc