@cogcoin/client 0.5.0

package/dist/cli/mutation-command-groups.d.ts

@@ -0,0 +1,15 @@
+import type { CommandName } from "./types.js";
+export declare const walletMutationCommands: readonly ["anchor", "domain-anchor", "register", "domain-register", "transfer", "domain-transfer", "sell", "domain-sell", "unsell", "domain-unsell", "buy", "domain-buy", "domain-endpoint-set", "domain-endpoint-clear", "domain-delegate-set", "domain-delegate-clear", "domain-miner-set", "domain-miner-clear", "domain-canonical", "field-create", "field-set", "field-clear", "send", "cog-send", "claim", "cog-claim", "reclaim", "cog-reclaim", "cog-lock", "rep-give", "rep-revoke"];
+export type WalletMutationCommand = (typeof walletMutationCommands)[number];
+export declare function isWalletMutationCommand(command: CommandName | null): command is WalletMutationCommand;
+export declare function isAnchorMutationCommand(command: CommandName | null): command is "anchor" | "domain-anchor";
+export declare function isRegisterMutationCommand(command: CommandName | null): command is "register" | "domain-register";
+export declare function isTransferMutationCommand(command: CommandName | null): command is "transfer" | "domain-transfer";
+export declare function isSellMutationCommand(command: CommandName | null): command is "sell" | "domain-sell";
+export declare function isUnsellMutationCommand(command: CommandName | null): command is "unsell" | "domain-unsell";
+export declare function isSellOrUnsellMutationCommand(command: CommandName | null): command is "sell" | "domain-sell" | "unsell" | "domain-unsell";
+export declare function isBuyMutationCommand(command: CommandName | null): command is "buy" | "domain-buy";
+export declare function isSendMutationCommand(command: CommandName | null): command is "send" | "cog-send";
+export declare function isClaimMutationCommand(command: CommandName | null): command is "claim" | "cog-claim";
+export declare function isReclaimMutationCommand(command: CommandName | null): command is "reclaim" | "cog-reclaim";
+export declare function isReputationMutationCommand(command: CommandName | null): command is "rep-give" | "rep-revoke";

package/dist/cli/mutation-command-groups.js

@@ -0,0 +1,71 @@
+export const walletMutationCommands = [
+    "anchor",
+    "domain-anchor",
+    "register",
+    "domain-register",
+    "transfer",
+    "domain-transfer",
+    "sell",
+    "domain-sell",
+    "unsell",
+    "domain-unsell",
+    "buy",
+    "domain-buy",
+    "domain-endpoint-set",
+    "domain-endpoint-clear",
+    "domain-delegate-set",
+    "domain-delegate-clear",
+    "domain-miner-set",
+    "domain-miner-clear",
+    "domain-canonical",
+    "field-create",
+    "field-set",
+    "field-clear",
+    "send",
+    "cog-send",
+    "claim",
+    "cog-claim",
+    "reclaim",
+    "cog-reclaim",
+    "cog-lock",
+    "rep-give",
+    "rep-revoke",
+];
+const walletMutationCommandSet = new Set(walletMutationCommands);
+export function isWalletMutationCommand(command) {
+    return command !== null
+        && walletMutationCommandSet.has(command);
+}
+export function isAnchorMutationCommand(command) {
+    return command === "anchor" || command === "domain-anchor";
+}
+export function isRegisterMutationCommand(command) {
+    return command === "register" || command === "domain-register";
+}
+export function isTransferMutationCommand(command) {
+    return command === "transfer" || command === "domain-transfer";
+}
+export function isSellMutationCommand(command) {
+    return command === "sell" || command === "domain-sell";
+}
+export function isUnsellMutationCommand(command) {
+    return command === "unsell" || command === "domain-unsell";
+}
+export function isSellOrUnsellMutationCommand(command) {
+    return isSellMutationCommand(command) || isUnsellMutationCommand(command);
+}
+export function isBuyMutationCommand(command) {
+    return command === "buy" || command === "domain-buy";
+}
+export function isSendMutationCommand(command) {
+    return command === "send" || command === "cog-send";
+}
+export function isClaimMutationCommand(command) {
+    return command === "claim" || command === "cog-claim";
+}
+export function isReclaimMutationCommand(command) {
+    return command === "reclaim" || command === "cog-reclaim";
+}
+export function isReputationMutationCommand(command) {
+    return command === "rep-give" || command === "rep-revoke";
+}

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

@@ -0,0 +1,430 @@
+import type { AnchorDomainResult, CogMutationResult, DomainAdminMutationResult, DomainMarketMutationResult, FieldMutationResult, RegisterDomainResult, ReputationMutationResult } from "../wallet/tx/index.js";
+import type { WalletInitializationResult, WalletExportResult, WalletImportResult, WalletRepairResult, WalletUnlockResult } from "../wallet/lifecycle.js";
+export declare function buildSingleTxMutationData(options: {
+    kind: string;
+    localStatus: string;
+    txid: string | null | undefined;
+    wtxid?: string | null | undefined;
+    reusedExisting: boolean;
+    intent: Record<string, unknown>;
+    journalKind?: string | null;
+    intentFingerprintHex?: string | null;
+}): {
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildFamilyMutationData(options: {
+    familyKind: string;
+    familyStatus: string;
+    reusedExisting: boolean;
+    intent: Record<string, unknown>;
+    currentStep?: string | null;
+    tx1Txid?: string | null | undefined;
+    tx1Wtxid?: string | null | undefined;
+    tx2Txid?: string | null | undefined;
+    tx2Wtxid?: string | null | undefined;
+    intentFingerprintHex?: string | null;
+}): {
+    resultType: "family-mutation";
+    family: {
+        kind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        currentStep: string | null;
+        intentFingerprintHex: string | null;
+    };
+    transactions: {
+        tx1: {
+            txid: string | null;
+            wtxid: string | null;
+        };
+        tx2: {
+            txid: string | null;
+            wtxid: string | null;
+        };
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildStateChangeData(options: {
+    kind: string;
+    state: Record<string, unknown>;
+    before?: Record<string, unknown> | null;
+    after?: Record<string, unknown> | null;
+}): {
+    resultType: "state-change";
+    stateChange: {
+        kind: string;
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    };
+    state: Record<string, unknown>;
+};
+export declare function buildOperationData(options: {
+    kind: string;
+    state?: Record<string, unknown> | null;
+    operation: Record<string, unknown>;
+}): {
+    resultType: "operation";
+    operation: {
+        kind: string;
+    };
+    state: Record<string, unknown> | null;
+};
+export declare function buildRegisterMutationData(result: RegisterDomainResult, options: {
+    forceRace: boolean;
+    fromIdentity: string | null;
+}): {
+    resolved: {
+        path: "root" | "subdomain";
+        parentDomainName: string | null;
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+        economicEffect: {
+            kind: "treasury-payment" | "cog-burn";
+            amount: string | null;
+        };
+    };
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildDomainMarketMutationData(result: DomainMarketMutationResult, options: {
+    commandKind: "transfer" | "sell" | "unsell" | "buy";
+    fromIdentity?: string | null;
+}): {
+    resolved: {
+        buyer: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        } | null;
+        seller: {
+            scriptPubKeyHex: string;
+            address: string | null;
+        } | null;
+        sender?: undefined;
+        recipient?: undefined;
+        economicEffect?: undefined;
+    } | {
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+        recipient: {
+            scriptPubKeyHex: string;
+            address: string | null;
+            opaque: boolean;
+        } | null;
+        economicEffect: {
+            kind: "ownership-transfer";
+            clearsListing: boolean;
+            listedPriceCogtoshi?: undefined;
+        } | {
+            kind: "listing-set" | "listing-clear";
+            listedPriceCogtoshi: string;
+            clearsListing?: undefined;
+        };
+        buyer?: undefined;
+        seller?: undefined;
+    } | null;
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildCogMutationData(result: CogMutationResult, options: {
+    commandKind: "send" | "claim" | "reclaim" | "cog-lock";
+    fromIdentity: string | null;
+    timeoutBlocksOrDuration?: string | null;
+    timeoutHeight?: string | null;
+    conditionHex?: string | null;
+}): {
+    resolved: {
+        claimPath?: import("../wallet/tx/cog.js").CogResolvedClaimPath | null | undefined;
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+    };
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildAnchorMutationData(result: AnchorDomainResult, options: {
+    foundingMessageText: string | null;
+}): {
+    resultType: "family-mutation";
+    family: {
+        kind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        currentStep: string | null;
+        intentFingerprintHex: string | null;
+    };
+    transactions: {
+        tx1: {
+            txid: string | null;
+            wtxid: string | null;
+        };
+        tx2: {
+            txid: string | null;
+            wtxid: string | null;
+        };
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildDomainAdminMutationData(result: DomainAdminMutationResult, options: {
+    commandKind: "domain-endpoint-set" | "domain-endpoint-clear" | "domain-delegate-set" | "domain-delegate-clear" | "domain-miner-set" | "domain-miner-clear" | "domain-canonical";
+}): {
+    resolved: {
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+        target: {
+            scriptPubKeyHex: string;
+            address: string | null;
+            opaque: boolean;
+        } | null;
+        effect: {
+            kind: "endpoint-set";
+            byteLength: number;
+        } | {
+            kind: "endpoint-clear" | "delegate-set" | "delegate-clear" | "miner-set" | "miner-clear" | "canonicalize-owner";
+            byteLength?: undefined;
+        };
+    } | null;
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildFieldMutationData(result: FieldMutationResult): {
+    resolved: {
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+        path: import("../wallet/tx/field.js").FieldResolvedPath;
+        value: {
+            format: number;
+            byteLength: number;
+        } | null;
+        effect: {
+            kind: "create-and-initialize-field";
+            tx1BurnCogtoshi: "100";
+            tx2AdditionalBurnCogtoshi: "1";
+            burnCogtoshi?: undefined;
+        } | {
+            kind: "create-empty-field" | "write-field-value" | "clear-field-value";
+            burnCogtoshi: "0" | "1" | "100";
+            tx1BurnCogtoshi?: undefined;
+            tx2AdditionalBurnCogtoshi?: undefined;
+        };
+    } | null;
+    resultType: "family-mutation";
+    family: {
+        kind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        currentStep: string | null;
+        intentFingerprintHex: string | null;
+    };
+    transactions: {
+        tx1: {
+            txid: string | null;
+            wtxid: string | null;
+        };
+        tx2: {
+            txid: string | null;
+            wtxid: string | null;
+        };
+    };
+    intent: Record<string, unknown>;
+} | {
+    resolved: {
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+        path: import("../wallet/tx/field.js").FieldResolvedPath;
+        value: {
+            format: number;
+            byteLength: number;
+        } | null;
+        effect: {
+            kind: "create-and-initialize-field";
+            tx1BurnCogtoshi: "100";
+            tx2AdditionalBurnCogtoshi: "1";
+            burnCogtoshi?: undefined;
+        } | {
+            kind: "create-empty-field" | "write-field-value" | "clear-field-value";
+            burnCogtoshi: "0" | "1" | "100";
+            tx1BurnCogtoshi?: undefined;
+            tx2AdditionalBurnCogtoshi?: undefined;
+        };
+    } | null;
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildReputationMutationData(result: ReputationMutationResult): {
+    resolved: {
+        sender: {
+            selector: string;
+            localIndex: number;
+            scriptPubKeyHex: string;
+            address: string;
+        };
+        effect: {
+            kind: "give-support" | "revoke-support";
+            burnCogtoshi: string;
+        };
+        review: {
+            included: boolean;
+            byteLength: number | null;
+        };
+        selfStake: boolean;
+    } | null;
+    resultType: "single-tx-mutation";
+    mutation: {
+        kind: string;
+        journalKind: string;
+        localStatus: string;
+        reusedExisting: boolean;
+        intentFingerprintHex: string | null;
+    };
+    transaction: {
+        txid: string | null;
+        wtxid: string | null;
+    };
+    intent: Record<string, unknown>;
+};
+export declare function buildWalletLockMutationData(result: {
+    walletRootId: string | null;
+}): {
+    resultType: "state-change";
+    stateChange: {
+        kind: string;
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    };
+    state: Record<string, unknown>;
+};
+export declare function buildInitMutationData(result: WalletInitializationResult): {
+    resultType: "state-change";
+    stateChange: {
+        kind: string;
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    };
+    state: Record<string, unknown>;
+};
+export declare function buildUnlockMutationData(result: WalletUnlockResult): {
+    resultType: "state-change";
+    stateChange: {
+        kind: string;
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    };
+    state: Record<string, unknown>;
+};
+export declare function buildWalletExportMutationData(result: WalletExportResult): {
+    resultType: "operation";
+    operation: {
+        kind: string;
+    };
+    state: Record<string, unknown> | null;
+};
+export declare function buildWalletImportMutationData(result: WalletImportResult): {
+    resultType: "state-change";
+    stateChange: {
+        kind: string;
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    };
+    state: Record<string, unknown>;
+};
+export declare function buildRepairMutationData(result: WalletRepairResult): {
+    resultType: "state-change";
+    stateChange: {
+        kind: string;
+        before: Record<string, unknown> | null;
+        after: Record<string, unknown> | null;
+    };
+    state: Record<string, unknown>;
+};