@cogcoin/client 1.1.8 → 1.1.10

package/dist/cli/wallet-format/locks.js

@@ -0,0 +1,52 @@
+import { listWalletLocks } from "../../wallet/read/index.js";
+import { appendWalletAvailability } from "./availability.js";
+import { formatCogAmount, formatServiceHealth } from "./shared.js";
+export function formatLocksReport(context, options = {}) {
+    const lines = ["COG Locks"];
+    if (context.model === null) {
+        appendWalletAvailability(lines, context);
+        return lines.join("\n");
+    }
+    const locks = listWalletLocks(context);
+    if (locks === null) {
+        lines.push(`Lock state is unavailable while the indexer is ${formatServiceHealth(context.indexer.health)}.`);
+        return lines.join("\n");
+    }
+    let filteredLocks = locks;
+    if (options.claimableOnly) {
+        filteredLocks = filteredLocks.filter((lock) => lock.claimableNow);
+    }
+    else if (options.reclaimableOnly) {
+        filteredLocks = filteredLocks.filter((lock) => lock.reclaimableNow);
+    }
+    const totalMatching = filteredLocks.length;
+    if (!options.all && options.limit !== null && options.limit !== undefined) {
+        filteredLocks = filteredLocks.slice(0, options.limit);
+    }
+    if (filteredLocks.length === 0) {
+        lines.push("No locally related active locks.");
+        return lines.join("\n");
+    }
+    for (const lock of filteredLocks) {
+        const role = lock.lockerLocalIndex !== null ? `locker ${lock.lockerLocalIndex}` : "recipient";
+        const action = lock.claimableNow
+            ? "claimable-now"
+            : lock.reclaimableNow
+                ? "reclaimable-now"
+                : "not-actionable-now";
+        lines.push(`lock:${lock.lockId}  ${formatCogAmount(lock.amountCogtoshi)}  timeout ${lock.timeoutHeight}  domain ${lock.recipientDomainName ?? lock.recipientDomainId}  ${role}  ${action}`);
+    }
+    for (const mutation of (context.localState.state?.pendingMutations ?? [])
+        .filter((entry) => (entry.kind === "lock" || entry.kind === "claim")
+        && entry.status !== "confirmed"
+        && entry.status !== "canceled")) {
+        const label = mutation.kind === "claim" && mutation.preimageHex === "0000000000000000000000000000000000000000000000000000000000000000"
+            ? "reclaim"
+            : mutation.kind;
+        lines.push(`Pending: ${label}  ${mutation.status}${mutation.lockId === null || mutation.lockId === undefined ? "" : `  lock:${mutation.lockId}`}${mutation.recipientDomainName === null || mutation.recipientDomainName === undefined ? "" : `  domain ${mutation.recipientDomainName}`}`);
+    }
+    if (!options.all && options.limit !== null && options.limit !== undefined && totalMatching > options.limit) {
+        lines.push(`Showing first ${filteredLocks.length} of ${totalMatching}. Use --limit <n> or --all for more.`);
+    }
+    return lines.join("\n");
+}

package/dist/cli/wallet-format/overview.d.ts

@@ -0,0 +1,2 @@
+import type { WalletReadContext } from "../../wallet/read/index.js";
+export declare function formatWalletOverviewReport(context: WalletReadContext, version: string): string;

package/dist/cli/wallet-format/overview.js

@@ -0,0 +1,122 @@
+import { formatMiningSummaryLine } from "../mining-format.js";
+import { getOverviewNextStep, resolveWalletRootLabel } from "./availability.js";
+import { formatIndexerTruthSource, formatMaybe, formatServiceHealth, } from "./shared.js";
+import { formatPendingMutationSummaryLabel, isReputationMutation, } from "./pending.js";
+import { formatCogAmount } from "./shared.js";
+import { formatFieldFormat } from "../../wallet/read/index.js";
+function overviewEntry(text, ok) {
+    return { text, ok };
+}
+function formatOverviewSection(header, entries) {
+    return [header, ...entries.map((entry) => `${entry.ok ? "✓" : "✗"} ${entry.text}`)].join("\n");
+}
+function isMiningOverviewOk(mining) {
+    return mining.runtime.bitcoindHealth === "ready"
+        && mining.runtime.nodeHealth === "synced"
+        && mining.runtime.indexerHealth === "synced"
+        && mining.runtime.miningState !== "repair-required"
+        && mining.runtime.miningState !== "paused-stale"
+        && !(mining.runtime.miningState === "paused" && mining.runtime.livePublishInMempool === true);
+}
+function buildOverviewPathsSection(context) {
+    return [
+        overviewEntry(`DB path: ${context.databasePath}`, true),
+        overviewEntry(`Bitcoin datadir: ${context.dataDir}`, true),
+    ];
+}
+function buildOverviewWalletSection(context) {
+    const lines = [
+        overviewEntry(`State: ${context.localState.availability}`, context.localState.availability === "ready"),
+        overviewEntry(`Root: ${resolveWalletRootLabel(context)}`, resolveWalletRootLabel(context) !== "none"),
+    ];
+    if (context.localState.message !== null) {
+        lines.push(overviewEntry(`Note: ${context.localState.message}`, false));
+    }
+    const nodeStatus = context.nodeStatus;
+    const replica = nodeStatus?.walletReplica ?? null;
+    if (replica !== null) {
+        lines.push(overviewEntry(`Managed Core wallet: ${replica.proofStatus ?? "not-proven"}`, replica.proofStatus === "ready"));
+    }
+    if (nodeStatus?.walletReplicaMessage) {
+        lines.push(overviewEntry(`Managed Core note: ${nodeStatus.walletReplicaMessage}`, replica?.proofStatus === "ready"));
+    }
+    return lines;
+}
+function buildOverviewServicesSection(context) {
+    const bitcoindOk = context.bitcoind.health === "ready";
+    const nodeOk = context.nodeHealth === "synced";
+    const indexerOk = context.indexer.health === "synced";
+    const lines = [
+        overviewEntry(`Managed bitcoind: ${formatServiceHealth(context.bitcoind.health)}`, bitcoindOk),
+    ];
+    if (context.bitcoind.message !== null) {
+        lines.push(overviewEntry(`Managed bitcoind note: ${context.bitcoind.message}`, bitcoindOk));
+    }
+    lines.push(overviewEntry(`Bitcoin service: ${formatServiceHealth(context.nodeHealth)}`, nodeOk));
+    if (context.nodeStatus !== null) {
+        lines.push(overviewEntry(`Bitcoin best height: ${formatMaybe(context.nodeStatus.nodeBestHeight)}`, nodeOk));
+        lines.push(overviewEntry(`Bitcoin headers: ${formatMaybe(context.nodeStatus.nodeHeaderHeight)}`, nodeOk));
+    }
+    if (context.nodeMessage !== null) {
+        lines.push(overviewEntry(`Bitcoin note: ${context.nodeMessage}`, nodeOk));
+    }
+    lines.push(overviewEntry(`Indexer service: ${formatServiceHealth(context.indexer.health)}`, indexerOk));
+    lines.push(overviewEntry(`Indexer truth source: ${formatIndexerTruthSource(context.indexer.source)}`, indexerOk));
+    if (context.indexer.daemonInstanceId !== null && context.indexer.daemonInstanceId !== undefined) {
+        lines.push(overviewEntry(`Indexer daemon instance: ${context.indexer.daemonInstanceId}`, indexerOk));
+    }
+    if (context.indexer.snapshotSeq !== null && context.indexer.snapshotSeq !== undefined) {
+        lines.push(overviewEntry(`Indexer snapshot sequence: ${context.indexer.snapshotSeq}`, indexerOk));
+    }
+    if (context.indexer.status?.reorgDepth !== null && context.indexer.status?.reorgDepth !== undefined) {
+        lines.push(overviewEntry(`Indexer reorg depth: ${context.indexer.status.reorgDepth}`, indexerOk));
+    }
+    lines.push(overviewEntry(`Indexer tip height: ${context.indexer.snapshotTip === null ? "unavailable" : context.indexer.snapshotTip.height}`, indexerOk));
+    if (context.indexer.message !== null) {
+        lines.push(overviewEntry(`Indexer note: ${context.indexer.message}`, indexerOk));
+    }
+    if (context.mining !== undefined) {
+        const miningOk = isMiningOverviewOk(context.mining);
+        lines.push(overviewEntry(`Mining: ${formatMiningSummaryLine(context.mining)}`, miningOk));
+        if (context.mining.runtime.note !== null) {
+            lines.push(overviewEntry(`Mining note: ${context.mining.runtime.note}`, miningOk));
+        }
+    }
+    return lines;
+}
+function buildOverviewLocalInventorySection(context) {
+    if (context.model === null) {
+        return [overviewEntry("Status: Wallet-derived sections unavailable", false)];
+    }
+    return [
+        overviewEntry("Local wallet address: 1", true),
+        overviewEntry(`Locally related domains: ${context.model.domains.length}`, true),
+    ];
+}
+function buildOverviewPendingWorkSection(context) {
+    const pendingMutations = (context.localState.state?.pendingMutations ?? [])
+        .filter((mutation) => mutation.status !== "confirmed" && mutation.status !== "canceled");
+    if (pendingMutations.length === 0) {
+        return [overviewEntry("Status: none", true)];
+    }
+    const lines = [];
+    for (const mutation of pendingMutations) {
+        lines.push(overviewEntry(`Mutation: ${formatPendingMutationSummaryLabel(mutation)}  ${mutation.status}  sender spk:${mutation.senderScriptPubKeyHex}${mutation.priceCogtoshi === undefined || mutation.priceCogtoshi === null ? "" : `  price ${formatCogAmount(mutation.priceCogtoshi)}`}${mutation.amountCogtoshi === undefined || mutation.amountCogtoshi === null ? "" : `  amount ${formatCogAmount(mutation.amountCogtoshi)}`}${isReputationMutation(mutation) ? "" : mutation.recipientDomainName === undefined || mutation.recipientDomainName === null ? "" : `  domain ${mutation.recipientDomainName}`}${mutation.lockId === undefined || mutation.lockId === null ? "" : `  lock ${mutation.lockId}`}${mutation.recipientScriptPubKeyHex === undefined || mutation.recipientScriptPubKeyHex === null ? "" : `  recipient spk:${mutation.recipientScriptPubKeyHex}`}${mutation.kind === "endpoint" ? (mutation.endpointValueHex === "" ? "  endpoint clear" : `  endpoint-bytes ${(mutation.endpointValueHex?.length ?? 0) / 2}`) : ""}${mutation.kind === "field-create" || mutation.kind === "field-set" ? `  format ${formatFieldFormat(mutation.fieldFormat ?? 0)}` : ""}${mutation.kind === "field-clear" ? "  clear" : ""}${mutation.reviewPayloadHex === undefined || mutation.reviewPayloadHex === null ? "" : "  review"}`, false));
+    }
+    return lines;
+}
+export function formatWalletOverviewReport(context, version) {
+    const parts = [
+        `\n⛭ Cogcoin Status v${version} ⛭`,
+        formatOverviewSection("Paths", buildOverviewPathsSection(context)),
+        formatOverviewSection("Wallet", buildOverviewWalletSection(context)),
+        formatOverviewSection("Services", buildOverviewServicesSection(context)),
+        formatOverviewSection("Local Inventory", buildOverviewLocalInventorySection(context)),
+        formatOverviewSection("Pending Work", buildOverviewPendingWorkSection(context)),
+    ];
+    const nextStep = getOverviewNextStep(context);
+    if (nextStep !== null) {
+        parts.push(`Next step: ${nextStep}`);
+    }
+    return parts.join("\n\n");
+}

package/dist/cli/wallet-format/pending.d.ts

@@ -0,0 +1,13 @@
+import type { WalletReadContext } from "../../wallet/read/index.js";
+import type { PendingMutationRecord } from "../../wallet/types.js";
+export declare function isReputationMutation(mutation: PendingMutationRecord): mutation is PendingMutationRecord & {
+    kind: "rep-give" | "rep-revoke";
+    recipientDomainName: string;
+};
+export declare function formatPendingMutationKind(mutation: PendingMutationRecord): string;
+export declare function formatPendingMutationSummaryLabel(mutation: PendingMutationRecord): string;
+export declare function formatPendingMutationDomainLabel(mutation: PendingMutationRecord): string;
+export declare function appendPendingMutationSummary(lines: string[], context: WalletReadContext): void;
+export declare function listPendingDomainMutations(context: WalletReadContext, domainName: string): PendingMutationRecord[];
+export declare function listPendingDomainShowMutations(context: WalletReadContext, domainName: string): PendingMutationRecord[];
+export declare function listPendingFieldMutations(context: WalletReadContext, domainName: string, fieldName?: string): PendingMutationRecord[];

package/dist/cli/wallet-format/pending.js

@@ -0,0 +1,101 @@
+import { formatFieldFormat } from "../../wallet/read/index.js";
+import { formatCogAmount } from "./shared.js";
+export function isReputationMutation(mutation) {
+    return (mutation.kind === "rep-give" || mutation.kind === "rep-revoke")
+        && mutation.recipientDomainName !== undefined
+        && mutation.recipientDomainName !== null;
+}
+export function formatPendingMutationKind(mutation) {
+    if (mutation.kind === "sell" && mutation.priceCogtoshi === 0n) {
+        return "unsell";
+    }
+    if (mutation.kind === "claim" && mutation.preimageHex === "0000000000000000000000000000000000000000000000000000000000000000") {
+        return "reclaim";
+    }
+    if (mutation.kind === "endpoint" && mutation.endpointValueHex === "") {
+        return "endpoint-clear";
+    }
+    if (mutation.kind === "delegate" && mutation.recipientScriptPubKeyHex === null) {
+        return "delegate-clear";
+    }
+    if (mutation.kind === "miner" && mutation.recipientScriptPubKeyHex === null) {
+        return "miner-clear";
+    }
+    return mutation.kind;
+}
+export function formatPendingMutationSummaryLabel(mutation) {
+    if (isReputationMutation(mutation)) {
+        return `${formatPendingMutationKind(mutation)} ${mutation.domainName}->${mutation.recipientDomainName}`;
+    }
+    return `${formatPendingMutationKind(mutation)}${mutation.domainName === "" ? "" : ` ${mutation.domainName}`}${mutation.fieldName == null ? "" : `.${mutation.fieldName}`}`;
+}
+export function formatPendingMutationDomainLabel(mutation) {
+    if (isReputationMutation(mutation)) {
+        return `${formatPendingMutationKind(mutation)} ${mutation.domainName}->${mutation.recipientDomainName}`;
+    }
+    const kind = mutation.kind === "endpoint" && mutation.endpointValueHex === ""
+        ? "endpoint-clear"
+        : mutation.kind === "delegate" && mutation.recipientScriptPubKeyHex === null
+            ? "delegate-clear"
+            : mutation.kind === "miner" && mutation.recipientScriptPubKeyHex === null
+                ? "miner-clear"
+                : formatPendingMutationKind(mutation);
+    return kind;
+}
+export function appendPendingMutationSummary(lines, context) {
+    const pendingMutations = (context.localState.state?.pendingMutations ?? [])
+        .filter((mutation) => mutation.status !== "confirmed" && mutation.status !== "canceled");
+    if (pendingMutations.length === 0) {
+        lines.push("Pending mutations: none");
+        return;
+    }
+    for (const mutation of pendingMutations) {
+        lines.push(`Pending mutation: ${formatPendingMutationSummaryLabel(mutation)}  ${mutation.status}  sender spk:${mutation.senderScriptPubKeyHex}${mutation.priceCogtoshi === undefined || mutation.priceCogtoshi === null ? "" : `  price ${formatCogAmount(mutation.priceCogtoshi)}`}${mutation.amountCogtoshi === undefined || mutation.amountCogtoshi === null ? "" : `  amount ${formatCogAmount(mutation.amountCogtoshi)}`}${isReputationMutation(mutation) ? "" : mutation.recipientDomainName === undefined || mutation.recipientDomainName === null ? "" : `  domain ${mutation.recipientDomainName}`}${mutation.lockId === undefined || mutation.lockId === null ? "" : `  lock ${mutation.lockId}`}${mutation.recipientScriptPubKeyHex === undefined || mutation.recipientScriptPubKeyHex === null ? "" : `  recipient spk:${mutation.recipientScriptPubKeyHex}`}${mutation.kind === "endpoint" ? (mutation.endpointValueHex === "" ? "  endpoint clear" : `  endpoint-bytes ${(mutation.endpointValueHex?.length ?? 0) / 2}`) : ""}${mutation.kind === "field-create" || mutation.kind === "field-set" ? `  format ${formatFieldFormat(mutation.fieldFormat ?? 0)}` : ""}${mutation.kind === "field-clear" ? "  clear" : ""}${mutation.reviewPayloadHex === undefined || mutation.reviewPayloadHex === null ? "" : "  review"}`);
+    }
+}
+export function listPendingDomainMutations(context, domainName) {
+    return (context.localState.state?.pendingMutations ?? [])
+        .filter((mutation) => (mutation.kind === "register"
+        || mutation.kind === "transfer"
+        || mutation.kind === "sell"
+        || mutation.kind === "buy"
+        || mutation.kind === "anchor"
+        || mutation.kind === "endpoint"
+        || mutation.kind === "delegate"
+        || mutation.kind === "miner"
+        || mutation.kind === "canonical"
+        || mutation.kind === "field-create"
+        || mutation.kind === "field-set"
+        || mutation.kind === "field-clear")
+        && mutation.domainName === domainName
+        && mutation.status !== "confirmed"
+        && mutation.status !== "canceled");
+}
+export function listPendingDomainShowMutations(context, domainName) {
+    return (context.localState.state?.pendingMutations ?? [])
+        .filter((mutation) => (mutation.kind === "register"
+        || mutation.kind === "transfer"
+        || mutation.kind === "sell"
+        || mutation.kind === "buy"
+        || mutation.kind === "anchor"
+        || mutation.kind === "endpoint"
+        || mutation.kind === "delegate"
+        || mutation.kind === "miner"
+        || mutation.kind === "canonical"
+        || mutation.kind === "field-create"
+        || mutation.kind === "field-set"
+        || mutation.kind === "field-clear"
+        || mutation.kind === "rep-give"
+        || mutation.kind === "rep-revoke")
+        && (mutation.domainName === domainName || mutation.recipientDomainName === domainName)
+        && mutation.status !== "confirmed"
+        && mutation.status !== "canceled");
+}
+export function listPendingFieldMutations(context, domainName, fieldName) {
+    return (context.localState.state?.pendingMutations ?? [])
+        .filter((mutation) => (mutation.kind === "field-create" || mutation.kind === "field-set" || mutation.kind === "field-clear")
+        && mutation.domainName === domainName
+        && (fieldName === undefined || mutation.fieldName === fieldName)
+        && mutation.status !== "confirmed"
+        && mutation.status !== "canceled");
+}

package/dist/cli/wallet-format/shared.d.ts

@@ -0,0 +1,7 @@
+import type { WalletReadContext } from "../../wallet/read/index.js";
+export declare function formatUnitAmount(value: bigint, unit: string): string;
+export declare function formatCogAmount(value: bigint): string;
+export declare function formatBitcoinAmount(value: bigint | null): string;
+export declare function formatServiceHealth(health: string): string;
+export declare function formatMaybe(value: string | number | null): string;
+export declare function formatIndexerTruthSource(source: WalletReadContext["indexer"]["source"]): string;

package/dist/cli/wallet-format/shared.js

@@ -0,0 +1,31 @@
+export function formatUnitAmount(value, unit) {
+    const sign = value < 0n ? "-" : "";
+    const absolute = value < 0n ? -value : value;
+    const whole = absolute / 100000000n;
+    const fraction = absolute % 100000000n;
+    return `${sign}${whole.toString()}.${fraction.toString().padStart(8, "0")} ${unit}`;
+}
+export function formatCogAmount(value) {
+    return formatUnitAmount(value, "COG");
+}
+export function formatBitcoinAmount(value) {
+    return value === null ? "unavailable BTC" : formatUnitAmount(value, "BTC");
+}
+export function formatServiceHealth(health) {
+    return health.replaceAll("-", " ");
+}
+export function formatMaybe(value) {
+    return value === null ? "unavailable" : String(value);
+}
+export function formatIndexerTruthSource(source) {
+    switch (source) {
+        case "lease":
+            return "coherent snapshot lease";
+        case "probe":
+            return "live daemon probe";
+        case "status-file":
+            return "advisory status file";
+        default:
+            return "none";
+    }
+}

package/dist/cli/wallet-format/status.d.ts

@@ -0,0 +1,3 @@
+import type { WalletReadContext } from "../../wallet/read/index.js";
+export declare function formatDetailedWalletStatusReport(context: WalletReadContext): string;
+export declare function formatFundingAddressReport(context: WalletReadContext): string;

package/dist/cli/wallet-format/status.js

@@ -0,0 +1,27 @@
+import { appendServiceSummary, appendWalletAvailability } from "./availability.js";
+import { appendPendingMutationSummary } from "./pending.js";
+export function formatDetailedWalletStatusReport(context) {
+    const lines = ["Cogcoin Wallet Status"];
+    appendWalletAvailability(lines, context);
+    appendServiceSummary(lines, context);
+    if (context.model === null) {
+        lines.push("Wallet details are unavailable until the encrypted wallet state can be read.");
+        return lines.join("\n");
+    }
+    lines.push(`Wallet address: ${context.model.walletAddress ?? "unavailable"}`);
+    lines.push(`Wallet script: spk:${context.model.walletScriptPubKeyHex ?? "unavailable"}`);
+    lines.push("Local wallet addresses: 1");
+    lines.push(`Locally related domains: ${context.model.domains.length}`);
+    appendPendingMutationSummary(lines, context);
+    return lines.join("\n");
+}
+export function formatFundingAddressReport(context) {
+    const lines = ["BTC Wallet Address"];
+    if (context.model === null) {
+        appendWalletAvailability(lines, context);
+        return lines.join("\n");
+    }
+    lines.push(`Address: ${context.model.walletAddress ?? "unavailable"}`);
+    lines.push(`ScriptPubKey: spk:${context.model.walletScriptPubKeyHex}`);
+    return lines.join("\n");
+}

package/dist/cli/wallet-format.d.ts

@@ -1,30 +1,8 @@
-import type { WalletDomainView, WalletReadContext } from "../wallet/read/index.js";
-export declare function getRepairRecommendation(context: WalletReadContext): string | null;
-export declare function getClientUnlockRecommendation(context: WalletReadContext): string | null;
-export declare function getMutationRecommendation(context: WalletReadContext): string | null;
-export declare function formatWalletOverviewReport(context: WalletReadContext, version: string): string;
-export declare function formatDetailedWalletStatusReport(context: WalletReadContext): string;
-export declare function formatFundingAddressReport(context: WalletReadContext): string;
-export declare function formatIdentityListReport(context: WalletReadContext, options?: {
-    limit?: number | null;
-    all?: boolean;
-}): string;
-export declare function formatBalanceReport(context: WalletReadContext): string;
-export declare function formatLocksReport(context: WalletReadContext, options?: {
-    claimableOnly?: boolean;
-    reclaimableOnly?: boolean;
-    limit?: number | null;
-    all?: boolean;
-}): string;
-export declare function formatDomainsReport(context: WalletReadContext, options?: {
-    limit?: number | null;
-    all?: boolean;
-    domains?: WalletDomainView[] | null;
-    activeFilters?: string[];
-}): string;
-export declare function formatDomainReport(context: WalletReadContext, domainName: string): string;
-export declare function formatFieldsReport(context: WalletReadContext, domainName: string, options?: {
-    limit?: number | null;
-    all?: boolean;
-}): string;
-export declare function formatFieldReport(context: WalletReadContext, domainName: string, fieldName: string): string;
+export { getClientUnlockRecommendation, getMutationRecommendation, getRepairRecommendation, } from "./recommendations.js";
+export { formatWalletOverviewReport } from "./wallet-format/overview.js";
+export { formatDetailedWalletStatusReport, formatFundingAddressReport, } from "./wallet-format/status.js";
+export { formatBalanceReport } from "./wallet-format/balance.js";
+export { formatIdentityListReport } from "./wallet-format/identity.js";
+export { formatLocksReport } from "./wallet-format/locks.js";
+export { formatDomainsReport, formatDomainReport, } from "./wallet-format/domains.js";
+export { formatFieldsReport, formatFieldReport, } from "./wallet-format/fields.js";