Class BlockGlobalAddr

Represents a block global address within the system, supporting both block time and message count addresses.

Hierarchy

BlockGlobalAddr

Index

Constructors

Properties

blockTime? messageCount?

Methods

toBytes toJSON toPrefixedString fromBytes fromJSON fromString

Constructors

constructor

new BlockGlobalAddr(blockTime?: object, messageCount?: object): BlockGlobalAddr
Constructs a new BlockGlobalAddr instance.
Parameters
- Optional blockTime: object
  
  Optional parameter for the block time object.
- Optional messageCount: object
  
  Optional parameter for the message count object.
Returns BlockGlobalAddr
- Defined in src/types/key/BlockGlobalAddr.ts:64

Properties

`Optional` blockTime

blockTime?: object

The block time object, if this is a block time address.

`Optional` messageCount

messageCount?: object

The message count object, if this is a message count address.

Methods

toBytes

toBytes(): Uint8Array
Converts the BlockGlobalAddr to a byte array representation.

Returns
A Uint8Array containing the byte tag representing the block global address type.

Returns Uint8Array
- Defined in src/types/key/BlockGlobalAddr.ts:117

toJSON

toJSON(): string
Converts the BlockGlobalAddr to its JSON string representation.

Returns
The JSON string that represents this BlockGlobalAddr.

Returns string
- Defined in src/types/key/BlockGlobalAddr.ts:137

toPrefixedString

toPrefixedString(): string
Returns a prefixed string representation of the BlockGlobalAddr.

Returns
A prefixed string that includes the block global address type and a default hash value.

Returns string
- Defined in src/types/key/BlockGlobalAddr.ts:88

`Static` fromBytes

fromBytes(bytes: Uint8Array): IResultWithBytes<BlockGlobalAddr>
Creates a BlockGlobalAddr from a byte array representation.

Returns
An instance of BlockGlobalAddr representing the given type.

Throws
Error if the byte array tag does not match any known BlockGlobalAddr type.
Parameters
- bytes: Uint8Array
  
  The byte array containing the tag for the block global address type.
Returns IResultWithBytes<BlockGlobalAddr>
- Defined in src/types/key/BlockGlobalAddr.ts:100

`Static` fromJSON

fromJSON(json: string): BlockGlobalAddr
Creates a BlockGlobalAddr from a JSON string representation.

Returns
A new BlockGlobalAddr instance.
Parameters
- json: string
  
  The JSON string representation.
Returns BlockGlobalAddr
- Defined in src/types/key/BlockGlobalAddr.ts:129

`Static` fromString

fromString(source: string): BlockGlobalAddr
Creates a BlockGlobalAddr from a string representation.

Returns
A new BlockGlobalAddr instance.

Throws
Error if the format does not match known block global address types.
Parameters
- source: string
  
  The string representation of the block global address.
Returns BlockGlobalAddr
- Defined in src/types/key/BlockGlobalAddr.ts:75

Generated using TypeDoc