@cogcoin/client 0.5.0

package/dist/cli/prompt.js

@@ -0,0 +1,33 @@
+import { createInterface } from "node:readline/promises";
+const CLEAR_SENSITIVE_DISPLAY_SEQUENCE = "\u001B[2J\u001B[3J\u001B[H";
+export function createTerminalPrompter(input, output) {
+    return {
+        isInteractive: Boolean(input.isTTY && output.isTTY),
+        writeLine(message) {
+            output.write(`${message}\n`);
+        },
+        async prompt(message) {
+            if (!("on" in input) || !("off" in input)) {
+                throw new Error("wallet_prompt_input_unavailable");
+            }
+            const readline = createInterface({
+                input: input,
+                output: output,
+            });
+            try {
+                return await readline.question(message);
+            }
+            finally {
+                readline.close();
+            }
+        },
+        clearSensitiveDisplay(scope) {
+            if (!input.isTTY || !output.isTTY) {
+                return;
+            }
+            if (scope === "mnemonic-reveal") {
+                output.write(CLEAR_SENSITIVE_DISPLAY_SEQUENCE);
+            }
+        },
+    };
+}

package/dist/cli/read-json.d.ts

@@ -0,0 +1,187 @@
+import type { WalletDomainView, WalletFieldView, WalletIdentityView, WalletLockView, WalletReadContext } from "../wallet/read/index.js";
+import type { MiningControlPlaneView, MiningEventRecord } from "../wallet/mining/index.js";
+import type { PendingMutationRecord } from "../wallet/types.js";
+import type { JsonAvailabilityEntry, JsonPage } from "./output.js";
+export interface ReadJsonResult<T> {
+    data: T;
+    warnings: string[];
+    explanations: string[];
+    nextSteps: string[];
+}
+export declare function buildAvailability(context: WalletReadContext): Record<string, JsonAvailabilityEntry>;
+declare function mapIdentity(identity: WalletIdentityView): {
+    index: number;
+    scriptPubKeyHex: string;
+    address: string | null;
+    selectors: string[];
+    assignedDomainNames: string[];
+    ownedDomainNames: string[];
+    anchoredOwnedDomainNames: string[];
+    localStatus: "funding" | "dedicated" | "read-only";
+    effectiveStatus: "funding" | "dedicated" | "read-only";
+    canonicalDomainId: number | null;
+    canonicalDomainName: string | null;
+    observedCogBalance: string | null;
+    readOnly: boolean;
+};
+declare function mapDomain(domain: WalletDomainView): {
+    name: string;
+    domainId: number | null;
+    anchored: boolean | null;
+    ownerScriptPubKeyHex: string | null;
+    ownerLocalIndex: number | null;
+    ownerAddress: string | null;
+    localRelationship: "unknown" | "read-only" | "owned" | "tracked" | "external";
+    chainStatus: "unknown" | "registered-unanchored" | "anchored";
+    localAnchorIntent: "none" | "repair-required" | "reserved" | "tx1-live" | "tx2-live" | null;
+    foundingMessageText: string | null;
+    endpointText: string | null;
+    delegateScriptPubKeyHex: string | null;
+    minerScriptPubKeyHex: string | null;
+    fieldCount: number | null;
+    listingPriceCogtoshi: string | null;
+    activeLockCount: number | null;
+    selfStakeCogtoshi: string | null;
+    supportedStakeCogtoshi: string | null;
+    totalSupportedCogtoshi: string | null;
+    totalRevokedCogtoshi: string | null;
+    readOnly: boolean;
+};
+declare function mapField(field: WalletFieldView): {
+    domainName: string;
+    domainId: number;
+    fieldId: number;
+    name: string;
+    permanent: boolean;
+    hasValue: boolean;
+    format: number | null;
+    preview: string | null;
+    rawValueHex: string | null;
+};
+declare function mapLock(lock: WalletLockView): {
+    lockId: number;
+    status: "active" | "claimed" | "reclaimed";
+    amountCogtoshi: string;
+    timeoutHeight: number;
+    lockerScriptPubKeyHex: string;
+    lockerLocalIndex: number | null;
+    recipientDomainId: number;
+    recipientDomainName: string | null;
+    recipientLocal: boolean;
+    claimableNow: boolean;
+    reclaimableNow: boolean;
+};
+declare function mapPendingMutation(mutation: PendingMutationRecord): {
+    kind: "register" | "transfer" | "sell" | "buy" | "rep-give" | "rep-revoke" | "send" | "lock" | "claim" | "field-create" | "field-set" | "field-clear" | "endpoint" | "delegate" | "miner" | "canonical";
+    domainName: string;
+    recipientDomainName: string | null;
+    fieldName: string | null;
+    status: import("../wallet/types.js").PendingMutationStatus;
+    senderScriptPubKeyHex: string;
+    recipientScriptPubKeyHex: string | null;
+    amountCogtoshi: string | null;
+    priceCogtoshi: string | null;
+    lockId: number | null;
+    txid: string | null;
+    wtxid: string | null;
+    reviewPresent: boolean;
+};
+export declare function buildStatusJson(context: WalletReadContext): ReadJsonResult<{
+    wallet: Record<string, unknown>;
+    btc: Record<string, unknown>;
+    cog: Record<string, unknown>;
+    domains: Record<string, unknown>;
+    mining: Record<string, unknown> | null;
+    hooks: Record<string, unknown> | null;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildAddressJson(context: WalletReadContext): ReadJsonResult<{
+    address: string | null;
+    scriptPubKeyHex: string | null;
+    network: string | null;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildIdsJson(context: WalletReadContext, page: JsonPage, identities: WalletIdentityView[]): ReadJsonResult<{
+    identities: ReturnType<typeof mapIdentity>[] | null;
+    page: JsonPage;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildWalletStatusJson(context: WalletReadContext): ReadJsonResult<{
+    lockState: string;
+    unlockUntilUnixMs: number | null;
+    fundingAddress: string | null;
+    fundingScriptPubKeyHex: string | null;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildHooksStatusJson(mining: MiningControlPlaneView): ReadJsonResult<{
+    mode: string;
+    validationState: string;
+    operatorValidationState: string;
+    launchFingerprintState: string;
+    fullFingerprintState: string;
+    lastValidationAtUnixMs: number | null;
+    lastValidationError: string | null;
+    trustChecks: Record<string, unknown>;
+}>;
+export declare function buildMineStatusJson(mining: MiningControlPlaneView): ReadJsonResult<{
+    runMode: string;
+    state: string;
+    tipHeight: number | null;
+    referencedBlockHashDisplay: string | null;
+    currentDomain: {
+        domainId: number | null;
+        name: string | null;
+    } | null;
+    liveMiningFamilyInMempool: boolean | null;
+    publishDecision: string | null;
+    phase: string;
+    lastSuspendDetectedAtUnixMs: number | null;
+    pauseReason: string | null;
+    fees: Record<string, unknown>;
+    worker: Record<string, unknown>;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildMineLogJson(events: MiningEventRecord[], page: JsonPage, rotation: number[]): ReadJsonResult<{
+    events: MiningEventRecord[];
+    truncated: boolean;
+    rotation: number[];
+    page: JsonPage;
+}>;
+export declare function buildBalanceJson(context: WalletReadContext): ReadJsonResult<{
+    assetLabel: string;
+    totalCogtoshi: string | null;
+    identities: ReturnType<typeof mapIdentity>[] | null;
+    pending: ReturnType<typeof mapPendingMutation>[];
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildLocksJson(context: WalletReadContext, locks: WalletLockView[] | null, page: JsonPage): ReadJsonResult<{
+    assetLabel: string;
+    locks: ReturnType<typeof mapLock>[] | null;
+    pending: ReturnType<typeof mapPendingMutation>[];
+    page: JsonPage;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildDomainsJson(context: WalletReadContext, domains: WalletDomainView[] | null, page: JsonPage): ReadJsonResult<{
+    domains: ReturnType<typeof mapDomain>[] | null;
+    page: JsonPage;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildShowJson(context: WalletReadContext, domainName: string): ReadJsonResult<{
+    domain: Record<string, unknown> | null;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildFieldsJson(context: WalletReadContext, domainName: string, fields: WalletFieldView[] | null, page: JsonPage): ReadJsonResult<{
+    fields: ReturnType<typeof mapField>[] | null;
+    page: JsonPage;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function buildFieldJson(context: WalletReadContext, domainName: string, fieldName: string): ReadJsonResult<{
+    field: ReturnType<typeof mapField> | null;
+    availability: Record<string, JsonAvailabilityEntry>;
+}>;
+export declare function listLocksForJson(context: WalletReadContext, options: {
+    claimableOnly: boolean;
+    reclaimableOnly: boolean;
+}): WalletLockView[] | null;
+export declare function listFieldsForJson(context: WalletReadContext, domainName: string): WalletFieldView[] | null;
+export {};