@cogcoin/client 0.5.14 → 1.0.0

package/dist/wallet/tx/common.d.ts

@@ -1,25 +1,42 @@
-import type { RpcDecodedPsbt, RpcFinalizePsbtResult, RpcListUnspentEntry, RpcLockedUnspent, RpcTestMempoolAcceptResult, RpcTransaction, RpcVin, RpcWalletCreateFundedPsbtResult, RpcWalletProcessPsbtResult } from "../../bitcoind/types.js";
+import type { RpcDecodedPsbt, RpcEstimateSmartFeeResult, RpcFinalizePsbtResult, RpcListUnspentEntry, RpcLockedUnspent, RpcMempoolEntry, RpcTestMempoolAcceptResult, RpcTransaction, RpcVin, RpcWalletCreateFundedPsbtResult, RpcWalletTransaction, RpcWalletProcessPsbtResult } from "../../bitcoind/types.js";
 import { type WalletSecretProvider } from "../state/provider.js";
 import type { OutpointRecord, PendingMutationRecord, PendingMutationStatus, WalletStateV1 } from "../types.js";
 import type { WalletReadContext } from "../read/index.js";
 import type { WalletRuntimePaths } from "../runtime.js";
 import { type MiningPreemptionHandle } from "../mining/coordination.js";
 export declare const DEFAULT_WALLET_MUTATION_FEE_RATE_SAT_VB = 10;
+export declare const NEXT_BLOCK_FEE_CONFIRM_TARGET = 1;
+export type WalletMutationFeeSelectionSource = "custom-satvb" | "estimated-next-block-plus-one" | "fallback-default";
+export interface WalletMutationFeeSelection {
+    feeRateSatVb: number;
+    source: WalletMutationFeeSelectionSource;
+}
+export interface WalletMutationFeeSummary extends WalletMutationFeeSelection {
+    feeSats: string | null;
+}
 export interface MutationSender {
     localIndex: number;
     scriptPubKeyHex: string;
     address: string;
 }
+export declare function isLocalWalletScript(state: WalletStateV1, scriptPubKeyHex: string | null | undefined): boolean;
+export declare function createFundingMutationSender(state: WalletStateV1): MutationSender;
 export interface WalletMutationRpcClient {
     listUnspent(walletName: string, minConf?: number): Promise<RpcListUnspentEntry[]>;
-    listLockUnspent(walletName: string): Promise<RpcLockedUnspent[]>;
-    lockUnspent(walletName: string, unlock: boolean, outputs: RpcLockedUnspent[]): Promise<boolean>;
+    listLockUnspent?(walletName: string): Promise<RpcLockedUnspent[]>;
+    lockUnspent?(walletName: string, unlock: boolean, outputs: RpcLockedUnspent[]): Promise<boolean>;
+    getTransaction?(walletName: string, txid: string): Promise<RpcWalletTransaction>;
+    getRawTransaction?(txid: string, verbose?: boolean): Promise<RpcTransaction>;
+    getMempoolEntry?(txid: string): Promise<RpcMempoolEntry>;
+    estimateSmartFee?(confirmTarget: number, mode: "conservative" | "economical"): Promise<RpcEstimateSmartFeeResult>;
     walletCreateFundedPsbt(walletName: string, inputs: Array<{
         txid: string;
         vout: number;
     }>, outputs: unknown[], locktime: number, options: Record<string, unknown>, bip32Derivs?: boolean): Promise<RpcWalletCreateFundedPsbtResult>;
     decodePsbt(psbt: string): Promise<RpcDecodedPsbt>;
+    walletPassphrase(walletName: string, passphrase: string, timeoutSeconds: number): Promise<null>;
     walletProcessPsbt(walletName: string, psbt: string, sign?: boolean, sighashType?: string): Promise<RpcWalletProcessPsbtResult>;
+    walletLock(walletName: string): Promise<null>;
     finalizePsbt(psbt: string, extract?: boolean): Promise<RpcFinalizePsbtResult>;
     decodeRawTransaction(hex: string): Promise<RpcTransaction>;
     testMempoolAccept(rawTransactions: string[]): Promise<RpcTestMempoolAcceptResult[]>;
@@ -35,28 +52,69 @@ export interface BuiltWalletMutationTransaction {
 }
 export interface FixedWalletInput extends OutpointRecord {
 }
+export declare function formatSatVb(value: number): string;
+export declare function createWalletMutationFeeMetadata(selection: WalletMutationFeeSelection): {
+    selectedFeeRateSatVb: number;
+    feeSelectionSource: WalletMutationFeeSelectionSource;
+};
+export declare function resolveWalletMutationFeeSelection(options: {
+    rpc: Pick<WalletMutationRpcClient, "estimateSmartFee">;
+    feeRateSatVb?: number | null;
+}): Promise<WalletMutationFeeSelection>;
+export declare function createWalletMutationFeeSummary(selection: WalletMutationFeeSelection, feeSats: string | null): WalletMutationFeeSummary;
+export declare function createBuiltWalletMutationFeeSummary(options: {
+    selection: WalletMutationFeeSelection;
+    built: BuiltWalletMutationTransaction;
+}): WalletMutationFeeSummary;
+export declare function resolvePendingMutationFeeSummary(options: {
+    rpc: Pick<WalletMutationRpcClient, "getMempoolEntry">;
+    mutation: PendingMutationRecord;
+}): Promise<WalletMutationFeeSummary>;
+export declare function loadAttemptedMutationFixedInputs(options: {
+    rpc: Pick<WalletMutationRpcClient, "getTransaction" | "getRawTransaction">;
+    walletName: string;
+    mutation: PendingMutationRecord;
+}): Promise<FixedWalletInput[] | null>;
+export declare function resolvePendingMutationReuseDecision(options: {
+    rpc: Pick<WalletMutationRpcClient, "getMempoolEntry" | "getTransaction" | "getRawTransaction">;
+    walletName: string;
+    mutation: PendingMutationRecord;
+    nextFeeSelection: WalletMutationFeeSelection;
+}): Promise<{
+    reuseExisting: boolean;
+    fees: WalletMutationFeeSummary;
+    replacementFixedInputs: FixedWalletInput[] | null;
+}>;
+export declare function mergeFixedWalletInputs(fixedInputs: readonly FixedWalletInput[], replacementInputs: readonly FixedWalletInput[] | null): FixedWalletInput[];
 export declare function saveWalletStatePreservingUnlock(options: {
     state: WalletStateV1;
     provider: WalletSecretProvider;
-    unlockUntilUnixMs: number;
-    nowUnixMs: number;
+    nowUnixMs?: number;
     paths: WalletRuntimePaths;
 }): Promise<void>;
 export declare function formatCogAmount(value: bigint): string;
 export declare function outpointKey(outpoint: OutpointRecord): string;
+export declare function findSpendableFundingInputsFromTransaction(options: {
+    allUtxos: RpcListUnspentEntry[];
+    txid: string;
+    fundingScriptPubKeyHex: string;
+    minConf?: number;
+}): FixedWalletInput[];
 export declare function updateMutationRecord(mutation: PendingMutationRecord, status: PendingMutationStatus, nowUnixMs: number, options?: {
     attemptedTxid?: string | null;
     attemptedWtxid?: string | null;
     temporaryBuilderLockedOutpoints?: OutpointRecord[];
+    selectedFeeRateSatVb?: number | null;
+    feeSelectionSource?: WalletMutationFeeSelectionSource | null;
 }): PendingMutationRecord;
 export declare function unlockTemporaryBuilderLocks(rpc: Pick<WalletMutationRpcClient, "lockUnspent">, walletName: string, outpoints: OutpointRecord[]): Promise<void>;
 export declare function diffTemporaryLockedOutpoints(before: RpcLockedUnspent[], after: RpcLockedUnspent[]): OutpointRecord[];
-export declare function getDecodedInputScriptPubKeyHex(input: RpcVin): string | null;
 export declare function getDecodedInputVout(input: RpcVin): number | null;
+export declare function getDecodedInputScriptPubKeyHex(decoded: RpcDecodedPsbt, inputIndex: number): string | null;
 export declare function inputMatchesOutpoint(input: RpcVin, outpoint: OutpointRecord): boolean;
 export declare function assertFixedInputPrefixMatches(inputs: RpcVin[], fixedInputs: FixedWalletInput[], errorCode: string): void;
 export declare function assertFundingInputsAfterFixedPrefix(options: {
-    inputs: RpcVin[];
+    decoded: RpcDecodedPsbt;
     fixedInputs: FixedWalletInput[];
     allowedFundingScriptPubKeyHex: string;
     eligibleFundingOutpointKeys: Set<string>;
@@ -77,11 +135,16 @@ export declare function assertWalletMutationContextReady(context: WalletReadCont
     localState: {
         availability: "ready";
         state: WalletStateV1;
-        unlockUntilUnixMs: number;
     };
     snapshot: NonNullable<WalletReadContext["snapshot"]>;
     model: NonNullable<WalletReadContext["model"]>;
 };
+export declare function assertWalletBitcoinTransferContextReady(context: WalletReadContext, errorPrefix: string): asserts context is WalletReadContext & {
+    localState: {
+        availability: "ready";
+        state: WalletStateV1;
+    };
+};
 export declare function pauseMiningForWalletMutation(options: {
     paths: WalletRuntimePaths;
     reason: string;
@@ -94,7 +157,7 @@ export declare function buildWalletMutationTransaction<TPlan>(options: {
         fixedInputs: FixedWalletInput[];
         outputs: unknown[];
         changeAddress: string;
-        changePosition: number;
+        changePosition?: number | null;
         allowedFundingScriptPubKeyHex: string;
         eligibleFundingOutpointKeys: Set<string>;
     };
@@ -102,6 +165,7 @@ export declare function buildWalletMutationTransaction<TPlan>(options: {
     finalizeErrorCode: string;
     mempoolRejectPrefix: string;
     feeRate?: number;
+    availableFundingMinConf?: number;
     temporarilyUnlockedPolicyOutpoints?: readonly OutpointRecord[];
 }): Promise<BuiltWalletMutationTransaction>;
 export declare function buildWalletMutationTransactionWithReserveFallback<TPlan>(options: {
@@ -120,5 +184,5 @@ export declare function buildWalletMutationTransactionWithReserveFallback<TPlan>
     finalizeErrorCode: string;
     mempoolRejectPrefix: string;
     feeRate?: number;
-    reserveCandidates: readonly OutpointRecord[];
+    availableFundingMinConf?: number;
 }): Promise<BuiltWalletMutationTransaction>;