AvalancheSDK | @ankr.com/staking-sdk

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

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

Hierarchy

GetBlocksManager
- AvalancheSDK

Implements

Constructors

Private constructor

new AvalancheSDK(__namedParameters: IAvalancheSDKArgs): AvalancheSDK

Overrides GetBlocksManager.constructor
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:144
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 contractConfig

contractConfig: IAvalancheConfig

Contract addresses by current network mode.

Private currentAccount

currentAccount: string

currentAccount — connected account.

Private Readonly networkMode

networkMode: ENetworkMode

Network mode.

readonly

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

Accessors

Private isMainnet

get isMainnet(): boolean

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:238
Returns true if instance is initialized with production mode.

Returns boolean

Methods

addTokenToWallet

addTokenToWallet(token: string): Promise<boolean>

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

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol (aAVAXb or ankrAVAX)
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:630
Approve ankrAVAX for aAVAXb, i.e. allow aAVAXb smart contract to access and transfer ankrAVAX 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:669
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:249
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:260
Internal function to convert value to hex format.

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

executeBatchCalls

executeBatchCalls<T>(web3: default, calls: TWeb3Call<T>[]): Promise<T[]>

Inherited from GetBlocksManager.executeBatchCalls
- Defined in packages/staking-sdk/src/modules/common/GetBlocksManager.ts:160
executeBatchCalls is supposed to decrease calls to blockchain. It only sends one request and returns data from each call.

Type Parameters
- T
Parameters
- web3: default
  
  web3 instance
- calls: TWeb3Call<T>[]
  
  web3 calls
Returns Promise<T[]>
array of return values from web3 calls

fetchTxData

fetchTxData(txHash: string): Promise<IFetchTxData>

Implementation of ISwitcher.fetchTxData
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:586
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:610
Fetch transaction receipt.

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

Private getAAVAXBTokenContract

getAAVAXBTokenContract(): Contract

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

Returns Contract

getABBalance

getABBalance(): Promise<BigNumber>

Implementation of ISwitcher.getABBalance
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:520
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:568
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:536
Return ankrAVAX 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:553
Return ankrAVAX/AVAX ratio.

note
Read about ankrAVAX/AVAX ratio.

Returns Promise<BigNumber>
- human readable ratio

getAVAXBalance

getAVAXBalance(): Promise<BigNumber>

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

Returns Promise<BigNumber>
- human-readable balance

Private getAnkrAVAXTokenContract

getAnkrAVAXTokenContract(): Contract

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

Returns Contract

Private getAvalanchePoolContract

getAvalanchePoolContract(): Contract

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

Returns Contract

getBlocks

getBlocks(web3: default, blockNumbers: number[]): Promise<BlockTransactionObject[]>

Inherited from GetBlocksManager.getBlocks
- Defined in packages/staking-sdk/src/modules/common/GetBlocksManager.ts:42
Internal function to get blocks by block number. It uses cache to avoid unnecessary requests.

Parameters
- web3: default
  
  web3 instance.
- blockNumbers: number[]
  
  block numbers to get.
Returns Promise<BlockTransactionObject[]>
blocks data.

getFullTxHistory

getFullTxHistory(): Promise<ITxHistory>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:895
Get transaction history for all period that starts from contract creation.

note
Amount of certificate event is in AVAX. If you need ankrAVAX, multiply by ratio. Pending status is not specified.

Returns Promise<ITxHistory>
full transaction history.

getLatestBlock

getLatestBlock(): Promise<number>

Implementation of IStakable.getLatestBlock
- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:972
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:763
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:322
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:335
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:363
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:824
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:841
Get pending data for aAVAXb and ankrAVAX.

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:782
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>

getPoolMinStake

getPoolMinStake(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:305
Returns Promise<BigNumber>

getStakeGasFee

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

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1049
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 ankrAVAX)
Returns Promise<BigNumber>

Private getStakeMethodName

getStakeMethodName(token: string): string

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

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

Private getTxEventsHistoryGroup

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

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:403
Internal function to return transaction history group from events.

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

getTxHistoryRange

getTxHistoryRange(lowestBlock: number, highestBlock: number, isUnstakeOnly?: boolean): Promise<ITxHistory>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:924
Get transaction history for block range.

note
Amount of each event is in AVAX. If you need ankrAVAX, multiply by ratio. Pending status is not specified.

Parameters
- lowestBlock: number
  
  from block number
- highestBlock: number
  
  to block number
- isUnstakeOnly: boolean = false
  
  if true, only unstake events will be returned
Returns Promise<ITxHistory>
- transaction history

Private getTxType

getTxType(rawTxType?: string): null | string

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:446
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:1094
Internal function to return unstake method by token symbol.

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

Private getWriteProvider

getWriteProvider(): Promise<Web3KeyWriteProvider>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:388
Internal function to get write provider. If provider is not connected, it will be connected.

Returns Promise<Web3KeyWriteProvider>

Private isAvalancheNetwork

isAvalancheNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:466
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:684
Switch ankrAVAX 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:1006
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 ankrAVAX)
Returns Promise<IStakeData>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

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

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:1114
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 ankrAVAX)
Returns Promise<IWeb3SendResult>

Static Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

- Defined in packages/staking-sdk/src/modules/avax/sdk.ts:1082
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:172
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

Accessors

Methods

Constructors

Private constructor

Parameters

__namedParameters: IAvalancheSDKArgs

Returns AvalancheSDK

Properties

Private Optional Readonly apiUrl

Private contractConfig

Private currentAccount

Private Readonly networkMode

Private Readonly readProvider

Private Optional stakeGasFee

Private Readonly writeProvider

Static Private Optional instance

Accessors

Private isMainnet

Returns boolean

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

executeBatchCalls

Type Parameters

T

Parameters

web3: default

calls: TWeb3Call<T>[]

Returns Promise<T[]>

fetchTxData

Parameters

txHash: string

Returns Promise<IFetchTxData>

fetchTxReceipt

Parameters

txHash: string

Returns Promise<null | TransactionReceipt>

Private getAAVAXBTokenContract

Returns 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 getAnkrAVAXTokenContract

Returns Contract

Private getAvalanchePoolContract

Returns Contract

getBlocks