PolygonOnEthereumSDK | @ankr.com/staking-sdk

PolygonOnEthereumSDK allows you to interact with Polygon Liquid Staking smart contracts on the Ethereum blockchain: MATIC, aMATICb, ankrMATIC, and polygonPool.

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

Hierarchy

GetBlocksManager
- PolygonOnEthereumSDK

Implements

Constructors

Private constructor

new PolygonOnEthereumSDK(__namedParameters: IPolygonSDKArgs): PolygonOnEthereumSDK

Overrides GetBlocksManager.constructor
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:135
Private constructor. Instead, use PolygonOnEthereumSDK.getInstance.

Parameters
- __namedParameters: IPolygonSDKArgs
Returns PolygonOnEthereumSDK

Properties

Private Optional Readonly apiUrl

apiUrl?: string

apiUrl — URL of the advanced API.

readonly

Private contractConfig

contractConfig: IEthereumConfig

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?: PolygonOnEthereumSDK

instance — SDK instance.

static

Accessors

Private isMainnet

get isMainnet(): boolean

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:226
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/polygon/sdk/ethSDK.ts:1177
Add token to wallet.

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol (ankrMATIC or aMATICb)
Returns Promise<boolean>

approveACForAB

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

Implementation of ISwitcher.approveACForAB
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:621
Approve ankrMATIC for aMATICb, i.e. allow aMATICb smart contract to access and transfer ankrMATIC tokens.

note
Initiates connect if writeProvider isn't connected.

note
Read about Ankr Liquid Staking token types.

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

approveMATICToken

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:465
Approve MATIC for PolygonPool, i.e. allow PolygonPool smart contract to access and transfer MATIC tokens.

note
Initiates connect if writeProvider doesn't connected.

note
Read about Ankr Liquid Staking token types.

Parameters
- amount: BigNumber = MAX_UINT256
- scale: number = ETH_SCALE_FACTOR
Returns Promise<IWeb3SendResult>

Private convertFromWei

convertFromWei(amount: string): BigNumber

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:341
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/polygon/sdk/ethSDK.ts:969
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/polygon/sdk/ethSDK.ts:992
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/polygon/sdk/ethSDK.ts:555
Return aMATICb token balance.

Returns Promise<BigNumber>
- human-readable balance

getACAllowance

getACAllowance(): Promise<BigNumber>

Implementation of ISwitcher.getACAllowance
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:602
Return ankrMATIC token allowance.

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

Returns Promise<BigNumber>
- allowance in wei

getACBalance

getACBalance(): Promise<BigNumber>

Implementation of ISwitcher.getACBalance
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:571
Return ankrMATIC token balance.

Returns Promise<BigNumber>
- human-readable balance

getACRatio

getACRatio(): Promise<BigNumber>

Implementation of ISwitcher.getACRatio
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:587
Return ankrMATIC/MATIC ratio.

Returns Promise<BigNumber>
- human-readable ratio

Private getAMATICBTokenContract

getAMATICBTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:280
Internal function to get aMATICb token contract.

Returns Contract

Private getANKRMATICTokenContract

getANKRMATICTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:293
Internal function to get ankrMATIC 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.

getFullTxHistory

getFullTxHistory(): Promise<ITxHistory>

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

note
Amount of certificate event is in ETH. If you need ankrETH, 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/polygon/sdk/ethSDK.ts:957
Get latest block number.

Returns Promise<number>

getMaticBalance

getMaticBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:539
Return MATIC token balance.

Returns Promise<BigNumber>
- human-readable balance

Private getMaticTokenContract

getMaticTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:267
Internal function to get MATIC token contract.

Returns Contract

getMinimumStake

getMinimumStake(): Promise<BigNumber>

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

Returns Promise<BigNumber>

Private getPastEvents

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:353
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/polygon/sdk/ethSDK.ts:366
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/polygon/sdk/ethSDK.ts:395
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/polygon/sdk/ethSDK.ts:730
Get total pending unstake amount.

Returns Promise<BigNumber>

getPendingData

getPendingData(): Promise<IPendingData>

Implementation of IStakable.getPendingData
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:747
Get pending data for aMATICb and ankrMATIC.

note
Read about Ankr Liquid Staking token types.

Returns Promise<IPendingData>

Private getPolygonPoolContract

getPolygonPoolContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:306
Internal function to get polygonPool contract.

Returns Contract

Private getPoolEventsBatch

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:830
Internal function to return pool raw events.

note
Currently returns raw pool events for block range.

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

getStakeGasFee

getStakeGasFee(amount: BigNumber, token: TMaticSyntToken, scale?: number): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:503
Get stake gas fee.

Parameters
- amount: BigNumber
  
  amount to stake
- token: TMaticSyntToken
  
  token symbol (aMATICb or ankrMATIC)
- scale: number = ETH_SCALE_FACTOR
Returns Promise<BigNumber>

Private getStakeMethodName

getStakeMethodName(token: TMaticSyntToken): string

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

Parameters
- token: TMaticSyntToken
  
  token symbol
Returns string

Private getTxEventsHistoryGroup

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:420
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/polygon/sdk/ethSDK.ts:908
Get transaction history for block range.

note
Amount of each event is in ETH. If you need ankrETH, 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/polygon/sdk/ethSDK.ts:320
Internal function to map event type to transaction type.

Parameters
- Optional rawTxType: string
Returns null | string

Private getUnstakeMethodName

getUnstakeMethodName(token: TMaticSyntToken): string

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

Parameters
- token: TMaticSyntToken
  
  token symbol
Returns string

Private getUnstakeTx

getUnstakeTx(amount: BigNumber, token: string): { encodeABI: any; estimateGas: any }

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:1148
Return web3 unstake transaction object.

Parameters
- amount: BigNumber
  
  amount to unstake
- token: string
  
  token symbol (aMATICb or ankrMATIC)
Returns { encodeABI: any; estimateGas: any }
web3 unstake transaction object
- encodeABI:function
  - encodeABI(): string
  - - Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:1152
    Returns string
- estimateGas:function
  - estimateGas(arg0: { from: string }): Promise<number>
  - - Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:1153
    Parameters
    - arg0: { from: string }
      - from: string
    Returns Promise<number>

getUnstakeTxFee

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:1127
Get unstake transaction fee.

Parameters
- amount: BigNumber
  
  amount to unstake
- token: string
  
  token symbol (aMATICb or ankrMATIC)
Returns Promise<BigNumber>
- transaction fee

Private getWriteProvider

getWriteProvider(): Promise<Web3KeyWriteProvider>

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

Returns Promise<Web3KeyWriteProvider>

Private isEthNetwork

isEthNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:252
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/polygon/sdk/ethSDK.ts:659
Switch ankrMATIC to aMATICb.

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, scale?: number): Promise<IStakeData>

Implementation of IStakable.stake
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:1029
Stake token.

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

note
Checks allowance and approves if it's needed. Then stakes.

note
Read about Ankr Liquid Staking token types.

Parameters
- amount: BigNumber
  
  amount of token
- token: string
  
  choose which token to receive (aMATICb or ankrMATIC)
- scale: number = ETH_SCALE_FACTOR
Returns Promise<IStakeData>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.unlockShares
- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:696
Switch aMATICb to ankrMATIC.

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/polygon/sdk/ethSDK.ts:1087
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 (aMATICb or ankrMATIC)
Returns Promise<IWeb3SendResult>

Static getInstance

getInstance(args?: Partial<IPolygonSDKArgs>): Promise<PolygonOnEthereumSDK>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/ethSDK.ts:163
Initialization method for the SDK.

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

static
Parameters
- Optional args: Partial<IPolygonSDKArgs>
Returns Promise<PolygonOnEthereumSDK>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

__namedParameters: IPolygonSDKArgs

Returns PolygonOnEthereumSDK

Properties

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

Optional scale: number

Returns Promise<undefined | IWeb3SendResult>

approveMATICToken

Parameters

amount: BigNumber = MAX_UINT256

scale: number = ETH_SCALE_FACTOR

Returns Promise<IWeb3SendResult>

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

Returns Promise<BigNumber>

getACBalance

Returns Promise<BigNumber>

getACRatio

Returns Promise<BigNumber>

Private getAMATICBTokenContract

Returns Contract

Private getANKRMATICTokenContract

Returns Contract

getBlocks

Parameters

web3: default

blockNumbers: number[]

Returns Promise<BlockTransactionObject[]>

getFullTxHistory

Returns Promise<ITxHistory>

getLatestBlock

Returns Promise<number>

getMaticBalance

Returns Promise<BigNumber>