Evolution SDK
Modules

ProposalProcedures.ts

ProposalProcedures overview

Table of contents

arbitrary

arbitrary

FastCheck arbitrary for ProposalProcedures.

Signature

export declare const arbitrary: FastCheck.Arbitrary<ProposalProcedures>

Added in v2.0.0

encoding

toCBORBytes

Encode ProposalProcedures to CBOR bytes.

Signature

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

Added in v2.0.0

toCBORHex

Encode ProposalProcedures to CBOR hex string.

Signature

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

Added in v2.0.0

helpers

single

Create ProposalProcedures for a single proposal.

Convenience function for the common case of submitting one governance action.

Signature

export declare const single: (
  deposit: Coin.Coin,
  rewardAccount: RewardAccount.RewardAccount,
  governanceAction: GovernanceAction.GovernanceAction,
  anchor: Anchor.Anchor | null
) => ProposalProcedures

Added in v2.0.0

model

ProposalProcedures (class)

ProposalProcedures based on Conway CDDL specification.

CDDL: proposal_procedures = nonempty_set<proposal_procedure>

Signature

export declare class ProposalProcedures

Added in v2.0.0

toJSON (method)

Signature

toJSON()

toString (method)

Signature

toString(): string

[Inspectable.NodeInspectSymbol] (method)

Signature

[Inspectable.NodeInspectSymbol](): unknown

[Equal.symbol] (method)

Signature

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

[Hash.symbol] (method)

Signature

[Hash.symbol](): number

parsing

fromCBORBytes

Parse ProposalProcedures from CBOR bytes.

Signature

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

Added in v2.0.0

fromCBORHex

Parse ProposalProcedures from CBOR hex string.

Signature

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

Added in v2.0.0

schemas

CDDLSchema

CDDL schema for ProposalProcedures that produces CBOR-compatible types.

Signature

export declare const CDDLSchema: Schema.Array$<
  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 ProposalProcedures.

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.Array$<
      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<ProposalProcedures, ProposalProcedures, never>,
    never
  >
>

Added in v2.0.0

FromCBORHex

CBOR hex transformation schema for ProposalProcedures.

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.Array$<
        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<ProposalProcedures, ProposalProcedures, never>,
      never
    >
  >
>

Added in v2.0.0

FromCDDL

CDDL transformation schema for ProposalProcedures.

Signature

export declare const FromCDDL: Schema.transformOrFail<
  Schema.Array$<
    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<ProposalProcedures, ProposalProcedures, never>,
  never
>

Added in v2.0.0

ProposalProcedure.ts

Previous Page

ProtocolParamUpdate.ts

Next Page

On this page

ProposalProcedures overviewarbitraryarbitraryencodingtoCBORBytestoCBORHexhelperssinglemodelProposalProcedures (class)toJSON (method)toString (method)[Inspectable.NodeInspectSymbol] (method)[Equal.symbol] (method)[Hash.symbol] (method)parsingfromCBORBytesfromCBORHexschemasCDDLSchemaFromCBORBytesFromCBORHexFromCDDL