@blockchaincommons/provenance-mark - v1.0.0-beta.3
    Preparing search index...

    Class ProvenanceMarkError

    The error every operation of this package throws. code names the condition (the reference's variant names), details is discriminated by it, and cause carries the sibling error when a decoder wrapped one.

    try {
    ProvenanceMark.fromBytewords("low", words);
    } catch (e) {
    if (ProvenanceMarkError.isProvenanceMarkError(e) && e.is("Bytewords")) console.log(e.details.message);
    }

    Hierarchy

    • Error
      • ProvenanceMarkError
    Index
    name: "ProvenanceMarkError"

    Always "ProvenanceMarkError".

    The condition, one of ProvenanceMarkErrorCode.

    The fields of the condition, discriminated by code; frozen.

    • InvalidSeedLength: a seed that is not 32 bytes.

      Parameters

      • actual: number

      Returns ProvenanceMarkError & {
          code: "InvalidSeedLength";
          details: SeedLengthDetails<"InvalidSeedLength">;
      }

      • Readonlycode: "InvalidSeedLength"

        The condition.

      • Readonlydetails: SeedLengthDetails<"InvalidSeedLength">

        The condition's fields.

    • InvalidRngStateLength: an RNG state that is not 32 bytes.

      Parameters

      • actual: number

      Returns ProvenanceMarkError & {
          code: "InvalidRngStateLength";
          details: SeedLengthDetails<"InvalidRngStateLength">;
      }

      • Readonlycode: "InvalidRngStateLength"

        The condition.

      • Readonlydetails: SeedLengthDetails<"InvalidRngStateLength">

        The condition's fields.

    • DuplicateKey: a key given twice.

      Parameters

      • key: string

      Returns ProvenanceMarkError & {
          code: "DuplicateKey";
          details: KeyDetails<"DuplicateKey">;
      }

      • Readonlycode: "DuplicateKey"

        The condition.

      • Readonlydetails: KeyDetails<"DuplicateKey">

        The condition's fields.

    • MissingKey: a key not given.

      Parameters

      • key: string

      Returns ProvenanceMarkError & { code: "MissingKey"; details: KeyDetails<"MissingKey"> }

      • Readonlycode: "MissingKey"

        The condition.

      • Readonlydetails: KeyDetails<"MissingKey">

        The condition's fields.

    • InvalidKey: a key with the wrong value.

      Parameters

      • key: string

      Returns ProvenanceMarkError & { code: "InvalidKey"; details: KeyDetails<"InvalidKey"> }

      • Readonlycode: "InvalidKey"

        The condition.

      • Readonlydetails: KeyDetails<"InvalidKey">

        The condition's fields.

    • InvalidNextKeyLength: a next key that is not the link length.

      Parameters

      • expected: number
      • actual: number

      Returns ProvenanceMarkError & {
          code: "InvalidNextKeyLength";
          details: ExpectedActualDetails<"InvalidNextKeyLength">;
      }

      • Readonlycode: "InvalidNextKeyLength"

        The condition.

      • Readonlydetails: ExpectedActualDetails<"InvalidNextKeyLength">

        The condition's fields.

    • InvalidChainIdLength: a chain id that is not the link length.

      Parameters

      • expected: number
      • actual: number

      Returns ProvenanceMarkError & {
          code: "InvalidChainIdLength";
          details: ExpectedActualDetails<"InvalidChainIdLength">;
      }

      • Readonlycode: "InvalidChainIdLength"

        The condition.

      • Readonlydetails: ExpectedActualDetails<"InvalidChainIdLength">

        The condition's fields.

    • InvalidMessageLength: a message shorter than the resolution's fixed part.

      Parameters

      • expected: number
      • actual: number

      Returns ProvenanceMarkError & {
          code: "InvalidMessageLength";
          details: ExpectedActualDetails<"InvalidMessageLength">;
      }

      • Readonlycode: "InvalidMessageLength"

        The condition.

      • Readonlydetails: ExpectedActualDetails<"InvalidMessageLength">

        The condition's fields.

    • DateOutOfRange: a date the codec cannot carry.

      Parameters

      • reason: string

      Returns ProvenanceMarkError & {
          code: "DateOutOfRange";
          details: ReasonDetails<"DateOutOfRange">;
      }

      • Readonlycode: "DateOutOfRange"

        The condition.

      • Readonlydetails: ReasonDetails<"DateOutOfRange">

        The condition's fields.

    • InvalidDate: a date string or Date that holds no date.

      Parameters

      • reason: string
      • Optionalcause: unknown

      Returns ProvenanceMarkError & {
          code: "InvalidDate";
          details: ReasonDetails<"InvalidDate">;
      }

      • Readonlycode: "InvalidDate"

        The condition.

      • Readonlydetails: ReasonDetails<"InvalidDate">

        The condition's fields.

    • ResolutionError: a resolution number, sequence number or field length the resolution refuses.

      Parameters

      • reason: string

      Returns ProvenanceMarkError & {
          code: "ResolutionError";
          details: ReasonDetails<"ResolutionError">;
      }

      • Readonlycode: "ResolutionError"

        The condition.

      • Readonlydetails: ReasonDetails<"ResolutionError">

        The condition's fields.

    • Bytewords: a bytewords decode failure (bytewords error: …).

      Parameters

      • message: string
      • Optionalcause: unknown

      Returns ProvenanceMarkError & {
          code: "Bytewords";
          details: MessageDetails<"Bytewords">;
      }

      • Readonlycode: "Bytewords"

        The condition.

      • Readonlydetails: MessageDetails<"Bytewords">

        The condition's fields.

    • Cbor from a CBOR or UR decoder entry point, where the reference returns the dcbor error itself: the message is the dcbor error's.

      Parameters

      • cause: Error

      Returns ProvenanceMarkError & { code: "Cbor"; details: MessageDetails<"Cbor"> }

      • Readonlycode: "Cbor"

        The condition.

      • Readonlydetails: MessageDetails<"Cbor">

        The condition's fields.

    • Base64: base64 that does not decode (base64 decoding error: …).

      Parameters

      • message: string
      • Optionalcause: unknown

      Returns ProvenanceMarkError & { code: "Base64"; details: MessageDetails<"Base64"> }

      • Readonlycode: "Base64"

        The condition.

      • Readonlydetails: MessageDetails<"Base64">

        The condition's fields.

    • Json: JSON that does not deserialise (JSON error: …, worded as serde words it).

      Parameters

      • message: string
      • Optionalcause: unknown

      Returns ProvenanceMarkError & { code: "Json"; details: MessageDetails<"Json"> }

      • Readonlycode: "Json"

        The condition.

      • Readonlydetails: MessageDetails<"Json">

        The condition's fields.

    • TryFromInt: an integer outside its type (integer conversion error: …).

      Parameters

      • message: string
      • Optionalcause: unknown

      Returns ProvenanceMarkError & {
          code: "TryFromInt";
          details: MessageDetails<"TryFromInt">;
      }

      • Readonlycode: "TryFromInt"

        The condition.

      • Readonlydetails: MessageDetails<"TryFromInt">

        The condition's fields.

    • Envelope: an envelope that is not a generator's, or an envelope failure (envelope error: …).

      Parameters

      • message: string
      • Optionalcause: unknown

      Returns ProvenanceMarkError & { code: "Envelope"; details: MessageDetails<"Envelope"> }

      • Readonlycode: "Envelope"

        The condition.

      • Readonlydetails: MessageDetails<"Envelope">

        The condition's fields.

    • Cbor, Bytewords or Envelope for a sibling error caught inside a decoder; other values pass through.

      Parameters

      • error: unknown

      Returns unknown