Class RLP

Root interface for all the classes part of the VeChain Data Model to provide a coherent API to represent, encode, and cast data among data types.

Hierarchy (view full)

RLP
- RLPProfiler

Implements

VeChainDataModel<RLP>

Index

Constructors

Properties

decoded encoded

Accessors

Methods

compareTo isEqual toHex of ofEncoded packData unpackData

Constructors

`Protected`constructor

new RLP(data): RLP
Parameters
- data: Input
Returns RLP
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:13
new RLP(data): RLP
Parameters
- data: Uint8Array
Returns RLP
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:14

Properties

`Readonly`decoded

decoded: Input

`Readonly`encoded

encoded: Uint8Array

Accessors

bi

get bi(): bigint
Returns the bigint representation of the encoded data in the RLP instance.

Returns bigint
The bigint representation of the encoded data.
Implementation of VeChainDataModel.bi
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:29

bytes

get bytes(): Uint8Array
Returns the encoded data as a Uint8Array.

Returns Uint8Array
The encoded data.
Implementation of VeChainDataModel.bytes
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:37

n

get n(): number
Returns the number representation of the encoded data in the RLP instance.

Returns number
The number representation of the encoded data.
Implementation of VeChainDataModel.n
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:45

Methods

compareTo

compareTo(that): number
Compares the current RLP instance with another RLP instance.
Parameters
- that: RLP
  The RLP instance to compare.
Returns number
0 if the RLP instances are equal, -1/1 if they are not.
Implementation of VeChainDataModel.compareTo
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:60

isEqual

isEqual(that): boolean
Relies on compareTo to check if the RLP instances are equal.
Parameters
- that: RLP
  The RLP instance to compare.
Returns boolean
true if the RLP instances are equal, false otherwise.
Implementation of VeChainDataModel.isEqual
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:79

toHex

toHex(): Hex
Creates Hex instance from the RLP encoded value.

Returns Hex
The Hex instance.
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:87

`Static`of

of(data): RLP
Returns an RLP instance from a plain value.
Parameters
- data: Input
  The plain data
Returns RLP
The RLP instance.
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:96

`Static`ofEncoded

ofEncoded(encodedData): RLP
Returns an RLP instancen from an encoded value.
Parameters
- encodedData: Uint8Array
  The RLP-encoded data.
Returns RLP
The decoded data or null if decoding fails.
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:120

`Protected` `Static`packData

packData(obj, profile, context): Input
Handles the RLP packing of data. Recursively processes through object properties or array elements to prepare data for RLP encoding.
Parameters
- obj: RLPValidObject
  The object data to be packed.
- profile: RLPProfile
  Profile for encoding structures.
- context: string
  Encoding context for error tracing.
Returns Input
Packed data as RLPInput.

Throws
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:150

`Protected` `Static`unpackData

unpackData(packed, profile, context): RLPValueType
Handles the RLP unpacking of data. Recursively processes through packed properties or elements to prepare data post RLP decoding.
Parameters
- packed: Input
  The packed data to be unpacked.
- profile: RLPProfile
  Profile for decoding structures.
- context: string
  Decoding context for error tracing.
Returns RLPValueType
Unpacked data as RLPValueType.

Throws
- Defined in packages/core/src/vcdm/encoding/rlp/RLP.ts:209