EthereumSDK | @ankr.com/staking-sdk

EthereumSDK allows you to interact with Ethereum Liquid Staking smart contracts on Ethereum (Mainnet, Goerli Tesnet) BNB Smart Chain: aETHb, aETHc, and GlobalPool.

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

Hierarchy

EthereumSDK

Implements

Constructors

Private constructor

new EthereumSDK(__namedParameters: IEthSDKArgs): EthereumSDK

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:114
Private constructor. Instead, use EthereumSDK.getInstance.

Parameters
- __namedParameters: IEthSDKArgs
Returns EthereumSDK

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

writeProvider: Web3KeyWriteProvider

writeProvider — provider which has signer for signing transactions.

readonly

Static Private Optional instance

instance?: EthereumSDK

instance — SDK instance.

static

Methods

addTokenToWallet

addTokenToWallet(token: string): Promise<boolean>

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

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol (aETHb or aETHc)
Returns Promise<boolean>

approveACForAB

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

Implementation of ISwitcher.approveACForAB
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:794
Approve aETHc for aETHb, i.e. allow aETHb smart contract to access and transfer aETHc 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<IWeb3SendResult>

claim

claim(token: string): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:895
Claim tokens.

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol
Returns Promise<IWeb3SendResult>

Private connectWriteProvider

connectWriteProvider(): Promise<void>

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:345
Returns Promise<void>

fetchTxData

fetchTxData(txHash: string, shouldDecodeAmount?: boolean): Promise<IFetchTxData>

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

note
Parses first uint256 param from transaction input.

Parameters
- txHash: string
  
  transaction hash
- shouldDecodeAmount: boolean = true
Returns Promise<IFetchTxData>

fetchTxReceipt

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

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

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

getABBalance

getABBalance(isFormatted?: boolean): Promise<BigNumber>

Implementation of ISwitcher.getABBalance
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:233
Return aETHb token balance.

Parameters
- Optional isFormatted: boolean
Returns Promise<BigNumber>
- human readable balance

getACAllowance

getACAllowance(): Promise<BigNumber>

Implementation of ISwitcher.getACAllowance
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:359
Return aETHc allowance.

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

Returns Promise<BigNumber>
- allowance in wei

getACBalance

getACBalance(isFormatted?: boolean): Promise<BigNumber>

Implementation of ISwitcher.getACBalance
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:268
Return aETHc token balance.

Parameters
- Optional isFormatted: boolean
Returns Promise<BigNumber>
- human readable balance

getACRatio

getACRatio(isFormatted?: boolean): Promise<BigNumber>

Implementation of ISwitcher.getACRatio
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:304
Return aETHc/ETH ratio.

note
Read about aBNBc/BNB ratio and draw analogy between BNB and ETH in respect to the ratio.

Parameters
- Optional isFormatted: boolean
Returns Promise<BigNumber>
- human readable ratio

getClaimable

getClaimable(token: string): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:872
Get claimable amount.

Parameters
- token: string
  
  token symbol
Returns Promise<BigNumber>

getEthBalance

getEthBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:195
Return ETH balance.

Returns Promise<BigNumber>

Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

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

Parameters
- gasLimit: number
  
  initial gas limit
Returns number

Private getIsEthChain

getIsEthChain(): boolean

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

Returns boolean

getLatestBlock

getLatestBlock(): Promise<number>

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

Returns Promise<number>

getMinimumStake

getMinimumStake(): Promise<BigNumber>

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

Returns Promise<BigNumber>

Private getPastEvents

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

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:724
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/ethereum/sdk.ts:737
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/ethereum/sdk.ts:766
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/ethereum/sdk.ts:478
Get total pending unstake amount.

note
not supported yet. Read why unstaking ETH is not possible at the moment.

Returns Promise<BigNumber>

getPendingData

getPendingData(): Promise<IPendingData>

Implementation of IStakable.getPendingData
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:490
Get pending data for aETHb and aETHc.

note
not supported yet. Read why unstaking ETH is not possible at the moment.

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/ethereum/sdk.ts:210
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/ethereum/sdk.ts:506
Get stake gas fee.

note
Cahes computed gas fee value for future computations.

Parameters
- amount: BigNumber
  
  amount to stake
- token: string
  
  token symbol
Returns Promise<BigNumber>

getTxEventsHistory

getTxEventsHistory(): Promise<ITxEventsHistoryData>

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

note
Currently returns data for the last 14 days.

Returns Promise<ITxEventsHistoryData>

getTxEventsHistoryRange

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

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

note
Currently returns data for block range.

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

lockShares

lockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.lockShares
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:824
Switch aETHc to aETHb.

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/ethereum/sdk.ts:406
Stake token.

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

note
Read about Ankr Liquid Staking token types.

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

stakeWithoutClaim

stakeWithoutClaim(amount: BigNumber): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:383
Stake without claim.

This method is only for creating a testing capability. It is related to the STAKAN-1259 Do not use it for the production code.

deprecated
Parameters
- amount: BigNumber
  
  amount to stake
Returns Promise<IWeb3SendResult>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.unlockShares
- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:849
Switch aETHb to aETHc.

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/ethereum/sdk.ts:462
Unstake token.

note
not supported yet. Read why unstaking ETH is not possible at the moment.

note
Read about Ankr Liquid Staking token types.

Parameters
- _amount: BigNumber
- _token: string
Returns Promise<IWeb3SendResult>

Static Private getAethbContract

getAethbContract(provider: Web3KeyReadProvider | Web3KeyWriteProvider): Contract

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:254
Internal function to get aETHb token contract.

Parameters
- provider: Web3KeyReadProvider | Web3KeyWriteProvider
  
  readProvider or writeProvider
Returns Contract

Static Private getAethcContract

getAethcContract(provider: Web3KeyReadProvider | Web3KeyWriteProvider): Contract

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:289
Internal function to get aETHc token contract.

Parameters
- provider: Web3KeyReadProvider | Web3KeyWriteProvider
  
  readProvider or writeProvider
Returns Contract

Static Private getEthPoolContract

getEthPoolContract(provider: Web3KeyReadProvider | Web3KeyWriteProvider): Contract

- Defined in packages/staking-sdk/src/modules/ethereum/sdk.ts:533
Internal function to get GlobalPool contract.

Parameters
- provider: Web3KeyReadProvider | Web3KeyWriteProvider
  
  readProvider or writeProvider
Returns Contract

Static getInstance

getInstance(args?: Partial<IEthSDKArgs>): Promise<EthereumSDK>

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

Auto-connects write provider if chains are the same. Initializes read provider to support multiple chains.

static
Parameters
- Optional args: Partial<IEthSDKArgs>
Returns Promise<EthereumSDK>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

__namedParameters: IEthSDKArgs

Returns EthereumSDK

Properties

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<IWeb3SendResult>

claim

Parameters

token: string

Returns Promise<IWeb3SendResult>

Private connectWriteProvider

Returns Promise<void>

fetchTxData

Parameters

txHash: string

shouldDecodeAmount: boolean = true

Returns Promise<IFetchTxData>

fetchTxReceipt

Parameters

txHash: string

Returns Promise<null | TransactionReceipt>

getABBalance

Parameters

Optional isFormatted: boolean

Returns Promise<BigNumber>

getACAllowance

Returns Promise<BigNumber>

getACBalance

Parameters

Optional isFormatted: boolean

Returns Promise<BigNumber>

getACRatio

Parameters

Optional isFormatted: boolean

Returns Promise<BigNumber>

getClaimable

Parameters

token: string

Returns Promise<BigNumber>

getEthBalance

Returns Promise<BigNumber>

Private getIncreasedGasLimit

Parameters

gasLimit: number

Returns number

Private getIsEthChain

Returns boolean

getLatestBlock

Returns Promise<number>

getMinimumStake

Returns Promise<BigNumber>

Private getPastEvents

Parameters

options: IGetPastEvents<Web3KeyReadProvider>

Returns Promise<EventData[]>

Private getPastEventsAPI

Parameters

__namedParameters: IGetPastEvents<Web3KeyReadProvider>

Returns Promise<EventData[]>