FantomSDK | @ankr.com/staking-sdk

FantomSDK allows you to interact with Fantom Liquid Staking smart contracts on Fantom (Mainnet, Tesnet): aFTMb, ankrFTM, and FantomPool.

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

Hierarchy

GetBlocksManager
- FantomSDK

Implements

Constructors

Private constructor

new FantomSDK(__namedParameters: IFantomSDKArgs): FantomSDK

Overrides GetBlocksManager.constructor
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:147
Private constructor. Instead, use FantomSDK.getInstance.

Parameters
- __namedParameters: IFantomSDKArgs
Returns FantomSDK

Properties

Private Readonly apiGateWay

apiGateWay: ApiGateway

apiGateWay — gateway instance.

Private Optional Readonly apiUrl

apiUrl?: string

apiUrl — URL of the advanced API.

readonly

Private contractConfig

contractConfig: IFantomConfig

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 Readonly writeProvider

writeProvider: Web3KeyWriteProvider

writeProvider — provider which has signer for signing transactions.

readonly

Static Private Optional instance

instance?: FantomSDK

instance — SDK instance.

static

Accessors

Private isMainnet

get isMainnet(): boolean

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:243
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/fantom/sdk.ts:904
Add token to wallet.

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol (aFTMb or ankrFTM)
Returns Promise<boolean>

approveACForAB

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

Implementation of ISwitcher.approveACForAB
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:700
Approve ankrFTM for aFTMb, i.e. allow aFTMb smart contract to access and transfer ankrFTM 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(amount: BigNumber): Promise<boolean>

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

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

Parameters
- amount: BigNumber
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/fantom/sdk.ts:285
Internal function to convert wei value to human readable format.

Parameters
- amount: string
  
  value in wei
Returns BigNumber

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/fantom/sdk.ts:546
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/fantom/sdk.ts:570
Fetch transaction receipt.

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

getABBalance

getABBalance(): Promise<BigNumber>

Implementation of ISwitcher.getABBalance
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:955
Return aFTMb 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/fantom/sdk.ts:664
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/fantom/sdk.ts:971
Return ankrFTM token balance.

Returns Promise<BigNumber>
- human readable balance

getACRatio

getACRatio(): Promise<BigNumber>

Implementation of ISwitcher.getACRatio
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:988
Return ankrFTM/FTM ratio.

note
Read about ankrFTM/FTM ratio.

Returns Promise<BigNumber>
- human readable ratio

Private getAftmbTokenContract

getAftmbTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:310
Internal function to get aFTMb token contract.

Returns Contract

Private getAnkrFTMTokenContract

getAnkrFTMTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:323
Internal function to get ankrFTM token 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.

Private getFantomPoolContract

getFantomPoolContract(): Contract

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:297
Internal function to get FantomPool contract.

Returns Contract

getFtmBalance

getFtmBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:942
Return FTM balance.

Returns Promise<BigNumber>
- human-readable balance

getFullTxHistory

getFullTxHistory(): Promise<ITxHistory>

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

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

Returns Promise<ITxHistory>
full transaction history.

Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

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

Parameters
- gasLimit: number
  
  initial gas limit
Returns number

getLatestBlock

getLatestBlock(): Promise<number>

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

Returns Promise<number>

getMinimumStake

getMinimumStake(): Promise<BigNumber>

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

Returns Promise<BigNumber>

Private getPastEvents

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

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:477
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/fantom/sdk.ts:492
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/fantom/sdk.ts:520
Internal function to get past events, using the defined range.

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

getPendingClaim

getPendingClaim(type?: TUnstakingStatsType): Promise<BigNumber>

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

Parameters
- type: TUnstakingStatsType = 'all'
Returns Promise<BigNumber>

getPendingData

getPendingData(): Promise<IPendingData>

Implementation of IStakable.getPendingData
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:1021
Get pending data for aFTMb and ankrFTM.

note
Read about Ankr Liquid Staking token types.

Returns Promise<IPendingData>

getStakeGasFee

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

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

Parameters
- amount: BigNumber
  
  amount to stake
- token: TFtmSyntToken
  
  token symbol (aFTMb or ankrFTM)
Returns Promise<BigNumber>

Private getStakeMethodName

getStakeMethodName(token: TFtmSyntToken): string

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

Parameters
- token: TFtmSyntToken
  
  token symbol (aFTMb or ankrFTM)
Returns string

Private getTxEventsHistoryGroup

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

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:425
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/fantom/sdk.ts:368
Get transaction history for block range.

note
Amount of each event is in FTM. If you need ankrFTM, 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 getUnstakeMethodName

getUnstakeMethodName(token: TFtmSyntToken): string

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

Parameters
- token: TFtmSyntToken
  
  token symbol (aFTMb or ankrFTM)
Returns string

Private getWriteProvider

getWriteProvider(): Promise<Web3KeyWriteProvider>

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

Returns Promise<Web3KeyWriteProvider>

Private isFtmNetwork

isFtmNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

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

Parameters
- provider: Web3KeyWriteProvider
Returns Promise<boolean>

lockShares

lockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.lockShares
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:740
Switch ankrFTM to aFTMb.

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/fantom/sdk.ts:591
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 (aFTMb or ankrFTM)
Returns Promise<IStakeData>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.unlockShares
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:775
Switch aFTMb to ankrFTM.

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/fantom/sdk.ts:811
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 (aFTMb or ankrFTM)
Returns Promise<IWeb3SendResult>

Static getInstance

getInstance(args?: Partial<IFantomSDKArgs>): Promise<FantomSDK>

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:177
Initialization method for the SDK.

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

static
Parameters
- Optional args: Partial<IFantomSDKArgs>
Returns Promise<FantomSDK>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

__namedParameters: IFantomSDKArgs

Returns FantomSDK

Properties

Private Readonly apiGateWay

Private Optional Readonly apiUrl

Private contractConfig

Private currentAccount

Private Readonly networkMode

Private Readonly readProvider

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

amount: BigNumber

Returns Promise<boolean>

Private convertFromWei

Parameters

amount: string

Returns BigNumber

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>

getABBalance

Returns Promise<BigNumber>

getACAllowance

Parameters

Optional spender: string

Returns Promise<BigNumber>

getACBalance

Returns Promise<BigNumber>

getACRatio

Returns Promise<BigNumber>

Private getAftmbTokenContract

Returns Contract

Private getAnkrFTMTokenContract

Returns Contract

getBlocks

Parameters

web3: default

blockNumbers: number[]

Returns Promise<BlockTransactionObject[]>

Private getFantomPoolContract

Returns Contract

getFtmBalance

Returns Promise<BigNumber>