@did-btcr2/cli 0.1.0

package/LICENSE

@@ -0,0 +1 @@
+{"key":"unlicense","name":"The Unlicense","spdx_id":"Unlicense","url":"https://api.github.com/licenses/unlicense","node_id":"MDc6TGljZW5zZTE1","html_url":"http://choosealicense.com/licenses/unlicense/","description":"A license with no conditions whatsoever which dedicates works to the public domain. Unlicensed works, modifications, and larger works may be distributed under different terms and without source code.","implementation":"Create a text file (typically named UNLICENSE or UNLICENSE.txt) in the root of your source code and copy the text of the license disclaimer into the file.","permissions":["private-use","commercial-use","modifications","distribution"],"conditions":[],"limitations":["liability","warranty"],"body":"This is free and unencumbered software released into the public domain.\n\nAnyone is free to copy, modify, publish, use, compile, sell, or\ndistribute this software, either in source code form or as a compiled\nbinary, for any purpose, commercial or non-commercial, and by any\nmeans.\n\nIn jurisdictions that recognize copyright laws, the author or authors\nof this software dedicate any and all copyright interest in the\nsoftware to the public domain. We make this dedication for the benefit\nof the public at large and to the detriment of our heirs and\nsuccessors. We intend this dedication to be an overt act of\nrelinquishment in perpetuity of all present and future rights to this\nsoftware under copyright law.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\nOTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\nARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\nFor more information, please refer to <https://unlicense.org>\n","featured":false}

package/README.md

@@ -0,0 +1,3 @@
+# CLI
+
+Command Line Interface (CLI) for interacting with did:btcr2 method.

package/dist/cjs/cli.js

@@ -0,0 +1,176 @@
+import { DidMethodError } from '@did-btcr2/common';
+import { Identifier } from '@did-btcr2/method';
+import { Command } from 'commander';
+import { readFile } from 'fs/promises';
+import Btcr2Command from './command.js';
+/**
+ * Custom CLI Error class extending DidMethodError.
+ */
+export class CLIError extends DidMethodError {
+    constructor(message, type = 'CLIError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+/**
+ * A class-based CLI using Commander.
+ * - No forced process.exit().
+ * - Configurable by calling `run(argv?)`.
+ */
+export class DidBtcr2Cli {
+    CLI;
+    constructor() {
+        // Create the main Commander program
+        this.CLI = new Command()
+            .name('btcr2')
+            .version('btcr2 0.1.0', '-v, --version', 'Output the current version')
+            .description('CLI tool for the did:btcr2 method');
+        // Configure top-level options and subcommands
+        this.configureCommands();
+    }
+    /**
+     * Configure the CLI commands and options.
+     * @private
+     */
+    configureCommands() {
+        /* CREATE */
+        this.CLI
+            .command('create')
+            .description('Create an identifier and initial DID document')
+            .requiredOption('-t, --type <type>', 'Identifier type <k|x>', 'k')
+            .requiredOption('-n, --network <network>', 'Identifier bitcoin network <bitcoin|testnet3|testnet4|signet|mutinynet|regtest>')
+            .requiredOption('-b, --bytes <bytes>', 'The genesis bytes used to create a DID and DID document as a hex string. ' +
+            'If type=k, MUST be secp256k1 public key. ' +
+            'If type=x, MUST be SHA-256 hash of a genesis document')
+            .action(async (options) => {
+            if (!['k', 'x'].includes(options.type)) {
+                throw new CLIError('Invalid type. Must be "k" or "x".', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            if (!['bitcoin', 'testnet3', 'testnet4', 'signet', 'mutinynet', 'regtest'].includes(options.network)) {
+                throw new CLIError('Invalid network. Must be one of "bitcoin", "testnet3", ' +
+                    '"testnet4", "signet", "mutinynet", or "regtest".', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            if (Buffer.from(options.bytes, 'hex').length === 0) {
+                throw new CLIError('Invalid bytes. Must be a non-empty hex string.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            await this.invokeCommand({ options, action: 'create', command: new Btcr2Command() });
+        });
+        /* READ / RESOLVE */
+        this.CLI
+            .command('resolve')
+            .alias('read')
+            .description('Resolve the DID document of the identifier.')
+            .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier')
+            .option('-r, --resolutionOptions <resolutionOptions>', 'JSON string containing resolution options')
+            .option('-p, --resolutionOptionsPath <resolutionOptionsPath>', 'Path to a JSON file containing resolution options')
+            .action(async (options) => {
+            try {
+                Identifier.decode(options.identifier);
+            }
+            catch {
+                throw new CLIError('Invalid identifier. Must be a valid did:btcr2 identifier.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            if (options.resolutionOptions) {
+                try {
+                    options.resolutionOptions = JSON.parse(options.resolutionOptions);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            if (options.resolutionOptionsPath) {
+                try {
+                    const data = await readFile(options.resolutionOptionsPath, 'utf-8');
+                    options.resolutionOptions = JSON.parse(data);
+                }
+                catch {
+                    throw new CLIError('Invalid options path. Must be a valid path to a JSON file.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            await this.invokeCommand({ options, action: 'resolve', command: new Btcr2Command() });
+        });
+        /* UPDATE */
+        this.CLI
+            .command('update')
+            .description('Update a did:btcr2 document.')
+            .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier')
+            .requiredOption('-s, --sourceDocument <sourceDocument>', 'Source DID document as JSON string')
+            .requiredOption('-v, --sourceVersionId <sourceVersionId>', 'Source version ID as a number')
+            .requiredOption('-p, --patch <patch>', 'JSON Patch operations as a JSON string array')
+            .requiredOption('-m, --verificationMethodId <verificationMethodId>', 'Did document verification method ID as a string')
+            .requiredOption('-b, --beaconIds <beaconIds>', 'Beacon IDs as a JSON string array')
+            .action(async (options) => {
+            // Validate identifier by decoding
+            try {
+                Identifier.decode(options.identifier);
+            }
+            catch {
+                throw new CLIError('Invalid identifier. Must be a valid did:btcr2 identifier.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            // Validate source document JSON
+            if (options.sourceDocument) {
+                try {
+                    options.sourceDocument = JSON.parse(options.sourceDocument);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            // Validate patch JSON
+            if (options.patch) {
+                try {
+                    options.patch = JSON.parse(options.patch);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            // Validate beacon IDs JSON
+            if (options.beaconIds) {
+                try {
+                    options.beaconIds = JSON.parse(options.beaconIds);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            await this.invokeCommand({ options, action: 'update', command: new Btcr2Command() });
+        });
+        /* DEACTIVATE / DELETE */
+        this.CLI
+            .command('deactivate')
+            .alias('delete')
+            .description('Deactivate the did:btcr2 identifier permanently.')
+            .action(async (options) => {
+            await this.invokeCommand({ options, action: 'deactivate', command: new Btcr2Command() });
+        });
+    }
+    /**
+     * A helper to invoke the command logic without forcibly exiting.
+     */
+    async invokeCommand({ options, action, command }) {
+        try {
+            await command.execute({ options, action });
+        }
+        catch (error) {
+            console.error('Error executing command:', error);
+        }
+    }
+    /**
+     * Parse and run the CLI.
+     */
+    run(argv) {
+        if (argv) {
+            this.CLI.parse(argv, { from: 'user' });
+        }
+        else {
+            // parse real process.argv
+            this.CLI.parse();
+        }
+        // If no subcommand was given, show help
+        if (!this.CLI.args.length) {
+            this.CLI.help();
+        }
+    }
+}
+export default new DidBtcr2Cli().run();
+//# sourceMappingURL=cli.js.map

package/dist/cjs/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,cAAc;IAC1C,YAAY,OAAe,EAAE,OAAe,UAAU,EAAE,IAA0B;QAChF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACd,GAAG,CAAU;IAErB;QACE,oCAAoC;QACpC,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,EAAE;aACrB,IAAI,CAAC,OAAO,CAAC;aACb,OAAO,CAAC,aAAa,EAAE,eAAe,EAAE,4BAA4B,CAAC;aACrE,WAAW,CAAC,mCAAmC,CAAC,CAAC;QAEpD,8CAA8C;QAC9C,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,YAAY;QACZ,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,QAAQ,CAAC;aACjB,WAAW,CAAC,+CAA+C,CAAC;aAC5D,cAAc,CAAC,mBAAmB,EAAE,uBAAuB,EAAE,GAAG,CAAC;aACjE,cAAc,CACb,yBAAyB,EACzB,iFAAiF,CAClF;aACA,cAAc,CACb,qBAAqB,EACrB,2EAA2E;YAC3E,2CAA2C;YAC3C,uDAAuD,CACxD;aACA,MAAM,CACL,KAAK,EAAE,OAA6E,EAAE,EAAE;YACtF,IAAG,CAAC,CAAC,GAAG,EAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,QAAQ,CAChB,mCAAmC,EACnC,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,IAAG,CAAC,CAAC,SAAS,EAAC,UAAU,EAAC,UAAU,EAAC,QAAQ,EAAC,WAAW,EAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/F,MAAM,IAAI,QAAQ,CAChB,yDAAyD;oBACzD,kDAAkD,EAClD,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,IAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,QAAQ,CAChB,gDAAgD,EAChD,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QACvF,CAAC,CACF,CAAC;QAEJ,oBAAoB;QACpB,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,SAAS,CAAC;aAClB,KAAK,CAAC,MAAM,CAAC;aACb,WAAW,CAAC,6CAA6C,CAAC;aAC1D,cAAc,CAAC,+BAA+B,EAAE,sBAAsB,CAAC;aACvE,MAAM,CAAC,6CAA6C,EAAE,2CAA2C,CAAC;aAClG,MAAM,CAAC,qDAAqD,EAAE,mDAAmD,CAAC;aAClH,MAAM,CAAC,KAAK,EAAE,OAA2F,EAAE,EAAE;YAC5G,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,QAAQ,CAChB,2DAA2D,EAC3D,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,IAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,IAAI,CAAC;oBACH,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;gBACpE,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBACjC,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;oBACpE,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC/C,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,4DAA4D,EAC5D,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEL,YAAY;QACZ,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,QAAQ,CAAC;aACjB,WAAW,CAAC,8BAA8B,CAAC;aAC3C,cAAc,CAAC,+BAA+B,EAAE,sBAAsB,CAAC;aACvE,cAAc,CAAC,uCAAuC,EAAE,oCAAoC,CAAC;aAC7F,cAAc,CAAC,yCAAyC,EAAE,+BAA+B,CAAC;aAC1F,cAAc,CAAC,qBAAqB,EAAE,8CAA8C,CAAC;aACrF,cAAc,CAAC,mDAAmD,EAAE,iDAAiD,CAAC;aACtH,cAAc,CAAC,6BAA6B,EAAE,mCAAmC,CAAC;aAClF,MAAM,CAAC,KAAK,EAAE,OAOb,EAAE,EAAE;YACJ,kCAAkC;YAClC,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,QAAQ,CAChB,2DAA2D,EAC3D,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,gCAAgC;YAChC,IAAG,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBAC9D,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,sBAAsB;YACtB,IAAG,OAAO,CAAC,KAAK,EAAE,CAAC;gBACjB,IAAI,CAAC;oBACH,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC5C,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,2BAA2B;YAC3B,IAAG,OAAO,CAAC,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC;oBACH,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACpD,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;QAEL,yBAAyB;QACzB,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,YAAY,CAAC;aACrB,KAAK,CAAC,QAAQ,CAAC;aACf,WAAW,CAAC,kDAAkD,CAAC;aAC/D,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACxB,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAIrD;QACC,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,IAAe;QACxB,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,0BAA0B;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC;QAED,wCAAwC;QACxC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;CACF;AAGD,eAAe,IAAI,WAAW,EAAE,CAAC,GAAG,EAAE,CAAC"}

package/dist/cjs/command.js

@@ -0,0 +1,41 @@
+import { IdentifierTypes, Logger, MethodError } from '@did-btcr2/common';
+import { DidBtcr2 } from '@did-btcr2/method';
+export default class Btcr2Command {
+    async execute({ options, action }) {
+        try {
+            switch (action) {
+                case 'create': {
+                    const { type, bytes } = options;
+                    const idType = type === 'k' ? IdentifierTypes.KEY : IdentifierTypes.EXTERNAL;
+                    const genesisBytes = Buffer.from(bytes, 'hex').toArray().toUint8Array();
+                    const did = await DidBtcr2.create({ idType, genesisBytes });
+                    console.log(did);
+                    break;
+                }
+                case 'read':
+                case 'resolve': {
+                    const { identifier, options: resolutionOptions } = options;
+                    const resolutionResult = await DidBtcr2.resolve(identifier, resolutionOptions);
+                    console.log(JSON.stringify(resolutionResult, null, 2));
+                    break;
+                }
+                case 'update': {
+                    const update = await DidBtcr2.update(options);
+                    console.log(JSON.stringify(update, null, 2));
+                    break;
+                }
+                case 'delete':
+                case 'deactivate':
+                    // await DidBtcr2.deactivate(options);
+                    Logger.warn('// TODO: Update once DidBtcr2.deactivate implemented');
+                    break;
+                default:
+                    throw new MethodError(`Invalid command: ${action}`, 'INVALID_COMMAND');
+            }
+        }
+        catch (error) {
+            console.error(error);
+        }
+    }
+}
+//# sourceMappingURL=command.js.map

package/dist/cjs/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAwB,MAAM,mBAAmB,CAAC;AAWnE,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAiB;QAC9C,IAAI,CAAC;YACH,QAAQ,MAAM,EAAE,CAAC;gBACf,KAAK,QAAQ,CAAC,CAAA,CAAC;oBACb,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAA0C,CAAC;oBACnE,MAAM,MAAM,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC;oBAC7E,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,YAAY,EAAE,CAAC;oBACxE,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;oBAC5D,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACjB,MAAM;gBACR,CAAC;gBACD,KAAK,MAAM,CAAC;gBACZ,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,OAA+B,CAAC;oBACnF,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;oBAC/E,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACvD,MAAM;gBACR,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC9C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC7C,MAAM;gBACR,CAAC;gBACD,KAAK,QAAQ,CAAC;gBACd,KAAK,YAAY;oBACf,sCAAsC;oBACtC,MAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;oBACpE,MAAM;gBACR;oBACE,MAAM,IAAI,WAAW,CAAC,oBAAoB,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;CACF"}

package/dist/cjs/index.js

@@ -0,0 +1,3 @@
+export * from './cli.js';
+export * from './command.js';
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/dist/cjs/package.json

@@ -0,0 +1 @@
+{"type": "commonjs"}

package/dist/esm/cli.js

@@ -0,0 +1,176 @@
+import { DidMethodError } from '@did-btcr2/common';
+import { Identifier } from '@did-btcr2/method';
+import { Command } from 'commander';
+import { readFile } from 'fs/promises';
+import Btcr2Command from './command.js';
+/**
+ * Custom CLI Error class extending DidMethodError.
+ */
+export class CLIError extends DidMethodError {
+    constructor(message, type = 'CLIError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+/**
+ * A class-based CLI using Commander.
+ * - No forced process.exit().
+ * - Configurable by calling `run(argv?)`.
+ */
+export class DidBtcr2Cli {
+    CLI;
+    constructor() {
+        // Create the main Commander program
+        this.CLI = new Command()
+            .name('btcr2')
+            .version('btcr2 0.1.0', '-v, --version', 'Output the current version')
+            .description('CLI tool for the did:btcr2 method');
+        // Configure top-level options and subcommands
+        this.configureCommands();
+    }
+    /**
+     * Configure the CLI commands and options.
+     * @private
+     */
+    configureCommands() {
+        /* CREATE */
+        this.CLI
+            .command('create')
+            .description('Create an identifier and initial DID document')
+            .requiredOption('-t, --type <type>', 'Identifier type <k|x>', 'k')
+            .requiredOption('-n, --network <network>', 'Identifier bitcoin network <bitcoin|testnet3|testnet4|signet|mutinynet|regtest>')
+            .requiredOption('-b, --bytes <bytes>', 'The genesis bytes used to create a DID and DID document as a hex string. ' +
+            'If type=k, MUST be secp256k1 public key. ' +
+            'If type=x, MUST be SHA-256 hash of a genesis document')
+            .action(async (options) => {
+            if (!['k', 'x'].includes(options.type)) {
+                throw new CLIError('Invalid type. Must be "k" or "x".', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            if (!['bitcoin', 'testnet3', 'testnet4', 'signet', 'mutinynet', 'regtest'].includes(options.network)) {
+                throw new CLIError('Invalid network. Must be one of "bitcoin", "testnet3", ' +
+                    '"testnet4", "signet", "mutinynet", or "regtest".', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            if (Buffer.from(options.bytes, 'hex').length === 0) {
+                throw new CLIError('Invalid bytes. Must be a non-empty hex string.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            await this.invokeCommand({ options, action: 'create', command: new Btcr2Command() });
+        });
+        /* READ / RESOLVE */
+        this.CLI
+            .command('resolve')
+            .alias('read')
+            .description('Resolve the DID document of the identifier.')
+            .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier')
+            .option('-r, --resolutionOptions <resolutionOptions>', 'JSON string containing resolution options')
+            .option('-p, --resolutionOptionsPath <resolutionOptionsPath>', 'Path to a JSON file containing resolution options')
+            .action(async (options) => {
+            try {
+                Identifier.decode(options.identifier);
+            }
+            catch {
+                throw new CLIError('Invalid identifier. Must be a valid did:btcr2 identifier.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            if (options.resolutionOptions) {
+                try {
+                    options.resolutionOptions = JSON.parse(options.resolutionOptions);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            if (options.resolutionOptionsPath) {
+                try {
+                    const data = await readFile(options.resolutionOptionsPath, 'utf-8');
+                    options.resolutionOptions = JSON.parse(data);
+                }
+                catch {
+                    throw new CLIError('Invalid options path. Must be a valid path to a JSON file.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            await this.invokeCommand({ options, action: 'resolve', command: new Btcr2Command() });
+        });
+        /* UPDATE */
+        this.CLI
+            .command('update')
+            .description('Update a did:btcr2 document.')
+            .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier')
+            .requiredOption('-s, --sourceDocument <sourceDocument>', 'Source DID document as JSON string')
+            .requiredOption('-v, --sourceVersionId <sourceVersionId>', 'Source version ID as a number')
+            .requiredOption('-p, --patch <patch>', 'JSON Patch operations as a JSON string array')
+            .requiredOption('-m, --verificationMethodId <verificationMethodId>', 'Did document verification method ID as a string')
+            .requiredOption('-b, --beaconIds <beaconIds>', 'Beacon IDs as a JSON string array')
+            .action(async (options) => {
+            // Validate identifier by decoding
+            try {
+                Identifier.decode(options.identifier);
+            }
+            catch {
+                throw new CLIError('Invalid identifier. Must be a valid did:btcr2 identifier.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+            // Validate source document JSON
+            if (options.sourceDocument) {
+                try {
+                    options.sourceDocument = JSON.parse(options.sourceDocument);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            // Validate patch JSON
+            if (options.patch) {
+                try {
+                    options.patch = JSON.parse(options.patch);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            // Validate beacon IDs JSON
+            if (options.beaconIds) {
+                try {
+                    options.beaconIds = JSON.parse(options.beaconIds);
+                }
+                catch {
+                    throw new CLIError('Invalid options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', options);
+                }
+            }
+            await this.invokeCommand({ options, action: 'update', command: new Btcr2Command() });
+        });
+        /* DEACTIVATE / DELETE */
+        this.CLI
+            .command('deactivate')
+            .alias('delete')
+            .description('Deactivate the did:btcr2 identifier permanently.')
+            .action(async (options) => {
+            await this.invokeCommand({ options, action: 'deactivate', command: new Btcr2Command() });
+        });
+    }
+    /**
+     * A helper to invoke the command logic without forcibly exiting.
+     */
+    async invokeCommand({ options, action, command }) {
+        try {
+            await command.execute({ options, action });
+        }
+        catch (error) {
+            console.error('Error executing command:', error);
+        }
+    }
+    /**
+     * Parse and run the CLI.
+     */
+    run(argv) {
+        if (argv) {
+            this.CLI.parse(argv, { from: 'user' });
+        }
+        else {
+            // parse real process.argv
+            this.CLI.parse();
+        }
+        // If no subcommand was given, show help
+        if (!this.CLI.args.length) {
+            this.CLI.help();
+        }
+    }
+}
+export default new DidBtcr2Cli().run();
+//# sourceMappingURL=cli.js.map

package/dist/esm/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,cAAc;IAC1C,YAAY,OAAe,EAAE,OAAe,UAAU,EAAE,IAA0B;QAChF,KAAK,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACd,GAAG,CAAU;IAErB;QACE,oCAAoC;QACpC,IAAI,CAAC,GAAG,GAAG,IAAI,OAAO,EAAE;aACrB,IAAI,CAAC,OAAO,CAAC;aACb,OAAO,CAAC,aAAa,EAAE,eAAe,EAAE,4BAA4B,CAAC;aACrE,WAAW,CAAC,mCAAmC,CAAC,CAAC;QAEpD,8CAA8C;QAC9C,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,YAAY;QACZ,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,QAAQ,CAAC;aACjB,WAAW,CAAC,+CAA+C,CAAC;aAC5D,cAAc,CAAC,mBAAmB,EAAE,uBAAuB,EAAE,GAAG,CAAC;aACjE,cAAc,CACb,yBAAyB,EACzB,iFAAiF,CAClF;aACA,cAAc,CACb,qBAAqB,EACrB,2EAA2E;YAC3E,2CAA2C;YAC3C,uDAAuD,CACxD;aACA,MAAM,CACL,KAAK,EAAE,OAA6E,EAAE,EAAE;YACtF,IAAG,CAAC,CAAC,GAAG,EAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBACrC,MAAM,IAAI,QAAQ,CAChB,mCAAmC,EACnC,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,IAAG,CAAC,CAAC,SAAS,EAAC,UAAU,EAAC,UAAU,EAAC,QAAQ,EAAC,WAAW,EAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC/F,MAAM,IAAI,QAAQ,CAChB,yDAAyD;oBACzD,kDAAkD,EAClD,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,IAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClD,MAAM,IAAI,QAAQ,CAChB,gDAAgD,EAChD,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QACvF,CAAC,CACF,CAAC;QAEJ,oBAAoB;QACpB,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,SAAS,CAAC;aAClB,KAAK,CAAC,MAAM,CAAC;aACb,WAAW,CAAC,6CAA6C,CAAC;aAC1D,cAAc,CAAC,+BAA+B,EAAE,sBAAsB,CAAC;aACvE,MAAM,CAAC,6CAA6C,EAAE,2CAA2C,CAAC;aAClG,MAAM,CAAC,qDAAqD,EAAE,mDAAmD,CAAC;aAClH,MAAM,CAAC,KAAK,EAAE,OAA2F,EAAE,EAAE;YAC5G,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,QAAQ,CAChB,2DAA2D,EAC3D,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,IAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;gBAC7B,IAAI,CAAC;oBACH,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;gBACpE,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,IAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBACjC,IAAI,CAAC;oBACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;oBACpE,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAC/C,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,4DAA4D,EAC5D,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QACxF,CAAC,CAAC,CAAC;QAEL,YAAY;QACZ,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,QAAQ,CAAC;aACjB,WAAW,CAAC,8BAA8B,CAAC;aAC3C,cAAc,CAAC,+BAA+B,EAAE,sBAAsB,CAAC;aACvE,cAAc,CAAC,uCAAuC,EAAE,oCAAoC,CAAC;aAC7F,cAAc,CAAC,yCAAyC,EAAE,+BAA+B,CAAC;aAC1F,cAAc,CAAC,qBAAqB,EAAE,8CAA8C,CAAC;aACrF,cAAc,CAAC,mDAAmD,EAAE,iDAAiD,CAAC;aACtH,cAAc,CAAC,6BAA6B,EAAE,mCAAmC,CAAC;aAClF,MAAM,CAAC,KAAK,EAAE,OAOb,EAAE,EAAE;YACJ,kCAAkC;YAClC,IAAI,CAAC;gBACH,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YACxC,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,QAAQ,CAChB,2DAA2D,EAC3D,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;YACD,gCAAgC;YAChC,IAAG,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBAC9D,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,sBAAsB;YACtB,IAAG,OAAO,CAAC,KAAK,EAAE,CAAC;gBACjB,IAAI,CAAC;oBACH,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;gBAC5C,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,2BAA2B;YAC3B,IAAG,OAAO,CAAC,SAAS,EAAE,CAAC;gBACrB,IAAI,CAAC;oBACH,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBACpD,CAAC;gBAAC,MAAM,CAAC;oBACP,MAAM,IAAI,QAAQ,CAChB,+CAA+C,EAC/C,wBAAwB,EACxB,OAAO,CACR,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QACvF,CAAC,CAAC,CAAC;QAEL,yBAAyB;QACzB,IAAI,CAAC,GAAG;aACL,OAAO,CAAC,YAAY,CAAC;aACrB,KAAK,CAAC,QAAQ,CAAC;aACf,WAAW,CAAC,kDAAkD,CAAC;aAC/D,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACxB,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAIrD;QACC,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,IAAe;QACxB,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACzC,CAAC;aAAM,CAAC;YACN,0BAA0B;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC;QAED,wCAAwC;QACxC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;CACF;AAGD,eAAe,IAAI,WAAW,EAAE,CAAC,GAAG,EAAE,CAAC"}

package/dist/esm/command.js

@@ -0,0 +1,41 @@
+import { IdentifierTypes, Logger, MethodError } from '@did-btcr2/common';
+import { DidBtcr2 } from '@did-btcr2/method';
+export default class Btcr2Command {
+    async execute({ options, action }) {
+        try {
+            switch (action) {
+                case 'create': {
+                    const { type, bytes } = options;
+                    const idType = type === 'k' ? IdentifierTypes.KEY : IdentifierTypes.EXTERNAL;
+                    const genesisBytes = Buffer.from(bytes, 'hex').toArray().toUint8Array();
+                    const did = await DidBtcr2.create({ idType, genesisBytes });
+                    console.log(did);
+                    break;
+                }
+                case 'read':
+                case 'resolve': {
+                    const { identifier, options: resolutionOptions } = options;
+                    const resolutionResult = await DidBtcr2.resolve(identifier, resolutionOptions);
+                    console.log(JSON.stringify(resolutionResult, null, 2));
+                    break;
+                }
+                case 'update': {
+                    const update = await DidBtcr2.update(options);
+                    console.log(JSON.stringify(update, null, 2));
+                    break;
+                }
+                case 'delete':
+                case 'deactivate':
+                    // await DidBtcr2.deactivate(options);
+                    Logger.warn('// TODO: Update once DidBtcr2.deactivate implemented');
+                    break;
+                default:
+                    throw new MethodError(`Invalid command: ${action}`, 'INVALID_COMMAND');
+            }
+        }
+        catch (error) {
+            console.error(error);
+        }
+    }
+}
+//# sourceMappingURL=command.js.map

package/dist/esm/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../src/command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACzE,OAAO,EAAE,QAAQ,EAAwB,MAAM,mBAAmB,CAAC;AAWnE,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAiB;QAC9C,IAAI,CAAC;YACH,QAAQ,MAAM,EAAE,CAAC;gBACf,KAAK,QAAQ,CAAC,CAAA,CAAC;oBACb,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAA0C,CAAC;oBACnE,MAAM,MAAM,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC;oBAC7E,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,YAAY,EAAE,CAAC;oBACxE,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;oBAC5D,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACjB,MAAM;gBACR,CAAC;gBACD,KAAK,MAAM,CAAC;gBACZ,KAAK,SAAS,CAAC,CAAC,CAAC;oBACf,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,OAA+B,CAAC;oBACnF,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;oBAC/E,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACvD,MAAM;gBACR,CAAC;gBACD,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC9C,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBAC7C,MAAM;gBACR,CAAC;gBACD,KAAK,QAAQ,CAAC;gBACd,KAAK,YAAY;oBACf,sCAAsC;oBACtC,MAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;oBACpE,MAAM;gBACR;oBACE,MAAM,IAAI,WAAW,CAAC,oBAAoB,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;CACF"}

package/dist/esm/index.js

@@ -0,0 +1,3 @@
+export * from './cli.js';
+export * from './command.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/dist/types/cli.d.ts

@@ -0,0 +1,31 @@
+import { DidMethodError } from '@did-btcr2/common';
+/**
+ * Custom CLI Error class extending DidMethodError.
+ */
+export declare class CLIError extends DidMethodError {
+    constructor(message: string, type?: string, data?: Record<string, any>);
+}
+/**
+ * A class-based CLI using Commander.
+ * - No forced process.exit().
+ * - Configurable by calling `run(argv?)`.
+ */
+export declare class DidBtcr2Cli {
+    private CLI;
+    constructor();
+    /**
+     * Configure the CLI commands and options.
+     * @private
+     */
+    private configureCommands;
+    /**
+     * A helper to invoke the command logic without forcibly exiting.
+     */
+    private invokeCommand;
+    /**
+     * Parse and run the CLI.
+     */
+    run(argv?: string[]): void;
+}
+declare const _default: void;
+export default _default;

package/dist/types/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAMnD;;GAEG;AACH,qBAAa,QAAS,SAAQ,cAAc;gBAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,MAAmB,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAGnF;AAED;;;;GAIG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,GAAG,CAAU;;IAarB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAqKzB;;OAEG;YACW,aAAa;IAY3B;;OAEG;IACI,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;CAalC;;AAGD,wBAAuC"}

package/dist/types/command.d.ts

@@ -0,0 +1,14 @@
+export interface CommandInterface {
+    execute(params: {
+        options?: any;
+        action?: string;
+    }): Promise<void>;
+}
+interface ExecuteParams {
+    options?: any;
+    action?: string;
+}
+export default class Btcr2Command implements CommandInterface {
+    execute({ options, action }: ExecuteParams): Promise<void>;
+}
+export {};

package/dist/types/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../src/command.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,MAAM,EAAE;QAAE,OAAO,CAAC,EAAE,GAAG,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpE;AAED,UAAU,aAAa;IACrB,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,gBAAgB;IACrD,OAAO,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAmCjE"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './cli.js';
+export * from './command.js';

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC"}

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "@did-btcr2/cli",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "CLI for interacting with did-btcr2-js, the JavaScript/TypeScript reference implementation of the did:btcr2 method. Exposes various parts of multiple packages in the did-btcr2-js monorepo.",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "bin": {
+    "btcr2": "./dist/esm/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "license": "MPL-2.0",
+  "contributors": [
+    {
+      "name": "dcdpr",
+      "url": "https://github.com/dcdpr"
+    },
+    {
+      "name": "jintekc",
+      "url": "https://github.com/jintekc",
+      "email": "github@jintek.consulting"
+    }
+  ],
+  "homepage": "https://github.com/dcdpr/did-btcr2-js/tree/main/packages/cli",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com:dcdpr/did-btcr2-js.git",
+    "directory": "packages/cli"
+  },
+  "bugs": "https://github.com/dcdpr/did-btcr2-js/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "keywords": [
+    "did",
+    "dids",
+    "decentralized identity",
+    "decentralized identifiers",
+    "did method",
+    "did:btcr2",
+    "bitcoin",
+    "cli"
+  ],
+  "dependencies": {
+    "commander": "^13.1.0",
+    "@did-btcr2/common": "2.2.2",
+    "@did-btcr2/method": "0.18.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.21.0",
+    "@types/chai": "^5.0.1",
+    "@types/chai-as-promised": "^8.0.1",
+    "@types/eslint": "^9.6.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.13.8",
+    "@typescript-eslint/eslint-plugin": "^8.25.0",
+    "@typescript-eslint/parser": "^8.25.0",
+    "c8": "^10.1.3",
+    "chai": "^5.2.0",
+    "chai-as-promised": "^8.0.1",
+    "esbuild": "^0.25.0",
+    "eslint": "^9.21.0",
+    "eslint-plugin-mocha": "^10.5.0",
+    "globals": "^16.0.0",
+    "mocha": "^11.1.0",
+    "mocha-junit-reporter": "^2.2.1",
+    "node-stdlib-browser": "^1.3.1",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.5.1",
+    "typedoc-plugin-markdown": "^4.7.0",
+    "typescript": "~5.7.3",
+    "typescript-eslint": "^8.25.0"
+  },
+  "scripts": {
+    "clean": "rimraf dist coverage tests/compiled",
+    "wipe": "rimraf node_modules pnpm-lock.json",
+    "wipe:clean": "pnpm wipe && pnpm clean",
+    "wipe:install": "pnpm wipe && pnpm install",
+    "clean:install": "pnpm clean && pnpm install",
+    "wipe:clean:install": "pnpm wipe:clean && pnpm install",
+    "reinstall": "pnpm install --force",
+    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs",
+    "build:esm": "rimraf dist/esm dist/types && pnpm tsc -p tsconfig.json",
+    "build:cjs": "rimraf dist/cjs && tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
+    "build:tests": "pnpm tsc -p tests/tsconfig.json",
+    "build:all": "pnpm build && pnpm build:tests",
+    "release": "pnpm build && pnpm pack && mv *.tgz ../../release/cli",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "test": "pnpm c8 --omit-relative mocha",
+    "build:test": "pnpm build && pnpm build:tests && pnpm c8 --omit-relative mocha",
+    "build:lint:test": "pnpm build && pnpm build:tests && pnpm lint:fix",
+    "prepublish": "pnpm build",
+    "version": "pnpm version",
+    "version:no-git": "pnpm version --no-commit-hooks --no-git-tag-version",
+    "version:new": "[ -z \"$NEW_VERSION\" ] && echo 'ERROR: NEW_VERSION is not set' && exit 1 || (git checkout -b $NEW_VERSION && git tag $NEW_VERSION && pnpm version:no-git $NEW_VERSION)"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,238 @@
+import { DidMethodError } from '@did-btcr2/common';
+import { Identifier } from '@did-btcr2/method';
+import { Command } from 'commander';
+import { readFile } from 'fs/promises';
+import Btcr2Command from './command.js';
+
+/**
+ * Custom CLI Error class extending DidMethodError.
+ */
+export class CLIError extends DidMethodError {
+  constructor(message: string, type: string = 'CLIError', data?: Record<string, any>) {
+    super(message, { type, name: type, data });
+  }
+}
+
+/**
+ * A class-based CLI using Commander.
+ * - No forced process.exit().
+ * - Configurable by calling `run(argv?)`.
+ */
+export class DidBtcr2Cli {
+  private CLI: Command;
+
+  constructor() {
+    // Create the main Commander program
+    this.CLI = new Command()
+      .name('btcr2')
+      .version('btcr2 0.1.0', '-v, --version', 'Output the current version')
+      .description('CLI tool for the did:btcr2 method');
+
+    // Configure top-level options and subcommands
+    this.configureCommands();
+  }
+
+  /**
+   * Configure the CLI commands and options.
+   * @private
+   */
+  private configureCommands(): void {
+    /* CREATE */
+    this.CLI
+      .command('create')
+      .description('Create an identifier and initial DID document')
+      .requiredOption('-t, --type <type>', 'Identifier type <k|x>', 'k')
+      .requiredOption(
+        '-n, --network <network>',
+        'Identifier bitcoin network <bitcoin|testnet3|testnet4|signet|mutinynet|regtest>'
+      )
+      .requiredOption(
+        '-b, --bytes <bytes>',
+        'The genesis bytes used to create a DID and DID document as a hex string. ' +
+        'If type=k, MUST be secp256k1 public key. ' +
+        'If type=x, MUST be SHA-256 hash of a genesis document'
+      )
+      .action(
+        async (options: { type: string; network: string; bytes: string, [key: string]: any }) => {
+          if(!['k','x'].includes(options.type)) {
+            throw new CLIError(
+              'Invalid type. Must be "k" or "x".',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+          if(!['bitcoin','testnet3','testnet4','signet','mutinynet','regtest'].includes(options.network)) {
+            throw new CLIError(
+              'Invalid network. Must be one of "bitcoin", "testnet3", ' +
+              '"testnet4", "signet", "mutinynet", or "regtest".',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+          if(Buffer.from(options.bytes, 'hex').length === 0) {
+            throw new CLIError(
+              'Invalid bytes. Must be a non-empty hex string.',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+          await this.invokeCommand({ options, action: 'create', command: new Btcr2Command() });
+        }
+      );
+
+    /* READ / RESOLVE */
+    this.CLI
+      .command('resolve')
+      .alias('read')
+      .description('Resolve the DID document of the identifier.')
+      .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier')
+      .option('-r, --resolutionOptions <resolutionOptions>', 'JSON string containing resolution options')
+      .option('-p, --resolutionOptionsPath <resolutionOptionsPath>', 'Path to a JSON file containing resolution options')
+      .action(async (options: { identifier: string; resolutionOptions?: string; resolutionOptionsPath?: string }) => {
+        try {
+          Identifier.decode(options.identifier);
+        } catch {
+          throw new CLIError(
+            'Invalid identifier. Must be a valid did:btcr2 identifier.',
+            'INVALID_ARGUMENT_ERROR',
+            options
+          );
+        }
+        if(options.resolutionOptions) {
+          try {
+            options.resolutionOptions = JSON.parse(options.resolutionOptions);
+          } catch {
+            throw new CLIError(
+              'Invalid options. Must be a valid JSON string.',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+        }
+        if(options.resolutionOptionsPath) {
+          try {
+            const data = await readFile(options.resolutionOptionsPath, 'utf-8');
+            options.resolutionOptions = JSON.parse(data);
+          } catch {
+            throw new CLIError(
+              'Invalid options path. Must be a valid path to a JSON file.',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+        }
+        await this.invokeCommand({ options, action: 'resolve', command: new Btcr2Command() });
+      });
+
+    /* UPDATE */
+    this.CLI
+      .command('update')
+      .description('Update a did:btcr2 document.')
+      .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier')
+      .requiredOption('-s, --sourceDocument <sourceDocument>', 'Source DID document as JSON string')
+      .requiredOption('-v, --sourceVersionId <sourceVersionId>', 'Source version ID as a number')
+      .requiredOption('-p, --patch <patch>', 'JSON Patch operations as a JSON string array')
+      .requiredOption('-m, --verificationMethodId <verificationMethodId>', 'Did document verification method ID as a string')
+      .requiredOption('-b, --beaconIds <beaconIds>', 'Beacon IDs as a JSON string array')
+      .action(async (options: {
+        identifier: string;
+        sourceDocument: string; // stringified DidDocument; e.g. '{ "@context": "...", "id": "did:btcr2:...", ... }'
+        sourceVersionId: number;
+        patch: string; // stringified PatchOperation[]; e.g. '[{ "op": "add", "path": "/foo", "value": "bar" }]'
+        verificationMethodId: string;
+        beaconIds: string // stringified string[]; e.g. '["beaconId1","beaconId2"]'
+       }) => {
+        // Validate identifier by decoding
+        try {
+          Identifier.decode(options.identifier);
+        } catch {
+          throw new CLIError(
+            'Invalid identifier. Must be a valid did:btcr2 identifier.',
+            'INVALID_ARGUMENT_ERROR',
+            options
+          );
+        }
+        // Validate source document JSON
+        if(options.sourceDocument) {
+          try {
+            options.sourceDocument = JSON.parse(options.sourceDocument);
+          } catch {
+            throw new CLIError(
+              'Invalid options. Must be a valid JSON string.',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+        }
+        // Validate patch JSON
+        if(options.patch) {
+          try {
+            options.patch = JSON.parse(options.patch);
+          } catch {
+            throw new CLIError(
+              'Invalid options. Must be a valid JSON string.',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+        }
+        // Validate beacon IDs JSON
+        if(options.beaconIds) {
+          try {
+            options.beaconIds = JSON.parse(options.beaconIds);
+          } catch {
+            throw new CLIError(
+              'Invalid options. Must be a valid JSON string.',
+              'INVALID_ARGUMENT_ERROR',
+              options
+            );
+          }
+        }
+        await this.invokeCommand({ options, action: 'update', command: new Btcr2Command() });
+      });
+
+    /* DEACTIVATE / DELETE */
+    this.CLI
+      .command('deactivate')
+      .alias('delete')
+      .description('Deactivate the did:btcr2 identifier permanently.')
+      .action(async (options) => {
+        await this.invokeCommand({ options, action: 'deactivate', command: new Btcr2Command() });
+      });
+  }
+
+  /**
+   * A helper to invoke the command logic without forcibly exiting.
+   */
+  private async invokeCommand({ options, action, command }: {
+    options: any;
+    action: string;
+    command: Btcr2Command;
+  }): Promise<void> {
+    try {
+      await command.execute({ options, action });
+    } catch (error) {
+      console.error('Error executing command:', error);
+    }
+  }
+
+  /**
+   * Parse and run the CLI.
+   */
+  public run(argv?: string[]): void {
+    if (argv) {
+      this.CLI.parse(argv, { from: 'user' });
+    } else {
+      // parse real process.argv
+      this.CLI.parse();
+    }
+
+    // If no subcommand was given, show help
+    if (!this.CLI.args.length) {
+      this.CLI.help();
+    }
+  }
+}
+
+
+export default new DidBtcr2Cli().run();

package/src/command.ts

@@ -0,0 +1,49 @@
+import { IdentifierTypes, Logger, MethodError } from '@did-btcr2/common';
+import { DidBtcr2, DidResolutionOptions } from '@did-btcr2/method';
+
+export interface CommandInterface {
+  execute(params: { options?: any; action?: string }): Promise<void>;
+}
+
+interface ExecuteParams {
+  options?: any;
+  action?: string
+}
+
+export default class Btcr2Command implements CommandInterface {
+  async execute({ options, action }: ExecuteParams): Promise<void> {
+    try {
+      switch (action) {
+        case 'create':{
+          const { type, bytes } = options as { type: string; bytes: string };
+          const idType = type === 'k' ? IdentifierTypes.KEY : IdentifierTypes.EXTERNAL;
+          const genesisBytes = Buffer.from(bytes, 'hex').toArray().toUint8Array();
+          const did = await DidBtcr2.create({ idType, genesisBytes });
+          console.log(did);
+          break;
+        }
+        case 'read':
+        case 'resolve': {
+          const { identifier, options: resolutionOptions } = options as DidResolutionOptions;
+          const resolutionResult = await DidBtcr2.resolve(identifier, resolutionOptions);
+          console.log(JSON.stringify(resolutionResult, null, 2));
+          break;
+        }
+        case 'update': {
+          const update = await DidBtcr2.update(options);
+          console.log(JSON.stringify(update, null, 2));
+          break;
+        }
+        case 'delete':
+        case 'deactivate':
+          // await DidBtcr2.deactivate(options);
+          Logger.warn('// TODO: Update once DidBtcr2.deactivate implemented');
+          break;
+        default:
+          throw new MethodError(`Invalid command: ${action}`, 'INVALID_COMMAND');
+      }
+    } catch (error: any) {
+      console.error(error);
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './cli.js';
+export * from './command.js';