@tokenops/sdk 1.1.1 → 1.5.1

package/README.md

@@ -720,17 +720,27 @@ See [Testnet Faucet — React hooks on docs.tokenops.xyz](https://docs.tokenops.
 
 ## Peer dependencies
 
-| Package                 | Range    | Required for                                                                   |
-| ----------------------- | -------- | ------------------------------------------------------------------------------ |
-| `viem`                  | `^2.47`  | all subpaths (hard required)                                                   |
-| `@zama-fhe/sdk`         | `^3.0.0` | encryption + decryption + FHE write flows on every FHE subpath (optional peer) |
-| `@zama-fhe/react-sdk`   | `^3.0.0` | `/react` hook subpaths that submit encrypted inputs (optional peer)            |
-| `react`                 | `>=18`   | `/react` hook subpaths (optional peer)                                         |
-| `wagmi`                 | `^2`     | `/react` hook subpaths (optional peer)                                         |
-| `@tanstack/react-query` | `^5`     | `/react` hook subpaths (optional peer)                                         |
+| Package                 | Range        | Required for                                                                   |
+| ----------------------- | ------------ | ------------------------------------------------------------------------------ |
+| `viem`                  | `^2.47`      | all subpaths (hard required)                                                   |
+| `@zama-fhe/sdk`         | `^3.0.0`     | encryption + decryption + FHE write flows on every FHE subpath (optional peer) |
+| `@zama-fhe/react-sdk`   | `^3.0.0`     | `/react` hook subpaths that submit encrypted inputs (optional peer)            |
+| `react`                 | `>=18`       | `/react` hook subpaths (optional peer)                                         |
+| `wagmi`                 | `^2 \|\| ^3` | `/react` hook subpaths (optional peer)                                         |
+| `@tanstack/react-query` | `^5`         | `/react` hook subpaths (optional peer)                                         |
 
 All peers except `viem` are marked `optional` via `peerDependenciesMeta` so read-only / ABI-only consumers can install the package without pulling them in. Install `@zama-fhe/sdk` explicitly the first time you encrypt, decrypt, or submit an FHE write; install the React peers if you use any `/react` hook subpath.
 
+### wagmi v2 and v3
+
+The SDK supports both wagmi majors. wagmi v3 renamed `useAccount` → `useConnection`; the SDK resolves the right hook internally at runtime, so no code change is needed on your side when you upgrade — the hooks' public API is identical under both majors. CI typechecks and runs the hook suites against both.
+
+**Still seeing `ERESOLVE` after upgrading to wagmi v3?** The error is almost certainly coming from _another_ package in your dependency tree, not from `@tokenops/sdk` (which accepts `^2.0.0 || ^3.0.0`). To diagnose:
+
+1. Read the `ERESOLVE` output carefully — npm names the package whose peer range could not be satisfied (`Could not resolve dependency: peer wagmi@"^2.x" from <package>@<version>`). If `<package>` is not `@tokenops/sdk`, that package still pins wagmi v2.
+2. Confirm with `npm ls wagmi` (or `pnpm why wagmi`) — it prints every dependent and the range each one declares.
+3. Fix by upgrading the offending package to a wagmi-v3-compatible release, or — if none exists yet — stay on wagmi v2 (fully supported by this SDK) until it does. npm's `--legacy-peer-deps` / pnpm's looser peer handling can silence the error, but you are then running that package against a wagmi major it does not declare support for.
+
 ## Design
 
 - **Single package, subpath exports.** No companion `@tokenops/react-sdk` — hooks live at `@tokenops/sdk/<product>/react`.

package/dist/{chunk-5SGMJADP.cjs → chunk-2NCLOQ56.cjs}

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunk56UI7LUR_cjs = require('./chunk-56UI7LUR.cjs');
+var chunk67OV5CX2_cjs = require('./chunk-67OV5CX2.cjs');
 
 // src/fhe/scale-ratio.ts
 var FHE_SPLIT_DENOMINATOR = 90090000n;
@@ -15,7 +15,7 @@ function scaleRatio({
   width = "uint128"
 }) {
   if (denominator <= 0n) {
-    throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+    throw new chunk67OV5CX2_cjs.InvalidArgumentError({
       method: "scaleRatio",
       argument: "denominator",
       reason: `must be > 0, got ${denominator}`,
@@ -23,7 +23,7 @@ function scaleRatio({
     });
   }
   if (numerator < 0n) {
-    throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+    throw new chunk67OV5CX2_cjs.InvalidArgumentError({
       method: "scaleRatio",
       argument: "numerator",
       reason: `must be >= 0, got ${numerator}`,
@@ -31,7 +31,7 @@ function scaleRatio({
     });
   }
   if (minDenominator <= 0n) {
-    throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+    throw new chunk67OV5CX2_cjs.InvalidArgumentError({
       method: "scaleRatio",
       argument: "minDenominator",
       reason: `must be > 0, got ${minDenominator}`,
@@ -51,7 +51,7 @@ function scaleRatio({
 function assertWithinWidth(value, width, label) {
   const max = width === "uint64" ? MAX_UINT64 : MAX_UINT128;
   if (value > max) {
-    throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+    throw new chunk67OV5CX2_cjs.InvalidArgumentError({
       method: "scaleRatio",
       argument: label,
       reason: `exceeds ${width} range`,
@@ -78,7 +78,7 @@ var share = {
     const n = toIntegerBigInt(numerator, "share.fraction", "numerator");
     const m = toIntegerBigInt(denominator, "share.fraction", "denominator");
     if (m <= 0n || m > MAX_FRACTION_DENOMINATOR) {
-      throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+      throw new chunk67OV5CX2_cjs.InvalidArgumentError({
         method: "share.fraction",
         argument: "denominator",
         reason: `must be in 1..${MAX_FRACTION_DENOMINATOR}, got ${m}`,
@@ -86,7 +86,7 @@ var share = {
       });
     }
     if (n < 0n || n > m) {
-      throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+      throw new chunk67OV5CX2_cjs.InvalidArgumentError({
         method: "share.fraction",
         argument: "numerator",
         reason: `must be in 0..${m} (denominator), got ${n}`,
@@ -111,7 +111,7 @@ var share = {
   basisPoints(bps) {
     const value = toIntegerBigInt(bps, "share.basisPoints", "bps");
     if (value < 0n || value > BASIS_POINT_SCALE) {
-      throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+      throw new chunk67OV5CX2_cjs.InvalidArgumentError({
         method: "share.basisPoints",
         argument: "bps",
         reason: `must be in 0..${BASIS_POINT_SCALE}, got ${value}`,
@@ -124,7 +124,7 @@ var share = {
 function toIntegerBigInt(value, method, argument) {
   if (typeof value === "bigint") return value;
   if (!Number.isInteger(value)) {
-    throw new chunk56UI7LUR_cjs.InvalidArgumentError({
+    throw new chunk67OV5CX2_cjs.InvalidArgumentError({
       method,
       argument,
       reason: `must be an integer, got ${value}`,

package/dist/{chunk-FXCW7LVB.js → chunk-2PWNH3UE.js}

@@ -1,11 +1,11 @@
-import { mapZamaError } from './chunk-ZXCOJY2Z.js';
-import { getFhevmAclAddress, requireFhevmAclAddress, ACL_ALLOWED_EVENT } from './chunk-FYQ2UW4T.js';
-import { SDK_VERSION, isContractRevert, mapContractRevert } from './chunk-JFLEEXKP.js';
-import { getFheDisperseSingletonAddress } from './chunk-M7V2EDPB.js';
-import { normaliseAddress } from './chunk-BE2AIZ3K.js';
+import { mapZamaError } from './chunk-WMACINXO.js';
+import { getFhevmAclAddress, requireFhevmAclAddress, ACL_ALLOWED_EVENT } from './chunk-ZWXJTBZO.js';
+import { SDK_VERSION, isContractRevert, mapContractRevert } from './chunk-SG65XWH7.js';
+import { getFheDisperseSingletonAddress } from './chunk-XGGTQQFH.js';
+import { normaliseAddress } from './chunk-ZA673I3O.js';
 import { withTelemetry } from './chunk-Q2GP5UDC.js';
 import { asExternalInputProof, asEncryptedHandle } from './chunk-KWFFIJYX.js';
-import { InvalidArgumentError, TokenOpsSdkError, DeploymentAddressUnavailableError, PausedError, InsufficientFeeError, MissingEncryptorError, ReceiptEventAmbiguousError, MissingWalletClientError, MissingAccountError, BatchTooLargeError } from './chunk-IVE3QEGD.js';
+import { InvalidArgumentError, TokenOpsSdkError, DeploymentAddressUnavailableError, PausedError, InsufficientFeeError, MissingEncryptorError, ReceiptEventAmbiguousError, MissingWalletClientError, MissingAccountError, BatchTooLargeError } from './chunk-QBJ7O2B4.js';
 import { bytesToHex, keccak256, encodePacked, parseEventLogs, isAddress, getCreate2Address } from 'viem';
 
 // src/fhe-disperse/abis/singleton.ts
@@ -2166,6 +2166,13 @@ var ConfidentialDisperseClient = class {
    * subtotal1` for the result to match the on-chain computation. Both this
    * SDK and the contract round the BPS multiplication down (floor division).
    *
+   * **Amount units:** TokenOps confidential (ERC-7984) tokens use a 6-decimals
+   * convention (1 token = 1_000_000 base units), not the 18 decimals typical of
+   * ERC-20. Amount parameters are base units of the token's actual decimals:
+   * for the CTTT test token (6 decimals) `1_000_000n` = 1 CTTT, while the
+   * transparent TTT test token uses 18 decimals. `totalTokens` follows this
+   * convention.
+   *
    * @throws {TokenOpsSdkError} if mode is `"wallet-token-fee"` and `totalTokens` is not provided.
    */
   async calculateFee(args) {
@@ -2229,6 +2236,13 @@ var ConfidentialDisperseClient = class {
    * - `hasApprovedSubwallets` (wallet modes) or `isOperator(sender, singleton)` (direct mode)
    * - `calculateFee` / `getBatchLimits`
    * - Structural recipient + amount validation
+   *
+   * **Amount units:** TokenOps confidential (ERC-7984) tokens use a 6-decimals
+   * convention (1 token = 1_000_000 base units), not the 18 decimals typical of
+   * ERC-20. Amount parameters are base units of the token's actual decimals:
+   * for the CTTT test token (6 decimals) `1_000_000n` = 1 CTTT, while the
+   * transparent TTT test token uses 18 decimals. Pass `amounts[]` in the same
+   * units you will pass to `disperse` so the report reflects the real call.
    */
   async preflightDisperse(args) {
     const { user, token, recipients, amounts, mode } = args;
@@ -2474,6 +2488,15 @@ var ConfidentialDisperseClient = class {
    * 4. Computes `msg.value` for gas-fee modes; `0` for token-fee mode.
    * 5. Dispatches to the correct contract function based on `mode`.
    *
+   * **Silent-zero transfers.** ERC-7984 transfers do not revert when the sender's encrypted balance is insufficient — the transfer succeeds and moves an encrypted zero instead. This is by design: reverting would leak balance information. The transaction receipt alone cannot tell you whether value actually moved.
+   *
+   * **Amount units:** TokenOps confidential (ERC-7984) tokens use a 6-decimals
+   * convention (1 token = 1_000_000 base units), not the 18 decimals typical of
+   * ERC-20. Amount parameters are base units of the token's actual decimals:
+   * for the CTTT test token (6 decimals) `1_000_000n` = 1 CTTT, while the
+   * transparent TTT test token uses 18 decimals. Every entry of `amounts[]`
+   * follows this convention.
+   *
    * @throws {TokenOpsSdkError} on input validation failure (first deterministic error).
    * @throws {TokenOpsSdkError} if no encryptor is available at call time.
    */
@@ -2789,6 +2812,12 @@ var ConfidentialDisperseClient = class {
    * encryptor, or pass `encryptedInput` directly. The contract caps the
    * withdrawal at the available reserve via `FHE.min`.
    *
+   * **Amount units:** TokenOps confidential (ERC-7984) tokens use a 6-decimals
+   * convention (1 token = 1_000_000 base units), not the 18 decimals typical of
+   * ERC-20. Amount parameters are base units of the token's actual decimals:
+   * for the CTTT test token (6 decimals) `1_000_000n` = 1 CTTT, while the
+   * transparent TTT test token uses 18 decimals.
+   *
    * Returns the tx hash plus the **transferred** handle parsed from the
    * `TokenFeeWithdrawn` event. Decrypt the handle via Zama's `userDecrypt`
    * to view the actual amount moved (which can be less than requested when

package/dist/{chunk-FPQBFIUW.cjs → chunk-4WPGQSNT.cjs}

@@ -1,9 +1,9 @@
 'use strict';
 
-var chunkSYHXDHWX_cjs = require('./chunk-SYHXDHWX.cjs');
+var chunkTIUKIY5V_cjs = require('./chunk-TIUKIY5V.cjs');
 
 // src/fhe-airdrop/advanced/factory-advanced.ts
-var ConfidentialAirdropFactoryAdvancedClient = class extends chunkSYHXDHWX_cjs.ConfidentialAirdropFactoryClient {
+var ConfidentialAirdropFactoryAdvancedClient = class extends chunkTIUKIY5V_cjs.ConfidentialAirdropFactoryClient {
   /**
    * Compute the deterministic CREATE2 address for an airdrop clone without
    * deploying it.
@@ -21,7 +21,7 @@ var ConfidentialAirdropFactoryAdvancedClient = class extends chunkSYHXDHWX_cjs.C
   async predictAirdropAddress(args) {
     return this.publicClient.readContract({
       address: this.address,
-      abi: chunkSYHXDHWX_cjs.confidentialAirdropFactoryAbi,
+      abi: chunkTIUKIY5V_cjs.confidentialAirdropFactoryAbi,
       functionName: "predictAirdropAddress",
       args: [toAbiParams(args.params), args.userSalt, args.deployer, args.gasFee]
     });