BinanceSDK | @ankr.com/staking-sdk

BinanceSDK allows you to interact with Binance Liquid Staking smart contracts on BNB Smart Chain: aBNBb, aBNBc, WBNB, and BinancePool.

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

Hierarchy

BinanceSDK

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new BinanceSDK(__namedParameters: IBinanceSDKArgs): BinanceSDK

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:141
Private constructor. Instead, use BinanceSDK.getInstance.

Parameters
- __namedParameters: IBinanceSDKArgs
Returns BinanceSDK

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

instance — SDK instance.

static

Methods

addTokenToWallet

addTokenToWallet(token: string): Promise<boolean>

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

note
Initiates connect if writeProvider isn't connected.

Parameters
- token: string
  
  token symbol (aBNBb, aBNBc, aETH, aETHc)
Returns Promise<boolean>

approveACForAB

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

Implementation of ISwitcher.approveACForAB
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1595
Approve aBNBc for aBNBb, i.e. allow aBNBb smart contract to access and transfer aBNBc 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>

approveACTokenForSwapPool

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1626
Approve aMATICc for SwapPool, i.e. allow SwapPool smart contract to access and transfer aMATICc 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>

checkAllowance

checkAllowance(hexAmount: string): Promise<boolean>

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

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

Parameters
- hexAmount: string
Returns Promise<boolean>
- true if amount doesn't exceed allowance, false - otherwise.

checkExistPartnerCode

checkExistPartnerCode(partnerCode: string): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1226
Checking whether a code partner exists.

Parameters
- partnerCode: string
  
  partner code
Returns Promise<boolean>

claimPartnerRewards

claimPartnerRewards(): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1314
Claim partner rewards.

Returns Promise<IWeb3SendResult>

Private convertFromWei

convertFromWei(amount: string, unit?: Unit): BigNumber

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

Parameters
- amount: string
  
  value in wei
- Optional unit: Unit
  
  units
Returns BigNumber

Private convertToHex

convertToHex(amount: BigNumber): string

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:339
Internal function to convert value to hex format.

Parameters
- amount: BigNumber
  
  value in wei
Returns string

fetchTxData

fetchTxData(txHash: string): Promise<IFetchTxData>

Implementation of ISwitcher.fetchTxData
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1060
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 | IGetTxReceipt>

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

note
Scans logs to find topic 0x19e86fee7352f6a0c9bf1635ff7e554c083f9af69dff8d69c054f2ac5dba1a9c to show the ankrBNB amount.

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

fetchTxReceiptOld

fetchTxReceiptOld(txHash: string): Promise<null | IGetTxReceipt>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1143
Fetch transaction receipt.

deprecated
usefull only for old BNB tokens contracts in the testnet.

note
Scans logs to find topic 0x0f0bc5b519ddefdd8e5f9e6423433aa2b869738de2ae34d58ebc796fc749fa0d to show the aBNBc amount.

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

fetchUnstakeTxData

fetchUnstakeTxData(txHash: string): Promise<IFetchTxData>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1087
Fetch unstake to external transaction data.

note
Parses first uint256 param from transaction input.

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

flashUnstake

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1810
Flash Unstake token.

note
For aMATICc token only.

note
You will need to call approveACTokenForSwapPool 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 aMATICc)
- scale: number = MATIC_SCALE_FACTOR
Returns Promise<IWeb3SendResult>

getABBalance

getABBalance(): Promise<BigNumber>

Implementation of ISwitcher.getABBalance
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:627
Return aBNBb token balance.

Returns Promise<BigNumber>
- human readable balance

Private getABNBBContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:416
Internal function to get aBNBb token contract.

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

Private getABNBCContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:430
Internal function to get aBNBc token contract.

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

getACAllowance

getACAllowance(): Promise<BigNumber>

Implementation of ISwitcher.getACAllowance
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1673
Return aBNBc token allowance.

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

Returns Promise<BigNumber>
- allowance

getACBalance

getACBalance(): Promise<BigNumber>

Implementation of ISwitcher.getACBalance
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1575
Returns aBNBc token balance

Returns Promise<BigNumber>
- human readable balance

getACRatio

getACRatio(): Promise<BigNumber>

Implementation of ISwitcher.getACRatio
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1545
Return aBNBc/BNB ratio.

note
Read about aBNBc/BNB ratio.

Returns Promise<BigNumber>
- human readable ratio

getACSwapPoolAllowance

getACSwapPoolAllowance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1694
Return aBNBc Swap Pool token allowance.

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

Returns Promise<BigNumber>
- allowance

getAETHBalance

getAETHBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:662
Returns old aETHc token balance

Returns Promise<BigNumber>
- human readable balance

getAETHCBalance

getAETHCBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:677
Returns aETHc token balance

Returns Promise<BigNumber>
- human readable balance

Private getAETHCContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:536
Internal function to get aETHc contract

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

Private getAETHContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:500
Internal function to get old aETHc contract

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

getAETHRatio

getAETHRatio(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1562
Returns certificate old aETHc token ratio

Returns Promise<BigNumber>
- human readable ratio

getAvailableToSwapAETHC

getAvailableToSwapAETHC(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:692
Returns available aETHc token balance for oldSwap

Returns Promise<BigNumber>
- human readable balance

getBNBBalance

getBNBBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:643
Return BNB token balance.

Returns Promise<BigNumber>
- human readable balance

getBNBSwapPoolLiquidity

getBNBSwapPoolLiquidity(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1866
Return BNB swap pool token balance.

Returns Promise<BigNumber>
- human readable balance

getBNBSwapPoolMaxFee

getBNBSwapPoolMaxFee(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1896
Return BNB swap pool max fee.

Returns Promise<BigNumber>
- human readable fee

Private getBinancePartersContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:462
Internal function to get BinancePartners contract.

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

Private getBinancePoolContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:444
Internal function to get BinancePool contract.

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

Private getIncreasedGasLimit

getIncreasedGasLimit(gasLimit: number): number

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:920
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/binance/sdk.ts:1045
Get latest block number.

Returns Promise<number>

getMinimumStake

getMinimumStake(): Promise<BigNumber>

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

Returns Promise<BigNumber>

getPartnerClaimHistory

getPartnerClaimHistory(code: string): Promise<IPartnerClaimHistoryData[]>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1268
Get claim history for partner.

Parameters
- code: string
Returns Promise<IPartnerClaimHistoryData[]>

getPartnerClaimableRewards

getPartnerClaimableRewards(code: string): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1254
Get claimable rewards for partner.

Parameters
- code: string
  
  partner code
Returns Promise<BigNumber>

getPartnerCodeByAddress

getPartnerCodeByAddress(address: string): Promise<string>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1240
Get partner code by address.

Parameters
- address: string
  
  partner address
Returns Promise<string>

Private getPastEvents

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:258
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/binance/sdk.ts:271
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/binance/sdk.ts:300
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/binance/sdk.ts:837
Get total pending unstake amount.

Returns Promise<BigNumber>

getPendingData

getPendingData(): Promise<IPendingData>

Implementation of IStakable.getPendingData
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:769
Get pending data for aBNBb and aBNBc.

note
Read about Ankr Liquid Staking token types.

Returns Promise<IPendingData>

Private getPoolEventsBatch

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:723
Internal function to return raw pool events.

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

Private getProvider

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:211
Internal function to choose the right provider for read or write purpose.

Parameters
- isForceRead: boolean = false
Returns Promise<Web3KeyReadProvider | Web3KeyWriteProvider>

getRelayerFee

getRelayerFee(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:854
Get relayer fee.

note
The fee for cross-chain transfer of BNB between BNB Chain and BNB (Smart) Chain while staking it.

Returns Promise<BigNumber>

Private getSafeBinanceHexAmount

getSafeBinanceHexAmount(amount: BigNumber): string

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:554
Internal method for getting a safe amount in HEX format.

Parameters
- amount: BigNumber
  
  amount for stake
Returns string

getStakeGasFee

getStakeGasFee(amount: BigNumber, token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"): Promise<BigNumber>

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

note
Caches computed gas fee value for future computations.

Parameters
- amount: BigNumber
  
  amount to stake
- token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"
  
  token symbol
Returns Promise<BigNumber>

Private getStakeMethodName

getStakeMethodName(token: "aETHc" | "aBNBb" | "aBNBc" | "aETH", withCode?: boolean): string

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

Parameters
- token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"
  
  token symbol
- withCode: boolean = false
Returns string

Private getSwapPoolContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:518
Internal function to get Swap Pool contract

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

getSwapPoolUnstakeFee

getSwapPoolUnstakeFee(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1882
Return unstake fee for swap pool.

Returns Promise<BigNumber>
- human readable fee

getTxEventsHistory

getTxEventsHistory(): Promise<ITxEventsHistoryData>

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

note
Currently returns data for the last 14 days.

Returns Promise<ITxEventsHistoryData>

Private getTxEventsHistoryGroup

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:351
Internal function to return transaction history group from events. TODO: reuse it from stake/api/getTxEventsHistoryGroup

Parameters
- Optional rawEvents: EventData[]
Returns Promise<ITxEventsHistoryGroupItem[]>

getTxEventsHistoryRange

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

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

note
Currently returns data for block range.

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

Private getTxType

getTxType(rawTxType?: string): null | string

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:396
Internal function to map event type to transaction type.

Parameters
- Optional rawTxType: string
Returns null | string

Private getUnstakeMethodName

getUnstakeMethodName(token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"): "unstakeBonds" | "unstakeCerts"

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

Parameters
- token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"
  
  token symbol
Returns "unstakeBonds" | "unstakeCerts"

Private getUnstakeToExternalMethodName

getUnstakeToExternalMethodName(token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"): "unstakeBondsFor" | "unstakeCertsFor"

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

Parameters
- token: "aETHc" | "aBNBb" | "aBNBc" | "aETH"
  
  token symbol
Returns "unstakeBondsFor" | "unstakeCertsFor"

getWBNBSwapPoolBalance

getWBNBSwapPoolBalance(): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1852
Return WBNBb swap pool token balance.

Returns Promise<BigNumber>
- human readable balance

Private getWrappedBNBContract

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

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:482
Internal function to get WBNB token contract.

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

Private isBinanceNetwork

isBinanceNetwork(provider: Web3KeyWriteProvider): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:238
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/binance/sdk.ts:1714
Switch aBNBc to aBNBb.

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, referralCode?: string): Promise<IStakeData>

Implementation of IStakable.stake
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1345
Stake token.

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

note
Estimates gas and multiplies it by ESTIMATE_GAS_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 (aBNBb or aBNBc)
- Optional scale: number
  
  scale factor for amount (not using)
- Optional referralCode: string
  
  referral code
Returns Promise<IStakeData>

swapOldAETHC

swapOldAETHC(amount: BigNumber): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1782
Swap old aETHc to new aETHc

Parameters
- amount: BigNumber
  
  amount to swap
Returns Promise<IWeb3SendResult>

unlockShares

unlockShares(args: IShareArgs): Promise<IWeb3SendResult>

Implementation of ISwitcher.unlockShares
- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1749
Switch aBNBb to aBNBc.

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/binance/sdk.ts:1429
Unstake token.

note
You will need to call approveACForAB before that.

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 (aBNBb or aBNBc)
Returns Promise<IWeb3SendResult>

unstakeToExternal

unstakeToExternal(amount: BigNumber, token: string, externalAddress: string): Promise<IWeb3SendResult>

- Defined in packages/staking-sdk/src/modules/binance/sdk.ts:1472
Unstake token to external address.

note
You will need to call approveACForAB before that.

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 (aBNBb or aBNBc)
- externalAddress: string
  
  choose external address to unstake to
Returns Promise<IWeb3SendResult>

Static getInstance

getInstance(args?: Partial<IBinanceSDKArgs>): Promise<BinanceSDK>

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

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

static
Parameters
- Optional args: Partial<IBinanceSDKArgs>
Returns Promise<BinanceSDK>

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

__namedParameters: IBinanceSDKArgs

Returns BinanceSDK

Properties

Private Optional Readonly apiUrl

Private currentAccount

Private Readonly readProvider

Private Optional stakeGasFee

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>

approveACTokenForSwapPool

Parameters

amount: BigNumber = MAX_UINT256

scale: number = MATIC_SCALE_FACTOR

Returns Promise<IWeb3SendResult>

checkAllowance

Parameters

hexAmount: string

Returns Promise<boolean>

checkExistPartnerCode

Parameters

partnerCode: string

Returns Promise<boolean>

claimPartnerRewards

Returns Promise<IWeb3SendResult>

Private convertFromWei

Parameters

amount: string

Optional unit: Unit

Returns BigNumber

Private convertToHex

Parameters

amount: BigNumber

Returns string

fetchTxData

Parameters

txHash: string

Returns Promise<IFetchTxData>

fetchTxReceipt

Parameters

txHash: string

Returns Promise<null | IGetTxReceipt>

fetchTxReceiptOld

Parameters

txHash: string

Returns Promise<null | IGetTxReceipt>

fetchUnstakeTxData

Parameters

txHash: string

Returns Promise<IFetchTxData>

flashUnstake

Parameters

amount: BigNumber

token: string

scale: number = MATIC_SCALE_FACTOR

Returns Promise<IWeb3SendResult>

getABBalance

Returns Promise<BigNumber>

Private getABNBBContract

Parameters

isForceRead: boolean = false

Returns Promise<Contract>