Class BalanceHoldAddr

Represents an address holding a balance, categorized by either 'Gas' or 'Processing' type.

Hierarchy

BalanceHoldAddr

Index

Constructors

Properties

gas? processing?

Methods

toBytes toJSON toPrefixedString fromBytes fromJSON fromString

Constructors

constructor

new BalanceHoldAddr(gas?: Hold, processing?: Hold): BalanceHoldAddr
Parameters
- Optional gas: Hold
- Optional processing: Hold
Returns BalanceHoldAddr
- Defined in src/types/key/BalanceHoldAddr.ts:90

Properties

`Optional` gas

gas?: Hold

The hold categorized as 'Gas', if any.

`Optional` processing

processing?: Hold

The hold categorized as 'Processing', if any.

Methods

toBytes

toBytes(): Uint8Array
Serializes the BalanceHoldAddr to its byte representation. Includes a byte for the hold type, the purse address, and an 8-byte block time.

Returns
The serialized byte representation of the BalanceHoldAddr.

Returns Uint8Array
- Defined in src/types/key/BalanceHoldAddr.ts:121

toJSON

toJSON(): string
Serializes the BalanceHoldAddr to its JSON string representation.

Returns
The JSON string representation of the BalanceHoldAddr.

Returns string
- Defined in src/types/key/BalanceHoldAddr.ts:189

toPrefixedString

toPrefixedString(): string
Converts the BalanceHoldAddr to a prefixed string, using 'balance-hold-' as the prefix.

Returns
The prefixed string representation of the BalanceHoldAddr.

Returns string
- Defined in src/types/key/BalanceHoldAddr.ts:111

`Static` fromBytes

fromBytes(bytes: Uint8Array): IResultWithBytes<BalanceHoldAddr>
Deserializes a BalanceHoldAddr from a byte array.

Returns
A new BalanceHoldAddr instance.

Throws
Error if the byte format is invalid.

Throws
BalanceHoldAddrTagError if the hold type is unexpected.
Parameters
- bytes: Uint8Array
  
  The byte array containing the BalanceHoldAddr data.
Returns IResultWithBytes<BalanceHoldAddr>
- Defined in src/types/key/BalanceHoldAddr.ts:150

`Static` fromJSON

fromJSON(json: string): BalanceHoldAddr
Parses a JSON string representation of a BalanceHoldAddr.

Returns
A new BalanceHoldAddr instance.
Parameters
- json: string
  
  The JSON string.
Returns BalanceHoldAddr
- Defined in src/types/key/BalanceHoldAddr.ts:181

`Static` fromString

fromString(source: string): BalanceHoldAddr
Parses a string representation of a BalanceHoldAddr and returns a new instance.

Returns
A new BalanceHoldAddr instance.
Parameters
- source: string
  
  The string representation of the BalanceHoldAddr.
Returns BalanceHoldAddr
- Defined in src/types/key/BalanceHoldAddr.ts:100

Generated using TypeDoc