@ledgerhq/zcash-utils 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ledgerhq/zcash-utils
 
+## 2.7.0
+
+### Minor Changes
+
+- 9f2aa1f: Move the Zcash crates to their NU7 pre-releases. A transaction whose target block is past NU7 activation is built under the ZIP 259 branch id (`0x77190AD9`), and the expiry cap now sees NU7 ahead on testnet. These releases carry no NU7 mainnet activation height yet, so mainnet transactions keep the NU6.3 branch id until a release that sets it is pinned. The PCZT encoding is unchanged.
+- 695c4e6: `buildTransaction` and `buildIronwoodTransaction` take an optional `regtestActivationHeights` for a regtest node whose activation schedule differs from the canonical one. The builder then selects the branch id that node enforces and caps the expiry below the upgrade it has scheduled. The field is refused with mainnet or testnet.
+- 57191c4: Apply ZIP 2009's ZIP-317 marginal fee: `buildTransaction` and `buildIronwoodTransaction` accept a fee computed at 1,000 zatoshis per logical action on mainnet from height 3,590,000 and on test networks, and keep 5,000 on mainnet below that height. A fee computed at 5,000 is still accepted past the switch.
+
+### Patch Changes
+
+- 38e0cfe: The error returned by `buildTransaction` and `buildIronwoodTransaction` for a fee that does not satisfy ZIP-317 reads `craft error: fee …` once, instead of repeating the `craft error:` prefix.
+
 ## 2.6.0
 
 ### Minor Changes

package/index.d.ts

@@ -210,6 +210,27 @@ export interface TransparentInputJs {
    */
   addressIndex: number
 }
+/**
+ * Regtest activation heights a local node was started with, one optional
+ * height per network upgrade. Each height given replaces the canonical
+ * regtest value (Overwinter through Canopy at 1, NU5 through NU6.3 at 2, NU7
+ * unscheduled); each one omitted keeps it. Lets the builder pick the same
+ * branch id, and cap the expiry height at the same upcoming activation, as a
+ * node whose `activation_heights` differ from the canonical set.
+ */
+export interface RegtestActivationHeightsJs {
+  overwinter?: number
+  sapling?: number
+  blossom?: number
+  heartwood?: number
+  canopy?: number
+  nu5?: number
+  nu6?: number
+  nu6_1?: number
+  nu6_2?: number
+  nu6_3?: number
+  nu7?: number
+}
 /**
  * Arguments for [`build_transaction`].
  *
@@ -242,6 +263,12 @@ export interface BuildTransactionParams {
    */
   transparentAccountPubkey?: string
   network?: string
+  /**
+   * Only with `network: "regtest"`: activation heights of the local node,
+   * when its schedule differs from the canonical regtest set. Refused with
+   * any other network.
+   */
+  regtestActivationHeights?: RegtestActivationHeightsJs
   /**
    * 64-char hex (32 bytes): ZIP-32 seed fingerprint of the wallet seed,
    * read from the device. Stamped onto each real spend so the device can
@@ -255,6 +282,11 @@ export interface BuildTransactionParams {
    * loss). Per FR-4 the fee is selected by ledger-live; this
    * crate validates it against ZIP-317 and derives change from it rather
    * than computing a fee itself.
+   *
+   * The ZIP-317 marginal fee depends on the target block (ZIP 2009): 1,000
+   * zatoshis per logical action on mainnet from height 3,590,000 and on test
+   * networks, 5,000 on mainnet below it. A fee computed at 5,000 is still
+   * accepted past the switch; one computed at 1,000 is refused before it.
    */
   feeZat: string
   spends: Array<OrchardSpendInputJs>
@@ -335,6 +367,12 @@ export interface BuildIronwoodTransactionParams {
   grpcUrl: string
   ufvk: string
   network?: string
+  /**
+   * Only with `network: "regtest"`: activation heights of the local node,
+   * when its schedule differs from the canonical regtest set. Refused with
+   * any other network.
+   */
+  regtestActivationHeights?: RegtestActivationHeightsJs
   /**
    * 64-char hex (32 bytes): ZIP-32 seed fingerprint of the wallet seed,
    * read from the device. Stamped onto each real spend so the device can
@@ -348,6 +386,11 @@ export interface BuildIronwoodTransactionParams {
    * loss). Per FR-4 the fee is selected by ledger-live; this
    * crate validates it against ZIP-317 Rev 1 and derives the (always
    * Ironwood) change from it rather than computing a fee itself.
+   *
+   * The ZIP-317 marginal fee depends on the target block (ZIP 2009): 1,000
+   * zatoshis per logical action on mainnet from height 3,590,000 and on test
+   * networks, 5,000 on mainnet below it. A fee computed at 5,000 is still
+   * accepted past the switch; one computed at 1,000 is refused before it.
    */
   feeZat: string
   spends: Array<IronwoodSpendInputJs>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/zcash-utils",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Native Zcash key derivation and shielded sync — Node.js (NAPI)",
   "main": "index.js",
   "types": "index.d.ts",