Class DidBtc1

constructor

• new DidBtc1(): DidBtc1

  Returns DidBtc1

StaticmethodName

Staticcreate

• create(params: Btc1CreateParams): Promise<Btc1CreateResponse>

  Entry point for section 4.1 Create. See Btc1Create for implementation details.

  A did:btc1 identifier and associated DID document can either be created deterministically from a cryptographic seed, or it can be created from an arbitrary genesis intermediate DID document representation. In both cases, DID creation can be undertaken in an offline manner, i.e., the DID controller does not need to interact with the Bitcoin network to create their DID.

  Parameters

  • params: Btc1CreateParams

    See Btc1CreateParams for details.

  Returns Promise<Btc1CreateResponse>

  Promise resolving to a CreateResponse object.

  Throws

  if any of the checks fail

StaticgetSigningMethod

• getSigningMethod(
      params: { didDocument: Btc1DidDocument; methodId?: string },
  ): Btc1VerificationMethod

  Given the W3C DID Document of a did:btc1 identifier, return the signing verification method that will be used for signing messages and credentials. If given, the methodId parameter is used to select the verification method. If not given, the Identity Key's verification method with an ID fragment of '#initialKey' is used.

  Parameters

  • params: { didDocument: Btc1DidDocument; methodId?: string }

    Parameters for the getSigningMethod method.

    • didDocument: Btc1DidDocument

      DID Document to get the verification method from.

    • OptionalmethodId?: string

      Optional ID of the verification method to use for signing.

  Returns Btc1VerificationMethod

  Promise resolving to the Btc1VerificationMethod object used for signing.

  Throws

  if the parsed did method does not match btc1 or signing method could not be determined.

Staticresolve

• resolve(
      identifier: string,
      options?: DidResolutionOptions,
  ): Promise<DidResolutionResult>

  Entry point for section 4.2 Read. See Btc1Read for implementation details.

  The read operation is executed by a resolver after a resolution request identifying a specific did:btc1 identifier is received from a client at Resolution Time. The request MAY contain a resolutionOptions object containing additional information to be used in resolution. The resolver then attempts to resolve the DID document of the identifier at a specific Target Time. The Target Time is either provided in resolutionOptions or is set to the Resolution Time of the request.

  Parameters

  • identifier: string

    The DID to be resolved
  • options: DidResolutionOptions = {}

    Optional parameters for the resolution operation

  Returns Promise<DidResolutionResult>

  Promise resolving to a DID Resolution Result

  Throws

  if the resolution fails for any reason

  Throws

  InvalidDid if the identifier is invalid

  Example

  const resolution = await DidBtc1.resolve('did:btc1:k1q0dygyp3gz969tp46dychzy4q78c2k3js68kvyr0shanzg67jnuez2cfplh')
  Copy

Staticupdate

• update(
      params: {
          beaconIds: string[];
          identifier: string;
          patch: PatchOperation[];
          sourceDocument: Btc1DidDocument;
          sourceVersionId: number;
          verificationMethodId: string;
      },
  ): Promise<any>

  Entry point for section 4.3 Update. See Btc1Update for implementation details.

  An update to a did:btc1 document is an invoked capability using the ZCAP-LD data format, signed by a verificationMethod that has the authority to make the update as specified in the previous DID document. Capability invocations for updates MUST be authorized using Data Integrity following the bip340-jcs-2025 cryptosuite with a proofPurpose of capabilityInvocation.

  The Update algorithm takes as inputs a btc1Identifier, sourceDocument, sourceVersionId, documentPatch, a verificationMethodId and an array of beaconIds. The sourceDocument is the DID document being updated. The documentPatch is a JSON Patch object containing a set of transformations to be applied to the sourceDocument. The result of these transformations MUST produce a DID document conformant to the DID Core specification. The verificationMethodId is an identifier for a verificationMethod within the sourceDocument. The verificationMethod identified MUST be a BIP340 Multikey. The beaconIds MUST identify service endpoints with one of the three Beacon Types SingletonBeacon, aCIDAggregateBeacon, and SMTAggregateBeacon.

  Parameters

  • params: {
        beaconIds: string[];
        identifier: string;
        patch: PatchOperation[];
        sourceDocument: Btc1DidDocument;
        sourceVersionId: number;
        verificationMethodId: string;
    }

    Required parameters for the update operation.

    • beaconIds: string[]

      The beacon IDs to announce the update

    • identifier: string

      The btc1 identifier to be updated.

    • patch: PatchOperation[]

    • sourceDocument: Btc1DidDocument

      The DID document being updated.

    • sourceVersionId: number

      The versionId of the source document.

    • verificationMethodId: string

      The verificationMethod ID to sign the update

  Returns Promise<any>

  Promise resolving to void

  Throws

  if the verificationMethod type is not Multikey or the publicKeyMultibase header is not z66P