@did-btcr2/cli 0.20.0 → 0.22.0

package/dist/esm/src/resolution-options.js

@@ -0,0 +1,47 @@
+import { DEFAULT_MIN_CONF } from '@did-btcr2/api';
+import { readFile } from 'node:fs/promises';
+import { CLIError } from './error.js';
+/** The help text of `--min-conf`. `resolve`, `update`, and `deactivate` share it. */
+export const MIN_CONF_HELP = 'Minimum block confirmations a beacon signal needs before resolution applies it '
+    + `(positive integer, default: ${DEFAULT_MIN_CONF}). Overrides a minConf inside the JSON resolution options`;
+/**
+ * Builds the resolution options from the flags. The inline JSON wins over
+ * the file. The `--min-conf` flag wins over a `minConf` inside the JSON.
+ * Returns `undefined` if no flag is set.
+ */
+export async function readResolutionOptions(flags) {
+    let resolutionOptions;
+    if (flags.resolutionOptions) {
+        try {
+            resolutionOptions = JSON.parse(flags.resolutionOptions);
+        }
+        catch {
+            throw new CLIError('Invalid resolution options. Must be a valid JSON string.', 'INVALID_ARGUMENT_ERROR', { resolutionOptions: flags.resolutionOptions });
+        }
+    }
+    else if (flags.resolutionOptionsPath) {
+        try {
+            const content = await readFile(flags.resolutionOptionsPath, 'utf-8');
+            resolutionOptions = JSON.parse(content);
+        }
+        catch {
+            throw new CLIError('Invalid resolution options path. Must be a valid path to a JSON file.', 'INVALID_ARGUMENT_ERROR', { resolutionOptionsPath: flags.resolutionOptionsPath });
+        }
+    }
+    // The flag wins over a minConf inside the JSON options.
+    if (flags.minConf !== undefined) {
+        resolutionOptions = { ...(resolutionOptions ?? {}), minConf: flags.minConf };
+    }
+    return resolutionOptions;
+}
+/**
+ * Commander argParser for `--min-conf`. Accepts a positive integer (minimum 1),
+ * the domain the specification gives `minConf`. Errors at parse time otherwise.
+ */
+export function parseMinConf(value) {
+    if (!/^[1-9]\d*$/.test(value)) {
+        throw new CLIError('--min-conf must be a positive integer (minimum 1).', 'INVALID_ARGUMENT_ERROR', { value });
+    }
+    return Number(value);
+}
+//# sourceMappingURL=resolution-options.js.map

package/dist/esm/src/resolution-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolution-options.js","sourceRoot":"","sources":["../../../src/resolution-options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAStC,qFAAqF;AACrF,MAAM,CAAC,MAAM,aAAa,GACxB,iFAAiF;MAC/E,+BAA+B,gBAAgB,2DAA2D,CAAC;AAE/G;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,KAA4B;IACtE,IAAI,iBAAgD,CAAC;IACrD,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC5B,IAAI,CAAC;YACH,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAChB,0DAA0D,EAC1D,wBAAwB,EACxB,EAAE,iBAAiB,EAAE,KAAK,CAAC,iBAAiB,EAAE,CAC/C,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,IAAI,KAAK,CAAC,qBAAqB,EAAE,CAAC;QACvC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;YACrE,iBAAiB,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,QAAQ,CAChB,uEAAuE,EACvE,wBAAwB,EACxB,EAAE,qBAAqB,EAAE,KAAK,CAAC,qBAAqB,EAAE,CACvD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,wDAAwD;IACxD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,iBAAiB,GAAG,EAAE,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;IAC/E,CAAC;IACD,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,QAAQ,CAChB,oDAAoD,EACpD,wBAAwB,EACxB,EAAE,KAAK,EAAE,CACV,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAkBA,MAAM,CAAC,MAAM,kBAAkB,GAAoB;IACjD,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS;CACpE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,KAAyB;IACpD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;AACjD,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAiBA,MAAM,CAAC,MAAM,kBAAkB,GAAoB;IACjD,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS;CACpE,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,KAAyB;IACpD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC;AACjD,CAAC"}

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

@@ -14,7 +14,7 @@ export declare class DidBtcr2Cli {
      * for known networks and localhost Polar for regtest.
      *
      * @param factory - Optional API factory for keystore-free commands (create,
-     *   resolve). Defaults to {@link defaultApiFactory}.
+     *   resolve, identifier). Defaults to {@link defaultApiFactory}.
      * @param keystoreFactory - Optional keystore-aware API factory for commands
      *   that need a signing identity (key, update, deactivate). Defaults to
      *   {@link keystoreApiFactory}.

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

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../src/cli.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAC;AAcpD,OAAO,EAA8D,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAI1G;;GAEG;AACH,qBAAa,WAAW;IACtB,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC;;;;;;;;;;;;;OAaG;gBAED,OAAO,GAAE,UAA8B,EACvC,eAAe,GAAE,UAA+B;IAyDlD;;;;OAIG;IACU,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CASjD"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../../../src/cli.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAkB,MAAM,WAAW,CAAC;AAepD,OAAO,EAA8D,KAAK,UAAU,EAAE,MAAM,aAAa,CAAC;AAI1G;;GAEG;AACH,qBAAa,WAAW;IACtB,SAAgB,OAAO,EAAE,OAAO,CAAC;IAEjC;;;;;;;;;;;;;OAaG;gBAED,OAAO,GAAE,UAA8B,EACvC,eAAe,GAAE,UAA+B;IA0DlD;;;;OAIG;IACU,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CASjD"}

package/dist/types/src/commands/deactivate.d.ts

@@ -1,5 +1,5 @@
 import type { Command } from 'commander';
-import { type ApiFactory } from '../config.js';
+import type { ApiFactory } from '../config.js';
 import type { GlobalOptions } from '../types.js';
 export declare function registerDeactivateCommand(program: Command, factory: ApiFactory, globals: () => GlobalOptions): void;
 //# sourceMappingURL=deactivate.d.ts.map

package/dist/types/src/commands/deactivate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deactivate.d.ts","sourceRoot":"","sources":["../../../../src/commands/deactivate.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAiG,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAK9I,OAAO,KAAK,EAAE,aAAa,EAAwB,MAAM,aAAa,CAAC;AAKvE,wBAAgB,yBAAyB,CACvC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CAyGN"}
+{"version":3,"file":"deactivate.d.ts","sourceRoot":"","sources":["../../../../src/commands/deactivate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGjD,wBAAgB,yBAAyB,CACvC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CAgBN"}

package/dist/types/src/commands/identifier.d.ts

@@ -0,0 +1,12 @@
+import type { Command } from 'commander';
+import type { ApiFactory } from '../config.js';
+import type { GlobalOptions } from '../types.js';
+/**
+ * Registers the `identifier` command group. `decode` prints the components of
+ * a did:btcr2 identifier. `validate` checks that an identifier conforms to the
+ * specification and prints a report. Both commands are offline and
+ * keystore-free: they use the api with no Bitcoin connection, no CAS, and no
+ * key material.
+ */
+export declare function registerIdentifierCommand(program: Command, factory: ApiFactory, globals: () => GlobalOptions): void;
+//# sourceMappingURL=identifier.d.ts.map

package/dist/types/src/commands/identifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifier.d.ts","sourceRoot":"","sources":["../../../../src/commands/identifier.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG/C,OAAO,KAAK,EAAiB,aAAa,EAAwB,MAAM,aAAa,CAAC;AAEtF;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CAuFN"}

package/dist/types/src/commands/index.d.ts

@@ -4,6 +4,7 @@ export { registerCreateCommand } from './create.js';
 export { registerResolveCommand } from './resolve.js';
 export { registerUpdateCommand } from './update.js';
 export { registerDeactivateCommand } from './deactivate.js';
+export { registerIdentifierCommand } from './identifier.js';
 export { registerKeyCommand } from './key.js';
 export { registerKeystoreCommand } from './keystore.js';
 export { registerConfigCommand } from './config.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/commands/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/commands/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAC;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/types/src/commands/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../../../src/commands/resolve.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAiB,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAG9D,OAAO,KAAK,EAAE,aAAa,EAAyB,MAAM,aAAa,CAAC;AAExE,wBAAgB,sBAAsB,CACpC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CA2BN"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../../../../src/commands/resolve.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAiB,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAG9D,OAAO,KAAK,EAAE,aAAa,EAAyB,MAAM,aAAa,CAAC;AAExE,wBAAgB,sBAAsB,CACpC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CAiBN"}

package/dist/types/src/commands/update.d.ts

@@ -1,5 +1,5 @@
 import type { Command } from 'commander';
-import { type ApiFactory } from '../config.js';
+import type { ApiFactory } from '../config.js';
 import type { GlobalOptions } from '../types.js';
 export declare function registerUpdateCommand(program: Command, factory: ApiFactory, globals: () => GlobalOptions): void;
 //# sourceMappingURL=update.d.ts.map

package/dist/types/src/commands/update.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../../src/commands/update.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAiG,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAK9I,OAAO,KAAK,EAAE,aAAa,EAAwB,MAAM,aAAa,CAAC;AAEvE,wBAAgB,qBAAqB,CACnC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CA4GN"}
+{"version":3,"file":"update.d.ts","sourceRoot":"","sources":["../../../../src/commands/update.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAGjD,wBAAgB,qBAAqB,CACnC,OAAO,EAAG,OAAO,EACjB,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,MAAM,aAAa,GAC5B,IAAI,CAuBN"}

package/dist/types/src/commands/write.d.ts

@@ -0,0 +1,47 @@
+import type { DidBtcr2Api, PublishToCasMode } from '@did-btcr2/api';
+import type { Command } from 'commander';
+import { type ApiFactory } from '../config.js';
+import { type ResolutionOptionFlags } from '../resolution-options.js';
+import type { GlobalOptions, NetworkOption, UpdateCommandOptions } from '../types.js';
+/** The parsed flags that `update` and `deactivate` share. */
+export type WriteFlags = ResolutionOptionFlags & {
+    identifier: string;
+    sourceDocument?: unknown;
+    sourceVersionId?: number;
+    verificationMethodId?: string;
+    beaconId?: string;
+    publishToCas: PublishToCasMode;
+    feeRate?: string;
+    changeAddress?: string;
+};
+/**
+ * Registers the flags that `update` and `deactivate` share. Each command
+ * registers `-i/--identifier` (and `update` its `-p/--patches`) before it
+ * calls this function, so those flags lead the help output.
+ */
+export declare function registerWriteOptions(command: Command): Command;
+/**
+ * Validates the shared write flags, derives the network from the identifier,
+ * applies the mainnet keystore guard, builds the signer, and returns the
+ * parameters for `updateDid` and `deactivateDid`.
+ *
+ * The checks run in this order, before any key material is read:
+ * 1. The identifier decodes and names a supported network.
+ * 2. `--source-document` and `--source-version-id` come together or not at
+ *    all (ADR 101). The api refuses a half pair too; the cli names the flags.
+ * 3. The resolution flags come only without the source pair. The api ignores
+ *    `resolutionOptions` when the pair is supplied (ADR 098). A silent ignore
+ *    of `--min-conf` would mislead.
+ * 4. A mainnet write is refused with an unencrypted dev keystore (ADR 080).
+ */
+export declare function prepareWrite(options: WriteFlags, factory: ApiFactory, g: GlobalOptions): Promise<{
+    network: NetworkOption;
+    api: DidBtcr2Api;
+    params: UpdateCommandOptions;
+}>;
+/**
+ * Returns a commander argParser that validates JSON.
+ * Errors at parse time with a clear flag reference.
+ */
+export declare function parseJsonArg(flagName: string): (value: string) => unknown;
+//# sourceMappingURL=write.d.ts.map

package/dist/types/src/commands/write.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.d.ts","sourceRoot":"","sources":["../../../../src/commands/write.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAoB,WAAW,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAEtF,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAKL,KAAK,UAAU,EAChB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAsD,KAAK,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAC1H,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEtF,6DAA6D;AAC7D,MAAM,MAAM,UAAU,GAAG,qBAAqB,GAAG;IAC/C,UAAU,EAAc,MAAM,CAAC;IAC/B,cAAc,CAAC,EAAS,OAAO,CAAC;IAChC,eAAe,CAAC,EAAQ,MAAM,CAAC;IAC/B,oBAAoB,CAAC,EAAG,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAe,MAAM,CAAC;IAC/B,YAAY,EAAY,gBAAgB,CAAC;IACzC,OAAO,CAAC,EAAgB,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAU,MAAM,CAAC;CAChC,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAiD9D;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAG,UAAU,EACpB,OAAO,EAAG,UAAU,EACpB,CAAC,EAAS,aAAa,GACtB,OAAO,CAAC;IAAE,OAAO,EAAE,aAAa,CAAC;IAAC,GAAG,EAAE,WAAW,CAAC;IAAC,MAAM,EAAE,oBAAoB,CAAA;CAAE,CAAC,CAmDrF;AA6BD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAYzE"}

package/dist/types/src/resolution-options.d.ts

@@ -0,0 +1,21 @@
+import type { ResolutionOptions } from '@did-btcr2/method';
+/** The flags that select the resolution options of a command. */
+export type ResolutionOptionFlags = {
+    resolutionOptions?: string;
+    resolutionOptionsPath?: string;
+    minConf?: number;
+};
+/** The help text of `--min-conf`. `resolve`, `update`, and `deactivate` share it. */
+export declare const MIN_CONF_HELP: string;
+/**
+ * Builds the resolution options from the flags. The inline JSON wins over
+ * the file. The `--min-conf` flag wins over a `minConf` inside the JSON.
+ * Returns `undefined` if no flag is set.
+ */
+export declare function readResolutionOptions(flags: ResolutionOptionFlags): Promise<ResolutionOptions | undefined>;
+/**
+ * Commander argParser for `--min-conf`. Accepts a positive integer (minimum 1),
+ * the domain the specification gives `minConf`. Errors at parse time otherwise.
+ */
+export declare function parseMinConf(value: string): number;
+//# sourceMappingURL=resolution-options.d.ts.map

package/dist/types/src/resolution-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolution-options.d.ts","sourceRoot":"","sources":["../../../src/resolution-options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAI3D,iEAAiE;AACjE,MAAM,MAAM,qBAAqB,GAAG;IAClC,iBAAiB,CAAC,EAAO,MAAM,CAAC;IAChC,qBAAqB,CAAC,EAAG,MAAM,CAAC;IAChC,OAAO,CAAC,EAAiB,MAAM,CAAC;CACjC,CAAC;AAEF,qFAAqF;AACrF,eAAO,MAAM,aAAa,QAEoF,CAAC;AAE/G;;;;GAIG;AACH,wBAAsB,qBAAqB,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,GAAG,SAAS,CAAC,CA6BhH;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CASlD"}

package/dist/types/src/types.d.ts

@@ -1,5 +1,4 @@
-import type { DidUpdateResult } from '@did-btcr2/api';
-import type { PatchOperation } from '@did-btcr2/common';
+import type { BroadcastOptions, DidUpdateResult, IdentifierReport, PublishToCasMode, Signer } from '@did-btcr2/api';
 import type { Btcr2DidDocument, ResolutionOptions } from '@did-btcr2/method';
 import type { DidResolutionResult } from '@web5/dids';
 import type { DoctorReport, EffectiveConfig } from './config.js';
@@ -25,12 +24,37 @@ export interface ResolveCommandOptions {
     identifier: string;
     options?: ResolutionOptions;
 }
+/**
+ * The parameters that `update` and `deactivate` hand to the api's `updateDid`
+ * and `deactivateDid`. `update` adds `patches`. An absent source pair lets the
+ * api resolve the current document with `resolutionOptions` (ADR 098, ADR
+ * 101). An absent `verificationMethodId` or `beaconId` lets the api derive it
+ * (ADR 104).
+ */
 export interface UpdateCommandOptions {
-    sourceDocument: Btcr2DidDocument;
-    patches: PatchOperation[];
-    sourceVersionId: number;
-    verificationMethodId: string;
-    beaconId: string;
+    did: string;
+    signer: Signer;
+    sourceDocument?: Btcr2DidDocument;
+    sourceVersionId?: number;
+    verificationMethodId?: string;
+    beaconId?: string;
+    resolutionOptions?: ResolutionOptions;
+    publishToCas: PublishToCasMode;
+    broadcastOptions?: BroadcastOptions;
+}
+/**
+ * The data that `identifier decode` prints: the decoded components of the
+ * identifier with the genesis bytes as hex, plus the initial DID document
+ * if the caller asked for it.
+ */
+export interface IdentifierDecodeData {
+    did: string;
+    idType: string;
+    hrp: string;
+    version: number;
+    network: string;
+    genesisBytes: string;
+    initialDocument?: Btcr2DidDocument;
 }
 export type CommandResult = {
     action: 'create';
@@ -46,6 +70,12 @@ export type CommandResult = {
 } | {
     action: 'deactivate';
     data: DidUpdateResult;
+} | {
+    action: 'identifier-decode';
+    data: IdentifierDecodeData;
+} | {
+    action: 'identifier-validate';
+    data: IdentifierReport;
 } | {
     action: 'key-generate';
     data: {

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AACrG,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,KAAK,GAAG,QAAQ,CAAC;AAErE,eAAO,MAAM,kBAAkB,EAAE,aAAa,EAE7C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAG1E;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAG,MAAM,CAAC;IACpB,OAAO,CAAC,EAAK,iBAAiB,CAAC;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAS,gBAAgB,CAAC;IACxC,OAAO,EAAgB,cAAc,EAAE,CAAC;IACxC,eAAe,EAAQ,MAAM,CAAC;IAC9B,oBAAoB,EAAG,MAAM,CAAC;IAC9B,QAAQ,EAAe,MAAM,CAAC;CAC/B;AAED,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,GAChD;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACvF;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;CAAE,GAC3G;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACjG;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACzG;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAC/F;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,GAChE;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,GAC5D;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,EAAE,uBAAuB,CAAA;KAAE,CAAA;CAAE,GAC5J;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAC5B,IAAI,EAAS,MAAM,CAAC;QACpB,MAAM,EAAO,MAAM,CAAC;QACpB,QAAQ,EAAK,MAAM,CAAC;QACpB,OAAO,EAAM,aAAa,CAAC;QAC3B,OAAO,EAAM,MAAM,EAAE,CAAC;QACtB,UAAU,EAAG,uBAAuB,CAAC;QACrC,QAAQ,EAAK,OAAO,CAAC;QACrB,OAAO,CAAC,EAAK;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAA;SAAE,CAAC;QACvD,MAAM,CAAC,EAAM,YAAY,CAAC;KAC3B,CAAA;CAAE,GACH;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjD;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACvC;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChD;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,WAAW,EAAE,CAAA;KAAE,CAAA;CAAE,GAC3E;IAAE,MAAM,EAAE,kBAAkB,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GACrD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACnF;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,YAAY,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,WAAW,GAAG,KAAK,CAAA;KAAE,CAAA;CAAE,GACpF;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,uBAAuB,CAAC;QAAC,WAAW,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,EAAE,aAAa,CAAA;KAAE,CAAA;CAAE,GACtL;IAAE,MAAM,EAAE,4BAA4B,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjF;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChG;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACrE;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACpD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACpD;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAgB,YAAY,CAAC;IACnC,OAAO,EAAe,OAAO,CAAC;IAC9B,KAAK,EAAiB,OAAO,CAAC;IAC9B,IAAI,CAAC,EAAiB,MAAM,CAAC;IAC7B,MAAM,CAAC,EAAe,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAc,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAc,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAY,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAI7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAY,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAQ,MAAM,EAAE,CAAC;IAC/B,YAAY,CAAC,EAAS,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAS,MAAM,EAAE,CAAC;IAC/B,kBAAkB,CAAC,EAAG,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAa,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAO,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;CAC9B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACpH,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,CAAC;AACrG,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,WAAW,GAAG,KAAK,GAAG,QAAQ,CAAC;AAErE,eAAO,MAAM,kBAAkB,EAAE,aAAa,EAE7C,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAG1E;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAG,MAAM,CAAC;IACpB,OAAO,CAAC,EAAK,iBAAiB,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAqB,MAAM,CAAC;IAC/B,MAAM,EAAkB,MAAM,CAAC;IAC/B,cAAc,CAAC,EAAS,gBAAgB,CAAC;IACzC,eAAe,CAAC,EAAQ,MAAM,CAAC;IAC/B,oBAAoB,CAAC,EAAG,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAe,MAAM,CAAC;IAC/B,iBAAiB,CAAC,EAAM,iBAAiB,CAAC;IAC1C,YAAY,EAAY,gBAAgB,CAAC;IACzC,gBAAgB,CAAC,EAAO,gBAAgB,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAgB,MAAM,CAAC;IAC1B,MAAM,EAAa,MAAM,CAAC;IAC1B,GAAG,EAAgB,MAAM,CAAC;IAC1B,OAAO,EAAY,MAAM,CAAC;IAC1B,OAAO,EAAY,MAAM,CAAC;IAC1B,YAAY,EAAO,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAG,gBAAgB,CAAC;CACrC;AAED,MAAM,MAAM,aAAa,GACrB;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,mBAAmB,CAAA;CAAE,GAChD;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAC3C;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,mBAAmB,CAAC;IAAC,IAAI,EAAE,oBAAoB,CAAA;CAAE,GAC3D;IAAE,MAAM,EAAE,qBAAqB,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,GACzD;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACvF;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;CAAE,GAC3G;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAA;CAAE,GACjG;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACzG;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAC/F;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,GAChE;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAA;CAAE,GAC5D;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,aAAa,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,EAAE,uBAAuB,CAAA;KAAE,CAAA;CAAE,GAC5J;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAC5B,IAAI,EAAS,MAAM,CAAC;QACpB,MAAM,EAAO,MAAM,CAAC;QACpB,QAAQ,EAAK,MAAM,CAAC;QACpB,OAAO,EAAM,aAAa,CAAC;QAC3B,OAAO,EAAM,MAAM,EAAE,CAAC;QACtB,UAAU,EAAG,uBAAuB,CAAC;QACrC,QAAQ,EAAK,OAAO,CAAC;QACrB,OAAO,CAAC,EAAK;YAAE,SAAS,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAA;SAAE,CAAC;QACvD,MAAM,CAAC,EAAM,YAAY,CAAC;KAC3B,CAAA;CAAE,GACH;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjD;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACvC;IAAE,MAAM,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChD;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACxC;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE;QAAE,EAAE,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,WAAW,EAAE,CAAA;KAAE,CAAA;CAAE,GAC3E;IAAE,MAAM,EAAE,kBAAkB,CAAC;IAAC,IAAI,EAAE,eAAe,CAAA;CAAE,GACrD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACnF;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,YAAY,CAAA;CAAE,GAC/C;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,WAAW,GAAG,KAAK,CAAA;KAAE,CAAA;CAAE,GACpF;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,uBAAuB,CAAC;QAAC,WAAW,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,OAAO,EAAE,aAAa,CAAA;KAAE,CAAA;CAAE,GACtL;IAAE,MAAM,EAAE,4BAA4B,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjF;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChG;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,GACrE;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACpD;IAAE,MAAM,EAAE,aAAa,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACpD;IAAE,MAAM,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GACzC;IAAE,MAAM,EAAE,gBAAgB,CAAC;IAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAC;AAE5D,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAgB,YAAY,CAAC;IACnC,OAAO,EAAe,OAAO,CAAC;IAC9B,KAAK,EAAiB,OAAO,CAAC;IAC9B,IAAI,CAAC,EAAiB,MAAM,CAAC;IAC7B,MAAM,CAAC,EAAe,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAc,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAc,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAY,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAI7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAC7B,SAAS,CAAC,EAAY,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAQ,MAAM,EAAE,CAAC;IAC/B,YAAY,CAAC,EAAS,MAAM,CAAC;IAC7B,YAAY,CAAC,EAAS,MAAM,EAAE,CAAC;IAC/B,kBAAkB,CAAC,EAAG,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAa,MAAM,CAAC;IAC7B,cAAc,CAAC,EAAO,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAW,MAAM,CAAC;CAC9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-btcr2/cli",
-  "version": "0.20.0",
+  "version": "0.22.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",
@@ -62,10 +62,10 @@
     "@web5/dids": "^1.2.0",
     "commander": "^13.1.0",
     "@did-btcr2/key-manager": "^0.7.0",
+    "@did-btcr2/api": "^0.22.0",
+    "@did-btcr2/common": "^9.4.0",
     "@did-btcr2/keypair": "^0.13.1",
-    "@did-btcr2/api": "^0.21.0",
-    "@did-btcr2/method": "^0.59.0",
-    "@did-btcr2/common": "^9.4.0"
+    "@did-btcr2/method": "^0.60.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.21.0",

package/src/cli.ts

@@ -5,6 +5,7 @@ import {
   registerConfigCommand,
   registerCreateCommand,
   registerDeactivateCommand,
+  registerIdentifierCommand,
   registerInitCommand,
   registerKeyCommand,
   registerKeystoreCommand,
@@ -32,7 +33,7 @@ export class DidBtcr2Cli {
    * for known networks and localhost Polar for regtest.
    *
    * @param factory - Optional API factory for keystore-free commands (create,
-   *   resolve). Defaults to {@link defaultApiFactory}.
+   *   resolve, identifier). Defaults to {@link defaultApiFactory}.
    * @param keystoreFactory - Optional keystore-aware API factory for commands
    *   that need a signing identity (key, update, deactivate). Defaults to
    *   {@link keystoreApiFactory}.
@@ -89,6 +90,7 @@ export class DidBtcr2Cli {
     registerResolveCommand(this.program, factory, globals);
     registerUpdateCommand(this.program, keystoreFactory, globals);
     registerDeactivateCommand(this.program, keystoreFactory, globals);
+    registerIdentifierCommand(this.program, factory, globals);
     registerKeyCommand(this.program, keystoreFactory, globals);
     registerKeystoreCommand(this.program, globals);
     registerConfigCommand(this.program, globals);

package/src/commands/completion.ts

@@ -2,7 +2,7 @@ import type { Command } from 'commander';
 import { CLIError } from '../error.js';
 import type { GlobalOptions } from '../types.js';
 
-const COMMANDS = 'create resolve read update deactivate delete key config profile completion';
+const COMMANDS = 'create resolve read update deactivate delete identifier key config profile completion';
 
 /** Registers the `completion` command, which prints a shell completion script to stdout. */
 export function registerCompletionCommand(program: Command, _globals: () => GlobalOptions): void {

package/src/commands/deactivate.ts

@@ -1,156 +1,28 @@
-import type { PublishToCasMode } from '@did-btcr2/api';
-import { KeyManagerSigner } from '@did-btcr2/key-manager';
 import type { Command } from 'commander';
-import { assertKeystoreAllowedForNetwork, deriveNetwork, resolveBroadcastOptions, resolveSigningKeyRef, type ApiFactory } from '../config.js';
-import { CLIError } from '../error.js';
+import type { ApiFactory } from '../config.js';
 import { printWatchHint } from '../hints.js';
-import { resolveKeyRef } from '../keystore/resolve-key-ref.js';
 import { formatResult } from '../output.js';
-import type { GlobalOptions, UpdateCommandOptions } from '../types.js';
-
-/** The JSON Patch that marks a DID document as permanently deactivated. */
-const DEACTIVATION_PATCH = [{ op: 'add' as const, path: '/deactivated', value: true }];
+import type { GlobalOptions } from '../types.js';
+import { prepareWrite, registerWriteOptions, type WriteFlags } from './write.js';
 
 export function registerDeactivateCommand(
   program : Command,
   factory : ApiFactory,
   globals : () => GlobalOptions,
 ): void {
-  program
+  const command = program
     .command('deactivate')
     .alias('delete')
     .description('Deactivate the did:btcr2 identifier permanently. This is irreversible.')
-    .requiredOption(
-      '-s, --source-document <json>',
-      'Current DID document as JSON string',
-      parseJsonArg('--source-document'),
-    )
-    .requiredOption(
-      '--source-version-id <number>',
-      'Current version ID of the DID document'
-    )
-    .requiredOption(
-      '-m, --verification-method-id <id>',
-      'DID document verification method ID used to sign the deactivation'
-    )
-    .requiredOption(
-      '-b, --beacon-id <json>',
-      'Beacon ID as a JSON string',
-      parseJsonArg('--beacon-id'),
-    )
-    .option(
-      '--publish-to-cas <mode>',
-      'Publish update artifacts to a writable CAS before broadcast: auto|always|never. '
-        + 'CAS publication is optional; the default distributes the returned artifacts via sidecar.',
-      parsePublishToCasMode,
-      'never',
-    )
-    .option(
-      '--fee-rate <satsPerVByte>',
-      'Fee rate in sats/vByte for the beacon transaction (default: 5). '
-        + 'Raise it under congestion so the transaction confirms.',
-    )
-    .option(
-      '--change-address <address>',
-      'Send transaction change to this address instead of the beacon address, '
-        + 'so a DID\'s announcements are not linked on-chain (ADR 044).',
-    )
-    .action(async (options: {
-      sourceDocument       : unknown;
-      sourceVersionId      : string;
-      verificationMethodId : string;
-      beaconId             : unknown;
-      publishToCas         : PublishToCasMode;
-      feeRate?             : string;
-      changeAddress?       : string;
-    }) => {
-      if (!/^\d+$/.test(options.sourceVersionId)) {
-        throw new CLIError(
-          '--source-version-id must be a non-negative integer.',
-          'INVALID_ARGUMENT_ERROR',
-          { value: options.sourceVersionId },
-        );
-      }
-      const parsed: UpdateCommandOptions = {
-        sourceDocument       : options.sourceDocument as UpdateCommandOptions['sourceDocument'],
-        patches              : DEACTIVATION_PATCH,
-        sourceVersionId      : Number(options.sourceVersionId),
-        verificationMethodId : options.verificationMethodId,
-        beaconId             : options.beaconId as UpdateCommandOptions['beaconId'],
-      };
-      const did = parsed.sourceDocument?.id;
-      if (!did) {
-        throw new CLIError(
-          'Source document must contain an "id" field.',
-          'INVALID_ARGUMENT_ERROR',
-          options
-        );
-      }
-      // Deactivation is an update that applies the deactivation patch. The core
-      // method has no separate deactivate path, so this routes through update.
-      const network = deriveNetwork(did);
-      // Refuse to sign a mainnet deactivation with an unencrypted dev keystore (ADR 080).
-      assertKeystoreAllowedForNetwork(network, globals());
-      const api = factory(network, globals());
-      const keyId = resolveKeyRef(api.kms.kms, resolveSigningKeyRef(globals()));
-      const signer = new KeyManagerSigner(api.kms.kms, keyId);
-      // Resolve fee-rate/change-address through the flag -> env -> profile chain
-      // into beacon broadcast options. Undefined when neither is set, so the
-      // SDK defaults (5 sat/vB, change back to the beacon address) still apply.
-      const broadcastOptions = resolveBroadcastOptions(network, globals(), {
-        feeRate       : options.feeRate,
-        changeAddress : options.changeAddress,
-      });
-      // CAS publication is optional and never required: every beacon update can
-      // be completed and shared via sidecar alone. It is opt-in and defaults to
-      // 'never'; pass --publish-to-cas auto|always to publish the signed update
-      // (and, for CAS beacons, the announcement) to a writable CAS configured
-      // via --cas-rpc-url. The returned artifacts (txid, announcement, proof)
-      // are always printed for sidecar distribution regardless.
-      const data = await api.btcr2.update({
-        sourceDocument       : parsed.sourceDocument,
-        patches              : parsed.patches,
-        sourceVersionId      : parsed.sourceVersionId,
-        verificationMethodId : parsed.verificationMethodId,
-        beaconId             : parsed.beaconId,
-        signer,
-        publishToCas         : options.publishToCas,
-        ...(broadcastOptions ? { broadcastOptions } : {}),
-      });
-      console.log(formatResult({ action: 'deactivate', data }, globals()));
-      printWatchHint(globals(), network, data.txid);
+    .requiredOption('-i, --identifier <identifier>', 'did:btcr2 identifier to deactivate');
+  registerWriteOptions(command)
+    .action(async (options: WriteFlags) => {
+      const g = globals();
+      const { network, api, params } = await prepareWrite(options, factory, g);
+      // The api supplies the deactivation patch (ADR 094) and refuses a
+      // document that is deactivated already (ADR 100).
+      const data = await api.deactivateDid(params);
+      console.log(formatResult({ action: 'deactivate', data }, g));
+      printWatchHint(g, network, data.txid);
     });
 }
-
-/**
- * Commander argParser for `--publish-to-cas`. Validates the value is one of the
- * three {@link PublishToCasMode} policies, erroring at parse time otherwise.
- */
-function parsePublishToCasMode(value: string): PublishToCasMode {
-  if (value !== 'auto' && value !== 'always' && value !== 'never') {
-    throw new CLIError(
-      '--publish-to-cas must be one of "auto", "always", or "never".',
-      'INVALID_ARGUMENT_ERROR',
-      { value },
-    );
-  }
-  return value;
-}
-
-/**
- * Returns a commander argParser that validates JSON.
- * Errors at parse time with a clear flag reference.
- */
-function parseJsonArg(flagName: string): (value: string) => unknown {
-  return (value: string): unknown => {
-    try {
-      return JSON.parse(value);
-    } catch {
-      throw new CLIError(
-        `Invalid JSON for ${flagName}. Must be a valid JSON string.`,
-        'INVALID_ARGUMENT_ERROR',
-        { flagName, value }
-      );
-    }
-  };
-}