Namespace XDC

Variables

Const XDC_BLOCK_1_DAY_RANGE

XDC_BLOCK_1_DAY_RANGE: 43200 = 43_200

Events block range for stake and unstake history that equal to 1 day.

Const XDC_DECIMALS

XDC_DECIMALS: 18 = 18

Decimals length for XDC.

Const XDC_SCALE_FACTOR

XDC_SCALE_FACTOR: number = ...

Scale factor for XDC.

Functions

addTokenToWallet

addTokenToWallet(__namedParameters: IAddTokenToWalletProps): Promise<boolean>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/addTokenToWallet.ts:19
Add token to wallet.

Parameters
- __namedParameters: IAddTokenToWalletProps
Returns Promise<boolean>

getAnkrXDCBalance

getAnkrXDCBalance(__namedParameters: ITokenBalanceProps<Web3KeyReadProvider>): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/balances.ts:21
Get ankrXDC token balance.

Parameters
- __namedParameters: ITokenBalanceProps<Web3KeyReadProvider>
Returns Promise<BigNumber>
- human-readable balance

getAnkrXDCRatio

getAnkrXDCRatio(__namedParameters: ICommonProps<Web3KeyReadProvider>): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/getAnkrXDCRatio.ts:16
Get ankrXDC ratio.

Parameters
- __namedParameters: ICommonProps<Web3KeyReadProvider>
Returns Promise<BigNumber>
- human-readable ratio

getMinStakeAmount

getMinStakeAmount(__namedParameters: ICommonProps<Web3KeyReadProvider>): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/getMinStakeAmount.ts:16
Get minimum stake amount.

Parameters
- __namedParameters: ICommonProps<Web3KeyReadProvider>
Returns Promise<BigNumber>
- human-readable amount

getPendingUnstakesAmount

getPendingUnstakesAmount(__namedParameters: IGetPendingUnstakesAmountProps): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/getPendingUnstakesAmount.ts:22
Get total pending unstakes amount.

Parameters
- __namedParameters: IGetPendingUnstakesAmountProps
Returns Promise<BigNumber>
- human-readable amount

getStakeGasFee

getStakeGasFee(__namedParameters: IStakeGasFeeProps<Web3KeyReadProvider>): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/getStakeGasFee.ts:23
Get stake gas fee.

Parameters
- __namedParameters: IStakeGasFeeProps<Web3KeyReadProvider>
Returns Promise<BigNumber>

getTxData

getTxData(__namedParameters: IGetTxDataProps): Promise<IFetchTxData>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/txData.ts:25
Get transaction data.

Parameters
- __namedParameters: IGetTxDataProps
Returns Promise<IFetchTxData>

getTxEventsHistoryRange

getTxEventsHistoryRange(__namedParameters: ITxEventsHistoryRangeProps<Web3KeyReadProvider>): Promise<ITxEventsHistoryData>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/txEventsHistory.ts:81
Get transaction history for block range.

deprecated
use getTxHistoryRange instead

Parameters
- __namedParameters: ITxEventsHistoryRangeProps<Web3KeyReadProvider>
Returns Promise<ITxEventsHistoryData>

getTxHistoryRange

getTxHistoryRange(__namedParameters: ITxEventsHistoryRangeProps<Web3KeyReadProvider>): Promise<ITxHistory>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/txEventsHistory.ts:198
Get transaction history for block range.

Parameters
- __namedParameters: ITxEventsHistoryRangeProps<Web3KeyReadProvider>
Returns Promise<ITxHistory>

getTxReceipt

getTxReceipt(__namedParameters: IWeb3TxInfoProps<Web3KeyReadProvider>): Promise<null | TransactionReceipt>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/txData.ts:61
Get transaction receipt.

Parameters
- __namedParameters: IWeb3TxInfoProps<Web3KeyReadProvider>
Returns Promise<null | TransactionReceipt>

getValidXDCAddress

getValidXDCAddress(address?: string): undefined | string

- Defined in packages/staking-sdk/src/modules/xdc/sdk/utils.ts:14
Get valid XDC address.

Parameters
- Optional address: string
  
  current user address
Returns undefined | string

getXDCBalance

getXDCBalance(__namedParameters: IWeb3BalanceProps<Web3KeyReadProvider>): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/balances.ts:48
Get XDC token balance.

Parameters
- __namedParameters: IWeb3BalanceProps<Web3KeyReadProvider>
Returns Promise<BigNumber>
- human-readable balance

getXDCPoolAmount

getXDCPoolAmount(__namedParameters: ICommonProps<Web3KeyReadProvider>): Promise<BigNumber>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/getXDCPoolAmount.ts:16
Get XDC token pool liquidity amount from XDCStakingPool contract.

Parameters
- __namedParameters: ICommonProps<Web3KeyReadProvider>
Returns Promise<BigNumber>
- human-readable amount

isValidStakeAmount

isValidStakeAmount(__namedParameters: IIsValidStakeAmountProps): boolean

- Defined in packages/staking-sdk/src/modules/xdc/sdk/utils.ts:29
Checking stake amount on validity.

Parameters
- __namedParameters: IIsValidStakeAmountProps
Returns boolean

stake

stake(__namedParameters: IStakeProps<Web3KeyReadProvider>): Promise<IStakeData>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/stake.ts:24
Stake XDC token.

Parameters
- __namedParameters: IStakeProps<Web3KeyReadProvider>
Returns Promise<IStakeData>

unstake

unstake(__namedParameters: IStakeProps<Web3KeyReadProvider>): Promise<IUnstakeData>

- Defined in packages/staking-sdk/src/modules/xdc/sdk/unstake.ts:22
Unstake ankrXDC token.

Parameters
- __namedParameters: IStakeProps<Web3KeyReadProvider>
Returns Promise<IUnstakeData>

Generated using TypeDoc