@anywalletkit/wallet-zcash 0.2.5 → 0.3.0

package/dist/index.cjs

@@ -22,6 +22,7 @@ var src_exports = {};
 __export(src_exports, {
   BLOCKCHAIR_URL: () => BLOCKCHAIR_URL,
   BlockchairClient: () => BlockchairClient,
+  BroadcastUnknownError: () => BroadcastUnknownError,
   CAIP2: () => CAIP2,
   CURRENT_BRANCH_ID: () => CURRENT_BRANCH_ID,
   DEFAULT_EXPIRY_DELTA: () => DEFAULT_EXPIRY_DELTA,
@@ -65,6 +66,7 @@ __export(src_exports, {
   estimateSize: () => estimateSize,
   hash160: () => hash160,
   headerDigest: () => headerDigest,
+  isAnsweredRefusal: () => isAnsweredRefusal,
   logicalActions: () => logicalActions,
   magicHash: () => magicHash,
   mapDashboardTx: () => mapDashboardTx,
@@ -164,77 +166,6 @@ function outputSize(script) {
 }
 var DUST_LIMIT = 546n;
 
-// src/fee.ts
-var import_core = require("@anywalletkit/core");
-var MARGINAL_FEE = 5000n;
-var GRACE_ACTIONS = 2;
-var P2PKH_STANDARD_INPUT_SIZE = 150;
-var P2PKH_STANDARD_OUTPUT_SIZE = 34;
-var P2PKH_INPUT_SIZE = 149;
-var MAX_UTXO_INPUTS = 200;
-function logicalActions(inputSizes2, outputSizes) {
-  const inBytes = inputSizes2.reduce((s, n) => s + n, 0);
-  const outBytes = outputSizes.reduce((s, n) => s + n, 0);
-  return Math.max(Math.ceil(inBytes / P2PKH_STANDARD_INPUT_SIZE), Math.ceil(outBytes / P2PKH_STANDARD_OUTPUT_SIZE));
-}
-function conventionalFee(inputSizes2, outputSizes) {
-  return MARGINAL_FEE * BigInt(Math.max(GRACE_ACTIONS, logicalActions(inputSizes2, outputSizes)));
-}
-function estimateSize(inputs, outputSizes) {
-  const cs = (n) => n < 253 ? 1 : 3;
-  return 20 + cs(inputs) + inputs * P2PKH_INPUT_SIZE + cs(outputSizes.length) + outputSizes.reduce((s, n) => s + n, 0) + 3;
-}
-var TooManyInputsError = class extends Error {
-  maxInputs;
-  constructor(maxInputs) {
-    super(`The spend needs more than ${maxInputs} inputs; consolidate the UTXOs first or raise maxInputs.`);
-    this.name = "TooManyInputsError";
-    this.maxInputs = maxInputs;
-  }
-};
-var cmpUtxo = (a, b) => a.value > b.value ? -1 : a.value < b.value ? 1 : a.txid < b.txid ? -1 : a.txid > b.txid ? 1 : a.vout - b.vout;
-function spendableUtxos(utxos) {
-  return utxos.filter((u) => u.value > MARGINAL_FEE).sort(cmpUtxo);
-}
-function selectCoins(o) {
-  const maxInputs = o.maxInputs ?? MAX_UTXO_INPUTS;
-  const dust = o.changeDust ?? DUST_LIMIT;
-  const candidates = spendableUtxos(o.utxos);
-  const available = o.utxos.reduce((s, u) => s + u.value, 0n);
-  const inputs = (n) => Array.from({ length: n }, () => P2PKH_INPUT_SIZE);
-  const selected = [];
-  let sum = 0n;
-  for (const u of candidates) {
-    if (selected.length >= maxInputs) throw new TooManyInputsError(maxInputs);
-    selected.push(u);
-    sum += u.value;
-    const n = selected.length;
-    const convNoChange = conventionalFee(inputs(n), [o.recipientOutputSize]);
-    const feeNoChange = o.fee ?? convNoChange;
-    if (sum < o.target + feeNoChange) continue;
-    const convWithChange = conventionalFee(inputs(n), [o.recipientOutputSize, o.changeOutputSize]);
-    const feeWithChange = o.fee ?? convWithChange;
-    const change = sum - o.target - feeWithChange;
-    if (change >= dust) {
-      return { utxos: selected, fee: feeWithChange, conventionalFee: convWithChange, change, changeFolded: false, size: estimateSize(n, [o.recipientOutputSize, o.changeOutputSize]) };
-    }
-    return { utxos: selected, fee: sum - o.target, conventionalFee: convNoChange, change: 0n, changeFolded: sum - o.target > feeNoChange, size: estimateSize(n, [o.recipientOutputSize]) };
-  }
-  const need = o.target + (o.fee ?? conventionalFee(inputs(Math.max(selected.length, 1)), [o.recipientOutputSize]));
-  throw new import_core.InsufficientFundsError(need, available, "ZEC");
-}
-function selectAll(o) {
-  const maxInputs = o.maxInputs ?? MAX_UTXO_INPUTS;
-  const utxos = spendableUtxos(o.utxos).slice(0, maxInputs);
-  if (utxos.length === 0) return { utxos, fee: 0n, amount: 0n, size: 0 };
-  const fee = o.fee ?? conventionalFee(Array.from({ length: utxos.length }, () => P2PKH_INPUT_SIZE), [o.outputSize]);
-  const amount = utxos.reduce((s, u) => s + u.value, 0n) - fee;
-  return { utxos, fee, amount: amount > 0n ? amount : 0n, size: estimateSize(utxos.length, [o.outputSize]) };
-}
-
-// src/tx.ts
-var import_blake2 = require("@noble/hashes/blake2.js");
-
 // src/encoding.ts
 var import_utils = require("@noble/hashes/utils.js");
 function compactSize(n) {
@@ -351,7 +282,76 @@ function reverseBytes(b) {
   return Uint8Array.from(b).reverse();
 }
 
+// src/fee.ts
+var import_core = require("@anywalletkit/core");
+var MARGINAL_FEE = 5000n;
+var GRACE_ACTIONS = 2;
+var P2PKH_STANDARD_INPUT_SIZE = 150;
+var P2PKH_STANDARD_OUTPUT_SIZE = 34;
+var P2PKH_INPUT_SIZE = 149;
+var MAX_UTXO_INPUTS = 200;
+function logicalActions(inputSizes2, outputSizes) {
+  const inBytes = inputSizes2.reduce((s, n) => s + n, 0);
+  const outBytes = outputSizes.reduce((s, n) => s + n, 0);
+  return Math.max(Math.ceil(inBytes / P2PKH_STANDARD_INPUT_SIZE), Math.ceil(outBytes / P2PKH_STANDARD_OUTPUT_SIZE));
+}
+function conventionalFee(inputSizes2, outputSizes) {
+  return MARGINAL_FEE * BigInt(Math.max(GRACE_ACTIONS, logicalActions(inputSizes2, outputSizes)));
+}
+function estimateSize(inputs, outputSizes) {
+  const cs = (n) => n < 253 ? 1 : 3;
+  return 20 + cs(inputs) + inputs * P2PKH_INPUT_SIZE + cs(outputSizes.length) + outputSizes.reduce((s, n) => s + n, 0) + 3;
+}
+var TooManyInputsError = class extends Error {
+  maxInputs;
+  constructor(maxInputs) {
+    super(`The spend needs more than ${maxInputs} inputs; consolidate the UTXOs first or raise maxInputs.`);
+    this.name = "TooManyInputsError";
+    this.maxInputs = maxInputs;
+  }
+};
+var cmpUtxo = (a, b) => a.value > b.value ? -1 : a.value < b.value ? 1 : a.txid < b.txid ? -1 : a.txid > b.txid ? 1 : a.vout - b.vout;
+function spendableUtxos(utxos) {
+  return utxos.filter((u) => u.value > MARGINAL_FEE).sort(cmpUtxo);
+}
+function selectCoins(o) {
+  const maxInputs = o.maxInputs ?? MAX_UTXO_INPUTS;
+  const dust = o.changeDust ?? DUST_LIMIT;
+  const candidates = spendableUtxos(o.utxos);
+  const available = o.utxos.reduce((s, u) => s + u.value, 0n);
+  const inputs = (n) => Array.from({ length: n }, () => P2PKH_INPUT_SIZE);
+  const selected = [];
+  let sum = 0n;
+  for (const u of candidates) {
+    if (selected.length >= maxInputs) throw new TooManyInputsError(maxInputs);
+    selected.push(u);
+    sum += u.value;
+    const n = selected.length;
+    const convNoChange = conventionalFee(inputs(n), [o.recipientOutputSize]);
+    const feeNoChange = o.fee ?? convNoChange;
+    if (sum < o.target + feeNoChange) continue;
+    const convWithChange = conventionalFee(inputs(n), [o.recipientOutputSize, o.changeOutputSize]);
+    const feeWithChange = o.fee ?? convWithChange;
+    const change = sum - o.target - feeWithChange;
+    if (change >= dust) {
+      return { utxos: selected, fee: feeWithChange, conventionalFee: convWithChange, change, changeFolded: false, size: estimateSize(n, [o.recipientOutputSize, o.changeOutputSize]) };
+    }
+    return { utxos: selected, fee: sum - o.target, conventionalFee: convNoChange, change: 0n, changeFolded: sum - o.target > feeNoChange, size: estimateSize(n, [o.recipientOutputSize]) };
+  }
+  const need = o.target + (o.fee ?? conventionalFee(inputs(Math.max(selected.length, 1)), [o.recipientOutputSize]));
+  throw new import_core.InsufficientFundsError(need, available, "ZEC");
+}
+function selectAll(o) {
+  const maxInputs = o.maxInputs ?? MAX_UTXO_INPUTS;
+  const utxos = spendableUtxos(o.utxos).slice(0, maxInputs);
+  if (utxos.length === 0) return { utxos, fee: 0n, amount: 0n, size: 0 };
+  const fee = o.fee ?? conventionalFee(Array.from({ length: utxos.length }, () => P2PKH_INPUT_SIZE), [o.outputSize]);
+  const amount = utxos.reduce((s, u) => s + u.value, 0n) - fee;
+  return { utxos, fee, amount: amount > 0n ? amount : 0n, size: estimateSize(utxos.length, [o.outputSize]) };
+}
+
 // src/tx.ts
+var import_blake2 = require("@noble/hashes/blake2.js");
 var TX_VERSION_V5 = 2147483653;
 var VERSION_GROUP_ID_V5 = 648488714;
 var SIGHASH_ALL = 1;
@@ -529,9 +529,26 @@ function describeTransaction(tx, spent, ctx) {
   const inputs = tx.inputs.map((i, k) => ({ txid: i.txid, vout: i.vout, value: spent[k].value, address: addressFromScript(spent[k].script, ctx.network) }));
   const outputs = [];
   const warnings = /* @__PURE__ */ new Set();
+  const scriptOf = (address) => {
+    try {
+      return (0, import_utils.bytesToHex)(decodeAddress(address, ctx.network).script);
+    } catch {
+      return void 0;
+    }
+  };
+  const ownScript = scriptOf(ctx.ownAddress);
+  const intendedScript = ctx.intended ? scriptOf(ctx.intended.to) : void 0;
+  let recipientSeen = false;
   for (const o of tx.outputs) {
     const address = addressFromScript(o.script, ctx.network);
-    const role = address !== void 0 && address === ctx.ownAddress ? "change" : ctx.intended === void 0 ? "recipient" : address !== void 0 && address === ctx.intended.to && o.value === ctx.intended.value ? "recipient" : "unknown";
+    const script = (0, import_utils.bytesToHex)(o.script);
+    const mine = script === ownScript;
+    let role;
+    if (ctx.intended === void 0) role = mine ? "change" : "recipient";
+    else if (!recipientSeen && script === intendedScript && o.value === ctx.intended.value) {
+      role = "recipient";
+      recipientSeen = true;
+    } else role = mine ? "change" : "unknown";
     if (scriptKind(o.script) !== "unknown" && o.value < DUST_LIMIT) warnings.add("dust-output");
     outputs.push({ address, value: o.value, role });
   }
@@ -591,6 +608,19 @@ async function fetchWithTimeout(fetchFn, url, init, timeoutMs, provider) {
     throw new import_core2.NetworkError(`Request failed: ${url}`, { provider, cause: e });
   }
 }
+var refusedStatus = (status) => status >= 400 && status < 500 && status !== 408;
+function refusal(e) {
+  return Object.assign(e, { answered: true });
+}
+function isAnsweredRefusal(e) {
+  return e?.answered === true;
+}
+function isAlreadyKnown(e) {
+  for (let x = e, depth = 0; x instanceof Error && depth < 5; x = x.cause, depth++) {
+    if (/txn-already-(in-mempool|known)|already (known|in (the )?(mempool|block ?chain))/i.test(x.message)) return true;
+  }
+  return false;
+}
 var isRecord = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
 var isIntString = (v) => typeof v === "string" && /^-?\d+$/.test(v);
 var isInt = (v) => typeof v === "number" && Number.isInteger(v);
@@ -725,14 +755,17 @@ var BlockchairClient = class {
     const url = this.url("push/transaction");
     const res = await fetchWithTimeout(this.fetchFn, url, { method: "POST", headers: { "content-type": "application/x-www-form-urlencoded" }, body }, this.timeoutMs, this.base);
     let env = {};
+    let parsed = false;
     try {
       env = await res.json();
+      parsed = true;
     } catch {
     }
     const hash = env.data?.transaction_hash;
     if (hash) return hash;
-    const reason = env.context?.error ?? `${res.status} ${res.statusText}`;
-    throw new Error(`Broadcast rejected: ${reason}`);
+    const reason = env.context?.error;
+    if (parsed && reason && (res.ok || refusedStatus(res.status))) throw refusal(new Error(`Broadcast rejected: ${reason}`));
+    throw new import_core3.NetworkError(`Blockchair broadcast: no answer to rely on (${res.status} ${res.statusText})`, { provider: this.base });
   }
   async getBlockHeight() {
     const { data } = await this.request("stats", {}, void 0, (v) => isRecord(v) && isInt(v.best_block_height));
@@ -767,7 +800,11 @@ var ZcashBlockbookClient = class _ZcashBlockbookClient {
   async get(path, check) {
     const url = `${this.base}/api${path}`;
     const res = await fetchWithTimeout(this.fetchFn, url, { headers: this.headers }, this.timeoutMs, this.base);
-    if (!res.ok) throw new import_core4.NetworkError(`Blockbook request failed: ${res.status} ${res.statusText} (${url})`, { provider: this.base });
+    if (!res.ok) {
+      const reason = refusedStatus(res.status) ? (await res.text().catch(() => "")).slice(0, 200) : "";
+      const err = new import_core4.NetworkError(`Blockbook request failed: ${res.status} ${res.statusText} (${url})${reason ? `: ${reason}` : ""}`, { provider: this.base });
+      throw refusedStatus(res.status) ? refusal(err) : err;
+    }
     let body;
     try {
       body = await res.json();
@@ -817,7 +854,7 @@ var ZcashBlockbookClient = class _ZcashBlockbookClient {
   }
   async broadcast(rawTx) {
     const data = await this.get(`/v2/sendtx/${rawTx}`, (v) => isRecord(v));
-    if (data.error) throw new Error(`Broadcast rejected: ${typeof data.error === "string" ? data.error : data.error.message ?? "broadcast failed"}`);
+    if (data.error) throw refusal(new Error(`Broadcast rejected: ${typeof data.error === "string" ? data.error : data.error.message ?? "broadcast failed"}`));
     if (!data.result) throw new import_core4.NetworkError("Blockbook returned no txid", { provider: this.base });
     return data.result;
   }
@@ -853,12 +890,19 @@ function createClient(config) {
   const attempts = list.length + (config.retries ?? 3);
   const call = (method) => async (...args) => {
     let last;
+    let silent = false;
     for (let i = 0; i < attempts; i++) {
       const c = list[i % list.length];
       try {
         return await c[method].apply(c, args);
       } catch (e) {
-        if (method === "broadcast" && !(e instanceof import_core5.NetworkError)) throw e;
+        if (method === "broadcast") {
+          if (isAnsweredRefusal(e)) {
+            if (!silent) throw e;
+            throw new import_core5.NetworkError("A Zcash client refused the broadcast after another never answered: it may be out", { cause: e });
+          }
+          silent = true;
+        }
         last = e;
       }
     }
@@ -869,6 +913,19 @@ function createClient(config) {
   return out;
 }
 
+// src/errors.ts
+var BroadcastUnknownError = class extends Error {
+  /** Always true: the transaction may be on its way. */
+  maybeSent = true;
+  /** The transaction id (hex). */
+  hash;
+  constructor(hash, cause) {
+    super(`Broadcast outcome unknown for ${hash}: ${cause instanceof Error ? cause.message.slice(0, 200) : String(cause).slice(0, 200)}`, { cause });
+    this.name = "BroadcastUnknownError";
+    this.hash = hash;
+  }
+};
+
 // src/message.ts
 var import_sha22 = require("@noble/hashes/sha2.js");
 var import_secp256k1 = require("@noble/curves/secp256k1.js");
@@ -1078,13 +1135,27 @@ var WalletAccountZcash = class _WalletAccountZcash extends WalletAccountReadOnly
   ctx(intended) {
     return { network: this._network, ownAddress: this.address, intended, maxFee: this.maxFee };
   }
-  /** Lock time + expiry + branch id from the tip (or the config override). */
+  /**
+   * Lock time, expiry and branch id for a transaction that lands in the next block (round 3, L7):
+   * expiry = tip + 1 + `expiryDelta`, the branch id in force at tip + 1 (mainnet table; off mainnet
+   * `consensusBranchId` must be configured — testnet and regtest activate upgrades at other heights).
+   * Without a tip nothing is signed when the expiry, anti-fee-sniping or the branch id need it: a
+   * transaction signed with expiry 0 never expires.
+   */
   async chainParams() {
-    const tip = await this.tipHeight();
     const delta = this._config.expiryDelta ?? DEFAULT_EXPIRY_DELTA;
-    const consensusBranchId = this._config.consensusBranchId ?? branchIdForHeight(tip);
-    const lockTime = tip !== void 0 && this._config.antiFeeSniping !== false ? tip : 0;
-    const expiryHeight = tip !== void 0 && delta > 0 ? tip + delta : 0;
+    const configured = this._config.consensusBranchId;
+    if (configured === void 0 && this._network !== "mainnet") {
+      throw new UnsafeTransactionError("unknown-branch-id", `On ${this._network} the consensus branch id depends on that network's upgrade heights; set consensusBranchId in the config.`);
+    }
+    const antiSnipe = this._config.antiFeeSniping !== false;
+    const needTip = delta > 0 || antiSnipe || configured === void 0;
+    const tip = needTip ? await this.tipHeight() : void 0;
+    if (needTip && tip === void 0) throw new import_core7.NetworkError("The Zcash chain tip is unknown, so the expiry height and the branch id cannot be set; nothing was signed.");
+    const next = tip === void 0 ? void 0 : tip + 1;
+    const consensusBranchId = configured ?? branchIdForHeight(next);
+    const lockTime = tip !== void 0 && antiSnipe ? tip : 0;
+    const expiryHeight = next !== void 0 && delta > 0 ? next + delta : 0;
     return { lockTime, expiryHeight, consensusBranchId };
   }
   /** Sign every input through the signer; the scriptSig is `<DER ‖ 0x01> <pubkey>`. */
@@ -1096,7 +1167,7 @@ var WalletAccountZcash = class _WalletAccountZcash extends WalletAccountReadOnly
       tx.inputs[i].scriptSig = p2pkhScriptSig(der, this.publicKey);
     }
   }
-  async buildSignedTransaction(spend) {
+  async signSpend(spend) {
     this.live();
     const plan = await this.planSpend(spend);
     const params = await this.chainParams();
@@ -1140,7 +1211,7 @@ var WalletAccountZcash = class _WalletAccountZcash extends WalletAccountReadOnly
   /** "What you sign": the fully resolved spend (signed, NOT broadcast) or a caller's raw hex. */
   async describeTransaction(tx) {
     if (typeof tx === "string") return (await this.describeRaw(tx)).desc;
-    return (await this.buildSignedTransaction(tx)).desc;
+    return (await this.signSpend(tx)).desc;
   }
   /** Sign without broadcasting. Returns the raw transaction hex. Raw hex input gets the checks `sendTransaction` runs (prevouts through the client) and is returned unchanged, never re-signed. */
   async signTransaction(tx, options = {}) {
@@ -1150,7 +1221,7 @@ var WalletAccountZcash = class _WalletAccountZcash extends WalletAccountReadOnly
       this.checkMax(desc.fee, (0, import_core7.feeLimit)(this._config.transactionMaxFee, options), "transaction");
       return tx;
     }
-    const built = await this.buildSignedTransaction(tx);
+    const built = await this.signSpend(tx);
     this.checkMax(built.fee, (0, import_core7.feeLimit)(this._config.transactionMaxFee, options), "transaction");
     return built.hex;
   }
@@ -1168,24 +1239,36 @@ var WalletAccountZcash = class _WalletAccountZcash extends WalletAccountReadOnly
       hash = txid(parsed);
       fee = desc.fee;
     } else {
-      const built = await this.buildSignedTransaction(tx);
+      const built = await this.signSpend(tx);
       rawHex = built.hex;
       hash = built.txid;
       fee = built.fee;
     }
     this.checkMax(fee, (0, import_core7.feeLimit)(this._config.transactionMaxFee, options), "transaction");
-    const id = await client.broadcast(rawHex);
-    return { hash: id || hash, fee };
+    return { hash: await this.broadcast(client, rawHex, hash), fee };
   }
   /** Native ZEC only (`token` is rejected). Subject to `transferMaxFee`. */
   async transfer(o, writeOptions = {}) {
     if (o.token) throw new Error("Tokens are not supported on the zcash blockchain.");
     this.live();
     const client = this.requireClient("transfer");
-    const built = await this.buildSignedTransaction({ to: o.recipient, value: o.amount });
+    const built = await this.signSpend({ to: o.recipient, value: o.amount });
     this.checkMax(built.fee, (0, import_core7.feeLimit)(this._config.transferMaxFee, writeOptions), "transfer");
-    const id = await client.broadcast(built.hex);
-    return { hash: id || built.txid, fee: built.fee };
+    return { hash: await this.broadcast(client, built.hex, built.txid), fee: built.fee };
+  }
+  /**
+   * Send once through the client. Only a node's refusal means nothing went out; "already in the
+   * mempool / block chain" means an earlier attempt delivered it; anything else may have landed and
+   * is a {@link BroadcastUnknownError} with the txid computed before sending (round 3, M12).
+   */
+  async broadcast(client, rawHex, txid2) {
+    try {
+      return await client.broadcast(rawHex) || txid2;
+    } catch (e) {
+      if (isAlreadyKnown(e)) return txid2;
+      if (isAnsweredRefusal(e)) throw e;
+      throw new BroadcastUnknownError(txid2, e);
+    }
   }
   /** The same address as a {@link WalletAccountReadOnlyZcash}. */
   toReadOnlyAccount() {