AvalancheSDK | @ankr.com/staking-sdk

AvalancheSDK allows you to interact with Avalanche Liquid Staking smart contracts on Avalanche network: aAVAXb, aAVAXc, and AvalanchePool.

For more information on Avalanche Liquid Staking from Ankr, refer to the development details.

Hierarchy

AvalancheSDK

Implements

Constructors

Private constructor

new AvalancheSDK(__namedParameters: IAvalancheSDKArgs): AvalancheSDK

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:123
Private constructor. Instead, use AvalancheSDK.getInstance.

Parameters
- __namedParameters: IAvalancheSDKArgs
Returns AvalancheSDK

Properties

Private Optional Readonly apiUrl

apiUrl?: string

apiUrl — URL of the advanced API.

readonly

Private currentAccount

currentAccount: string

currentAccount — connected account.

Private Readonly readProvider

readProvider: Web3KeyReadProvider

readProvider — provider which allows to read data without connecting the wallet.

readonly

Private Optional stakeGasFee

stakeGasFee?: BigNumber

stakeGasFee — cached stake gas fee.

Private Readonly writeProvider

writeProvider: Web3KeyWriteProvider

writeProvider — provider which has signer for signing transactions.

readonly

Static Private Optional instance

instance?: AvalancheSDK

instance — SDK instance.

static

Methods

addTokenToWallet

addTokenToWallet(token: string): Promise<boolean>

Implementation of ISwitcher.addTokenToWallet
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:458
Add token to wallet.

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol (aAVAXb or aAVAXc)
Returns Promise<boolean>

approveACForAB

approveACForAB(amount?: BigNumber, scale?: number): Promise<undefined | IWeb3SendResult>

Implementation of ISwitcher.approveACForAB
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:608
Approve aAVAXc for aAVAXb, i.e. allow aAVAXb smart contract to access and transfer aAVAXc tokens.

note
Initiates connect if writeProvider isn't connected.

note
Read about Ankr Liquid Staking token types.

Parameters
- amount: BigNumber = MAX_UINT256
- scale: number = 1
Returns Promise<undefined | IWeb3SendResult>

checkAllowance

checkAllowance(hexAmount: string): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:646
Checks if allowance is greater or equal to amount.

note
Allowance is the amount which spender is still allowed to withdraw from owner.

Parameters
- hexAmount: string
Returns Promise<boolean>
- true if amount doesn't exceed allowance, false - otherwise.

Private convertFromWei

convertFromWei(amount: string): BigNumber

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:143
Internal function to convert wei value to human readable format.

Parameters
- amount: string
  
  value in wei
Returns BigNumber

Private convertToHex

convertToHex(amount: BigNumber): string

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:154
Internal function to convert value to hex format.

Parameters
- amount: BigNumber
  
  value in human readable format
Returns string

fetchTxData

fetchTxData(txHash: string): Promise<IFetchTxData>

Implementation of ISwitcher.fetchTxData
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:561
Fetch transaction data.

note
Parses first uint256 param from transaction input.

Parameters
- txHash: string
  
  transaction hash.
Returns Promise<IFetchTxData>

fetchTxReceipt

fetchTxReceipt(txHash: string): Promise<null | TransactionReceipt>

Implementation of ISwitcher.fetchTxReceipt
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:587
Fetch transaction receipt.

Parameters
- txHash: string
  
  transaction hash.
Returns Promise<null | TransactionReceipt>

Private getAAVAXBTokenContract

getAAVAXBTokenContract(isForceRead?: boolean): Promise<Contract>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:167
Internal function to get aAVAXb token contract.

Parameters
- isForceRead: boolean = false
Returns Promise<Contract>

Private getAAVAXCTokenContract

getAAVAXCTokenContract(isForceRead?: boolean): Promise<Contract>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:185
Internal function to get aAVAXc token contract.

Parameters
- isForceRead: boolean = false
Returns Promise<Contract>

getABBalance

getABBalance(): Promise<BigNumber>

Implementation of ISwitcher.getABBalance
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:494
Return aAVAXb token balance.

Returns Promise<BigNumber>
- human readable balance

getACAllowance

getACAllowance(spender?: string): Promise<BigNumber>

Implementation of ISwitcher.getACAllowance
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:542
Checks if allowance is greater or equal to amount.

note
Allowance is the amount which spender is still allowed to withdraw from owner.

Parameters
- Optional spender: string
Returns Promise<BigNumber>
- allowance in wei

getACBalance

getACBalance(): Promise<BigNumber>

Implementation of ISwitcher.getACBalance
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:510
Return aAVAXc token balance.

Returns Promise<BigNumber>
- human readable balance

getACRatio

getACRatio(): Promise<BigNumber>

Implementation of ISwitcher.getACRatio
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:527
Return aAVAXc/AVAX ratio.

note
Read about aAVAXc/AVAX ratio.

Returns Promise<BigNumber>
- human readable ratio

getAVAXBalance

getAVAXBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:722
Return AVAX balance.

Returns Promise<BigNumber>
- human-readable balance

Private getAvalanchePoolContract

getAvalanchePoolContract(isForceRead?: boolean): Promise<Contract>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:203
Internal function to get AvalanchePool contract.

Parameters
- isForceRead: boolean = false
Returns Promise<Contract>

getLatestBlock

getLatestBlock(): Promise<number>

Implementation of IStakable.getLatestBlock
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1010
Get latest block number.

Returns Promise<number>

getMinimumStake

getMinimumStake(): Promise<BigNumber>

Implementation of IStakable.getMinimumStake
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:736
Get minimum stake amount.

Returns Promise<BigNumber>

Private getPastEvents

getPastEvents(options: IGetPastEvents<Web3KeyReadProvider>): Promise<EventData[]>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:224
An internal function for getting past events from the API or blockchain according to the current environment.

Parameters
- options: IGetPastEvents<Web3KeyReadProvider>
Returns Promise<EventData[]>

Private getPastEventsAPI

getPastEventsAPI(__namedParameters: IGetPastEvents<Web3KeyReadProvider>): Promise<EventData[]>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:237
Internal function to get past events from indexed logs API.

Parameters
- __namedParameters: IGetPastEvents<Web3KeyReadProvider>
Returns Promise<EventData[]>

Private getPastEventsBlockchain

getPastEventsBlockchain(__namedParameters: IGetPastEvents<Web3KeyReadProvider>): Promise<EventData[]>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:266
Internal function to get past events, using the defined range.

Parameters
- __namedParameters: IGetPastEvents<Web3KeyReadProvider>
Returns Promise<EventData[]>

getPendingClaim

getPendingClaim(): Promise<BigNumber>

Implementation of IStakable.getPendingClaim
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:797
Get total pending unstake amount.

Returns Promise<BigNumber>

getPendingData

getPendingData(): Promise<IPendingData>

Implementation of IStakable.getPendingData
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:814
Get pending data for aAVAXb and aAVAXc.

note
Read about Ankr Liquid Staking token types.

Returns Promise<IPendingData>

Private getPoolEventsBatch

getPoolEventsBatch(from: number, to: number): Promise<IEventsBatch>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:755
Internal function to return raw pool events.

note
Currently returns raw pool events for block range.

Parameters
- from: number
  
  from block
- to: number
  
  to block
Returns Promise<IEventsBatch>

Private getProvider

getProvider(isForceRead?: boolean): Promise<Web3KeyReadProvider | Web3KeyWriteProvider>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:291
Internal function to choose the right provider for read or write purpose.

Parameters
- isForceRead: boolean = false
Returns Promise<Web3KeyReadProvider | Web3KeyWriteProvider>

getStakeGasFee

getStakeGasFee(amount: BigNumber, token: string): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1094
Get stake gas fee.

note
Caches computed gas fee value for future computations.

Parameters
- amount: BigNumber
  
  amount to stake
- token: string
  
  token symbol (aAVAXb or aAVAXc)
Returns Promise<BigNumber>

Private getStakeMethodName

getStakeMethodName(token: string): string

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1024
Internal function to return stake method by token symbol.

Parameters
- token: string
  
  token symbol (aAVAXb or aAVAXc)
Returns string

getTxEventsHistory

getTxEventsHistory(): Promise<ITxEventsHistoryData>

Implementation of IStakable.getTxEventsHistory
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:867
Get transaction history.

note
Currently returns data for the last 26 days.

Returns Promise<ITxEventsHistoryData>

Private getTxEventsHistoryGroup

getTxEventsHistoryGroup(rawEvents?: EventData[]): Promise<ITxEventsHistoryGroupItem[]>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:319
Internal function to return transaction history group from events. TODO: reuse it from stake/api/getTxEventsHistoryGroup

Parameters
- Optional rawEvents: EventData[]
Returns Promise<ITxEventsHistoryGroupItem[]>

getTxEventsHistoryRange

getTxEventsHistoryRange(from: number, to: number): Promise<ITxEventsHistoryData>

Implementation of IStakable.getTxEventsHistoryRange
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:887
Get transaction history.

note
Currently returns data for block range.

Parameters
- from: number
  
  from block
- to: number
  
  to block
Returns Promise<ITxEventsHistoryData>

Private getTxType

getTxType(rawTxType?: string): null | string

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:369
Internal function to map event type to transaction type.

Parameters
- Optional rawTxType: string
Returns null | string

Private getUnstakeMethodName

getUnstakeMethodName(token: string): string

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1138
Internal function to return unstake method by token symbol.

Parameters
- token: string
  
  token symbol (aAVAXb or aAVAXc)
Returns string

Private isAvalancheNetwork

isAvalancheNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:389
Internal function to check the current network.

Parameters
- provider: Web3KeyWriteProvider
  
  current selected provider
Returns Promise<boolean>

lockShares

lockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.lockShares
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:661
Switch aAVAXc to aAVAXb.

note
Initiates connect if writeProvider isn't connected.

note
Read about Ankr Liquid Staking token types.

Parameters
- args: IShareArgs
  
  object with amount to switch and scale
Returns Promise<IWeb3SendResult>

stake

stake(amount: BigNumber, token: string): Promise<IStakeData>

Implementation of IStakable.stake
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1045
Stake token.

note
Initiates two transactions and connect if writeProvider isn't connected.

note
Estimates gas and multiplies it by GAS_FEE_MULTIPLIER to prevent MetaMask issue with gas calculation.

note
Read about Ankr Liquid Staking token types.

Parameters
- amount: BigNumber
  
  amount of token
- token: string
  
  choose which token to receive (aAVAXb or aAVAXc)
Returns Promise<IStakeData>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.unlockShares
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:693
Switch aAVAXb to aAVAXc.

note
Initiates connect if writeProvider isn't connected.

note
Read about Ankr Liquid Staking token types.

Parameters
- args: IShareArgs
  
  object with amount to switch and scale
Returns Promise<IWeb3SendResult>

unstake

unstake(amount: BigNumber, token: string): Promise<IWeb3SendResult>

Implementation of IStakable.unstake
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1158
Unstake token.

note
Initiates connect if writeProvider isn't connected.

note
Read about Ankr Liquid Staking token types.

Parameters
- amount: BigNumber
  
  amount to unstake
- token: string
  
  choose which token to unstake (aAVAXb or aAVAXc)
Returns Promise<IWeb3SendResult>

Static Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1126
Internal function to return increased gas limit.

static
Parameters
- gasLimit: number
  
  initial gas limit
Returns number

Static getInstance

getInstance(args?: Partial<IAvalancheSDKArgs>): Promise<AvalancheSDK>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:412
Initialization method for SDK.

Auto-connects writeProvider if chains are the same. Initializes readProvider to support multiple chains.

static
Parameters
- Optional args: Partial<IAvalancheSDKArgs>
Returns Promise<AvalancheSDK>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

__namedParameters: IAvalancheSDKArgs

Returns AvalancheSDK

Properties

Private Optional Readonly apiUrl

Private currentAccount

Private Readonly readProvider

Private Optional stakeGasFee

Private Readonly writeProvider

Static Private Optional instance

Methods

addTokenToWallet

Parameters

token: string

Returns Promise<boolean>

approveACForAB

Parameters

amount: BigNumber = MAX_UINT256

scale: number = 1

Returns Promise<undefined | IWeb3SendResult>

checkAllowance

Parameters

hexAmount: string

Returns Promise<boolean>

Private convertFromWei

Parameters

amount: string

Returns BigNumber

Private convertToHex

Parameters

amount: BigNumber

Returns string

fetchTxData

Parameters

txHash: string

Returns Promise<IFetchTxData>

fetchTxReceipt

Parameters

txHash: string

Returns Promise<null | TransactionReceipt>

Private getAAVAXBTokenContract

Parameters

isForceRead: boolean = false

Returns Promise<Contract>

Private getAAVAXCTokenContract

Parameters

isForceRead: boolean = false

Returns Promise<Contract>

getABBalance

Returns Promise<BigNumber>

getACAllowance

Parameters

Optional spender: string

Returns Promise<BigNumber>

getACBalance

Returns Promise<BigNumber>

getACRatio

Returns Promise<BigNumber>

getAVAXBalance

Returns Promise<BigNumber>

Private getAvalanchePoolContract

Parameters

isForceRead: boolean = false

Returns Promise<Contract>

getLatestBlock

Returns Promise<number>

getMinimumStake

Returns Promise<BigNumber>

Private getPastEvents

Parameters

options: IGetPastEvents<Web3KeyReadProvider>

Returns Promise<EventData[]>