Class ByteCode

Represents a byte code in the system, providing support for V1 Casper WASM or an empty byte code.

Hierarchy

ByteCode

Index

Constructors

Properties

V1CasperWasm? isEmpty

Methods

isEmptyCode toBytes toJSON toPrefixedString fromBytes fromJSON newByteCodeKindFromByte

Constructors

constructor

new ByteCode(V1CasperWasm?: Hash, isEmpty?: boolean): ByteCode
Constructs a new ByteCode instance.
Parameters
- Optional V1CasperWasm: Hash
  
  The hash representing V1 Casper WASM byte code.
- isEmpty: boolean = false
  
  Whether the byte code is empty. Default is false.
Returns ByteCode
- Defined in src/types/key/ByteCode.ts:48

Properties

`Private` `Optional` V1CasperWasm

V1CasperWasm?: Hash

`Private` isEmpty

isEmpty: boolean

Methods

isEmptyCode

isEmptyCode(): boolean
Determines if the ByteCode instance represents an empty byte code.

Returns
True if the byte code is empty; otherwise, false.

Returns boolean
- Defined in src/types/key/ByteCode.ts:81

toBytes

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

Returns
The byte array representation of the ByteCode.

Throws
Error if the ByteCode type is unexpected.

Returns Uint8Array
- Defined in src/types/key/ByteCode.ts:145

toJSON

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

Returns
The JSON string representation of the ByteCode.

Returns string
- Defined in src/types/key/ByteCode.ts:73

toPrefixedString

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

Returns
A prefixed string based on the byte code type.

Throws
Error if the ByteCode type is unexpected.

Returns string
- Defined in src/types/key/ByteCode.ts:90

`Static` fromBytes

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

Returns
An object with the new ByteCode instance and remaining bytes.

Throws
ByteCodeError.ErrInvalidByteCodeFormat if the format is invalid.
Parameters
- bytes: Uint8Array
  
  The byte array.
Returns IResultWithBytes<ByteCode>
- Defined in src/types/key/ByteCode.ts:108

`Static` fromJSON

fromJSON(data: string): ByteCode
Creates a ByteCode from a JSON string representation.

Returns
A new ByteCode instance.

Throws
ByteCodeError.ErrInvalidByteCodeFormat if the format is invalid.
Parameters
- data: string
  
  The JSON string representation of the ByteCode.
Returns ByteCode
- Defined in src/types/key/ByteCode.ts:59

`Static` newByteCodeKindFromByte

newByteCodeKindFromByte(tag: number): ByteCodeKind
Converts a byte to its corresponding ByteCodeKind.

Returns
The corresponding ByteCodeKind.

Throws
ByteCodeError.ErrInvalidByteCodeKind if the byte doesn't match a valid ByteCodeKind.
Parameters
- tag: number
  
  The byte to convert.
Returns ByteCodeKind
- Defined in src/types/key/ByteCode.ts:133

Generated using TypeDoc