FantomSDK | @ankr.com/staking-sdk

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

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

Hierarchy

FantomSDK

Implements

Constructors

Private constructor

new FantomSDK(__namedParameters: IFantomSDKArgs): FantomSDK

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:120
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 currentAccount

currentAccount: string

currentAccount — connected account.

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

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 aFTMc)
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:675
Approve aFTMc for aFTMb, i.e. allow aFTMb smart contract to access and transfer aFTMc 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:657
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:233
Internal function to convert wei value to human readable format.

Parameters
- amount: string
  
  value in wei
Returns BigNumber

fetchTxData

fetchTxData(txHash: string): Promise<IFetchTxData>

Implementation of ISwitcher.fetchTxData
- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:512
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:537
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:957
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:638
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:973
Return aFTMc 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:990
Return aFTMc/FTM ratio.

note
Read about aFTMc/FTM ratio.

Returns Promise<BigNumber>
- human readable ratio

Private getAftmbTokenContract

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

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

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

Private getAftmcTokenContract

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

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

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

getBurnFee

getBurnFee(amount: BigNumber): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:869
Get burn fee for amount

Parameters
- amount: BigNumber
  
  amount to burn
Returns Promise<BigNumber>

Private getFantomPoolContract

getFantomPoolContract(provider: Web3KeyReadProvider | Web3KeyWriteProvider): Contract

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

Parameters
- provider: Web3KeyReadProvider | Web3KeyWriteProvider
  
  read or write provider
Returns Contract

getFtmBalance

getFtmBalance(): Promise<BigNumber>

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

Returns Promise<BigNumber>
- human-readable balance

Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:609
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:304
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:887
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:444
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:457
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:486
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:1008
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:1024
Get pending data for aFTMb and aFTMc.

note
Read about Ankr Liquid Staking token types.

Returns Promise<IPendingData>

Private getProvider

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

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:190
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: TFtmSyntToken): Promise<BigNumber>

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

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

Private getStakeMethodName

getStakeMethodName(token: TFtmSyntToken): string

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

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

getTxEventsHistory

getTxEventsHistory(): Promise<ITxEventsHistoryData>

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

note
Currently returns data for the last 7 days.

Returns Promise<ITxEventsHistoryData>

getTxEventsHistoryRange

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

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

note
Currently returns data for block range.

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

Private getUnstakeMethodName

getUnstakeMethodName(token: TFtmSyntToken): string

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

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

Private isFtmNetwork

isFtmNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:216
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:712
Switch aFTMc 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:559
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 aFTMc)
Returns Promise<IStakeData>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

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

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:783
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 aFTMc)
Returns Promise<IWeb3SendResult>

Static getInstance

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

- Defined in packages/staking-sdk/src/modules/fantom/sdk.ts:144
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

Methods

Constructors

Private constructor

Parameters

__namedParameters: IFantomSDKArgs

Returns FantomSDK

Properties

Private Readonly apiGateWay

Private Optional Readonly apiUrl

Private currentAccount

Private Readonly readProvider

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

amount: BigNumber

Returns Promise<boolean>

Private convertFromWei

Parameters

amount: string

Returns BigNumber

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

Parameters

isForceRead: boolean = false

Returns Promise<Contract>

Private getAftmcTokenContract

Parameters

isForceRead: boolean = false

Returns Promise<Contract>

getBurnFee

Parameters

amount: BigNumber

Returns Promise<BigNumber>

Private getFantomPoolContract

Parameters

provider: Web3KeyReadProvider | Web3KeyWriteProvider

Returns Contract

getFtmBalance

Returns Promise<BigNumber>

Private getIncreasedGasLimit

Parameters

gasLimit: number

Returns number

getLatestBlock

Returns Promise<number>

getMinimumStake

Returns Promise<BigNumber>