Evolution SDK
Modules

ProposalProcedure.ts

ProposalProcedure overview

Table of contents

encoding

toCBORBytes

Encode individual ProposalProcedure to CBOR bytes.

Signature

export declare const toCBORBytes: (procedure: ProposalProcedure, options?: CBOR.CodecOptions) => any

Added in v2.0.0

toCBORHex

Encode individual ProposalProcedure to CBOR hex string.

Signature

export declare const toCBORHex: (procedure: ProposalProcedure, options?: CBOR.CodecOptions) => string

Added in v2.0.0

model

ProposalProcedure (class)

Schema for a single proposal procedure based on Conway CDDL specification.

proposal_procedure = [
  deposit : coin,
  reward_account : reward_account,
  governance_action : governance_action,
  anchor : anchor / null
]

governance_action = [action_type, action_data]

Signature

export declare class ProposalProcedure

Added in v2.0.0

toJSON (method)

Convert to JSON representation.

Signature

toJSON()

Added in v2.0.0

toString (method)

Convert to string representation.

Signature

toString(): string

Added in v2.0.0

[Inspectable.NodeInspectSymbol] (method)

Custom inspect for Node.js REPL.

Signature

[Inspectable.NodeInspectSymbol](): unknown

Added in v2.0.0

[Equal.symbol] (method)

Structural equality check.

Signature

[Equal.symbol](that: unknown): boolean

Added in v2.0.0

[Hash.symbol] (method)

Hash code generation.

Signature

[Hash.symbol](): number

Added in v2.0.0

parsing

fromCBORBytes

Parse individual ProposalProcedure from CBOR bytes.

Signature

export declare const fromCBORBytes: (bytes: Uint8Array, options?: CBOR.CodecOptions) => ProposalProcedure

Added in v2.0.0

fromCBORHex

Parse individual ProposalProcedure from CBOR hex string.

Signature

export declare const fromCBORHex: (hex: string, options?: CBOR.CodecOptions) => ProposalProcedure

Added in v2.0.0

schemas

CDDLSchema

CDDL schema for ProposalProcedure tuple structure.

Signature

export declare const CDDLSchema: Schema.Tuple<
  [
    typeof Schema.BigIntFromSelf,
    typeof Schema.Uint8ArrayFromSelf,
    Schema.SchemaClass<
      | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
      | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
      | readonly [2n, ReadonlyMap<any, bigint>, any]
      | readonly [3n, readonly [any, bigint] | null]
      | readonly [
          4n,
          readonly [any, bigint] | null,
          (
            | readonly (readonly [0n | 1n, any])[]
            | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
          ),
          ReadonlyMap<readonly [0n | 1n, any], bigint>,
          { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
        ]
      | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
      | readonly [6n],
      | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
      | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
      | readonly [2n, ReadonlyMap<any, bigint>, any]
      | readonly [3n, readonly [any, bigint] | null]
      | readonly [
          4n,
          readonly [any, bigint] | null,
          (
            | readonly (readonly [0n | 1n, any])[]
            | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
          ),
          ReadonlyMap<readonly [0n | 1n, any], bigint>,
          { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
        ]
      | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
      | readonly [6n],
      never
    >,
    Schema.NullOr<Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>>
  ]
>

Added in v2.0.0

FromCBORBytes

CBOR bytes transformation schema for individual ProposalProcedure.

Signature

export declare const FromCBORBytes: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.transformOrFail<
    typeof Schema.Uint8ArrayFromSelf,
    Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
    never
  >,
  Schema.transformOrFail<
    Schema.Tuple<
      [
        typeof Schema.BigIntFromSelf,
        typeof Schema.Uint8ArrayFromSelf,
        Schema.SchemaClass<
          | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
          | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
          | readonly [2n, ReadonlyMap<any, bigint>, any]
          | readonly [3n, readonly [any, bigint] | null]
          | readonly [
              4n,
              readonly [any, bigint] | null,
              (
                | readonly (readonly [0n | 1n, any])[]
                | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
              ),
              ReadonlyMap<readonly [0n | 1n, any], bigint>,
              { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
            ]
          | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
          | readonly [6n],
          | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
          | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
          | readonly [2n, ReadonlyMap<any, bigint>, any]
          | readonly [3n, readonly [any, bigint] | null]
          | readonly [
              4n,
              readonly [any, bigint] | null,
              (
                | readonly (readonly [0n | 1n, any])[]
                | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
              ),
              ReadonlyMap<readonly [0n | 1n, any], bigint>,
              { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
            ]
          | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
          | readonly [6n],
          never
        >,
        Schema.NullOr<Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>>
      ]
    >,
    Schema.SchemaClass<ProposalProcedure, ProposalProcedure, never>,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for individual ProposalProcedure.

Signature

export declare const FromCBORHex: (
  options?: CBOR.CodecOptions
) => Schema.transform<
  Schema.Schema<Uint8Array, string, never>,
  Schema.transform<
    Schema.transformOrFail<
      typeof Schema.Uint8ArrayFromSelf,
      Schema.declare<CBOR.CBOR, CBOR.CBOR, readonly [], never>,
      never
    >,
    Schema.transformOrFail<
      Schema.Tuple<
        [
          typeof Schema.BigIntFromSelf,
          typeof Schema.Uint8ArrayFromSelf,
          Schema.SchemaClass<
            | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
            | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
            | readonly [2n, ReadonlyMap<any, bigint>, any]
            | readonly [3n, readonly [any, bigint] | null]
            | readonly [
                4n,
                readonly [any, bigint] | null,
                (
                  | readonly (readonly [0n | 1n, any])[]
                  | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
                ),
                ReadonlyMap<readonly [0n | 1n, any], bigint>,
                { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
              ]
            | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
            | readonly [6n],
            | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
            | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
            | readonly [2n, ReadonlyMap<any, bigint>, any]
            | readonly [3n, readonly [any, bigint] | null]
            | readonly [
                4n,
                readonly [any, bigint] | null,
                (
                  | readonly (readonly [0n | 1n, any])[]
                  | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
                ),
                ReadonlyMap<readonly [0n | 1n, any], bigint>,
                { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
              ]
            | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
            | readonly [6n],
            never
          >,
          Schema.NullOr<Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>>
        ]
      >,
      Schema.SchemaClass<ProposalProcedure, ProposalProcedure, never>,
      never
    >
  >
>

Added in v2.0.0

FromCDDL

CDDL transformation schema for individual ProposalProcedure.

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Tuple<
    [
      typeof Schema.BigIntFromSelf,
      typeof Schema.Uint8ArrayFromSelf,
      Schema.SchemaClass<
        | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
        | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
        | readonly [2n, ReadonlyMap<any, bigint>, any]
        | readonly [3n, readonly [any, bigint] | null]
        | readonly [
            4n,
            readonly [any, bigint] | null,
            (
              | readonly (readonly [0n | 1n, any])[]
              | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
            ),
            ReadonlyMap<readonly [0n | 1n, any], bigint>,
            { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
          ]
        | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
        | readonly [6n],
        | readonly [0n, readonly [any, bigint] | null, ReadonlyMap<bigint, CBOR.CBOR>, any]
        | readonly [1n, readonly [any, bigint] | null, readonly [bigint, bigint]]
        | readonly [2n, ReadonlyMap<any, bigint>, any]
        | readonly [3n, readonly [any, bigint] | null]
        | readonly [
            4n,
            readonly [any, bigint] | null,
            (
              | readonly (readonly [0n | 1n, any])[]
              | { readonly _tag: "Tag"; readonly tag: 258; readonly value: readonly (readonly [0n | 1n, any])[] }
            ),
            ReadonlyMap<readonly [0n | 1n, any], bigint>,
            { readonly _tag: "Tag"; readonly tag: 30; readonly value: readonly [bigint, bigint] }
          ]
        | readonly [5n, readonly [any, bigint] | null, readonly [readonly [string, any], any]]
        | readonly [6n],
        never
      >,
      Schema.NullOr<Schema.Tuple2<typeof Schema.String, typeof Schema.Uint8ArrayFromSelf>>
    ]
  >,
  Schema.SchemaClass<ProposalProcedure, ProposalProcedure, never>,
  never
>

Added in v2.0.0

PrivateKey.ts

Previous Page

ProposalProcedures.ts

Next Page

On this page

ProposalProcedure overviewencodingtoCBORBytestoCBORHexmodelProposalProcedure (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)parsingfromCBORBytesfromCBORHexschemasCDDLSchemaFromCBORBytesFromCBORHexFromCDDL