@did-btcr2/cli 0.1.0 → 0.2.0

package/dist/esm/src/cli.js

@@ -0,0 +1,294 @@
+import { Identifier } from '@did-btcr2/method';
+import { Command, CommanderError } from 'commander';
+import { readFile } from 'fs/promises';
+import Btcr2Command from './command.js';
+import { CLIError } from './error.js';
+const SUPPORTED_NETWORKS = ['bitcoin', 'testnet3', 'testnet4', 'signet', 'mutinynet', 'regtest'];
+/**
+ * CLI tool for the did:btcr2 method.
+ * @type {DidBtcr2Cli}
+ * @class DidBtcr2Cli
+ */
+export class DidBtcr2Cli {
+    program;
+    constructor() {
+        this.program = new Command('btcr2')
+            .version('btcr2 0.1.0', '-v, --version', 'Output the current version')
+            .description('CLI tool for the did:btcr2 method');
+        this.configureCommands();
+    }
+    /**
+     * Configures the CLI commands.
+     * @returns {void}
+     */
+    configureCommands() {
+        // Create command
+        this.program
+            .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) => {
+            const parsedOptions = this.parseCreateOptions(options);
+            const result = await this.invokeCommand({ options: parsedOptions, action: 'create', command: new Btcr2Command() });
+            this.printResult(result);
+        });
+        // Resolve command
+        this.program
+            .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) => {
+            const parsedOptions = await this.parseResolveOptions(options);
+            const result = await this.invokeCommand({ options: parsedOptions, action: 'resolve', command: new Btcr2Command() });
+            this.printResult(result);
+        });
+        // Update command
+        this.program
+            .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) => {
+            const parsedOptions = this.parseUpdateOptions(options);
+            const result = await this.invokeCommand({ options: parsedOptions, action: 'update', command: new Btcr2Command() });
+            this.printResult(result);
+        });
+        // Deactivate command
+        this.program
+            .command('deactivate')
+            .alias('delete')
+            .description('Deactivate the did:btcr2 identifier permanently.')
+            .action(async () => {
+            const result = await this.invokeCommand({ options: {}, action: 'deactivate', command: new Btcr2Command() });
+            this.printResult(result);
+        });
+    }
+    /**
+     * Invokes a command with the provided request.
+     * @param {object} request The command request
+     * @param {any} request.options The command options
+     * @param {CommandRequest['action']} request.action The command action
+     * @param {Btcr2Command} request.command The command instance
+     * @returns {Promise<CommandResult>} The command result
+     */
+    async invokeCommand(request) {
+        return await request.command.execute({ action: request.action, options: request.options });
+    }
+    /**
+     * Runs the CLI with the provided argv or process.argv.
+     * @param {string[]} [argv] The argv array to use. Defaults to process.argv.
+     */
+    async run(argv) {
+        try {
+            const normalized = this.normalizeArgv(argv ?? process.argv);
+            await this.program.parseAsync(normalized, { from: 'node' });
+            if (!this.program.args.length)
+                this.program.outputHelp();
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+    /**
+     * Normalizes argv to ensure it has at least two elements.
+     * @param {string[]} argv The argv array to normalize
+     * @returns {string[]} Normalized argv array
+     */
+    normalizeArgv(argv) {
+        if (argv.length >= 2)
+            return argv;
+        if (argv.length === 1)
+            return ['node', argv[0]];
+        return ['node', 'btcr2'];
+    }
+    /**
+     * Handles errors thrown during CLI execution.
+     * @param {unknown} error The error to handle
+     * @returns {void}
+     */
+    handleError(error) {
+        if (error instanceof CommanderError && (error.code === 'commander.helpDisplayed' || error.code === 'commander.help')) {
+            return;
+        }
+        if (error instanceof CLIError) {
+            console.error(error.message);
+            process.exitCode ??= 1;
+            return;
+        }
+        console.error(error);
+        process.exitCode ??= 1;
+    }
+    /**
+     * Parses create command options and throws CLIError on invalid input.
+     * @param {object} options The create command options
+     * @param {string} options.type The identifier type
+     * @param {string} options.network The bitcoin network
+     * @param {string} options.bytes The genesis bytes as a hex string
+     * @returns {CreateCommandOptions} The parsed create command options
+     */
+    parseCreateOptions(options) {
+        if (!['k', 'x'].includes(options.type)) {
+            throw new CLIError('Invalid type. Must be "k" or "x".', 'INVALID_ARGUMENT_ERROR', options);
+        }
+        if (!this.isNetworkValid(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);
+        }
+        return {
+            type: options.type,
+            network: options.network,
+            bytes: options.bytes,
+        };
+    }
+    /**
+     * Parses resolve command options and throws CLIError on invalid input.
+     * @param {object} options The resolve command options
+     * @param {string} options.identifier The did:btcr2 identifier
+     * @param {string} [options.resolutionOptions] JSON string of resolution options
+     * @param {string} [options.resolutionOptionsPath] Path to a JSON file of resolution options
+     * @returns {Promise<ResolveCommandOptions>} The parsed resolve command options
+     */
+    async parseResolveOptions(options) {
+        this.validateIdentifier(options.identifier, options);
+        const resolutionOptions = await this.parseResolutionOptions(options);
+        return {
+            identifier: options.identifier,
+            ...(resolutionOptions && { options: resolutionOptions }),
+        };
+    }
+    /**
+     * Parses update command options and throws CLIError on invalid input.
+     * @param {object} options The update command options
+     * @param {string} options.identifier The did:btcr2 identifier
+     * @param {string} options.sourceDocument The source DID document as a JSON string
+     * @param {number} options.sourceVersionId The source version ID as a number
+     * @param {string} options.patch The JSON Patch operations as a JSON string array
+     * @param {string} options.verificationMethodId The DID document verification method ID as a string
+     * @param {string} options.beaconIds The beacon IDs as a JSON string array
+     * @returns {UpdateCommandOptions} The parsed update command options
+     */
+    parseUpdateOptions(options) {
+        this.validateIdentifier(options.identifier, options);
+        const sourceDocument = this.parseJsonOption(options.sourceDocument, 'Invalid options. Must be a valid JSON string.', options);
+        const patch = this.parseJsonOption(options.patch, 'Invalid options. Must be a valid JSON string.', options);
+        const beaconIds = this.parseJsonOption(options.beaconIds, 'Invalid options. Must be a valid JSON string.', options);
+        return {
+            identifier: options.identifier,
+            sourceDocument,
+            sourceVersionId: Number(options.sourceVersionId),
+            patch,
+            verificationMethodId: options.verificationMethodId,
+            beaconIds,
+        };
+    }
+    /**
+     * Parses a JSON option and throws a CLIError on failure.
+     * @param {string} value JSON string to parse
+     * @param {string} errorMessage Error message to use on failure
+     * @param {Record<string, any>} data Additional data to include in the error
+     * @returns {T} Parsed JSON object
+     */
+    parseJsonOption(value, errorMessage, data) {
+        try {
+            return JSON.parse(value);
+        }
+        catch {
+            throw new CLIError(errorMessage, 'INVALID_ARGUMENT_ERROR', data);
+        }
+    }
+    /**
+     * Parses resolution options from JSON string or file path.
+     * @param {object} options The options containing resolution options
+     * @param {string} [options.resolutionOptions] JSON string of resolution options
+     * @param {string} [options.resolutionOptionsPath] Path to a JSON file of resolution options
+     * @returns {Promise<any>} The parsed resolution options
+     */
+    async parseResolutionOptions(options) {
+        if (options.resolutionOptions) {
+            return this.parseJsonOption(options.resolutionOptions, 'Invalid options. Must be a valid JSON string.', options);
+        }
+        if (options.resolutionOptionsPath) {
+            try {
+                const data = await readFile(options.resolutionOptionsPath, 'utf-8');
+                return JSON.parse(data);
+            }
+            catch {
+                throw new CLIError('Invalid options path. Must be a valid path to a JSON file.', 'INVALID_ARGUMENT_ERROR', options);
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Validates the did:btcr2 identifier format.
+     * @param {string} identifier The identifier to validate
+     * @param {Record<string, any>} data Additional data to include in the error
+     * @returns {void}
+     */
+    validateIdentifier(identifier, data) {
+        try {
+            Identifier.decode(identifier);
+        }
+        catch {
+            throw new CLIError('Invalid identifier. Must be a valid did:btcr2 identifier.', 'INVALID_ARGUMENT_ERROR', data);
+        }
+    }
+    /**
+     * Validates if the provided network is supported.
+     * @param {string} network The network to validate
+     * @returns {boolean} True if the network is valid
+     */
+    isNetworkValid(network) {
+        return SUPPORTED_NETWORKS.includes(network);
+    }
+    /**
+     * Prints the command result to the console.
+     * @param {CommandResult} result The command result to print
+     * @returns {void}
+     */
+    printResult(result) {
+        switch (result.action) {
+            case 'create':
+                this.log(result.did);
+                break;
+            case 'resolve':
+            case 'read':
+                this.log(result.resolution);
+                break;
+            case 'update':
+                this.log(result.sidecar);
+                break;
+            case 'deactivate':
+            case 'delete':
+                this.log(result.message);
+                break;
+            default:
+                this.log(result);
+        }
+    }
+    /**
+     * Logs a payload to the console, formatting objects as JSON.
+     * @param {unknown} payload The payload to log
+     * @returns {void}
+     */
+    log(payload) {
+        if (typeof payload === 'string') {
+            console.log(payload);
+            return;
+        }
+        console.log(JSON.stringify(payload, null, 2));
+    }
+}
+//# sourceMappingURL=cli.js.map

package/dist/esm/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/cli.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,YAON,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,MAAM,kBAAkB,GAAoB,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;AAElH;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACN,OAAO,CAAU;IAEjC;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC;aAChC,OAAO,CAAC,aAAa,EAAE,eAAe,EAAE,4BAA4B,CAAC;aACrE,WAAW,CAAC,mCAAmC,CAAC,CAAC;QAEpD,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACK,iBAAiB;QACvB,iBAAiB;QACjB,IAAI,CAAC,OAAO;aACT,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,CAAC,KAAK,EAAE,OAAyD,EAAE,EAAE;YAC1E,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;YACnH,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEL,kBAAkB;QAClB,IAAI,CAAC,OAAO;aACT,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,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAC9D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;YACpH,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEL,iBAAiB;QACjB,IAAI,CAAC,OAAO;aACT,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,OAOd,EAAE,EAAE;YACH,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;YACnH,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEL,qBAAqB;QACrB,IAAI,CAAC,OAAO;aACT,OAAO,CAAC,YAAY,CAAC;aACrB,KAAK,CAAC,QAAQ,CAAC;aACf,WAAW,CAAC,kDAAkD,CAAC;aAC/D,MAAM,CAAC,KAAK,IAAI,EAAE;YACjB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,YAAY,EAAE,EAAE,CAAC,CAAC;YAC5G,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,aAAa,CAAC,OAI3B;QACC,OAAO,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAoB,CAAC,CAAC;IAC/G,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,CAAC,IAAe;QAC9B,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YAC5D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM;gBAAE,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3D,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,aAAa,CAAC,IAAc;QAClC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QAChD,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,KAAc;QAChC,IAAI,KAAK,YAAY,cAAc,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,yBAAyB,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,EAAE,CAAC;YACrH,OAAO;QACT,CAAC;QACD,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;YAC9B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,OAAO,CAAC,QAAQ,KAAK,CAAC,CAAC;YACvB,OAAO;QACT,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,QAAQ,KAAK,CAAC,CAAC;IACzB,CAAC;IAED;;;;;;;OAOG;IACK,kBAAkB,CAAC,OAA0D;QACnF,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,QAAQ,CAChB,mCAAmC,EACnC,wBAAwB,EACxB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,QAAQ,CAChB,yGAAyG,EACzG,wBAAwB,EACxB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,QAAQ,CAChB,gDAAgD,EAChD,wBAAwB,EACxB,OAAO,CACR,CAAC;QACJ,CAAC;QACD,OAAO;YACL,IAAI,EAAM,OAAO,CAAC,IAAoC;YACtD,OAAO,EAAG,OAAO,CAAC,OAAwB;YAC1C,KAAK,EAAK,OAAO,CAAC,KAAK;SACxB,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACK,KAAK,CAAC,mBAAmB,CAAC,OAIjC;QACC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC;QACrE,OAAO;YACL,UAAU,EAAG,OAAO,CAAC,UAAU;YAC/B,GAAG,CAAC,iBAAiB,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC;SACzD,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACK,kBAAkB,CAAC,OAO1B;QACC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CACzC,OAAO,CAAC,cAAc,EACtB,+CAA+C,EAC/C,OAAO,CACR,CAAC;QACF,MAAM,KAAK,GAAG,IAAI,CAAC,eAAe,CAChC,OAAO,CAAC,KAAK,EACb,+CAA+C,EAC/C,OAAO,CACR,CAAC;QACF,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CACpC,OAAO,CAAC,SAAS,EACjB,+CAA+C,EAC/C,OAAO,CACR,CAAC;QAEF,OAAO;YACL,UAAU,EAAa,OAAO,CAAC,UAAU;YACzC,cAAc;YACd,eAAe,EAAQ,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;YACtD,KAAK;YACL,oBAAoB,EAAG,OAAO,CAAC,oBAAoB;YACnD,SAAS;SACc,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACK,eAAe,CAAI,KAAa,EAAE,YAAoB,EAAE,IAAyB;QACvF,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAM,CAAC;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAChB,YAAY,EACZ,wBAAwB,EACxB,IAAI,CACL,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,sBAAsB,CAAC,OAAwE;QAC3G,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,iBAAiB,EAAE,+CAA+C,EAAE,OAAO,CAAC,CAAC;QACnH,CAAC;QACD,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAClC,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;gBACpE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,IAAI,QAAQ,CAChB,4DAA4D,EAC5D,wBAAwB,EACxB,OAAO,CACR,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACK,kBAAkB,CAAC,UAAkB,EAAE,IAAyB;QACtE,IAAI,CAAC;YACH,UAAU,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QAChC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAChB,2DAA2D,EAC3D,wBAAwB,EACxB,IAAI,CACL,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,OAAe;QACpC,OAAO,kBAAkB,CAAC,QAAQ,CAAC,OAAwB,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,MAAqB;QACvC,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,KAAK,QAAQ;gBACX,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACrB,MAAM;YACR,KAAK,SAAS,CAAC;YACf,KAAK,MAAM;gBACT,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;gBAC5B,MAAM;YACR,KAAK,QAAQ;gBACX,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,YAAY,CAAC;YAClB,KAAK,QAAQ;gBACX,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACzB,MAAM;YACR;gBACE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,GAAG,CAAC,OAAgB;QAC1B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;CACF"}

package/dist/esm/src/command.js

@@ -0,0 +1,35 @@
+import { IdentifierTypes, Logger, MethodError } from '@did-btcr2/common';
+import { DidBtcr2 } from '@did-btcr2/method';
+export default class Btcr2Command {
+    async execute(request) {
+        const action = request.action;
+        switch (action) {
+            case 'create': {
+                const { type, bytes, network } = request.options;
+                const idType = type === 'k' ? IdentifierTypes.KEY : IdentifierTypes.EXTERNAL;
+                const genesisBytes = Buffer.from(bytes, 'hex');
+                const did = await DidBtcr2.create(genesisBytes, { idType, network });
+                return { action: 'create', did };
+            }
+            case 'read':
+            case 'resolve': {
+                const { identifier, options } = request.options;
+                const resolution = await DidBtcr2.resolve(identifier, options);
+                return { action: request.action, resolution };
+            }
+            case 'update': {
+                const sidecar = await DidBtcr2.update(request.options);
+                return { action: 'update', sidecar };
+            }
+            case 'delete':
+            case 'deactivate': {
+                Logger.warn('// TODO: Update once DidBtcr2.deactivate implemented');
+                return { action: 'deactivate', message: 'Deactivate not yet implemented' };
+            }
+            default: {
+                throw new MethodError(`Invalid command: ${action}`, 'INVALID_COMMAND');
+            }
+        }
+    }
+}
+//# sourceMappingURL=command.js.map

package/dist/esm/src/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../../src/command.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAkB,MAAM,mBAAmB,CAAC;AACzF,OAAO,EAAE,QAAQ,EAA+C,MAAM,mBAAmB,CAAC;AA4C1F,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,KAAK,CAAC,OAAO,CAAC,OAAuB;QACnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;gBACjD,MAAM,MAAM,GAAG,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC;gBAC7E,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC/C,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;gBACrE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC;YACnC,CAAC;YACD,KAAK,MAAM,CAAC;YACZ,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;gBAChD,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;gBAC/D,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC;YAChD,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,OAAc,CAAC,CAAC;gBAC9D,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;YACvC,CAAC;YACD,KAAK,QAAQ,CAAC;YACd,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,MAAM,CAAC,IAAI,CAAC,sDAAsD,CAAC,CAAC;gBACpE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,gCAAgC,EAAE,CAAC;YAC7E,CAAC;YACD,OAAO,CAAC,CAAA,CAAC;gBACP,MAAM,IAAI,WAAW,CAAC,oBAAoB,MAAM,EAAE,EAAE,iBAAiB,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/error.js

@@ -0,0 +1,10 @@
+import { DidMethodError } from '@did-btcr2/common';
+/**
+ * Custom CLI Error class extending DidMethodError.
+ */
+export class CLIError extends DidMethodError {
+    constructor(message, type = 'CLIError', data) {
+        super(message, { type, name: type, data });
+    }
+}
+//# sourceMappingURL=error.js.map

package/dist/esm/src/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD;;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"}

package/dist/esm/src/index.js

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

package/dist/esm/src/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;AAC7B,cAAc,YAAY,CAAC"}

package/dist/types/bin/btcr2.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=btcr2.d.ts.map

package/dist/types/bin/btcr2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"btcr2.d.ts","sourceRoot":"","sources":["../../../bin/btcr2.ts"],"names":[],"mappings":""}

package/dist/types/cli.d.ts

@@ -1,31 +1,112 @@
-import { DidMethodError } from '@did-btcr2/common';
+import { Command } from 'commander';
 /**
- * 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?)`.
+ * CLI tool for the did:btcr2 method.
+ * @type {DidBtcr2Cli}
+ * @class DidBtcr2Cli
  */
 export declare class DidBtcr2Cli {
-    private CLI;
+    readonly program: Command;
     constructor();
     /**
-     * Configure the CLI commands and options.
-     * @private
+     * Configures the CLI commands.
+     * @returns {void}
      */
     private configureCommands;
     /**
-     * A helper to invoke the command logic without forcibly exiting.
+     * Invokes a command with the provided request.
+     * @param {object} request The command request
+     * @param {any} request.options The command options
+     * @param {CommandRequest['action']} request.action The command action
+     * @param {Btcr2Command} request.command The command instance
+     * @returns {Promise<CommandResult>} The command result
      */
     private invokeCommand;
     /**
-     * Parse and run the CLI.
+     * Runs the CLI with the provided argv or process.argv.
+     * @param {string[]} [argv] The argv array to use. Defaults to process.argv.
+     */
+    run(argv?: string[]): Promise<void>;
+    /**
+     * Normalizes argv to ensure it has at least two elements.
+     * @param {string[]} argv The argv array to normalize
+     * @returns {string[]} Normalized argv array
+     */
+    private normalizeArgv;
+    /**
+     * Handles errors thrown during CLI execution.
+     * @param {unknown} error The error to handle
+     * @returns {void}
+     */
+    private handleError;
+    /**
+     * Parses create command options and throws CLIError on invalid input.
+     * @param {object} options The create command options
+     * @param {string} options.type The identifier type
+     * @param {string} options.network The bitcoin network
+     * @param {string} options.bytes The genesis bytes as a hex string
+     * @returns {CreateCommandOptions} The parsed create command options
+     */
+    private parseCreateOptions;
+    /**
+     * Parses resolve command options and throws CLIError on invalid input.
+     * @param {object} options The resolve command options
+     * @param {string} options.identifier The did:btcr2 identifier
+     * @param {string} [options.resolutionOptions] JSON string of resolution options
+     * @param {string} [options.resolutionOptionsPath] Path to a JSON file of resolution options
+     * @returns {Promise<ResolveCommandOptions>} The parsed resolve command options
+     */
+    private parseResolveOptions;
+    /**
+     * Parses update command options and throws CLIError on invalid input.
+     * @param {object} options The update command options
+     * @param {string} options.identifier The did:btcr2 identifier
+     * @param {string} options.sourceDocument The source DID document as a JSON string
+     * @param {number} options.sourceVersionId The source version ID as a number
+     * @param {string} options.patch The JSON Patch operations as a JSON string array
+     * @param {string} options.verificationMethodId The DID document verification method ID as a string
+     * @param {string} options.beaconIds The beacon IDs as a JSON string array
+     * @returns {UpdateCommandOptions} The parsed update command options
+     */
+    private parseUpdateOptions;
+    /**
+     * Parses a JSON option and throws a CLIError on failure.
+     * @param {string} value JSON string to parse
+     * @param {string} errorMessage Error message to use on failure
+     * @param {Record<string, any>} data Additional data to include in the error
+     * @returns {T} Parsed JSON object
+     */
+    private parseJsonOption;
+    /**
+     * Parses resolution options from JSON string or file path.
+     * @param {object} options The options containing resolution options
+     * @param {string} [options.resolutionOptions] JSON string of resolution options
+     * @param {string} [options.resolutionOptionsPath] Path to a JSON file of resolution options
+     * @returns {Promise<any>} The parsed resolution options
+     */
+    private parseResolutionOptions;
+    /**
+     * Validates the did:btcr2 identifier format.
+     * @param {string} identifier The identifier to validate
+     * @param {Record<string, any>} data Additional data to include in the error
+     * @returns {void}
+     */
+    private validateIdentifier;
+    /**
+     * Validates if the provided network is supported.
+     * @param {string} network The network to validate
+     * @returns {boolean} True if the network is valid
+     */
+    private isNetworkValid;
+    /**
+     * Prints the command result to the console.
+     * @param {CommandResult} result The command result to print
+     * @returns {void}
+     */
+    private printResult;
+    /**
+     * Logs a payload to the console, formatting objects as JSON.
+     * @param {unknown} payload The payload to log
+     * @returns {void}
      */
-    run(argv?: string[]): void;
+    private log;
 }
-declare const _default: void;
-export default _default;

package/dist/types/command.d.ts

@@ -1,14 +1,55 @@
+import { DidResolutionResult } from '@web5/dids';
+import { PatchOperation } from '@did-btcr2/common';
+import { DidDocument, ResolutionOptions, SidecarData } from '@did-btcr2/method';
+export type NetworkOption = 'bitcoin' | 'testnet3' | 'testnet4' | 'signet' | 'mutinynet' | 'regtest';
 export interface CommandInterface {
-    execute(params: {
-        options?: any;
-        action?: string;
-    }): Promise<void>;
+    execute(request: CommandRequest): Promise<CommandResult>;
 }
-interface ExecuteParams {
-    options?: any;
-    action?: string;
+export interface CreateCommandOptions {
+    type: 'k' | 'x';
+    bytes: string;
+    network: NetworkOption;
 }
+export interface ResolveCommandOptions {
+    identifier: string;
+    options?: ResolutionOptions;
+}
+export interface UpdateCommandOptions {
+    identifier: string;
+    sourceDocument: DidDocument;
+    sourceVersionId: number;
+    patch: PatchOperation[];
+    verificationMethodId: string;
+    beaconIds: string[];
+}
+export interface DeactivateCommandOptions {
+}
+export type CommandRequest = {
+    action: 'create';
+    options: CreateCommandOptions;
+} | {
+    action: 'resolve' | 'read';
+    options: ResolveCommandOptions;
+} | {
+    action: 'update';
+    options: UpdateCommandOptions;
+} | {
+    action: 'deactivate' | 'delete';
+    options: DeactivateCommandOptions;
+};
+export type CommandResult = {
+    action: 'create';
+    did: string;
+} | {
+    action: 'resolve' | 'read';
+    resolution: DidResolutionResult;
+} | {
+    action: 'update';
+    sidecar: SidecarData;
+} | {
+    action: 'deactivate' | 'delete';
+    message: string;
+};
 export default class Btcr2Command implements CommandInterface {
-    execute({ options, action }: ExecuteParams): Promise<void>;
+    execute(request: CommandRequest): Promise<CommandResult>;
 }
-export {};

package/dist/types/error.d.ts

@@ -0,0 +1,7 @@
+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>);
+}

package/dist/types/index.d.ts

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