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

    Class XIDError

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

    try {
    doc.addKey(key);
    } catch (e) {
    if (XIDError.isXIDError(e) && e.is("Duplicate")) console.log(e.details.item);
    }

    Hierarchy

    • Error
      • XIDError
    Index
    name: "XIDError"

    Always "XIDError".

    The condition, one of XIDErrorCode.

    The fields of the condition, discriminated by code.

    • Whether value is an XIDError: an instance of this class.

      Parameters

      • value: unknown

      Returns value is XIDError

    • Duplicate: an item of this kind is already there.

      Parameters

      • item: string

      Returns XIDError & {
          code: "Duplicate";
          details: { code: "Duplicate" } & { item: string };
      }

      • Readonlycode: "Duplicate"

        The condition.

      • Readonlydetails: { code: "Duplicate" } & { item: string }

        The condition's fields.

    • NotFound: no item of this kind is there.

      Parameters

      • item: string

      Returns XIDError & {
          code: "NotFound";
          details: { code: "NotFound" } & { item: string };
      }

      • Readonlycode: "NotFound"

        The condition.

      • Readonlydetails: { code: "NotFound" } & { item: string }

        The condition's fields.

    • StillReferenced: a service still names the item.

      Parameters

      • item: string

      Returns XIDError & {
          code: "StillReferenced";
          details: { code: "StillReferenced" } & { item: string };
      }

      • Readonlycode: "StillReferenced"

        The condition.

      • Readonlydetails: { code: "StillReferenced" } & { item: string }

        The condition's fields.

    • EmptyValue: the field must not be empty.

      Parameters

      • field: string

      Returns XIDError & {
          code: "EmptyValue";
          details: { code: "EmptyValue" } & { field: string };
      }

      • Readonlycode: "EmptyValue"

        The condition.

      • Readonlydetails: { code: "EmptyValue" } & { field: string }

        The condition's fields.

    • UnknownPrivilege: a known value that names no privilege.

      Returns XIDError & { code: "UnknownPrivilege"; details: { code: "UnknownPrivilege" } }

      • Readonlycode: "UnknownPrivilege"

        The condition.

      • Readonlydetails: { code: "UnknownPrivilege" }

        The condition's fields.

        • Readonlycode: "UnknownPrivilege"

          The discriminant.

    • InvalidXid: the inception key does not produce the document's XID.

      Returns XIDError & { code: "InvalidXid"; details: { code: "InvalidXid" } }

      • Readonlycode: "InvalidXid"

        The condition.

      • Readonlydetails: { code: "InvalidXid" }

        The condition's fields.

        • Readonlycode: "InvalidXid"

          The discriminant.

    • MissingInceptionKey: the document has no inception key, or it has no private keys.

      Returns XIDError & {
          code: "MissingInceptionKey";
          details: { code: "MissingInceptionKey" };
      }

      • Readonlycode: "MissingInceptionKey"

        The condition.

      • Readonlydetails: { code: "MissingInceptionKey" }

        The condition's fields.

        • Readonlycode: "MissingInceptionKey"

          The discriminant.

    • InvalidResolutionMethod: a 'dereferenceVia' object that is not a URI.

      Returns XIDError & {
          code: "InvalidResolutionMethod";
          details: { code: "InvalidResolutionMethod" };
      }

      • Readonlycode: "InvalidResolutionMethod"

        The condition.

      • Readonlydetails: { code: "InvalidResolutionMethod" }

        The condition's fields.

        • Readonlycode: "InvalidResolutionMethod"

          The discriminant.

    • MultipleProvenanceMarks: more than one 'provenance' assertion.

      Returns XIDError & {
          code: "MultipleProvenanceMarks";
          details: { code: "MultipleProvenanceMarks" };
      }

      • Readonlycode: "MultipleProvenanceMarks"

        The condition.

      • Readonlydetails: { code: "MultipleProvenanceMarks" }

        The condition's fields.

        • Readonlycode: "MultipleProvenanceMarks"

          The discriminant.

    • UnexpectedPredicate: a service assertion with a predicate the parser does not take.

      Parameters

      • predicate: string

      Returns XIDError & {
          code: "UnexpectedPredicate";
          details: { code: "UnexpectedPredicate" } & { predicate: string };
      }

      • Readonlycode: "UnexpectedPredicate"

        The condition.

      • Readonlydetails: { code: "UnexpectedPredicate" } & { predicate: string }

        The condition's fields.

    • UnexpectedNestedAssertions: a service assertion whose object has assertions.

      Returns XIDError & {
          code: "UnexpectedNestedAssertions";
          details: { code: "UnexpectedNestedAssertions" };
      }

      • Readonlycode: "UnexpectedNestedAssertions"

        The condition.

      • Readonlydetails: { code: "UnexpectedNestedAssertions" }

        The condition's fields.

        • Readonlycode: "UnexpectedNestedAssertions"

          The discriminant.

    • NoPermissions: the service allows nothing.

      Parameters

      • uri: string

      Returns XIDError & {
          code: "NoPermissions";
          details: { code: "NoPermissions" } & { uri: string };
      }

      • Readonlycode: "NoPermissions"

        The condition.

      • Readonlydetails: { code: "NoPermissions" } & { uri: string }

        The condition's fields.

    • NoReferences: the service names no key and no delegate.

      Parameters

      • uri: string

      Returns XIDError & {
          code: "NoReferences";
          details: { code: "NoReferences" } & { uri: string };
      }

      • Readonlycode: "NoReferences"

        The condition.

      • Readonlydetails: { code: "NoReferences" } & { uri: string }

        The condition's fields.

    • UnknownKeyReference: the service names a key the document lacks.

      Parameters

      • reference: string
      • uri: string

      Returns XIDError & {
          code: "UnknownKeyReference";
          details: { code: "UnknownKeyReference" } & {
              reference: string;
              uri: string;
          };
      }

      • Readonlycode: "UnknownKeyReference"

        The condition.

      • Readonlydetails: { code: "UnknownKeyReference" } & { reference: string; uri: string }

        The condition's fields.

    • UnknownDelegateReference: the service names a delegate the document lacks.

      Parameters

      • reference: string
      • uri: string

      Returns XIDError & {
          code: "UnknownDelegateReference";
          details: { code: "UnknownDelegateReference" } & {
              reference: string;
              uri: string;
          };
      }

      • Readonlycode: "UnknownDelegateReference"

        The condition.

      • Readonlydetails: { code: "UnknownDelegateReference" } & { reference: string; uri: string }

        The condition's fields.

    • KeyNotFoundInDocument: checkContainsKey found no such key.

      Parameters

      • key: string

      Returns XIDError & {
          code: "KeyNotFoundInDocument";
          details: { code: "KeyNotFoundInDocument" } & { key: string };
      }

      • Readonlycode: "KeyNotFoundInDocument"

        The condition.

      • Readonlydetails: { code: "KeyNotFoundInDocument" } & { key: string }

        The condition's fields.

    • DelegateNotFoundInDocument: checkContainsDelegate found no such delegate.

      Parameters

      • delegate: string

      Returns XIDError & {
          code: "DelegateNotFoundInDocument";
          details: { code: "DelegateNotFoundInDocument" } & { delegate: string };
      }

      • Readonlycode: "DelegateNotFoundInDocument"

        The condition.

      • Readonlydetails: { code: "DelegateNotFoundInDocument" } & { delegate: string }

        The condition's fields.

    • InvalidPassword: a locked key or generator did not open.

      Returns XIDError & { code: "InvalidPassword"; details: { code: "InvalidPassword" } }

      • Readonlycode: "InvalidPassword"

        The condition.

      • Readonlydetails: { code: "InvalidPassword" }

        The condition's fields.

        • Readonlycode: "InvalidPassword"

          The discriminant.

    • EnvelopeNotSigned: verification was asked of an unsigned envelope.

      Returns XIDError & { code: "EnvelopeNotSigned"; details: { code: "EnvelopeNotSigned" } }

      • Readonlycode: "EnvelopeNotSigned"

        The condition.

      • Readonlydetails: { code: "EnvelopeNotSigned" }

        The condition's fields.

        • Readonlycode: "EnvelopeNotSigned"

          The discriminant.

    • SignatureVerificationFailed: the inception key did not sign the envelope.

      Returns XIDError & {
          code: "SignatureVerificationFailed";
          details: { code: "SignatureVerificationFailed" };
      }

      • Readonlycode: "SignatureVerificationFailed"

        The condition.

      • Readonlydetails: { code: "SignatureVerificationFailed" }

        The condition's fields.

        • Readonlycode: "SignatureVerificationFailed"

          The discriminant.

    • NoProvenanceMark: the document has no mark to advance.

      Returns XIDError & { code: "NoProvenanceMark"; details: { code: "NoProvenanceMark" } }

      • Readonlycode: "NoProvenanceMark"

        The condition.

      • Readonlydetails: { code: "NoProvenanceMark" }

        The condition's fields.

        • Readonlycode: "NoProvenanceMark"

          The discriminant.

    • GeneratorConflict: a generator was given to a document that holds one.

      Returns XIDError & { code: "GeneratorConflict"; details: { code: "GeneratorConflict" } }

      • Readonlycode: "GeneratorConflict"

        The condition.

      • Readonlydetails: { code: "GeneratorConflict" }

        The condition's fields.

        • Readonlycode: "GeneratorConflict"

          The discriminant.

    • NoGenerator: the document holds no generator and none was given.

      Returns XIDError & { code: "NoGenerator"; details: { code: "NoGenerator" } }

      • Readonlycode: "NoGenerator"

        The condition.

      • Readonlydetails: { code: "NoGenerator" }

        The condition's fields.

        • Readonlycode: "NoGenerator"

          The discriminant.

    • ChainIdMismatch: the generator continues another chain.

      Parameters

      • expected: Uint8Array
      • actual: Uint8Array

      Returns XIDError & {
          code: "ChainIdMismatch";
          details: { code: "ChainIdMismatch" } & {
              expected: Uint8Array;
              actual: Uint8Array;
          };
      }

      • Readonlycode: "ChainIdMismatch"

        The condition.

      • Readonlydetails: { code: "ChainIdMismatch" } & { expected: Uint8Array; actual: Uint8Array }

        The condition's fields.

    • SequenceMismatch: the generator's next sequence number is not the mark's plus one.

      Parameters

      • expected: number
      • actual: number

      Returns XIDError & {
          code: "SequenceMismatch";
          details: { code: "SequenceMismatch" } & {
              expected: number;
              actual: number;
          };
      }

      • Readonlycode: "SequenceMismatch"

        The condition.

      • Readonlydetails: { code: "SequenceMismatch" } & { expected: number; actual: number }

        The condition's fields.

    • EnvelopeParsing: an envelope error inside a decoder. The message is the reference's envelope parsing error; the envelope error is cause and its message is details.message.

      Parameters

      • cause: unknown

      Returns XIDError & {
          code: "EnvelopeParsing";
          details: { code: "EnvelopeParsing" } & { message: string };
      }

      • Readonlycode: "EnvelopeParsing"

        The condition.

      • Readonlydetails: { code: "EnvelopeParsing" } & { message: string }

        The condition's fields.

    • Component: a components error; the message is the reference's component error.

      Parameters

      • cause: unknown

      Returns XIDError & {
          code: "Component";
          details: { code: "Component" } & { message: string };
      }

      • Readonlycode: "Component"

        The condition.

      • Readonlydetails: { code: "Component" } & { message: string }

        The condition's fields.

    • Cbor: a dcbor error inside a decoder; the message is the reference's CBOR error.

      Parameters

      • cause: unknown

      Returns XIDError & { code: "Cbor"; details: { code: "Cbor" } & { message: string } }

      • Readonlycode: "Cbor"

        The condition.

      • Readonlydetails: { code: "Cbor" } & { message: string }

        The condition's fields.

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

      Parameters

      • cause: Error

      Returns XIDError & { code: "Cbor"; details: { code: "Cbor" } & { message: string } }

      • Readonlycode: "Cbor"

        The condition.

      • Readonlydetails: { code: "Cbor" } & { message: string }

        The condition's fields.

    • ProvenanceMark: a provenance-mark error; the message is the reference's provenance mark error.

      Parameters

      • cause: unknown

      Returns XIDError & {
          code: "ProvenanceMark";
          details: { code: "ProvenanceMark" } & { message: string };
      }

      • Readonlycode: "ProvenanceMark"

        The condition.

      • Readonlydetails: { code: "ProvenanceMark" } & { message: string }

        The condition's fields.