Class PoolSimulator

constructor

• new PoolSimulator(
      poolAddress: string,
      initA: number,
      decimals: Allocation[],
      feeNumerator: number,
      adminFeeNumerator: number,
      rates?: Allocation[],
  ): PoolSimulator

• Parameters

  • poolAddress: string
  • initA: number
  • decimals: Allocation[]
  • feeNumerator: number
  • adminFeeNumerator: number
  • Optionalrates: Allocation[]

  Returns PoolSimulator

adminFeeNumerator

adminFees

assetIndexes

assets

balances

decimals

feeNumerator

futureA

futureATime

initA

initATime

lpTotalSupply

now

poolAddress

poolAssetCount

precisionMultipliers

rates

claimAdminFees

• claimAdminFees(rates?: Allocation[]): SimulateDepositResult

• Parameters

  • Optionalrates: Allocation[]

  Returns SimulateDepositResult

deposit

• deposit(depositParams: SimulateDepositParams): SimulateDepositResult

• Parameters

  • depositParams: SimulateDepositParams

  Returns SimulateDepositResult

dy

• dy(i: number, j: number, dx: bigint, _rates: bigint[]): bigint

• Parameters

  • i: number
  • j: number
  • dx: bigint
  • _rates: bigint[]

  Returns bigint

getA

• getA(): number

• Returns number

getD

• getD(xp: bigint[], amp: number): bigint

• Parameters

  • xp: bigint[]
  • amp: number

  Returns bigint

getDMem

• getDMem(balances: bigint[], rates: bigint[], amp: number): bigint

• Parameters

  • balances: bigint[]
  • rates: bigint[]
  • amp: number

  Returns bigint

getIndex

• getIndex(asset: Asset): number

• Parameters

  • asset: Asset

  Returns number

getVirtualPrice

• getVirtualPrice(rates?: Allocation[]): bigint

• Parameters

  • Optionalrates: Allocation[]

  Returns bigint

getY

• getY(i: number, j: number, x: bigint, xp_: bigint[]): bigint

• Parameters

  • i: number
  • j: number
  • x: bigint
  • xp_: bigint[]

  Returns bigint

getYD

• getYD(i: number, xp: bigint[], d: bigint): bigint

• Parameters

  • i: number
  • xp: bigint[]
  • d: bigint

  Returns bigint

rampA

• rampA(futureA: number, futureATime: number, nowBeforeRampA: number): void

• Parameters

  • futureA: number
  • futureATime: number
  • nowBeforeRampA: number

  Returns void

restoreSnapshot

• restoreSnapshot(state: SimulatorSnapshot): void

• Parameters

  • state: SimulatorSnapshot

  Returns void

saveSnapshot

• saveSnapshot(): SimulatorSnapshot

• Returns SimulatorSnapshot

stopRampA

• stopRampA(now: number): void

• Parameters

  • now: number

  Returns void

swap

• swap(swapParams: SimulateSwapParams): SimulateSwapResult

• Parameters

  • swapParams: SimulateSwapParams

  Returns SimulateSwapResult

withdraw

• withdraw(withdrawParams: SimulateWithdrawParams): SimulateWithdrawResult

• Parameters

  • withdrawParams: SimulateWithdrawParams

  Returns SimulateWithdrawResult

Staticcreate

• create(state: SimulatorState): PoolSimulator

• Parameters

  • state: SimulatorState

  Returns PoolSimulator