PolygonOnPolygonSDK | @ankr.com/staking-sdk

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

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

Hierarchy

PolygonOnPolygonSDK

Implements

IStakable

Constructors

Private constructor

new PolygonOnPolygonSDK(__namedParameters: IPolygonSDKArgs): PolygonOnPolygonSDK

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:114
Private constructor. Instead, use PolygonOnPolygonSDK.getInstance.

Parameters
- __namedParameters: IPolygonSDKArgs
Returns PolygonOnPolygonSDK

Properties

Private contractConfig

contractConfig: IPolygonConfig

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

instance — SDK instance.

static

Accessors

Private isMainnet

get isMainnet(): boolean

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

Returns boolean

Methods

addTokenToWallet

addTokenToWallet(token: string): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:325
Add token to wallet.

note
Initiates connect if writeProvider doesn't connected.

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

approveACToken

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:357
Approve ankrMATIC for SwapPool, i.e. allow SwapPool smart contract to access and transfer ankrMATIC tokens.

note
Initiates connect if writeProvider doesn't connected.

note
Read about Ankr Liquid Staking token types.

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

Private convertFromWei

convertFromWei(amount: string): BigNumber

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:230
Internal function to convert wei value to human-readable format.

Parameters
- amount: string
  
  value in wei
Returns BigNumber

Private convertToWei

convertToWei(amount: Value): BigNumber

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:241
Internal function to convert wei value to human-readable format.

Parameters
- amount: Value
  
  value in wei
Returns BigNumber

getABBalance

getABBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:392
Return aMATICb token balance.

Returns Promise<BigNumber>
- human-readable balance

getABRatio

getABRatio(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:408
Return aMATICb ratio.

Returns Promise<BigNumber>
- human-readable balance

Private getABTokenContract

getABTokenContract(): Contract

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

Returns Contract

getACAllowance

getACAllowance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:819
Return ankrMATIC token allowance.

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

Returns Promise<BigNumber>
- allowance

getACBalance

getACBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:422
Return ankrMATIC token balance.

Returns Promise<BigNumber>
- human-readable balance

getACPoolLiquidity

getACPoolLiquidity(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:438
Returns amount of the ankrMATIC token pool liquidity from SwapPool contract.

Returns Promise<BigNumber>
- human-readable liquidity

getACPoolLiquidityInMATIC

getACPoolLiquidityInMATIC(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:458
Returns amount of the ankrMATIC token pool liquidity in MATIC from SwapPool contract.

Returns Promise<BigNumber>
- human-readable liquidity

getACRatio

getACRatio(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:489
Return ankrMATIC/MATIC ratio.

Returns Promise<BigNumber>
- human-readable ratio

Private getACTokenContract

getACTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:216
Internal function to get ankrMATIC token contract.

Returns Contract

Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:254
Internal function to return increased gas limit.

Parameters
- gasLimit: number
  
  initial gas limit
Returns number

getMATICPoolLiquidityInAC

getMATICPoolLiquidityInAC(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:519
Returns amount of the MATIC token pool liquidity in ankrMATIC from SwapPool contract.

Returns Promise<BigNumber>
- human-readable liquidity

getMaticBalance

getMaticBalance(): Promise<BigNumber>

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

Returns Promise<BigNumber>
- human-readable balance

Private getMaticTokenContract

getMaticTokenContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:264
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/polygonSDK.ts:551
Get minimum stake amount.

note
Method for interface covering only. Not applicable here.

Returns Promise<BigNumber>
- returns zero

getPendingClaim

getPendingClaim(): Promise<BigNumber>

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

note
Method for interface covering only. Not applicable here.

Returns Promise<BigNumber>
- returns zero

getPendingData

getPendingData(): Promise<IPendingData>

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

note
Method for interface covering only. Not applicable here.

note
Read about Ankr Liquid Staking token types.

Returns Promise<IPendingData>
- returns zero values

getStakeFeePct

getStakeFeePct(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:587
Get stake fee in percents.

Returns Promise<BigNumber>

getStakeGasFee

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

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

note
For ankrMATIC token only.

note
Caches computed gas fee value for future computations.

Parameters
- amount: BigNumber
  
  amount to stake
- token: TMaticSyntToken
  
  token symbol (aMATICb or ankrMATIC) as reserved value (not using now)
- scale: number = MATIC_SCALE_FACTOR
Returns Promise<BigNumber>

Private getSwapPoolContract

getSwapPoolContract(): Contract

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:292
Internal function to get SwapPool contract.

Returns Contract

getTxData

getTxData(txHash: string): Promise<IFetchTxData>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:645
Get transaction data.

Parameters
- txHash: string
  
  transaction hash
Returns Promise<IFetchTxData>

getTxReceipt

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:669
Get transaction receipt.

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

getUnstakeFeePct

getUnstakeFeePct(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:685
Get unstake fee in percents.

Returns Promise<BigNumber>

Private getWriteProvider

getWriteProvider(): Promise<Web3KeyWriteProvider>

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

Returns Promise<Web3KeyWriteProvider>

Private isPolygonNetwork

isPolygonNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:306
Internal function to check the current network.

Parameters
- provider: Web3KeyWriteProvider
  
  current selected provider
Returns Promise<boolean>

stake

stake(amount: BigNumber, token: string, scale?: number): Promise<IStakeData>

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

note
For ankrMATIC token only.

note
Initiates connect if writeProvider doesn't connected.

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 = MATIC_SCALE_FACTOR
Returns Promise<IStakeData>

unstake

unstake(amount: BigNumber, token: string, scale?: number): Promise<IWeb3SendResult>

Implementation of IStakable.unstake
- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:779
Unstake token.

note
For ankrMATIC token only.

note
You will need to call approveACToken before that.

note
Initiates connect if writeProvider doesn'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)
- scale: number = MATIC_SCALE_FACTOR
Returns Promise<IWeb3SendResult>

Static getInstance

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

- Defined in packages/staking-sdk/src/modules/polygon/sdk/polygonSDK.ts:139
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>
  
  user defined providers
Returns Promise<PolygonOnPolygonSDK>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

__namedParameters: IPolygonSDKArgs

Returns PolygonOnPolygonSDK

Properties

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>

approveACToken

Parameters

amount: BigNumber = MAX_UINT256

scale: number = MATIC_SCALE_FACTOR

Returns Promise<IWeb3SendResult>

Private convertFromWei

Parameters

amount: string

Returns BigNumber

Private convertToWei

Parameters

amount: Value

Returns BigNumber

getABBalance

Returns Promise<BigNumber>

getABRatio

Returns Promise<BigNumber>

Private getABTokenContract

Returns Contract

getACAllowance

Returns Promise<BigNumber>

getACBalance

Returns Promise<BigNumber>

getACPoolLiquidity

Returns Promise<BigNumber>

getACPoolLiquidityInMATIC

Returns Promise<BigNumber>

getACRatio

Returns Promise<BigNumber>

Private getACTokenContract

Returns Contract

Private getIncreasedGasLimit

Parameters

gasLimit: number

Returns number

getMATICPoolLiquidityInAC

Returns Promise<BigNumber>

getMaticBalance

Returns Promise<BigNumber>

Private getMaticTokenContract

Returns Contract

getMinimumStake

Returns Promise<BigNumber>

getPendingClaim

Returns Promise<BigNumber>

getPendingData

Returns Promise<IPendingData>

getStakeFeePct

Returns Promise<BigNumber>

getStakeGasFee

Parameters

amount: BigNumber