Class EntityAddr

Represents an entity address in the system. This class supports addresses for three types of entities: system, account, and smart contract. The address type is indicated by either the system, account, or smartContract property being set.

Hierarchy

EntityAddr

Index

Constructors

constructor

new EntityAddr(system?: Hash, account?: Hash, smartContract?: Hash): EntityAddr
Creates a new EntityAddr instance.
Parameters
- Optional system: Hash
  
  The hash representing a system entity.
- Optional account: Hash
  
  The hash representing an account entity.
- Optional smartContract: Hash
  
  The hash representing a smart contract entity.
Returns EntityAddr
- Defined in src/types/key/EntityAddr.ts:49

Properties

`Optional` account

account?: Hash

The account hash, if this is an account entity.

`Optional` smartContract

smartContract?: Hash

The smart contract hash, if this is a smart contract entity.

`Optional` system

system?: Hash

The system hash, if this is a system entity.

Methods

toBytes

toBytes(): Uint8Array
Converts the EntityAddr to a byte array. The first byte represents the entity type, followed by the bytes of the associated hash.

Returns
The byte array representation of the EntityAddr.

Throws
If the EntityAddr type is unexpected.

Returns Uint8Array
- Defined in src/types/key/EntityAddr.ts:98

toJSON

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

Returns
The JSON string representation of the EntityAddr.

Returns string
- Defined in src/types/key/EntityAddr.ts:183

toPrefixedString

toPrefixedString(): string
Returns a prefixed string representation of the EntityAddr, with different prefixes for each entity type.

Returns
The prefixed string representation, with "entity-system-", "entity-account-", or "entity-contract-" based on entity type.

Returns string
- Defined in src/types/key/EntityAddr.ts:59

`Static` fromBytes

fromBytes(bytes: Uint8Array): IResultWithBytes<EntityAddr>
Creates an EntityAddr from a byte array. The first byte indicates the entity type, and the remaining bytes represent the hash.

Returns
A new EntityAddr instance.

Throws
If the buffer is empty or the format is invalid.
Parameters
- bytes: Uint8Array
  
  The byte array.
Returns IResultWithBytes<EntityAddr>
- Defined in src/types/key/EntityAddr.ts:125

`Static` fromJSON

fromJSON(json: string): EntityAddr
Creates an EntityAddr from its JSON representation.

Returns
A new EntityAddr instance.
Parameters
- json: string
  
  The JSON string representation of the EntityAddr.
Returns EntityAddr
- Defined in src/types/key/EntityAddr.ts:175

`Static` fromPrefixedString

fromPrefixedString(source: string): EntityAddr
Creates an EntityAddr from a prefixed string representation.

Returns
A new EntityAddr instance.

Throws
If the format is invalid.
Parameters
- source: string
  
  The prefixed string representation of the EntityAddr.
Returns EntityAddr
- Defined in src/types/key/EntityAddr.ts:76

`Static` `Private` getEntityKindFromByte

getEntityKindFromByte(tag: number): EntityKindType
Converts a byte to an EntityKind.

Returns
The corresponding EntityKind.

Throws
If the byte doesn't correspond to a valid EntityKind.
Parameters
- tag: number
  
  The byte to convert.
Returns EntityKindType
- Defined in src/types/key/EntityAddr.ts:162

Class EntityAddr

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional system: Hash

Optional account: Hash

Optional smartContract: Hash

Returns EntityAddr

Properties

Optional account

Optional smartContract

Optional system

Methods

toBytes

Returns

Throws

Returns Uint8Array

toJSON

Returns

Returns string

toPrefixedString

Returns

Returns string

Static fromBytes

Returns

Throws

Parameters

bytes: Uint8Array

Returns IResultWithBytes<EntityAddr>

Static fromJSON

Returns

Parameters

json: string

Returns EntityAddr

Static fromPrefixedString

Returns

Throws

Parameters

source: string

Returns EntityAddr

Static Private getEntityKindFromByte

Returns

Throws

Parameters

tag: number

Returns EntityKindType

Settings

Member Visibility

Theme

`Optional` system: Hash

`Optional` account: Hash

`Optional` smartContract: Hash

`Optional` account

`Optional` smartContract

`Optional` system

`Static` fromBytes

`Static` fromJSON

`Static` fromPrefixedString

`Static` `Private` getEntityKindFromByte