Evolution SDK
ModulesPlutus

plutus/Credential.ts

Credential overview

Table of contents

utils

Credential

Credential - Either a verification key hash or script hash

Signature

export declare const Credential: TSchema.Union<
  readonly (
    | TSchema.Struct<{ readonly VerificationKey: TSchema.Struct<{ readonly hash: TSchema.ByteArray }> }>
    | TSchema.Struct<{ readonly Script: TSchema.Struct<{ readonly hash: TSchema.ByteArray }> }>
  )[]
>

Credential (type alias)

Signature

export type Credential = typeof Credential.Type

CredentialCodec

Signature

export declare const CredentialCodec: {
  toData: (
    a: { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } },
    overrideOptions?: ParseOptions
  ) => Data.Constr
  fromData: (
    i: Data.Constr,
    overrideOptions?: ParseOptions
  ) => { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } }
  toCBORHex: (
    a: { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } },
    overrideOptions?: ParseOptions
  ) => string
  toCBORBytes: (
    a: { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } },
    overrideOptions?: ParseOptions
  ) => any
  fromCBORHex: (
    i: string,
    overrideOptions?: ParseOptions
  ) => { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } }
  fromCBORBytes: (
    i: any,
    overrideOptions?: ParseOptions
  ) => { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } }
}

PaymentCredential

Payment Credential - Used for payment addresses

Signature

export declare const PaymentCredential: TSchema.Union<
  readonly (
    | TSchema.Struct<{ readonly VerificationKey: TSchema.Struct<{ readonly hash: TSchema.ByteArray }> }>
    | TSchema.Struct<{ readonly Script: TSchema.Struct<{ readonly hash: TSchema.ByteArray }> }>
  )[]
>

PaymentCredential (type alias)

Signature

export type PaymentCredential = typeof PaymentCredential.Type

PaymentCredentialCodec

Signature

export declare const PaymentCredentialCodec: {
  toData: (
    a: { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } },
    overrideOptions?: ParseOptions
  ) => Data.Constr
  fromData: (
    i: Data.Constr,
    overrideOptions?: ParseOptions
  ) => { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } }
  toCBORHex: (
    a: { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } },
    overrideOptions?: ParseOptions
  ) => string
  toCBORBytes: (
    a: { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } },
    overrideOptions?: ParseOptions
  ) => any
  fromCBORHex: (
    i: string,
    overrideOptions?: ParseOptions
  ) => { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } }
  fromCBORBytes: (
    i: any,
    overrideOptions?: ParseOptions
  ) => { readonly VerificationKey: { readonly hash: Uint8Array } } | { readonly Script: { readonly hash: Uint8Array } }
}

ScriptHash

Script Hash (28 bytes)

Signature

export declare const ScriptHash: TSchema.ByteArray

ScriptHash (type alias)

Signature

export type ScriptHash = typeof ScriptHash.Type

ScriptHashCodec

Signature

export declare const ScriptHashCodec: {
  toData: (a: Uint8Array, overrideOptions?: ParseOptions) => Uint8Array
  fromData: (i: Uint8Array, overrideOptions?: ParseOptions) => Uint8Array
  toCBORHex: (a: Uint8Array, overrideOptions?: ParseOptions) => string
  toCBORBytes: (a: Uint8Array, overrideOptions?: ParseOptions) => any
  fromCBORHex: (i: string, overrideOptions?: ParseOptions) => Uint8Array
  fromCBORBytes: (i: any, overrideOptions?: ParseOptions) => Uint8Array
}

StakeCredential

Stake Credential - Either inline credential or pointer

Signature

export declare const StakeCredential: TSchema.Union<
  readonly (
    | TSchema.Struct<{
        readonly Pointer: TSchema.Struct<{
          readonly slot_number: TSchema.Integer
          readonly transaction_index: TSchema.Integer
          readonly certificate_index: TSchema.Integer
        }>
      }>
    | TSchema.Struct<{
        readonly Inline: TSchema.Struct<{
          readonly credential: TSchema.Union<
            readonly (
              | TSchema.Struct<{ readonly VerificationKey: TSchema.Struct<{ readonly hash: TSchema.ByteArray }> }>
              | TSchema.Struct<{ readonly Script: TSchema.Struct<{ readonly hash: TSchema.ByteArray }> }>
            )[]
          >
        }>
      }>
  )[]
>

StakeCredential (type alias)

Signature

export type StakeCredential = typeof StakeCredential.Type

StakeCredentialCodec

Signature

export declare const StakeCredentialCodec: {
  toData: (
    a:
      | {
          readonly Pointer: {
            readonly slot_number: bigint
            readonly transaction_index: bigint
            readonly certificate_index: bigint
          }
        }
      | {
          readonly Inline: {
            readonly credential:
              | { readonly VerificationKey: { readonly hash: Uint8Array } }
              | { readonly Script: { readonly hash: Uint8Array } }
          }
        },
    overrideOptions?: ParseOptions
  ) => Data.Constr
  fromData: (
    i: Data.Constr,
    overrideOptions?: ParseOptions
  ) =>
    | {
        readonly Pointer: {
          readonly slot_number: bigint
          readonly transaction_index: bigint
          readonly certificate_index: bigint
        }
      }
    | {
        readonly Inline: {
          readonly credential:
            | { readonly VerificationKey: { readonly hash: Uint8Array } }
            | { readonly Script: { readonly hash: Uint8Array } }
        }
      }
  toCBORHex: (
    a:
      | {
          readonly Pointer: {
            readonly slot_number: bigint
            readonly transaction_index: bigint
            readonly certificate_index: bigint
          }
        }
      | {
          readonly Inline: {
            readonly credential:
              | { readonly VerificationKey: { readonly hash: Uint8Array } }
              | { readonly Script: { readonly hash: Uint8Array } }
          }
        },
    overrideOptions?: ParseOptions
  ) => string
  toCBORBytes: (
    a:
      | {
          readonly Pointer: {
            readonly slot_number: bigint
            readonly transaction_index: bigint
            readonly certificate_index: bigint
          }
        }
      | {
          readonly Inline: {
            readonly credential:
              | { readonly VerificationKey: { readonly hash: Uint8Array } }
              | { readonly Script: { readonly hash: Uint8Array } }
          }
        },
    overrideOptions?: ParseOptions
  ) => any
  fromCBORHex: (
    i: string,
    overrideOptions?: ParseOptions
  ) =>
    | {
        readonly Pointer: {
          readonly slot_number: bigint
          readonly transaction_index: bigint
          readonly certificate_index: bigint
        }
      }
    | {
        readonly Inline: {
          readonly credential:
            | { readonly VerificationKey: { readonly hash: Uint8Array } }
            | { readonly Script: { readonly hash: Uint8Array } }
        }
      }
  fromCBORBytes: (
    i: any,
    overrideOptions?: ParseOptions
  ) =>
    | {
        readonly Pointer: {
          readonly slot_number: bigint
          readonly transaction_index: bigint
          readonly certificate_index: bigint
        }
      }
    | {
        readonly Inline: {
          readonly credential:
            | { readonly VerificationKey: { readonly hash: Uint8Array } }
            | { readonly Script: { readonly hash: Uint8Array } }
        }
      }
}

VerificationKeyHash

Verification Key Hash (28 bytes)

Signature

export declare const VerificationKeyHash: TSchema.ByteArray

VerificationKeyHash (type alias)

Signature

export type VerificationKeyHash = typeof VerificationKeyHash.Type

VerificationKeyHashCodec

Signature

export declare const VerificationKeyHashCodec: {
  toData: (a: Uint8Array, overrideOptions?: ParseOptions) => Uint8Array
  fromData: (i: Uint8Array, overrideOptions?: ParseOptions) => Uint8Array
  toCBORHex: (a: Uint8Array, overrideOptions?: ParseOptions) => string
  toCBORBytes: (a: Uint8Array, overrideOptions?: ParseOptions) => any
  fromCBORHex: (i: string, overrideOptions?: ParseOptions) => Uint8Array
  fromCBORBytes: (i: any, overrideOptions?: ParseOptions) => Uint8Array
}

plutus/CIP68Metadata.ts

Previous Page

plutus/OutputReference.ts

Next Page

On this page

Credential overviewutilsCredentialCredential (type alias)CredentialCodecPaymentCredentialPaymentCredential (type alias)PaymentCredentialCodecScriptHashScriptHash (type alias)ScriptHashCodecStakeCredentialStakeCredential (type alias)StakeCredentialCodecVerificationKeyHashVerificationKeyHash (type alias)VerificationKeyHashCodec