@did-btcr2/method 0.13.1

package/dist/esm/btcr2/crud/create.js

@@ -0,0 +1,102 @@
+import { Btcr2IdentifierTypes } from '@did-btcr2/common';
+import { PublicKey } from '@did-btcr2/keypair';
+import { getNetwork } from '../../bitcoin/network.js';
+import { BeaconUtils } from '../../utils/beacons.js';
+import { Btc1DidDocument } from '../../utils/did-document.js';
+import { Btc1Identifier } from '../../utils/identifier.js';
+/**
+ * Implements section {@link https://dcdpr.github.io/did-btcr2/#create | 4.1 Create}.
+ *
+ * A did:btcr2 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.
+ *
+ * @class Btc1Create
+ * @type {Btc1Create}
+ */
+export class Btc1Create {
+    /**
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#deterministic-key-based-creation | 4.1.1 Deterministic Key-Based Creation}.
+     *
+     * For deterministic key-based creation, the did:btcr2 identifier encodes a secp256k1 public key. The key is then used
+     * to deterministically generate the initial DID document.
+     *
+     * @param {Btc1CreateKeyParams} params See {@link Btc1CreateKeyParams} for details.
+     * @param {number} params.version did-btcr2 identifier version.
+     * @param {string} params.network did-btcr2 bitcoin network.
+     * @param {KeyBytes} params.pubKeyBytes public key bytes for id creation.
+     * @returns {Btc1CreateResponse} A response object of type {@link Btc1CreateResponse}.
+     * @throws {DidError} if the public key is missing or invalid.
+     */
+    static deterministic({ pubKeyBytes, options }) {
+        // Deconstruct options and set the default values
+        const { version = 1, network = 'bitcoin' } = options;
+        // Set idType to "KEY"
+        const idType = Btcr2IdentifierTypes.KEY;
+        // Call the the did:btcr2 Identifier Encoding algorithm
+        const identifier = Btc1Identifier.encode({ version, network, idType, genesisBytes: pubKeyBytes });
+        // Instantiate PublicKey object and get the multibase formatted publicKey
+        const { compressed: publicKey, multibase: publicKeyMultibase } = new PublicKey(pubKeyBytes);
+        // Generate the service field for the DID Document
+        const service = BeaconUtils.generateBeaconServices({
+            identifier,
+            publicKey,
+            network: getNetwork(network),
+            type: 'SingletonBeacon',
+        });
+        // Create initialDocument ensuring conformant to spec as Btc1DidDocument
+        const initialDocument = new Btc1DidDocument({
+            id: identifier,
+            controller: [identifier],
+            verificationMethod: [{
+                    id: `${identifier}#initialKey`,
+                    type: 'Multikey',
+                    controller: identifier,
+                    publicKeyMultibase: publicKeyMultibase.address,
+                }],
+            service,
+        });
+        // Return did & initialDocument
+        return { did: identifier, initialDocument };
+    }
+    /**
+     * Implements {@link https://dcdpr.github.io/did-btcr2/#external-initial-document-creation | 4.1.2 External Initial Document Creation}.
+     *
+     * Creates a did:btcr2 identifier from some initiating arbitrary DID document. This allows for more complex
+     * initial DID documents, including the ability to include Service Endpoints and Beacons that support aggregation.
+     * Inputs include `intermediateDocument`, optional version and network returning initialDidDocument. The
+     * intermediateDocument should be a valid DID document except all places where the DID document requires the use of
+     * the identifier (e.g. the id field). These fields should use placeholder value
+     * `did:btcr2:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`. The intermediateDocument should include at
+     * least one verificationMethod and service of the type SingletonBeacon.
+     *
+     * @param {Btc1CreateExternalParams} params See {@link Btc1CreateExternalParams} for details.
+     * @param {number} params.version Identifier version.
+     * @param {string} params.network Identifier network name.
+     * @param {string} params.documentBytes Intermediate DID Document bytes.
+     * @returns {Btc1CreateResponse} A Promise resolving to {@link Btc1CreateResponses}.
+     * @throws {DidError} if the verificationMethod or service objects are missing required properties
+     */
+    static async external({ intermediateDocument, options }) {
+        // 1. Set idType to "EXTERNAL"
+        const idType = Btcr2IdentifierTypes.EXTERNAL;
+        // 2. Set version to 1
+        // 3. Set network to the desired network.
+        const { version = 1, network = 'bitcoin' } = options;
+        // Validate intermediateDocument
+        intermediateDocument.validateIntermediate();
+        // 4. Set genesisBytes to the result of passing intermediateDocument into the JSON Canonicalization and Hash
+        //    algorithm.
+        const genesisBytes = await JSON.canonicalization.canonicalhash(intermediateDocument);
+        // 5. Pass idType, version, network, and genesisBytes to the did:btcr2 Identifier Encoding algorithm, retrieving id.
+        // 6. Set did to id
+        const did = Btc1Identifier.encode({ idType, genesisBytes, version, network });
+        // 7. Set initialDocument to a copy of the intermediateDocument.
+        // 8. Replace all did:btcr2:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx values in the initialDocument with the did.
+        const initialDocument = intermediateDocument.toBtc1DidDocument(did);
+        // Return DID & DID Document.
+        return { did, initialDocument };
+    }
+}
+//# sourceMappingURL=create.js.map

package/dist/esm/btcr2/crud/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../../../src/btcr2/crud/create.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAA4B,MAAM,mBAAmB,CAAC;AACnF,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,eAAe,EAA2B,MAAM,6BAA6B,CAAC;AACvF,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAwC3D;;;;;;;;;;GAUG;AACH,MAAM,OAAO,UAAU;IACrB;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,aAAa,CAAC,EAAE,WAAW,EAAE,OAAO,EAGjD;QACC,iDAAiD;QACjD,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC;QAErD,sBAAsB;QACtB,MAAM,MAAM,GAAG,oBAAoB,CAAC,GAAG,CAAC;QAExC,uDAAuD;QACvD,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,CAAC,CAAC;QAElG,yEAAyE;QACzE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAE,GAAG,IAAI,SAAS,CAAC,WAAW,CAAC,CAAC;QAE5F,kDAAkD;QAClD,MAAM,OAAO,GAAG,WAAW,CAAC,sBAAsB,CAAC;YACjD,UAAU;YACV,SAAS;YACT,OAAO,EAAG,UAAU,CAAC,OAAO,CAAC;YAC7B,IAAI,EAAM,iBAAiB;SAC5B,CAAC,CAAC;QAEH,wEAAwE;QACxE,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC;YAC1C,EAAE,EAAmB,UAAU;YAC/B,UAAU,EAAW,CAAC,UAAU,CAAC;YACjC,kBAAkB,EAAG,CAAC;oBACpB,EAAE,EAAmB,GAAG,UAAU,aAAa;oBAC/C,IAAI,EAAiB,UAAU;oBAC/B,UAAU,EAAW,UAAU;oBAC/B,kBAAkB,EAAG,kBAAkB,CAAC,OAAO;iBAChD,CAAC;YACF,OAAO;SACR,CAAC,CAAC;QAEH,+BAA+B;QAC/B,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,oBAAoB,EAAE,OAAO,EAG3D;QACC,8BAA8B;QAC9B,MAAM,MAAM,GAAG,oBAAoB,CAAC,QAAQ,CAAC;QAE7C,sBAAsB;QACtB,yCAAyC;QACzC,MAAM,EAAE,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC;QAErD,gCAAgC;QAChC,oBAAoB,CAAC,oBAAoB,EAAE,CAAC;QAE5C,4GAA4G;QAC5G,gBAAgB;QAChB,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;QAErF,oHAAoH;QACpH,mBAAmB;QACnB,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;QAE9E,gEAAgE;QAChE,oIAAoI;QACpI,MAAM,eAAe,GAAG,oBAAoB,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAEpE,6BAA6B;QAC7B,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC;IAClC,CAAC;CACF"}

package/dist/esm/btcr2/crud/deactivate.js

@@ -0,0 +1,14 @@
+import { DidBtc1 } from '../../did-btcr2.js';
+/**
+ * Implements {@link https://dcdpr.github.io/did-btcr2/#deactivate | 4.4 Deactivate}
+ * To deactivate a did:btcr2, the DID controller MUST add the property deactivated with the value true on the DID
+ * document. To do this, the DID controller constructs a valid DID Update Payload with a JSON patch that adds this
+ * property and announces the payload through a Beacon in their current DID document following the algorithm in Update.
+ * Once a did:btcr2 has been deactivated this state is considered permanent and resolution MUST terminate.
+ * @class Btc1Deactivate
+ * @type {Btc1Deactivate}
+ * @extends {DidBtc1}
+ */
+export class Btc1Deactivate extends DidBtc1 {
+}
+//# sourceMappingURL=deactivate.js.map

package/dist/esm/btcr2/crud/deactivate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deactivate.js","sourceRoot":"","sources":["../../../../src/btcr2/crud/deactivate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C;;;;;;;;;GASG;AACH,MAAM,OAAO,cAAe,SAAQ,OAAO;CAAG"}