Class StakingBalance

A representation of the staking balance for a given asset on a specific date.

Index

Constructors

Properties

Methods

address bondedStake date participantType toString unbondedBalance list

Constructors

constructor

new StakingBalance(model): StakingBalance
Creates the StakingBalance object.
Parameters
- model: StakingBalance
  The underlying staking balance object.
Returns StakingBalance
- Defined in src/coinbase/staking_balance.ts:16

Properties

`Private` model

model: StakingBalance

Methods

address

address(): string
Returns the onchain address of the StakingBalance.

Returns string
The onchain address.
- Defined in src/coinbase/staking_balance.ts:108

bondedStake

bondedStake(): Balance
Returns the bonded stake amount of the StakingBalance.

Returns Balance
The Balance.
- Defined in src/coinbase/staking_balance.ts:72

date

date(): Date
Returns the date of the StakingBalance.

Returns Date
The date.
- Defined in src/coinbase/staking_balance.ts:99

participantType

participantType(): string
Returns the participant type of the address.

Returns string
The participant type.
- Defined in src/coinbase/staking_balance.ts:90

toString

toString(): string
Print the Staking Balance as a string.

Returns string
The string representation of the Staking Balance.
- Defined in src/coinbase/staking_balance.ts:117

unbondedBalance

unbondedBalance(): Balance
Returns the unbonded stake amount of the StakingBalance.

Returns Balance
The Balance.
- Defined in src/coinbase/staking_balance.ts:81

`Static` list

list(networkId, assetId, addressId, startTime, endTime): Promise<StakingBalance[]>
Returns a list of StakingBalances for the provided network, asset, and address.
Parameters
- networkId: string
  The network ID.
- assetId: string
  The asset ID.
- addressId: string
  The address ID.
- startTime: string
  The start time.
- endTime: string
  The end time.
Returns Promise<StakingBalance[]>
The staking balances.
- Defined in src/coinbase/staking_balance.ts:30