default | @apwine/sdk

Hierarchy

default

Constructors

constructor

new default(__namedParameters: SDKProps, options?: SDKOptions): default

- Defined in src/sdk.ts:126
Creates a new APWine SDK instance.

Parameters
- __namedParameters: SDKProps
- options: SDKOptions = ...
Returns default

Properties

AMMRegistry

AMMRegistry: AMMRegistry

The AMM Registry contract instance. Keeps track of all AMMs.

Controller

Controller: null | Controller = null

The Controller contract instance. Provides some basic flows, like withdraw/deposit.

async

FutureVault

FutureVault: (address: string) => FutureVault

Type declaration

- (address: string): FutureVault
- Get a target FutureVault contract instance.
  
  Parameters
  - address: string
    
    address of the desired Future.
  Returns FutureVault
  - FutureVault instance on the given address

Registry

Registry: Registry

The Registry contract instance. Keeps track of all utility contracts.

Router

Router: AMMRouterV1

The AMM Router contract instance. Simplifies some processes through AMMs.

defaultSlippage

defaultSlippage: number

The slippage tolerance being used by default on swaps.

defaultUser

defaultUser: string = ''

The default user which will be used in case no user is passed to certain functions. The initial value will be the result of signer.getAddress()

network

network: Network

The network the SDK instance is connected to.

provider

provider: Provider

The provider, necessary for fetching data.

ready

ready: boolean | Promise<[Controller, undefined | string]> = false

Await this propery to use asynchronous props, like Controller.

async

signer

signer: null | Signer

The signer, necessary for executing transactions.

signerOrProvider

signerOrProvider: Signer | Provider

Keep track of whether the signer or the provider is being used, when creating contract instances.

Methods

addLiquidity

addLiquidity(params: AddLiquidityParams, options?: Options): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:478
Add liqidity for the target AMM for a user.
transaction
- requires a signer.
Parameters
- params: AddLiquidityParams
  
  AddLiquidityParams
- Optional options: Options
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

allowance

allowance(spender: string, tokenAddress: string, account?: string): Promise<TokenAmount>

- Defined in src/sdk.ts:329
Fetch the spendable amount by another party(spender) from the owner's tokens on a future vault

Parameters
- spender: string
  
  The contract/entity to which the allowance is set.
- tokenAddress: string
  
  The address of the token contract.
- Optional account: string
  
  The token owner's wallet address
Returns Promise<TokenAmount>
- The allowance in TokenAmount.

approve

approve(spender: string, tokenAddress: string, amount: BigNumberish): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:311
Approve transactions for a token amount for the target token.
transaction
- requires a signer.
Parameters
- spender: string
  
  The contract/entity receiving approval for spend.
- tokenAddress: string
  
  The address of the token contract.
- amount: BigNumberish
  
  The amount of tokens to be approved.
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

approveLPForAll

approveLPForAll(amm: AMM, approval?: boolean): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:440
Set LPToken approval status for an account.
transaction
- requires a signer.
Parameters
- amm: AMM
  
  The AMM on which the approval will happen.
- approval: boolean = true
  
  Boolean value of the approval.
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

deposit

deposit(future: FutureVault, amount: BigNumberish, options?: { autoApprove: boolean }): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:563
Deposit amount to a future vault.
transaction
- requires a signer.
Parameters
- future: FutureVault
  
  The future to be withdrawn from.
- amount: BigNumberish
  
  The amount to be withdrawn.
- options: { autoApprove: boolean } = ...
  - autoApprove: boolean
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

fetchAMM

fetchAMM(future: FutureVault): Promise<AMM>

- Defined in src/sdk.ts:291
Fetch the AMM of the provided FutureVault instance.

Parameters
- future: FutureVault
  
  The target Future vault.
Returns Promise<AMM>
- AMM contract instance.

fetchAllAMMs

fetchAllAMMs(): Promise<AMM[]>

- Defined in src/sdk.ts:299
Fetch all AMMs

Returns Promise<AMM[]>
- Promise of an AMM collection.

fetchAllFYTs

fetchAllFYTs(): Promise<FutureYieldToken[]>

- Defined in src/sdk.ts:419
Fetch all FYT contract instances.

Returns Promise<FutureYieldToken[]>
- a collection of FYT token contract instances.

fetchAllFutureAggregates

fetchAllFutureAggregates(amm: AMM): Promise<FutureAggregate[]>

- Defined in src/sdk.ts:370
Fetch all aggregated Future constructs on an AMM.

Parameters
- amm: AMM
Returns Promise<FutureAggregate[]>
- A collection of aggregated objects with future related data

fetchAllFutureVaults

fetchAllFutureVaults(): Promise<FutureVault[]>

- Defined in src/sdk.ts:378
Fetch all future vaults.

Returns Promise<FutureVault[]>
- All FutureVault instances.

fetchAllLPTokenPools

fetchAllLPTokenPools(amm: AMM): Promise<{ address: string; id: BigNumber; pairId: 0 | 1; periodIndex: undefined | BigNumberish; token: LPToken }[]>

- Defined in src/sdk.ts:467
Fetch an aggregated construct collection of all LPTokenPools.

Parameters
- amm: AMM
  
  Fetch all liquidity pools of an AMM.
Returns Promise<{ address: string; id: BigNumber; pairId: 0 | 1; periodIndex: undefined | BigNumberish; token: LPToken }[]>
- A collection of aggregated constructs with LPTokenPool related data.

fetchFutureAggregateFromAddress

fetchFutureAggregateFromAddress(futureAddress: string): Promise<FutureAggregate>

- Defined in src/sdk.ts:357
Fetch an aggregated Future construct by future vault address.

Parameters
- futureAddress: string
  
  The address of the future to be fetched.
Returns Promise<FutureAggregate>
- An aggregated object with future related data.

fetchFutureAggregateFromIndex

fetchFutureAggregateFromIndex(index: number): Promise<FutureAggregate>

- Defined in src/sdk.ts:344
Fetch an aggregated Future construct by future vault index.

Parameters
- index: number
  
  The index of the future to be fetched.
Returns Promise<FutureAggregate>
- An aggregated object with future related data.

fetchLPTokenPool

fetchLPTokenPool(amm: AMM, pairId: 0 | 1, periodIndex?: number): Promise<{ address: string; id: BigNumber; pairId: 0 | 1; periodIndex: undefined | BigNumberish; token: LPToken }>

- Defined in src/sdk.ts:458
Fetch an aggregated construct of an LPTokenPool

Parameters
- amm: AMM
  
  The target AMM on which the tokenPool exists.
- pairId: 0 | 1
  
  The pair id of the token pair, 0 or 1.
- Optional periodIndex: number
  
  anything from 0 to the current period index. Default is the current period.
Returns Promise<{ address: string; id: BigNumber; pairId: 0 | 1; periodIndex: undefined | BigNumberish; token: LPToken }>
- An aggregated construct with LPTokenPool related data.

fetchPT

fetchPT(amm: AMM): Promise<PT>

- Defined in src/sdk.ts:410
Fetch PT token contract instance of an AMM.

Parameters
- amm: AMM
  
  The target AMM.
Returns Promise<PT>
- PT token contract instance.

fetchSpotPrice

fetchSpotPrice(future: FutureVault, from: "PT" | "Underlying" | "FYT", to: "PT" | "Underlying" | "FYT"): Promise<BigNumber | Error>

- Defined in src/sdk.ts:590
Fetch spot price of a swap route.

Parameters
- future: FutureVault
  
  The target future on which the spot price is being queried.
- from: "PT" | "Underlying" | "FYT"
  
  APWToken: PT, Underlying or FYT.
- to: "PT" | "Underlying" | "FYT"
  
  APWToken: PT, Underlying or FYT.
Returns Promise<BigNumber | Error>
- spot price in BigNumber format.

initialize

initialize(): Promise<[Controller, undefined | string]>

- Defined in src/sdk.ts:160
Initializes all asynchronous properties, and sets the resulting promise in sdkInstance.ready

Returns Promise<[Controller, undefined | string]>
- A Promise of a collection of asynchronous props wrapped into Promise.all

isApprovalNecessary

isApprovalNecessary(tokenAddress: string, amount: BigNumberish, spender: string, account?: string): Promise<boolean>

- Defined in src/sdk.ts:390
Check if the user needs to give approval to an entity, for an amount of a token.

Parameters
- tokenAddress: string
  
  The address of the token.
- amount: BigNumberish
  
  The amount in question.
- spender: string
  
  The entity of which the approval is being queried.
- Optional account: string
  
  The owner of the tokens.
Returns Promise<boolean>
- a boolean value.

isLPApprovedForAll

isLPApprovedForAll(amm: AMM, account?: string): Promise<boolean>

- Defined in src/sdk.ts:429
Inspect LPToken approval status of an account.

Parameters
- amm: AMM
  
  The amm on which to check LPToken approval status.
- Optional account: string
  
  The user whose approval status is queried.
Returns Promise<boolean>
- a boolean value of the approval of this account for all LPs.

removeLiquidity

removeLiquidity(params: RemoveLiquidityParams, options?: Options): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:496
Remove liquidity from the target AMM for a user.
transaction
- requires a signer.
Parameters
- params: RemoveLiquidityParams
  
  RemoveLiquidityParams
- Optional options: Options
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

swapIn

swapIn(params: WithOptional<SwapParams, "slippageTolerance">, options?: Options): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:601
Swap by controlling the exact amount of tokens passed in.
transaction
- requires a signer.
Parameters
- params: WithOptional<SwapParams, "slippageTolerance">
  
  SwapParams with optional slippageTolerance.
- options: Options = ...
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- either an error object, or a ContractTransaction

swapOut

swapOut(params: WithOptional<SwapParams, "slippageTolerance">, options?: Options): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:631
Swap by controlling the exact amount of tokens coming out.
transaction
- requires a signer.
Parameters
- params: WithOptional<SwapParams, "slippageTolerance">
  
  SwapParams with optional slippageTolerance.
- options: Options = ...
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- either an error object, or a ContractTransaction

updateAllowance

updateAllowance(spender: string, tokenAddress: string, amount: BigNumberish, options?: { autoApprove: boolean }): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:516
Update the spendable amount by another party(spender) from the owner's tokens on a future vault.
transaction
- requires a signer.
Parameters
- spender: string
  
  The contract/entity for which the allowance will be updated.
- tokenAddress: string
  
  The address of the token contract.
- amount: BigNumberish
  
  The amount of the allowance.
- options: { autoApprove: boolean } = ...
  - autoApprove: boolean
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

updateDefaultUser

updateDefaultUser(address: string): void

- Defined in src/sdk.ts:240
Update default user on an existing APWineSDK instance.

Parameters
- address: string
  
  The address of the new user.
Returns void

updateNetwork

updateNetwork(network: Network): void

- Defined in src/sdk.ts:261
Updates the network on an existing APWineSDK instance.

Parameters
- network: Network
  
  The network on which the SDK instance operates
Returns void

updateProvider

updateProvider(provider: Provider, useWithContracts?: boolean): void

- Defined in src/sdk.ts:249
Updates the provider on an existing APWineSDK instance.

Parameters
- provider: Provider
  
  A provider to connect to the ethereum blockchain.
- useWithContracts: boolean = false
  
  'Set this provider to sdk.signerOrProvider, and re-instantiate contract instances with it.'
Returns void

updateSigner

updateSigner(signer: Signer, useWithContracts?: boolean): void

- Defined in src/sdk.ts:270
Updates the signer on an existing APWineSDK instance.

Parameters
- signer: Signer
  
  A transaction signer.
- useWithContracts: boolean = true
  
  'Set this signer to sdk.signerOrProvider, and re-instantiate contract instances with it.'
Returns void

updateSlippageTolerance

updateSlippageTolerance(slippage: number): void

- Defined in src/sdk.ts:282
Set default slippage tolerance for the SDK instance.

Parameters
- slippage: number
  
  Default slippage to be set.
Returns void

useProvider

useProvider(): void

- Defined in src/sdk.ts:212
Switch to provider usage on the sdk instance. This is useful, when the priority is fetching. (utilizing MulticallProvider)

Returns void

useSigner

useSigner(): void

- Defined in src/sdk.ts:176
Switch to signer usage on the sdk instance. This is necessary if transactions are to be executed.

Returns void

withdraw

withdraw(future: FutureVault, amount: BigNumberish): Promise<undefined | SDKFunctionReturnType<Transaction>>

- Defined in src/sdk.ts:544
Withdraw amount from a future vault.
transaction
- requires a signer.
Parameters
- future: FutureVault
  
  The future to be withdrawn from.
- amount: BigNumberish
  
  The amount to be withdrawn.
Returns Promise<undefined | SDKFunctionReturnType<Transaction>>
- an SDK returnType which contains a transaction and/or an error.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: SDKProps

options: SDKOptions = ...

Returns default

Properties

AMMRegistry

Controller

FutureVault

Type declaration

Parameters

address: string

Returns FutureVault

Registry

Router

defaultSlippage

defaultUser

network

provider

ready

signer

signerOrProvider

Methods

addLiquidity

Parameters

params: AddLiquidityParams

Optional options: Options

Returns Promise<undefined | SDKFunctionReturnType<Transaction>>

allowance

Parameters

spender: string

tokenAddress: string

Optional account: string

Returns Promise<TokenAmount>

approve

Parameters

spender: string

tokenAddress: string

amount: BigNumberish

Returns Promise<undefined | SDKFunctionReturnType<Transaction>>

approveLPForAll

Parameters

amm: AMM

approval: boolean = true

Returns Promise<undefined | SDKFunctionReturnType<Transaction>>

deposit

Parameters

future: FutureVault

amount: BigNumberish

options: { autoApprove: boolean } = ...

autoApprove: boolean

Returns Promise<undefined | SDKFunctionReturnType<Transaction>>

fetchAMM

Parameters

future: FutureVault

Returns Promise<AMM>

fetchAllAMMs

Returns Promise<AMM[]>

fetchAllFYTs

Returns Promise<FutureYieldToken[]>

fetchAllFutureAggregates

Parameters

amm: AMM

Returns Promise<FutureAggregate[]>

fetchAllFutureVaults

Returns Promise<FutureVault[]>

fetchAllLPTokenPools

Parameters

amm: AMM

Returns Promise<{ address: string; id: BigNumber; pairId: 0 | 1; periodIndex: undefined | BigNumberish; token: LPToken }[]>

fetchFutureAggregateFromAddress

Parameters

futureAddress: string

Returns Promise<FutureAggregate>