@pancakeswap/swap-sdk-evm 1.2.1 → 1.3.0

package/dist/scaledUIAmount.d.ts

@@ -1,60 +1,424 @@
 import type { Address, PublicClient } from 'viem';
-/**
- * ERC-8056 ERC-165 interface IDs.
- *
- * Pinned in the BNB Chain partner integration doc v1.0 (8 Apr 2026). The spec lists
- * "others TBD" for the optional conversion / new-multiplier sub-interfaces — do not
- * rely on those IDs being stable until the spec moves out of Draft status.
- */
+/** ERC-8056 ERC-165 ids. B20 claims none of them — its `supportsInterface` reverts outright. */
 export declare const SCALED_UI_AMOUNT_INTERFACE_ID: "0xa60bf13d";
 export declare const SCALED_UI_AMOUNT_BALANCES_INTERFACE_ID: "0xd890fd71";
+export type ScaledUIDialect = 'erc8056' | 'b20';
+export type ScaledUIAmountReadFn = 'uiMultiplier' | 'multiplier' | 'newUIMultiplier' | 'effectiveAt';
+declare const ABI_BY_FN: {
+    readonly uiMultiplier: readonly [{
+        readonly type: "function";
+        readonly name: "uiMultiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "toUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "rawAmount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "fromUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "uiAmount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "balanceOfUI";
+        readonly inputs: readonly [{
+            readonly name: "account";
+            readonly type: "address";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "newUIMultiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "effectiveAt";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "event";
+        readonly name: "UIMultiplierUpdated";
+        readonly inputs: readonly [{
+            readonly name: "oldMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "newMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "setAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "effectiveAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }, {
+        readonly type: "event";
+        readonly name: "TransferWithUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "from";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "to";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "uiAmount";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }];
+    readonly newUIMultiplier: readonly [{
+        readonly type: "function";
+        readonly name: "uiMultiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "toUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "rawAmount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "fromUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "uiAmount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "balanceOfUI";
+        readonly inputs: readonly [{
+            readonly name: "account";
+            readonly type: "address";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "newUIMultiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "effectiveAt";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "event";
+        readonly name: "UIMultiplierUpdated";
+        readonly inputs: readonly [{
+            readonly name: "oldMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "newMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "setAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "effectiveAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }, {
+        readonly type: "event";
+        readonly name: "TransferWithUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "from";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "to";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "uiAmount";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }];
+    readonly effectiveAt: readonly [{
+        readonly type: "function";
+        readonly name: "uiMultiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "toUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "rawAmount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "fromUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "uiAmount";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "balanceOfUI";
+        readonly inputs: readonly [{
+            readonly name: "account";
+            readonly type: "address";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "newUIMultiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "effectiveAt";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "event";
+        readonly name: "UIMultiplierUpdated";
+        readonly inputs: readonly [{
+            readonly name: "oldMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "newMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "setAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "effectiveAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }, {
+        readonly type: "event";
+        readonly name: "TransferWithUIAmount";
+        readonly inputs: readonly [{
+            readonly name: "from";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "to";
+            readonly type: "address";
+            readonly indexed: true;
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "uiAmount";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }];
+    readonly multiplier: readonly [{
+        readonly type: "function";
+        readonly name: "multiplier";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "WAD_PRECISION";
+        readonly inputs: readonly [];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "toScaledBalance";
+        readonly inputs: readonly [{
+            readonly name: "rawBalance";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "toRawBalance";
+        readonly inputs: readonly [{
+            readonly name: "scaledBalance";
+            readonly type: "uint256";
+        }];
+        readonly outputs: readonly [{
+            readonly name: "rawBalance";
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "function";
+        readonly name: "scaledBalanceOf";
+        readonly inputs: readonly [{
+            readonly name: "account";
+            readonly type: "address";
+        }];
+        readonly outputs: readonly [{
+            readonly type: "uint256";
+        }];
+        readonly stateMutability: "view";
+    }, {
+        readonly type: "event";
+        readonly name: "UIMultiplierUpdated";
+        readonly inputs: readonly [{
+            readonly name: "oldMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "newMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "effectiveAtTimestamp";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }, {
+        readonly type: "event";
+        readonly name: "MultiplierUpdateCancelled";
+        readonly inputs: readonly [{
+            readonly name: "cancelledMultiplier";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }, {
+            readonly name: "cancelledEffectiveAt";
+            readonly type: "uint256";
+            readonly indexed: false;
+        }];
+    }];
+};
+/** A conventional ERC-8056 token deployed on Base still gets the `erc8056` dialect. */
+export declare function resolveScaledUIDialect(chainId?: number, address?: string | null): ScaledUIDialect;
+export interface ScaledUIAmountRead {
+    address: Address;
+    abi: (typeof ABI_BY_FN)[ScaledUIAmountReadFn];
+    functionName: ScaledUIAmountReadFn;
+    chainId?: number;
+}
+/** Shape shared by viem `multicall` and wagmi `useReadContracts` result entries. */
+export interface ScaledUIAmountReadResult {
+    status: 'success' | 'failure';
+    result?: unknown;
+}
+/** Positional — `parseScaledUIAmountReads` must be called with the same dialect. */
+export declare function buildScaledUIAmountReads(params: {
+    address: Address;
+    chainId?: number;
+    dialect: ScaledUIDialect;
+}): ScaledUIAmountRead[];
 /**
- * Live ScaledUI metadata for a token, fetched from chain.
- *
- * The single join point between tokenlist `extensions.scaledUIAmount.enabled` and the
- * on-chain multiplier state. Consumers should treat `{ enabled: false, multiplier: 1e18 }`
+ * Live ScaledUI metadata for a token. Consumers should treat `{ enabled: false, multiplier: 1e18 }`
  * as the identity case and early-out from any scaling logic.
  */
 export type ScaledUIAmountMetadata = {
-    /** True if the contract implements ERC-8056's `uiMultiplier()`. */
     enabled: boolean;
-    /** Currently active multiplier (18-decimal fixed point). Defaults to `1e18` (identity). */
+    /** 18-decimal fixed point. Defaults to `1e18` (identity). */
     multiplier: bigint;
-    /** Pending scheduled multiplier (only present when an upcoming change is announced). */
     newMultiplier?: bigint;
-    /** Unix timestamp (seconds) at which the pending change activates. */
+    /** Unix seconds. */
     effectiveAt?: number;
 };
-/**
- * The identity metadata — returned for non-scaled tokens and on any read failure.
- * Safe default: behaves like a normal ERC-20 in every downstream calculation.
- */
+/** Returned for non-scaled tokens and on any read failure; behaves like a normal ERC-20. */
 export declare const IDENTITY_SCALED_UI_AMOUNT_METADATA: ScaledUIAmountMetadata;
+export declare function parseScaledUIAmountReads(results: readonly ScaledUIAmountReadResult[], dialect: ScaledUIDialect): ScaledUIAmountMetadata;
 /**
- * Probe a token contract for ERC-8056 support via ERC-165 `supportsInterface(0xa60bf13d)`.
- *
- * Returns `false` on any error (contract doesn't implement ERC-165, RPC failure, etc.) —
- * the caller is responsible for caching positive AND negative results with appropriate
- * TTL (see ticket memory: asymmetric 6-month/30-day cache in IndexedDB).
- *
- * Note: this is a perf-optimisation probe, not a correctness gate. Even if it returns
- * a stale "yes", `fetchScaledUIAmountMetadata` below will gracefully fall back to the
- * identity metadata if the actual contract calls revert.
- */
-export declare function probeIsScaledUIAmount(client: PublicClient, address: Address): Promise<boolean>;
-/**
- * Fetch live ScaledUI metadata for a token via a single multicall.
- *
- * Defensive read posture:
- * - All three reads use `allowFailure: true`.
- * - If `uiMultiplier()` fails, treats the token as non-scaled (identity metadata).
- * - If only the pending getters fail (common — they're optional in the spec), returns
- *   the active multiplier without pending-change info.
- *
- * Use this in concert with the IndexedDB ERC-165 cache to skip the call entirely for
- * tokens we know aren't 8056. But even without the cache, this function is safe to
- * call against any contract — it won't throw.
+ * A perf gate, not a correctness gate — `fetchScaledUIAmountMetadata` falls back to identity anyway
+ * if the reads revert. Callers cache both outcomes (asymmetric TTL in IndexedDB).
  */
-export declare function fetchScaledUIAmountMetadata(client: PublicClient, address: Address): Promise<ScaledUIAmountMetadata>;
+export declare function probeIsScaledUIAmount(client: PublicClient, address: Address, chainId?: number): Promise<boolean>;
+/** Safe against any contract — won't throw. */
+export declare function fetchScaledUIAmountMetadata(client: PublicClient, address: Address, chainId?: number): Promise<ScaledUIAmountMetadata>;
 export { SCALED_UI_DENOMINATOR, SCALED_UI_MULTIPLIER_DECIMALS, fromScaledUIAmount, isIdentityScaledUIMultiplier, toScaledUIAmount, } from '@pancakeswap/swap-sdk-core';
 //# sourceMappingURL=scaledUIAmount.d.ts.map

package/dist/scaledUIAmount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scaledUIAmount.d.ts","sourceRoot":"","sources":["../src/scaledUIAmount.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAIjD;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B,EAAG,YAAqB,CAAA;AAClE,eAAO,MAAM,sCAAsC,EAAG,YAAqB,CAAA;AAE3E;;;;;;GAMG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,mEAAmE;IACnE,OAAO,EAAE,OAAO,CAAA;IAChB,2FAA2F;IAC3F,UAAU,EAAE,MAAM,CAAA;IAClB,wFAAwF;IACxF,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,sEAAsE;IACtE,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kCAAkC,EAAE,sBAGhD,CAAA;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAYpG;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,sBAAsB,CAAC,CAgCjC;AAID,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,kBAAkB,EAClB,4BAA4B,EAC5B,gBAAgB,GACjB,MAAM,4BAA4B,CAAA"}
+{"version":3,"file":"scaledUIAmount.d.ts","sourceRoot":"","sources":["../src/scaledUIAmount.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAMjD,gGAAgG;AAChG,eAAO,MAAM,6BAA6B,EAAG,YAAqB,CAAA;AAClE,eAAO,MAAM,sCAAsC,EAAG,YAAqB,CAAA;AAE3E,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,KAAK,CAAA;AAE/C,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,YAAY,GAAG,iBAAiB,GAAG,aAAa,CAAA;AAyBpG,QAAA,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAK2C,CAAA;AAE1D,uFAAuF;AACvF,wBAAgB,sBAAsB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,eAAe,CAEjG;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,CAAC,OAAO,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAA;IAC7C,YAAY,EAAE,oBAAoB,CAAA;IAClC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,oFAAoF;AACpF,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,SAAS,GAAG,SAAS,CAAA;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED,oFAAoF;AACpF,wBAAgB,wBAAwB,CAAC,MAAM,EAAE;IAC/C,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,eAAe,CAAA;CACzB,GAAG,kBAAkB,EAAE,CASvB;AAKD;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,6DAA6D;IAC7D,UAAU,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,oBAAoB;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,4FAA4F;AAC5F,eAAO,MAAM,kCAAkC,EAAE,sBAGhD,CAAA;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,SAAS,wBAAwB,EAAE,EAC5C,OAAO,EAAE,eAAe,GACvB,sBAAsB,CA8BxB;AAED;;;GAGG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAelB;AAED,+CAA+C;AAC/C,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,YAAY,EACpB,OAAO,EAAE,OAAO,EAChB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,sBAAsB,CAAC,CAOjC;AAED,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,kBAAkB,EAClB,4BAA4B,EAC5B,gBAAgB,GACjB,MAAM,4BAA4B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pancakeswap/swap-sdk-evm",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "An SDK for Pancakeswap EVM based chains",
   "repository": {
     "type": "git",
@@ -18,8 +18,8 @@
     "tiny-invariant": "^1.3.0",
     "tiny-warning": "^1.0.3",
     "viem": "2.37.13",
-    "@pancakeswap/chains": "0.9.0",
-    "@pancakeswap/swap-sdk-core": "1.6.0"
+    "@pancakeswap/chains": "0.10.0",
+    "@pancakeswap/swap-sdk-core": "1.6.1"
   },
   "devDependencies": {
     "tsup": "^6.7.0",