@augustdigital/sdk 8.22.1 → 8.24.0

package/lib/core/analytics/version.d.ts

@@ -3,4 +3,4 @@
  * Generated during publish from package.json version
  * This file is gitignored and created at publish time
  */
-export declare const SDK_VERSION = "8.22.1";
+export declare const SDK_VERSION = "8.24.0";

package/lib/core/analytics/version.js

@@ -6,5 +6,5 @@ exports.SDK_VERSION = void 0;
  * Generated during publish from package.json version
  * This file is gitignored and created at publish time
  */
-exports.SDK_VERSION = '8.22.1';
+exports.SDK_VERSION = '8.24.0';
 //# sourceMappingURL=version.js.map

package/lib/core/attribution.d.ts

@@ -42,10 +42,15 @@ export interface IAttributionConfig {
     /**
      * EVM chain IDs to attribute. Omit to attribute writes on every EVM chain
      * (the suffix is inert on chains without an ERC-8021 indexer and costs
-     * ~16 gas per non-zero byte). When set, writes on other chains are sent
-     * without the suffix; call sites that cannot determine their chain ID
-     * append the suffix regardless, since over-attribution is harmless and
-     * under-attribution loses data.
+     * ~16 gas per non-zero byte). When set, gating is fail-closed: writes on
+     * other chains — and writes whose chain ID cannot be determined — are sent
+     * without the suffix.
+     *
+     * Over-attribution is not harmless. The suffix makes calldata longer than
+     * the ABI encoding of the call, which breaks clear-signing on hardware
+     * wallets: a Ledger rejects an over-long ERC-20 `approve` with
+     * `EthAppCommandError: Invalid data 6a80`, so an unattributed chain that
+     * receives the suffix anyway cannot be transacted on from a Ledger at all.
      */
     chains?: number[];
 }
@@ -83,13 +88,23 @@ export declare function buildAttributionSuffix(codes: string[]): string;
  *   init, not on the first write.
  */
 export declare function setAttribution(config: IAttributionConfig | null): void;
+/**
+ * Whether attribution is configured at all, independent of any chain gate.
+ *
+ * Call sites that need to know whether to resolve a chain ID before asking
+ * for the suffix use this; {@link getAttributionSuffix} applies the gate.
+ *
+ * @returns `true` when builder codes are configured.
+ */
+export declare function isAttributionEnabled(): boolean;
 /**
  * Return the active ERC-8021 suffix for a write on the given chain, or
- * `undefined` when attribution is off or the chain is excluded.
+ * `undefined` when attribution is off or the chain is not attributed.
  *
  * @param chainId EVM chain ID of the transaction, when the call site knows
- *   it. When omitted and a `chains` restriction is configured, the suffix is
- *   returned anyway (over-attribution is harmless; see
+ *   it. When a `chains` restriction is configured, gating is fail-closed: an
+ *   omitted chain ID yields no suffix, since a suffix on an unattributed
+ *   chain buys nothing and breaks hardware-wallet clear-signing (see
  *   {@link IAttributionConfig.chains}).
  * @returns `0x`-prefixed hex suffix, or `undefined` when nothing should be
  *   appended.
@@ -99,7 +114,8 @@ export declare function getAttributionSuffix(chainId?: number): string | undefin
  * Append the active attribution suffix to calldata.
  *
  * No-ops (returns `data` unchanged) when attribution is off, the chain is
- * excluded, `data` is empty/absent (plain value transfers are never
+ * not attributed (including an unknown chain under a `chains` restriction),
+ * `data` is empty/absent (plain value transfers are never
  * attributed), or `data` already ends with the ERC-8021 marker (guards
  * against double-appending when an upstream layer — e.g. a wagmi config
  * `dataSuffix` — already attributed the transaction).

package/lib/core/attribution.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ERC8021_MARKER = void 0;
 exports.buildAttributionSuffix = buildAttributionSuffix;
 exports.setAttribution = setAttribution;
+exports.isAttributionEnabled = isAttributionEnabled;
 exports.getAttributionSuffix = getAttributionSuffix;
 exports.appendAttributionSuffix = appendAttributionSuffix;
 /**
@@ -96,13 +97,25 @@ function setAttribution(config) {
             ? config.chains
             : null;
 }
+/**
+ * Whether attribution is configured at all, independent of any chain gate.
+ *
+ * Call sites that need to know whether to resolve a chain ID before asking
+ * for the suffix use this; {@link getAttributionSuffix} applies the gate.
+ *
+ * @returns `true` when builder codes are configured.
+ */
+function isAttributionEnabled() {
+    return activeSuffix !== null;
+}
 /**
  * Return the active ERC-8021 suffix for a write on the given chain, or
- * `undefined` when attribution is off or the chain is excluded.
+ * `undefined` when attribution is off or the chain is not attributed.
  *
  * @param chainId EVM chain ID of the transaction, when the call site knows
- *   it. When omitted and a `chains` restriction is configured, the suffix is
- *   returned anyway (over-attribution is harmless; see
+ *   it. When a `chains` restriction is configured, gating is fail-closed: an
+ *   omitted chain ID yields no suffix, since a suffix on an unattributed
+ *   chain buys nothing and breaks hardware-wallet clear-signing (see
  *   {@link IAttributionConfig.chains}).
  * @returns `0x`-prefixed hex suffix, or `undefined` when nothing should be
  *   appended.
@@ -110,7 +123,9 @@ function setAttribution(config) {
 function getAttributionSuffix(chainId) {
     if (!activeSuffix)
         return undefined;
-    if (activeChains && typeof chainId === 'number') {
+    if (activeChains) {
+        if (typeof chainId !== 'number')
+            return undefined;
         if (!activeChains.includes(chainId))
             return undefined;
     }
@@ -120,7 +135,8 @@ function getAttributionSuffix(chainId) {
  * Append the active attribution suffix to calldata.
  *
  * No-ops (returns `data` unchanged) when attribution is off, the chain is
- * excluded, `data` is empty/absent (plain value transfers are never
+ * not attributed (including an unknown chain under a `chains` restriction),
+ * `data` is empty/absent (plain value transfers are never
  * attributed), or `data` already ends with the ERC-8021 marker (guards
  * against double-appending when an upstream layer — e.g. a wagmi config
  * `dataSuffix` — already attributed the transaction).

package/lib/core/helpers/signer.d.ts

@@ -44,7 +44,8 @@ export type CompatibleSigner = Signer | Wallet | any;
  * already ending in the ERC-8021 marker is left untouched. When the
  * configured `chains` list requires a chain check and the transaction does
  * not carry a `chainId`, the signer's provider network is consulted (one
- * cached RPC call).
+ * cached RPC call); if that lookup fails the transaction is sent
+ * unattributed.
  *
  * @param signer Normalized ethers Signer or Wallet.
  * @returns A proxied signer with an attribution-aware `sendTransaction`.

package/lib/core/helpers/signer.js

@@ -107,7 +107,8 @@ async function normalizeSigner(signer) {
  * already ending in the ERC-8021 marker is left untouched. When the
  * configured `chains` list requires a chain check and the transaction does
  * not carry a `chainId`, the signer's provider network is consulted (one
- * cached RPC call).
+ * cached RPC call); if that lookup fails the transaction is sent
+ * unattributed.
  *
  * @param signer Normalized ethers Signer or Wallet.
  * @returns A proxied signer with an attribution-aware `sendTransaction`.
@@ -117,7 +118,7 @@ function wrapSignerWithAttribution(signer) {
         get(target, prop) {
             if (prop === 'sendTransaction') {
                 return async (tx) => {
-                    if (!(0, attribution_1.getAttributionSuffix)() || typeof tx?.data !== 'string') {
+                    if (!(0, attribution_1.isAttributionEnabled)() || typeof tx?.data !== 'string') {
                         return target.sendTransaction(tx);
                     }
                     let chainId = tx.chainId != null ? Number(tx.chainId) : undefined;
@@ -126,9 +127,10 @@ function wrapSignerWithAttribution(signer) {
                             chainId = Number((await target.provider.getNetwork()).chainId);
                         }
                         catch {
-                            // Unknown chain: fall through with chainId undefined, which
-                            // appends regardless of a `chains` restriction —
-                            // over-attribution is harmless, under-attribution loses data.
+                            // Unknown chain: fall through with chainId undefined. Under a
+                            // `chains` restriction that means no suffix — attributing a
+                            // chain we cannot identify risks breaking hardware-wallet
+                            // clear-signing for a gain we cannot confirm.
                         }
                     }
                     const data = (0, attribution_1.appendAttributionSuffix)(tx.data, chainId);

package/lib/evm/methods/crossChainVault.d.ts

@@ -43,6 +43,10 @@ export declare function needsCrossChainApproval(tokenAddress: IAddress, spenderA
 /**
  * Execute a token approval for a cross-chain operation.
  *
+ * @param chainId Chain the approval is sent on, used to gate ERC-8021
+ *   attribution. Omitted means unattributed under a `chains` restriction —
+ *   the suffix would lengthen `approve` calldata past its ABI encoding and
+ *   break Ledger clear-signing.
  * @returns Transaction hash of the approval
  */
 export declare function approveCrossChain(tokenAddress: IAddress, spenderAddress: IAddress, amount: bigint, walletClient: {
@@ -56,7 +60,7 @@ export declare function approveCrossChain(tokenAddress: IAddress, spenderAddress
     }) => Promise<{
         status: string;
     }>;
-}): Promise<string>;
+}, chainId?: number): Promise<string>;
 /**
  * Execute a cross-chain deposit via LayerZero OVault. Validates the source
  * chain, ensures approval, estimates gas with a buffer, and waits for the

package/lib/evm/methods/crossChainVault.js

@@ -526,9 +526,13 @@ async function needsCrossChainApproval(tokenAddress, spenderAddress, walletAddre
 /**
  * Execute a token approval for a cross-chain operation.
  *
+ * @param chainId Chain the approval is sent on, used to gate ERC-8021
+ *   attribution. Omitted means unattributed under a `chains` restriction —
+ *   the suffix would lengthen `approve` calldata past its ABI encoding and
+ *   break Ledger clear-signing.
  * @returns Transaction hash of the approval
  */
-async function approveCrossChain(tokenAddress, spenderAddress, amount, walletClient, publicClient) {
+async function approveCrossChain(tokenAddress, spenderAddress, amount, walletClient, publicClient, chainId) {
     if (!walletClient.account) {
         throw new Error('Wallet not ready — please reconnect your wallet');
     }
@@ -538,7 +542,7 @@ async function approveCrossChain(tokenAddress, spenderAddress, amount, walletCli
         abi: OFT_1.ABI_CROSS_CHAIN_ERC20,
         functionName: 'approve',
         args: [spenderAddress, amount],
-        dataSuffix: (0, attribution_1.getAttributionSuffix)(),
+        dataSuffix: (0, attribution_1.getAttributionSuffix)(chainId),
     });
     const receipt = await publicClient.waitForTransactionReceipt({
         hash: hash,
@@ -595,7 +599,7 @@ async function crossChainVaultDeposit(props) {
             BigInt((0, core_1.toNormalizedBn)(props.amount, props.decimals).raw);
         const approvalNeeded = await needsCrossChainApproval(tokenAddr, spenderAddr, props.walletAddress, approvalAmount, publicClient);
         if (approvalNeeded) {
-            await approveCrossChain(tokenAddr, spenderAddr, approvalAmount, walletClient, publicClient);
+            await approveCrossChain(tokenAddr, spenderAddr, approvalAmount, walletClient, publicClient, props.userChainId);
         }
     }
     // 3. Estimate gas with buffer
@@ -678,7 +682,7 @@ async function crossChainVaultRedeem(props) {
     if (!props.skipApprovalCheck && txInputs.approval) {
         const approvalNeeded = await needsCrossChainApproval(txInputs.approval.tokenAddress, txInputs.approval.spender, props.walletAddress, txInputs.approval.amount, publicClient);
         if (approvalNeeded) {
-            await approveCrossChain(txInputs.approval.tokenAddress, txInputs.approval.spender, txInputs.approval.amount, walletClient, publicClient);
+            await approveCrossChain(txInputs.approval.tokenAddress, txInputs.approval.spender, txInputs.approval.amount, walletClient, publicClient, props.config.hubChainId);
         }
     }
     // 4. Estimate gas with buffer

package/lib/sdk.d.ts

@@ -15020,7 +15020,8 @@ export declare function allowance(signer: IContractRunner, options: IAllowanceOp
  * Append the active attribution suffix to calldata.
  *
  * No-ops (returns `data` unchanged) when attribution is off, the chain is
- * excluded, `data` is empty/absent (plain value transfers are never
+ * not attributed (including an unknown chain under a `chains` restriction),
+ * `data` is empty/absent (plain value transfers are never
  * attributed), or `data` already ends with the ERC-8021 marker (guards
  * against double-appending when an upstream layer — e.g. a wagmi config
  * `dataSuffix` — already attributed the transaction).
@@ -15065,6 +15066,10 @@ export declare function approve(signer: Signer | Wallet, options: IContractWrite
 /**
  * Execute a token approval for a cross-chain operation.
  *
+ * @param chainId Chain the approval is sent on, used to gate ERC-8021
+ *   attribution. Omitted means unattributed under a `chains` restriction —
+ *   the suffix would lengthen `approve` calldata past its ABI encoding and
+ *   break Ledger clear-signing.
  * @returns Transaction hash of the approval
  */
 export declare function approveCrossChain(tokenAddress: IAddress, spenderAddress: IAddress, amount: bigint, walletClient: {
@@ -15078,7 +15083,7 @@ export declare function approveCrossChain(tokenAddress: IAddress, spenderAddress
     }) => Promise<{
         status: string;
     }>;
-}): Promise<string>;
+}, chainId?: number): Promise<string>;
 
 /**
  * Discriminated union returned by {@link approve}. Lets callers tell apart
@@ -18277,11 +18282,12 @@ declare type AsArray<T> = T extends readonly unknown[] ? T : never;
 
                      /**
                       * Return the active ERC-8021 suffix for a write on the given chain, or
-                      * `undefined` when attribution is off or the chain is excluded.
+                      * `undefined` when attribution is off or the chain is not attributed.
                       *
                       * @param chainId EVM chain ID of the transaction, when the call site knows
-                      *   it. When omitted and a `chains` restriction is configured, the suffix is
-                      *   returned anyway (over-attribution is harmless; see
+                      *   it. When a `chains` restriction is configured, gating is fail-closed: an
+                      *   omitted chain ID yields no suffix, since a suffix on an unattributed
+                      *   chain buys nothing and breaks hardware-wallet clear-signing (see
                       *   {@link IAttributionConfig.chains}).
                       * @returns `0x`-prefixed hex suffix, or `undefined` when nothing should be
                       *   appended.
@@ -19649,10 +19655,15 @@ declare type AsArray<T> = T extends readonly unknown[] ? T : never;
                           /**
                            * EVM chain IDs to attribute. Omit to attribute writes on every EVM chain
                            * (the suffix is inert on chains without an ERC-8021 indexer and costs
-                           * ~16 gas per non-zero byte). When set, writes on other chains are sent
-                           * without the suffix; call sites that cannot determine their chain ID
-                           * append the suffix regardless, since over-attribution is harmless and
-                           * under-attribution loses data.
+                           * ~16 gas per non-zero byte). When set, gating is fail-closed: writes on
+                           * other chains — and writes whose chain ID cannot be determined — are sent
+                           * without the suffix.
+                           *
+                           * Over-attribution is not harmless. The suffix makes calldata longer than
+                           * the ABI encoding of the call, which breaks clear-signing on hardware
+                           * wallets: a Ledger rejects an over-long ERC-20 `approve` with
+                           * `EthAppCommandError: Invalid data 6a80`, so an unattributed chain that
+                           * receives the suffix anyway cannot be transacted on from a Ledger at all.
                            */
                           chains?: number[];
                       }
@@ -21066,6 +21077,16 @@ declare type AsArray<T> = T extends readonly unknown[] ? T : never;
                        */
                       export declare function isAnalyticsForcedOnViaEnv(): boolean;
 
+                      /**
+                       * Whether attribution is configured at all, independent of any chain gate.
+                       *
+                       * Call sites that need to know whether to resolve a chain ID before asking
+                       * for the suffix use this; {@link getAttributionSuffix} applies the gate.
+                       *
+                       * @returns `true` when builder codes are configured.
+                       */
+                      export declare function isAttributionEnabled(): boolean;
+
                       /** Type guard. Works across realms (e.g. Web Worker / VM contexts). */
                       export declare function isAugustSDKError(err: unknown): err is AugustSDKError;
 
@@ -26834,7 +26855,8 @@ declare type AsArray<T> = T extends readonly unknown[] ? T : never;
                                              * already ending in the ERC-8021 marker is left untouched. When the
                                              * configured `chains` list requires a chain check and the transaction does
                                              * not carry a `chainId`, the signer's provider network is consulted (one
-                                             * cached RPC call).
+                                             * cached RPC call); if that lookup fails the transaction is sent
+                                             * unattributed.
                                              *
                                              * @param signer Normalized ethers Signer or Wallet.
                                              * @returns A proxied signer with an attribution-aware `sendTransaction`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@augustdigital/sdk",
-  "version": "8.22.1",
+  "version": "8.24.0",
   "main": "lib/index.js",
   "types": "lib/sdk.d.ts",
   "keywords": [