Class UPLCEncoder

UPLCEncoder class for encoding Untyped Plutus Core (UPLC) programs. Extends the FlatEncoder class to provide UPLC-specific encoding functionality.

Hierarchy

Encoder
- UPLCEncoder

Index

Constructors

Methods

encodeBool encodeByteString encodeConst encodeData encodeInteger encodeList encodeNatural encodeProgram encodeTerm encodeType encodeVersion getBytes pad pushBit pushBits pushByte

Constructors

constructor

new UPLCEncoder(): UPLCEncoder
Returns UPLCEncoder
Inherited from Encoder.constructor

Methods

encodeBool

encodeBool(value): void
Encodes a boolean value.
Parameters
- value: boolean
  The boolean value to encode.
Returns void
- Defined in packages/blaze-uplc/dist/index.d.ts:193

encodeByteString

encodeByteString(bytes): void
Encodes a byte string.
Parameters
- bytes: Uint8Array
  The byte string to encode as a Uint8Array.
Returns void
- Defined in packages/blaze-uplc/dist/index.d.ts:188

encodeConst

encodeConst(type, value): void
Encodes a constant value with its type.
Parameters
- type: DataType
  The type of the constant.
- value: PlutusData
  The value of the constant.
Returns void
- Defined in packages/blaze-uplc/dist/index.d.ts:213

encodeData

encodeData(type, data): void
Encodes data based on its type.
Parameters
- type: DataType
  The type of the data to encode.
- data: PlutusData
  The data to encode.
Returns void
Throws
If the data type is not supported.
- Defined in packages/blaze-uplc/dist/index.d.ts:200

encodeInteger

encodeInteger(i): void
Encodes an integer (positive or negative).
Parameters
- i: bigint
  The integer to encode.
Returns void
- Defined in packages/blaze-uplc/dist/index.d.ts:183

encodeList

encodeList<T>(items, encode): void
Type Parameters
- T
Parameters
- items: T[]
- encode: ((t: T) => void)
  - - (t): void
    - Parameters
      t: T
      Returns void
Returns void
- Defined in packages/blaze-uplc/dist/index.d.ts:173

encodeNatural

encodeNatural(n): void
Encodes a natural number (non-negative integer).
Parameters
- n: bigint
  The natural number to encode.
Returns void
- Defined in packages/blaze-uplc/dist/index.d.ts:178

encodeProgram

encodeProgram(program): Uint8Array
Encodes a complete UPLC program.
Parameters
- program: ParsedProgram
  The parsed program to encode.
Returns Uint8Array
A Uint8Array containing the encoded program.
- Defined in packages/blaze-uplc/dist/index.d.ts:225

encodeTerm

encodeTerm(term): void
Encodes a UPLC term.
Parameters
- term: ParsedTerm
  The parsed term to encode.
Returns void
Throws
If the term type is not supported.
- Defined in packages/blaze-uplc/dist/index.d.ts:219

encodeType

encodeType(type): number[]
Encodes a data type.
Parameters
- type: DataType
  The data type to encode.
Returns number[]
An array of numbers representing the encoded type.

Throws
If the type cannot be encoded.
- Defined in packages/blaze-uplc/dist/index.d.ts:207

encodeVersion

encodeVersion(version): void
Encodes a semantic version number.
Parameters
- version: `${number}.${number}.${number}`
  The semantic version as a string (e.g., "1.0.0").
Returns void
Throws
If the version format is invalid.
- Defined in packages/blaze-uplc/dist/index.d.ts:172

getBytes

getBytes(): Uint8Array
Returns Uint8Array
Inherited from Encoder.getBytes
- Defined in packages/blaze-uplc/dist/index.d.ts:130

pad

pad(): void
Returns void
Inherited from Encoder.pad
- Defined in packages/blaze-uplc/dist/index.d.ts:129

pushBit

pushBit(bit): void
Parameters
- bit: 0 | 1
Returns void
Inherited from Encoder.pushBit
- Defined in packages/blaze-uplc/dist/index.d.ts:126

pushBits

pushBits(value, numBits): void
Parameters
- value: number
- numBits: number
Returns void
Inherited from Encoder.pushBits
- Defined in packages/blaze-uplc/dist/index.d.ts:127

pushByte

pushByte(byte): void
Parameters
- byte: number
Returns void
Inherited from Encoder.pushByte
- Defined in packages/blaze-uplc/dist/index.d.ts:128