Options
All
  • Public
  • Public/Protected
  • All
Menu

Module types

Index

Type aliases

APWToken: typeof APW_TOKENS[number]
AddLiquidityParams: { account?: string; amm: AMM; amount: BigNumberish; maxAmountsIn?: [BigNumberish, BigNumberish]; pairId: PairId }

Type declaration

  • Optional account?: string
  • amm: AMM
  • amount: BigNumberish
  • Optional maxAmountsIn?: [BigNumberish, BigNumberish]
  • pairId: PairId
Error: { error?: string }

Type declaration

  • Optional error?: string
FutureAggregate: { address: string; amm: AMM; depositsPaused: boolean; ibtAddress: string; nextPeriodIndex: BigNumber; nextPeriodTimestamp: BigNumber; period: BigNumber; platform: string; ptAddress: string; vault: FutureVault; withdrawalsPaused: boolean }

Type declaration

  • address: string
  • amm: AMM
  • depositsPaused: boolean
  • ibtAddress: string
  • nextPeriodIndex: BigNumber
  • nextPeriodTimestamp: BigNumber
  • period: BigNumber
  • platform: string
  • ptAddress: string
  • vault: FutureVault
  • withdrawalsPaused: boolean
Network: keyof typeof CHAIN_IDS | typeof CHAIN_IDS[keyof typeof CHAIN_IDS] | BigNumber
Options: { autoApprove?: boolean }

Type declaration

  • Optional autoApprove?: boolean
PairId: typeof PAIR_IDS[number]
QueryParams: { signerOrProvider: Signer | Provider }

Type declaration

  • signerOrProvider: Signer | Provider
RemoveLiquidityParams: { account?: string; amm: AMM; amount: BigNumberish; minAmountsOut?: [BigNumberish, BigNumberish]; pairId: PairId }

Type declaration

  • Optional account?: string
  • amm: AMM
  • amount: BigNumberish
  • Optional minAmountsOut?: [BigNumberish, BigNumberish]
  • pairId: PairId
RequireExclusive<T, Keys>: Pick<T, Exclude<keyof T, Keys>> & { [ K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>> }[Keys]

Type parameters

  • T

  • Keys: keyof T = keyof T

SDKFunctionReturnType<T>: Error & T

Type parameters

  • T

SDKOptions: { initialize: boolean }

Type declaration

  • initialize: boolean
SDKProps: { defaultSlippage?: number; network: Network; provider: Provider; signer?: Signer | null }

Type declaration

  • Optional defaultSlippage?: number
  • network: Network
  • provider: Provider
  • Optional signer?: Signer | null
SwapParams: { amm: AMM; amount: BigNumberish; deadline?: Date; from: APWToken; slippageTolerance: number; to: APWToken }

Type declaration

  • amm: AMM
  • amount: BigNumberish
  • Optional deadline?: Date
  • from: APWToken
  • slippageTolerance: number
  • to: APWToken
Transaction: { transaction?: ContractTransaction }

Type declaration

  • Optional transaction?: ContractTransaction
TransactionParams: { signer: Signer }

Type declaration

  • signer: Signer
WithNetwork: { network: Network }

Type declaration

WithOptional<T, K>: Omit<T, K> & Partial<Pick<T, K>>

Type parameters

  • T

  • K: keyof T

Generated using TypeDoc, the 11/12/2022