@did-btcr2/cli 0.21.0 → 0.23.0

package/src/resolution-options.ts

@@ -2,14 +2,24 @@ import { DEFAULT_MIN_CONF } from '@did-btcr2/api';
 import type { ResolutionOptions } from '@did-btcr2/method';
 import { readFile } from 'node:fs/promises';
 import { CLIError } from './error.js';
+import { readGenesisDocumentFile } from './genesis-document-file.js';
 
 /** The flags that select the resolution options of a command. */
 export type ResolutionOptionFlags = {
   resolutionOptions?     : string;
   resolutionOptionsPath? : string;
   minConf?               : number;
+  genesisDocument?       : string;
 };
 
+/** Whether any resolution flag is set. */
+export function hasResolutionFlags(flags: ResolutionOptionFlags): boolean {
+  return flags.resolutionOptions !== undefined
+    || flags.resolutionOptionsPath !== undefined
+    || flags.minConf !== undefined
+    || flags.genesisDocument !== undefined;
+}
+
 /** 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 '
@@ -17,8 +27,9 @@ export const MIN_CONF_HELP =
 
 /**
  * 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.
+ * the file. The `--min-conf` flag wins over a `minConf` inside the JSON. The
+ * `--genesis-document` file wins over a `sidecar.genesisDocument` inside the
+ * JSON. Returns `undefined` if no flag is set.
  */
 export async function readResolutionOptions(flags: ResolutionOptionFlags): Promise<ResolutionOptions | undefined> {
   let resolutionOptions: ResolutionOptions | undefined;
@@ -48,6 +59,14 @@ export async function readResolutionOptions(flags: ResolutionOptionFlags): Promi
   if (flags.minConf !== undefined) {
     resolutionOptions = { ...(resolutionOptions ?? {}), minConf: flags.minConf };
   }
+  // The file wins over a sidecar.genesisDocument inside the JSON options.
+  if (flags.genesisDocument !== undefined) {
+    const genesisDocument = await readGenesisDocumentFile(flags.genesisDocument);
+    resolutionOptions = {
+      ...(resolutionOptions ?? {}),
+      sidecar : { ...(resolutionOptions?.sidecar ?? {}), genesisDocument },
+    };
+  }
   return resolutionOptions;
 }
 

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { BroadcastOptions, DidUpdateResult, PublishToCasMode, Signer } from '@did-btcr2/api';
+import type { BeaconInfo, 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';
@@ -54,11 +54,43 @@ export interface UpdateCommandOptions {
   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;
+}
+
+/**
+ * The data that `genesis build` prints: the external identifier, its
+ * network, its genesis bytes as hex, the path of the written genesis
+ * document, and the beacons of the initial DID document with their
+ * addresses to fund.
+ */
+export interface GenesisBuildData {
+  did          : string;
+  network      : NetworkOption;
+  genesisBytes : string;
+  path         : string;
+  beacons      : BeaconInfo[];
+}
+
 export type CommandResult =
-  | { action: 'create'; data: string; keyId?: string; publicKey?: string }
+  | { action: 'create'; data: string; keyId?: string; publicKey?: string; genesisBytes?: string }
   | { action: 'resolve'; data: DidResolutionResult }
   | { action: 'update'; data: DidUpdateResult }
   | { action: 'deactivate'; data: DidUpdateResult }
+  | { action: 'identifier-decode'; data: IdentifierDecodeData }
+  | { action: 'identifier-validate'; data: IdentifierReport }
+  | { action: 'genesis-build'; data: GenesisBuildData }
   | { action: 'key-generate'; data: { keyId: string; publicKey: string; active: boolean } }
   | { action: 'key-list'; data: Array<{ keyId: string; fingerprint: string; name?: string; active: boolean }> }
   | { action: 'key-show'; data: { keyId: string; publicKey: string; tags?: Record<string, string> } }