@bananapus/nana-sdk-core 6.4.0 → 6.6.0

package/dist/cjs/v6/permit2.d.ts

@@ -1,4 +1,4 @@
-import type { Address, Hex, PublicClient } from "viem";
+import { type Address, type Hex, type PublicClient } from "viem";
 import type { JBChainId } from "../types.js";
 /** Canonical Permit2 deployment shared by supported EVM chains. */
 export declare const PERMIT2_ADDRESS: `0x${string}`;
@@ -166,4 +166,109 @@ export declare function shouldUsePermit2Signature({ needsApproval, walletLookupS
 }): boolean;
 /** Fall back only for wallets that cannot sign typed data, never on rejection. */
 export declare function permit2SignatureNeedsOnchainFallback(error: unknown): boolean;
+/** How long a signed pay authorization stays usable, matching the swap flows. */
+export declare const PERMIT2_PAY_AUTHORIZATION_SECONDS = 1800;
+/** What an ERC-20 payment to a pay entry still needs from the payer. */
+export interface Permit2PayAuthorization {
+    /** The entry's own ERC-20 allowance covers the amount: pay with no authorization. */
+    direct: boolean;
+    /** The token's allowance for Permit2 is short: one approval of Permit2 comes first. */
+    needsTokenApproval: boolean;
+    /** The exact, expiring allowance to sign with `signReviewed({ kind: "permit2" })`. */
+    authorization: Permit2SignatureAuthorization;
+}
+/**
+ * Read what paying `amount` of an ERC-20 into a pay entry needs. The entry is
+ * the contract the payer calls: JBMultiTerminal, JBRouterTerminal, its registry
+ * or its gateway. Each pulls through its own ERC-20 allowance when that covers
+ * the amount, and otherwise through Permit2 with the allowance its pay
+ * metadata carries (see {@link addPermit2PayMetadata}).
+ *
+ * The authorization is for exactly `amount`, to `entry` only, and expires
+ * {@link PERMIT2_PAY_AUTHORIZATION_SECONDS} after the chain's latest block.
+ */
+export declare function readPermit2PayAuthorization(client: PublicClient, { chainId, owner, token, entry, amount, blockNumber, }: {
+    chainId: JBChainId;
+    owner: Address;
+    token: Address;
+    entry: Address;
+    amount: bigint;
+    /** Read allowances at this block, so an approval just mined is seen on a lagging backend. */
+    blockNumber?: bigint;
+}): Promise<Permit2PayAuthorization>;
+/**
+ * Add a signed Permit2 allowance to pay metadata, keyed to the entry that
+ * spends it. The entry decodes one `JBSingleAllowance` tuple
+ * (`sigDeadline, amount, expiration, nonce, signature`), so the payload is a
+ * single dynamic tuple, not flat fields.
+ *
+ * @link https://github.com/Bananapus/nana-core-v6/blob/main/src/structs/JBSingleAllowance.sol
+ */
+export declare function addPermit2PayMetadata({ metadata, authorization, signature, }: {
+    metadata?: Hex;
+    authorization: Permit2SignatureAuthorization;
+    signature: Hex;
+}): Hex;
+/** A pay authorization the payer signed, kept while its payment retries. */
+export interface SignedPermit2PayAuthorization {
+    /** The account that signed. Permit2 checks the signature against the payer. */
+    owner: Address;
+    authorization: Permit2SignatureAuthorization;
+    signature: Hex;
+}
+/**
+ * Whether a signature from an earlier attempt still authorizes this exact
+ * payment: the same payer, chain, token, entry, amount and Permit2 nonce as a freshly
+ * read authorization, with time left. Permit2 moves the nonce on when an
+ * allowance is used, so a spent signature is never reused.
+ *
+ * @param signed The kept signature, if any.
+ * @param fresh From {@link readPermit2PayAuthorization} or {@link planErc20PayAuthorization} now.
+ * @param owner The account `fresh` was read for, which pays.
+ */
+export declare function permit2PayAuthorizationReusable(signed: SignedPermit2PayAuthorization | null | undefined, fresh: Permit2SignatureAuthorization, owner: Address): signed is SignedPermit2PayAuthorization;
+/** How a payer authorizes an ERC-20 payment to a pay entry. */
+export type Erc20PayAuthorizationPlan = 
+/** The entry's own allowance already covers the amount. */
+{
+    kind: "none";
+}
+/**
+ * A contract wallet (a Safe, or any account with code) approves the entry
+ * for the exact amount: it cannot produce the signature Permit2 checks, and
+ * its signers can outlast the authorization's deadline.
+ */
+ | {
+    kind: "approve";
+    spender: Address;
+    amount: bigint;
+}
+/**
+ * An EOA signs an exact, expiring Permit2 allowance for the entry. When
+ * `needsTokenApproval`, one approval of Permit2 itself comes first.
+ */
+ | {
+    kind: "permit2";
+    needsTokenApproval: boolean;
+    authorization: Permit2SignatureAuthorization;
+};
+/**
+ * Decide how `owner` authorizes paying `amount` of an ERC-20 into a pay entry.
+ * One rule for every client: nothing when the entry is already approved, an
+ * exact approval of the entry for contract wallets, a Permit2 signature for
+ * EOAs. The native token needs no authorization and has no plan; do not call
+ * this for it.
+ *
+ * @param args.isSafe The connected wallet is a Safe (a Safe app or a Safe
+ * reached through WalletConnect), whatever its code reads as here.
+ */
+export declare function planErc20PayAuthorization(client: PublicClient, { isSafe, ...args }: {
+    chainId: JBChainId;
+    owner: Address;
+    token: Address;
+    entry: Address;
+    amount: bigint;
+    blockNumber?: bigint;
+    isSafe: boolean;
+}): Promise<Erc20PayAuthorizationPlan>;
 //# sourceMappingURL=permit2.d.ts.map

package/dist/cjs/v6/permit2.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permit2.d.ts","sourceRoot":"","sources":["../../../src/v6/permit2.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAM7C,mEAAmE;AACnE,eAAO,MAAM,eAAe,eAA0B,CAAC;AAEvD,gFAAgF;AAChF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4Bb,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;CAYhB,CAAC;AAEX,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,0EAA0E;AAC1E,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoB5E;AAED,qFAAqF;AACrF,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,KAAK,EACL,KAAK,EACL,OAAO,GACR,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACA,OAAO,CAAC,gBAAgB,CAAC,CAe3B;AAED,6EAA6E;AAC7E,wBAAgB,4BAA4B,CAAC,EAC3C,SAAS,EACT,MAAM,EACN,GAAmC,EACnC,uBAA+B,GAChC,EAAE;IACD,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,GAAG,OAAO,CAQV;AAED,uFAAuF;AACvF,wBAAsB,oBAAoB,CAAC,EACzC,MAAM,EACN,OAAO,EACP,KAAK,EACL,KAAK,EACL,MAAM,EACN,GAAG,EACH,uBAAuB,GACxB,EAAE;IACD,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,GAAG,OAAO,CAAC,OAAO,CAAC,CAanB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,EACxC,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,MAAM,GACP,EAAE;IACD,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB,GAAG,OAAO,CAGV;AAED,kFAAkF;AAClF,wBAAgB,oCAAoC,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAgB5E"}
+{"version":3,"file":"permit2.d.ts","sourceRoot":"","sources":["../../../src/v6/permit2.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,OAAO,EACZ,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAEd,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAO7C,mEAAmE;AACnE,eAAO,MAAM,eAAe,eAA0B,CAAC;AAEvD,gFAAgF;AAChF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA4Bb,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;CAYhB,CAAC;AAEX,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,0EAA0E;AAC1E,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoB5E;AAED,qFAAqF;AACrF,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,KAAK,EACL,KAAK,EACL,OAAO,GACR,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACA,OAAO,CAAC,gBAAgB,CAAC,CAe3B;AAED,6EAA6E;AAC7E,wBAAgB,4BAA4B,CAAC,EAC3C,SAAS,EACT,MAAM,EACN,GAAmC,EACnC,uBAA+B,GAChC,EAAE;IACD,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAAE,QAAQ,GAAG,YAAY,CAAC,CAAC;IAC3D,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,GAAG,OAAO,CAQV;AAED,uFAAuF;AACvF,wBAAsB,oBAAoB,CAAC,EACzC,MAAM,EACN,OAAO,EACP,KAAK,EACL,KAAK,EACL,MAAM,EACN,GAAG,EACH,uBAAuB,GACxB,EAAE;IACD,MAAM,EAAE,YAAY,CAAC;IACrB,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC,GAAG,OAAO,CAAC,OAAO,CAAC,CAanB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,CAAC,EACxC,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,MAAM,GACP,EAAE;IACD,aAAa,EAAE,OAAO,CAAC;IACvB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,GAAG,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB,GAAG,OAAO,CAGV;AAED,kFAAkF;AAClF,wBAAgB,oCAAoC,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAgB5E;AAED,iFAAiF;AACjF,eAAO,MAAM,iCAAiC,OAAQ,CAAC;AAIvD,wEAAwE;AACxE,MAAM,WAAW,uBAAuB;IACtC,qFAAqF;IACrF,MAAM,EAAE,OAAO,CAAC;IAChB,uFAAuF;IACvF,kBAAkB,EAAE,OAAO,CAAC;IAC5B,sFAAsF;IACtF,aAAa,EAAE,6BAA6B,CAAC;CAC9C;AAED;;;;;;;;;GASG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,KAAK,EACL,KAAK,EACL,KAAK,EACL,MAAM,EACN,WAAW,GACZ,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,6FAA6F;IAC7F,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,OAAO,CAAC,uBAAuB,CAAC,CA0ClC;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,QAAQ,EACR,aAAa,EACb,SAAS,GACV,EAAE;IACD,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,aAAa,EAAE,6BAA6B,CAAC;IAC7C,SAAS,EAAE,GAAG,CAAC;CAChB,GAAG,GAAG,CA4BN;AAED,4EAA4E;AAC5E,MAAM,WAAW,6BAA6B;IAC5C,+EAA+E;IAC/E,KAAK,EAAE,OAAO,CAAC;IACf,aAAa,EAAE,6BAA6B,CAAC;IAC7C,SAAS,EAAE,GAAG,CAAC;CAChB;AAKD;;;;;;;;;GASG;AACH,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,6BAA6B,GAAG,IAAI,GAAG,SAAS,EACxD,KAAK,EAAE,6BAA6B,EACpC,KAAK,EAAE,OAAO,GACb,MAAM,IAAI,6BAA6B,CAkBzC;AAED,+DAA+D;AAC/D,MAAM,MAAM,yBAAyB;AACnC,2DAA2D;AACzD;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE;AAClB;;;;GAIG;GACD;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AACvD;;;GAGG;GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,aAAa,EAAE,6BAA6B,CAAC;CAC9C,CAAC;AAEN;;;;;;;;;GASG;AACH,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,YAAY,EACpB,EACE,MAAM,EACN,GAAG,IAAI,EACR,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;CACjB,GACA,OAAO,CAAC,yBAAyB,CAAC,CAkBpC"}

package/dist/cjs/v6/permit2.js

@@ -1,13 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PERMIT2_TYPES = exports.permit2Abi = exports.PERMIT2_ADDRESS = void 0;
+exports.PERMIT2_PAY_AUTHORIZATION_SECONDS = exports.PERMIT2_TYPES = exports.permit2Abi = exports.PERMIT2_ADDRESS = void 0;
 exports.permit2TypedData = permit2TypedData;
 exports.readPermit2Allowance = readPermit2Allowance;
 exports.permit2AllowanceNeedsRefresh = permit2AllowanceNeedsRefresh;
 exports.needsPermit2Approval = needsPermit2Approval;
 exports.shouldUsePermit2Signature = shouldUsePermit2Signature;
 exports.permit2SignatureNeedsOnchainFallback = permit2SignatureNeedsOnchainFallback;
+exports.readPermit2PayAuthorization = readPermit2PayAuthorization;
+exports.addPermit2PayMetadata = addPermit2PayMetadata;
+exports.permit2PayAuthorizationReusable = permit2PayAuthorizationReusable;
+exports.planErc20PayAuthorization = planErc20PayAuthorization;
+const viem_1 = require("viem");
 const constants_js_1 = require("../constants.js");
+const hook_js_1 = require("../utils/hook.js");
 const uniswapV4Deployments_js_1 = require("./uniswapV4Deployments.js");
 /** Canonical Permit2 deployment shared by supported EVM chains. */
 exports.PERMIT2_ADDRESS = uniswapV4Deployments_js_1.UNISWAP_PERMIT2_ADDRESS;
@@ -142,4 +148,147 @@ function permit2SignatureNeedsOnchainFallback(error) {
         return false;
     return /(^|\s)-32602(\s|$)|(^|\s)-32601(\s|$)|(^|\s)4200(\s|$)|invalid parameters|method .*not supported|unsupported method|typed data.*not supported/.test(text);
 }
+/** How long a signed pay authorization stays usable, matching the swap flows. */
+exports.PERMIT2_PAY_AUTHORIZATION_SECONDS = 1_800;
+const MAX_UINT160 = (1n << 160n) - 1n;
+/**
+ * Read what paying `amount` of an ERC-20 into a pay entry needs. The entry is
+ * the contract the payer calls: JBMultiTerminal, JBRouterTerminal, its registry
+ * or its gateway. Each pulls through its own ERC-20 allowance when that covers
+ * the amount, and otherwise through Permit2 with the allowance its pay
+ * metadata carries (see {@link addPermit2PayMetadata}).
+ *
+ * The authorization is for exactly `amount`, to `entry` only, and expires
+ * {@link PERMIT2_PAY_AUTHORIZATION_SECONDS} after the chain's latest block.
+ */
+async function readPermit2PayAuthorization(client, { chainId, owner, token, entry, amount, blockNumber, }) {
+    if (amount <= 0n || amount > MAX_UINT160) {
+        throw new Error("The payment amount is outside Permit2's uint160 range.");
+    }
+    const allowanceFor = (spender) => client.readContract({
+        address: token,
+        abi: viem_1.erc20Abi,
+        functionName: "allowance",
+        args: [owner, spender],
+        blockNumber,
+    });
+    const [direct, permit2Token, [, , nonce], block] = await Promise.all([
+        allowanceFor(entry),
+        allowanceFor(exports.PERMIT2_ADDRESS),
+        client.readContract({
+            address: exports.PERMIT2_ADDRESS,
+            abi: exports.permit2Abi,
+            functionName: "allowance",
+            args: [owner, token, entry],
+            blockNumber,
+        }),
+        client.getBlock({ blockTag: "latest" }),
+    ]);
+    const now = Number(block.timestamp);
+    if (!Number.isSafeInteger(now) || now <= 0) {
+        throw new Error("Could not read the chain's time for the authorization.");
+    }
+    const deadline = now + exports.PERMIT2_PAY_AUTHORIZATION_SECONDS;
+    return {
+        direct: direct >= amount,
+        needsTokenApproval: permit2Token < amount,
+        authorization: {
+            chainId,
+            token,
+            spender: entry,
+            amount,
+            expiration: deadline,
+            nonce,
+            sigDeadline: BigInt(deadline),
+        },
+    };
+}
+/**
+ * Add a signed Permit2 allowance to pay metadata, keyed to the entry that
+ * spends it. The entry decodes one `JBSingleAllowance` tuple
+ * (`sigDeadline, amount, expiration, nonce, signature`), so the payload is a
+ * single dynamic tuple, not flat fields.
+ *
+ * @link https://github.com/Bananapus/nana-core-v6/blob/main/src/structs/JBSingleAllowance.sol
+ */
+function addPermit2PayMetadata({ metadata, authorization, signature, }) {
+    return (0, hook_js_1.addToHookMetadata)(metadata, (0, hook_js_1.hookMetadataId)(authorization.spender, "permit2"), (0, viem_1.encodeAbiParameters)([
+        {
+            type: "tuple",
+            components: [
+                { name: "sigDeadline", type: "uint256" },
+                { name: "amount", type: "uint160" },
+                { name: "expiration", type: "uint48" },
+                { name: "nonce", type: "uint48" },
+                { name: "signature", type: "bytes" },
+            ],
+        },
+    ], [
+        {
+            sigDeadline: authorization.sigDeadline,
+            amount: authorization.amount,
+            expiration: authorization.expiration,
+            nonce: authorization.nonce,
+            signature,
+        },
+    ]));
+}
+/** A signed pay authorization this close to its deadline is signed again. */
+const PERMIT2_PAY_REUSE_MARGIN_SECONDS = 120;
+/**
+ * Whether a signature from an earlier attempt still authorizes this exact
+ * payment: the same payer, chain, token, entry, amount and Permit2 nonce as a freshly
+ * read authorization, with time left. Permit2 moves the nonce on when an
+ * allowance is used, so a spent signature is never reused.
+ *
+ * @param signed The kept signature, if any.
+ * @param fresh From {@link readPermit2PayAuthorization} or {@link planErc20PayAuthorization} now.
+ * @param owner The account `fresh` was read for, which pays.
+ */
+function permit2PayAuthorizationReusable(signed, fresh, owner) {
+    if (!signed)
+        return false;
+    const was = signed.authorization;
+    return (signed.owner.toLowerCase() === owner.toLowerCase() &&
+        was.chainId === fresh.chainId &&
+        was.token.toLowerCase() === fresh.token.toLowerCase() &&
+        was.spender.toLowerCase() === fresh.spender.toLowerCase() &&
+        was.amount === fresh.amount &&
+        was.nonce === fresh.nonce &&
+        // A fresh authorization expires a fixed time after the chain's latest
+        // block, so this compares against chain time.
+        was.sigDeadline >=
+            fresh.sigDeadline -
+                BigInt(exports.PERMIT2_PAY_AUTHORIZATION_SECONDS - PERMIT2_PAY_REUSE_MARGIN_SECONDS));
+}
+/**
+ * Decide how `owner` authorizes paying `amount` of an ERC-20 into a pay entry.
+ * One rule for every client: nothing when the entry is already approved, an
+ * exact approval of the entry for contract wallets, a Permit2 signature for
+ * EOAs. The native token needs no authorization and has no plan; do not call
+ * this for it.
+ *
+ * @param args.isSafe The connected wallet is a Safe (a Safe app or a Safe
+ * reached through WalletConnect), whatever its code reads as here.
+ */
+async function planErc20PayAuthorization(client, { isSafe, ...args }) {
+    const [read, walletBytecode] = await Promise.all([
+        readPermit2PayAuthorization(client, args),
+        client.getCode({ address: args.owner }),
+    ]);
+    if (read.direct)
+        return { kind: "none" };
+    return shouldUsePermit2Signature({
+        needsApproval: true,
+        walletLookupSettled: true,
+        walletBytecode,
+        isSafe,
+    })
+        ? {
+            kind: "permit2",
+            needsTokenApproval: read.needsTokenApproval,
+            authorization: read.authorization,
+        }
+        : { kind: "approve", spender: args.entry, amount: args.amount };
+}
 //# sourceMappingURL=permit2.js.map

package/dist/cjs/v6/permit2.js.map

@@ -1 +1 @@
-{"version":3,"file":"permit2.js","sourceRoot":"","sources":["../../../src/v6/permit2.ts"],"names":[],"mappings":";;;AA0EA,4CAoBC;AAGD,oDA4BC;AAGD,oEAkBC;AAGD,oDA6BC;AAMD,8DAaC;AAGD,oFAgBC;AAvND,kDAA+C;AAE/C,uEAGmC;AAEnC,mEAAmE;AACtD,QAAA,eAAe,GAAG,iDAAuB,CAAC;AAEvD,gFAAgF;AACnE,QAAA,UAAU,GAAG;IACxB;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,WAAW;QACjB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;SACrC;QACD,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;SAClC;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;QACf,eAAe,EAAE,YAAY;QAC7B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;SACvC;QACD,OAAO,EAAE,EAAE;KACZ;CACO,CAAC;AAEX,wEAAwE;AAC3D,QAAA,aAAa,GAAG;IAC3B,aAAa,EAAE;QACb,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;QAClC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;QACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;QACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;KAClC;IACD,YAAY,EAAE;QACZ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE;QAC1C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE;KACzC;CACO,CAAC;AAkBX,0EAA0E;AAC1E,SAAgB,gBAAgB,CAAC,aAA4C;IAC3E,OAAO;QACL,MAAM,EAAE;YACN,IAAI,EAAE,SAAkB;YACxB,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,iBAAiB,EAAE,uBAAe;SACnC;QACD,KAAK,EAAE,qBAAa;QACpB,WAAW,EAAE,cAAuB;QACpC,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,KAAK,EAAE,aAAa,CAAC,KAAK;gBAC1B,MAAM,EAAE,aAAa,CAAC,MAAM;gBAC5B,UAAU,EAAE,aAAa,CAAC,UAAU;gBACpC,KAAK,EAAE,aAAa,CAAC,KAAK;aAC3B;YACD,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,WAAW,EAAE,aAAa,CAAC,WAAW;SACvC;KACF,CAAC;AACJ,CAAC;AAED,qFAAqF;AAC9E,KAAK,UAAU,oBAAoB,CACxC,MAAoB,EACpB,EACE,OAAO,EACP,KAAK,EACL,KAAK,EACL,OAAO,GAMR;IAED,MAAM,eAAe,GACnB,OAAO,IAAI,IAAA,6CAAmB,EAAC,OAAO,CAAC,EAAE,eAAe,CAAC;IAC3D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,kDAAkD,OAAO,GAAG,CAC7D,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QAC5D,OAAO,EAAE,uBAAe;QACxB,GAAG,EAAE,kBAAU;QACf,YAAY,EAAE,WAAW;QACzB,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,eAAe,CAAC;KACtC,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;AACvC,CAAC;AAED,6EAA6E;AAC7E,SAAgB,4BAA4B,CAAC,EAC3C,SAAS,EACT,MAAM,EACN,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EACnC,uBAAuB,GAAG,KAAK,GAMhC;IACC,IAAI,uBAAuB,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,CACL,SAAS,CAAC,MAAM,GAAG,MAAM;QACzB,SAAS,CAAC,UAAU,IAAI,GAAG,GAAG,uBAAuB,CACtD,CAAC;AACJ,CAAC;AAED,uFAAuF;AAChF,KAAK,UAAU,oBAAoB,CAAC,EACzC,MAAM,EACN,OAAO,EACP,KAAK,EACL,KAAK,EACL,MAAM,EACN,GAAG,EACH,uBAAuB,GASxB;IACC,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,2BAAY,CAAC,WAAW,EAAE;QAAE,OAAO,KAAK,CAAC;IACrE,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,MAAM,EAAE;QACnD,OAAO;QACP,KAAK;QACL,KAAK;KACN,CAAC,CAAC;IACH,OAAO,4BAA4B,CAAC;QAClC,SAAS;QACT,MAAM;QACN,GAAG;QACH,uBAAuB;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,yBAAyB,CAAC,EACxC,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,MAAM,GAMP;IACC,MAAM,UAAU,GAAG,CAAC,CAAC,cAAc,IAAI,cAAc,KAAK,IAAI,CAAC;IAC/D,OAAO,aAAa,IAAI,mBAAmB,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC;AACxE,CAAC;AAED,kFAAkF;AAClF,SAAgB,oCAAoC,CAAC,KAAc;IACjE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,OAAO,GAAY,KAAK,CAAC;IAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,OAAO,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,MAAM;QACvC,MAAM,KAAK,GAAG,OAAkC,CAAC;QACjD,KAAK,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACjE,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS;gBAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC;IACxB,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9C,IAAI,gDAAgD,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9E,OAAO,+IAA+I,CAAC,IAAI,CACzJ,IAAI,CACL,CAAC;AACJ,CAAC"}
+{"version":3,"file":"permit2.js","sourceRoot":"","sources":["../../../src/v6/permit2.ts"],"names":[],"mappings":";;;AAiFA,4CAoBC;AAGD,oDA4BC;AAGD,oEAkBC;AAGD,oDA6BC;AAMD,8DAaC;AAGD,oFAgBC;AA2BD,kEA4DC;AAUD,sDAoCC;AAuBD,0EAsBC;AAgCD,8DAgCC;AAjdD,+BAMc;AACd,kDAA+C;AAE/C,8CAAqE;AACrE,uEAGmC;AAEnC,mEAAmE;AACtD,QAAA,eAAe,GAAG,iDAAuB,CAAC;AAEvD,gFAAgF;AACnE,QAAA,UAAU,GAAG;IACxB;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,WAAW;QACjB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;SACrC;QACD,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;YACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;SAClC;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,SAAS;QACf,eAAe,EAAE,YAAY;QAC7B,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;YAClC,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;YACpC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;YACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;SACvC;QACD,OAAO,EAAE,EAAE;KACZ;CACO,CAAC;AAEX,wEAAwE;AAC3D,QAAA,aAAa,GAAG;IAC3B,aAAa,EAAE;QACb,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;QAClC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;QACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;QACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;KAClC;IACD,YAAY,EAAE;QACZ,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE;QAC1C,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE;QACpC,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE;KACzC;CACO,CAAC;AAkBX,0EAA0E;AAC1E,SAAgB,gBAAgB,CAAC,aAA4C;IAC3E,OAAO;QACL,MAAM,EAAE;YACN,IAAI,EAAE,SAAkB;YACxB,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,iBAAiB,EAAE,uBAAe;SACnC;QACD,KAAK,EAAE,qBAAa;QACpB,WAAW,EAAE,cAAuB;QACpC,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,KAAK,EAAE,aAAa,CAAC,KAAK;gBAC1B,MAAM,EAAE,aAAa,CAAC,MAAM;gBAC5B,UAAU,EAAE,aAAa,CAAC,UAAU;gBACpC,KAAK,EAAE,aAAa,CAAC,KAAK;aAC3B;YACD,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,WAAW,EAAE,aAAa,CAAC,WAAW;SACvC;KACF,CAAC;AACJ,CAAC;AAED,qFAAqF;AAC9E,KAAK,UAAU,oBAAoB,CACxC,MAAoB,EACpB,EACE,OAAO,EACP,KAAK,EACL,KAAK,EACL,OAAO,GAMR;IAED,MAAM,eAAe,GACnB,OAAO,IAAI,IAAA,6CAAmB,EAAC,OAAO,CAAC,EAAE,eAAe,CAAC;IAC3D,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CACb,kDAAkD,OAAO,GAAG,CAC7D,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QAC5D,OAAO,EAAE,uBAAe;QACxB,GAAG,EAAE,kBAAU;QACf,YAAY,EAAE,WAAW;QACzB,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,eAAe,CAAC;KACtC,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;AACvC,CAAC;AAED,6EAA6E;AAC7E,SAAgB,4BAA4B,CAAC,EAC3C,SAAS,EACT,MAAM,EACN,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,EACnC,uBAAuB,GAAG,KAAK,GAMhC;IACC,IAAI,uBAAuB,GAAG,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,CACL,SAAS,CAAC,MAAM,GAAG,MAAM;QACzB,SAAS,CAAC,UAAU,IAAI,GAAG,GAAG,uBAAuB,CACtD,CAAC;AACJ,CAAC;AAED,uFAAuF;AAChF,KAAK,UAAU,oBAAoB,CAAC,EACzC,MAAM,EACN,OAAO,EACP,KAAK,EACL,KAAK,EACL,MAAM,EACN,GAAG,EACH,uBAAuB,GASxB;IACC,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,2BAAY,CAAC,WAAW,EAAE;QAAE,OAAO,KAAK,CAAC;IACrE,MAAM,SAAS,GAAG,MAAM,oBAAoB,CAAC,MAAM,EAAE;QACnD,OAAO;QACP,KAAK;QACL,KAAK;KACN,CAAC,CAAC;IACH,OAAO,4BAA4B,CAAC;QAClC,SAAS;QACT,MAAM;QACN,GAAG;QACH,uBAAuB;KACxB,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAgB,yBAAyB,CAAC,EACxC,aAAa,EACb,mBAAmB,EACnB,cAAc,EACd,MAAM,GAMP;IACC,MAAM,UAAU,GAAG,CAAC,CAAC,cAAc,IAAI,cAAc,KAAK,IAAI,CAAC;IAC/D,OAAO,aAAa,IAAI,mBAAmB,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC;AACxE,CAAC;AAED,kFAAkF;AAClF,SAAgB,oCAAoC,CAAC,KAAc;IACjE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAI,OAAO,GAAY,KAAK,CAAC;IAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,OAAO,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,MAAM;QACvC,MAAM,KAAK,GAAG,OAAkC,CAAC;QACjD,KAAK,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC;YACjE,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS;gBAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC;IACxB,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9C,IAAI,gDAAgD,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9E,OAAO,+IAA+I,CAAC,IAAI,CACzJ,IAAI,CACL,CAAC;AACJ,CAAC;AAED,iFAAiF;AACpE,QAAA,iCAAiC,GAAG,KAAK,CAAC;AAEvD,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AAYtC;;;;;;;;;GASG;AACI,KAAK,UAAU,2BAA2B,CAC/C,MAAoB,EACpB,EACE,OAAO,EACP,KAAK,EACL,KAAK,EACL,KAAK,EACL,MAAM,EACN,WAAW,GASZ;IAED,IAAI,MAAM,IAAI,EAAE,IAAI,MAAM,GAAG,WAAW,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAE,EAAE,CACxC,MAAM,CAAC,YAAY,CAAC;QAClB,OAAO,EAAE,KAAK;QACd,GAAG,EAAE,eAAQ;QACb,YAAY,EAAE,WAAW;QACzB,IAAI,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;QACtB,WAAW;KACZ,CAAC,CAAC;IACL,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,EAAE,AAAD,EAAG,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACnE,YAAY,CAAC,KAAK,CAAC;QACnB,YAAY,CAAC,uBAAe,CAAC;QAC7B,MAAM,CAAC,YAAY,CAAC;YAClB,OAAO,EAAE,uBAAe;YACxB,GAAG,EAAE,kBAAU;YACf,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;YAC3B,WAAW;SACZ,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;KACxC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACpC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,QAAQ,GAAG,GAAG,GAAG,yCAAiC,CAAC;IACzD,OAAO;QACL,MAAM,EAAE,MAAM,IAAI,MAAM;QACxB,kBAAkB,EAAE,YAAY,GAAG,MAAM;QACzC,aAAa,EAAE;YACb,OAAO;YACP,KAAK;YACL,OAAO,EAAE,KAAK;YACd,MAAM;YACN,UAAU,EAAE,QAAQ;YACpB,KAAK;YACL,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC;SAC9B;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,EACpC,QAAQ,EACR,aAAa,EACb,SAAS,GAKV;IACC,OAAO,IAAA,2BAAiB,EACtB,QAAQ,EACR,IAAA,wBAAc,EAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,EAChD,IAAA,0BAAmB,EACjB;QACE;YACE,IAAI,EAAE,OAAO;YACb,UAAU,EAAE;gBACV,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,SAAS,EAAE;gBACxC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;gBACnC,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACjC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE;aACrC;SACF;KACF,EACD;QACE;YACE,WAAW,EAAE,aAAa,CAAC,WAAW;YACtC,MAAM,EAAE,aAAa,CAAC,MAAM;YAC5B,UAAU,EAAE,aAAa,CAAC,UAAU;YACpC,KAAK,EAAE,aAAa,CAAC,KAAK;YAC1B,SAAS;SACV;KACF,CACF,CACF,CAAC;AACJ,CAAC;AAUD,6EAA6E;AAC7E,MAAM,gCAAgC,GAAG,GAAG,CAAC;AAE7C;;;;;;;;;GASG;AACH,SAAgB,+BAA+B,CAC7C,MAAwD,EACxD,KAAoC,EACpC,KAAc;IAEd,IAAI,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,aAAa,CAAC;IACjC,OAAO,CACL,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE;QAClD,GAAG,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO;QAC7B,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,KAAK,CAAC,WAAW,EAAE;QACrD,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE;QACzD,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM;QAC3B,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK;QACzB,sEAAsE;QACtE,8CAA8C;QAC9C,GAAG,CAAC,WAAW;YACb,KAAK,CAAC,WAAW;gBACf,MAAM,CACJ,yCAAiC,GAAG,gCAAgC,CACrE,CACN,CAAC;AACJ,CAAC;AAsBD;;;;;;;;;GASG;AACI,KAAK,UAAU,yBAAyB,CAC7C,MAAoB,EACpB,EACE,MAAM,EACN,GAAG,IAAI,EASR;IAED,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/C,2BAA2B,CAAC,MAAM,EAAE,IAAI,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;KACxC,CAAC,CAAC;IACH,IAAI,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACzC,OAAO,yBAAyB,CAAC;QAC/B,aAAa,EAAE,IAAI;QACnB,mBAAmB,EAAE,IAAI;QACzB,cAAc;QACd,MAAM;KACP,CAAC;QACA,CAAC,CAAC;YACE,IAAI,EAAE,SAAS;YACf,kBAAkB,EAAE,IAAI,CAAC,kBAAkB;YAC3C,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC;QACH,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;AACpE,CAAC"}

package/dist/cjs/v6/projectHooks.d.ts

@@ -0,0 +1,53 @@
+import { type Address, type PublicClient } from "viem";
+import type { JBChainId } from "../types.js";
+/** Where a project's buyback hook was found. */
+export type ProjectBuybackHookSource = 
+/** The ruleset's data hook is the buyback registry. */
+"registry"
+/** The data hook is a revnet's owner contract, which forwards to its registry. */
+ | "revnet"
+/** The data hook is the omnichain deployer, which forwards to the project's extra hook. */
+ | "omnichain"
+/** The data hook is a buyback hook itself. */
+ | "direct"
+/** The ruleset calls no buyback hook in this direction. */
+ | "none";
+export interface ResolvedProjectBuybackHook {
+    /** The buyback hook the project's current ruleset reaches, or null. */
+    hook: Address | null;
+    via: ProjectBuybackHookSource;
+    /** The current ruleset's data hook, or the zero address. */
+    dataHook: Address;
+    rulesetId: bigint;
+    /** The registry that resolved `hook`, when one did. */
+    registry: Address | null;
+}
+/**
+ * The buyback hook a project's current ruleset actually calls when it is paid
+ * or cashed out, found the way the contracts find it: through the ruleset's
+ * data hook.
+ *
+ * `JBBuybackHookRegistry.hookOf` answers for every project, with a cohort
+ * default when nothing is pinned, so reading it alone names a hook for
+ * projects whose rulesets never call one. This follows the data hook instead:
+ *
+ * - the registry itself: its `hookOf`;
+ * - a revnet's `REVOwner`: its own `BUYBACK_HOOK()` registry, then `hookOf`;
+ * - `JBOmnichainDeployer`: the project's extra data hook for this ruleset,
+ *   when it is used in this direction, resolved by the rules above. On cash
+ *   out the deployer skips the extra hook when the project's 721 hook handles
+ *   cash outs;
+ * - a buyback hook of any generation: that hook;
+ * - anything else, no data hook, or the direction's use flag off: none.
+ *
+ * A failed read throws: "no hook" is an answer, never a guess.
+ *
+ * @link https://github.com/Bananapus/nana-omnichain-deployers-v6/blob/main/src/JBOmnichainDeployer.sol
+ * @link https://github.com/rev-net/revnet-core-v6/blob/main/src/REVOwner.sol
+ */
+export declare function resolveProjectBuybackHook(client: PublicClient, { chainId, projectId, direction, }: {
+    chainId: JBChainId;
+    projectId: bigint;
+    direction?: "pay" | "cashOut";
+}): Promise<ResolvedProjectBuybackHook>;
+//# sourceMappingURL=projectHooks.d.ts.map

package/dist/cjs/v6/projectHooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectHooks.d.ts","sourceRoot":"","sources":["../../../src/v6/projectHooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,YAAY,EAA2B,MAAM,MAAM,CAAC;AAChF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAwG7C,gDAAgD;AAChD,MAAM,MAAM,wBAAwB;AAClC,uDAAuD;AACrD,UAAU;AACZ,kFAAkF;GAChF,QAAQ;AACV,2FAA2F;GACzF,WAAW;AACb,8CAA8C;GAC5C,QAAQ;AACV,2DAA2D;GACzD,MAAM,CAAC;AAEX,MAAM,WAAW,0BAA0B;IACzC,uEAAuE;IACvE,IAAI,EAAE,OAAO,GAAG,IAAI,CAAC;IACrB,GAAG,EAAE,wBAAwB,CAAC;IAC9B,4DAA4D;IAC5D,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,uDAAuD;IACvD,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,YAAY,EACpB,EACE,OAAO,EACP,SAAS,EACT,SAAiB,GAClB,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;CAC/B,GACA,OAAO,CAAC,0BAA0B,CAAC,CAwGrC"}

package/dist/cjs/v6/projectHooks.js

@@ -0,0 +1,203 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveProjectBuybackHook = resolveProjectBuybackHook;
+const viem_1 = require("viem");
+const types_js_1 = require("./types.js");
+// Only the reads below: the full ABIs would weigh on every card that asks.
+const hookConfig = [
+    { name: "dataHook", type: "address" },
+    { name: "useDataHookForPay", type: "bool" },
+    { name: "useDataHookForCashOut", type: "bool" },
+];
+const projectHooksAbi = [
+    {
+        type: "function",
+        name: "controllerOf",
+        stateMutability: "view",
+        inputs: [{ name: "projectId", type: "uint256" }],
+        outputs: [{ name: "", type: "address" }],
+    },
+    {
+        type: "function",
+        name: "currentRulesetOf",
+        stateMutability: "view",
+        inputs: [{ name: "projectId", type: "uint256" }],
+        outputs: [
+            {
+                name: "ruleset",
+                type: "tuple",
+                components: [
+                    { name: "cycleNumber", type: "uint48" },
+                    { name: "id", type: "uint48" },
+                    { name: "basedOnId", type: "uint48" },
+                    { name: "start", type: "uint48" },
+                    { name: "duration", type: "uint32" },
+                    { name: "weight", type: "uint112" },
+                    { name: "weightCutPercent", type: "uint32" },
+                    { name: "approvalHook", type: "address" },
+                    { name: "metadata", type: "uint256" },
+                ],
+            },
+            {
+                name: "metadata",
+                type: "tuple",
+                components: [
+                    { name: "reservedPercent", type: "uint16" },
+                    { name: "cashOutTaxRate", type: "uint16" },
+                    { name: "baseCurrency", type: "uint32" },
+                    { name: "pausePay", type: "bool" },
+                    { name: "pauseCreditTransfers", type: "bool" },
+                    { name: "allowOwnerMinting", type: "bool" },
+                    { name: "allowSetCustomToken", type: "bool" },
+                    { name: "allowTerminalMigration", type: "bool" },
+                    { name: "allowSetTerminals", type: "bool" },
+                    { name: "allowSetController", type: "bool" },
+                    { name: "allowAddAccountingContext", type: "bool" },
+                    { name: "allowAddPriceFeed", type: "bool" },
+                    { name: "ownerMustSendPayouts", type: "bool" },
+                    { name: "holdFees", type: "bool" },
+                    { name: "scopeCashOutsToLocalBalances", type: "bool" },
+                    { name: "useDataHookForPay", type: "bool" },
+                    { name: "useDataHookForCashOut", type: "bool" },
+                    { name: "dataHook", type: "address" },
+                    { name: "metadata", type: "uint16" },
+                ],
+            },
+        ],
+    },
+    {
+        type: "function",
+        name: "extraDataHookOf",
+        stateMutability: "view",
+        inputs: [
+            { name: "projectId", type: "uint256" },
+            { name: "rulesetId", type: "uint256" },
+        ],
+        outputs: [{ name: "hook", type: "tuple", components: hookConfig }],
+    },
+    {
+        type: "function",
+        name: "tiered721HookOf",
+        stateMutability: "view",
+        inputs: [
+            { name: "projectId", type: "uint256" },
+            { name: "rulesetId", type: "uint256" },
+        ],
+        outputs: [
+            { name: "hook", type: "address" },
+            { name: "useDataHookForCashOut", type: "bool" },
+        ],
+    },
+    {
+        type: "function",
+        name: "BUYBACK_HOOK",
+        stateMutability: "view",
+        inputs: [],
+        outputs: [{ name: "", type: "address" }],
+    },
+    {
+        type: "function",
+        name: "hookOf",
+        stateMutability: "view",
+        inputs: [{ name: "projectId", type: "uint256" }],
+        outputs: [{ name: "", type: "address" }],
+    },
+];
+/**
+ * The buyback hook a project's current ruleset actually calls when it is paid
+ * or cashed out, found the way the contracts find it: through the ruleset's
+ * data hook.
+ *
+ * `JBBuybackHookRegistry.hookOf` answers for every project, with a cohort
+ * default when nothing is pinned, so reading it alone names a hook for
+ * projects whose rulesets never call one. This follows the data hook instead:
+ *
+ * - the registry itself: its `hookOf`;
+ * - a revnet's `REVOwner`: its own `BUYBACK_HOOK()` registry, then `hookOf`;
+ * - `JBOmnichainDeployer`: the project's extra data hook for this ruleset,
+ *   when it is used in this direction, resolved by the rules above. On cash
+ *   out the deployer skips the extra hook when the project's 721 hook handles
+ *   cash outs;
+ * - a buyback hook of any generation: that hook;
+ * - anything else, no data hook, or the direction's use flag off: none.
+ *
+ * A failed read throws: "no hook" is an answer, never a guess.
+ *
+ * @link https://github.com/Bananapus/nana-omnichain-deployers-v6/blob/main/src/JBOmnichainDeployer.sol
+ * @link https://github.com/rev-net/revnet-core-v6/blob/main/src/REVOwner.sol
+ */
+async function resolveProjectBuybackHook(client, { chainId, projectId, direction = "pay", }) {
+    const read = (address, functionName, args = []) => client.readContract({
+        address,
+        abi: projectHooksAbi,
+        functionName,
+        args,
+    });
+    const used = (hook) => direction === "pay" ? hook.useDataHookForPay : hook.useDataHookForCashOut;
+    const is = (address, contract) => (0, types_js_1.isV6Deployment)(address, contract, chainId);
+    const controller = (await read((0, types_js_1.v6Address)("JBDirectory", chainId), "controllerOf", [projectId]));
+    const none = (dataHook, rulesetId) => ({
+        hook: null,
+        via: "none",
+        dataHook,
+        rulesetId,
+        registry: null,
+    });
+    if (controller === viem_1.zeroAddress)
+        return none(viem_1.zeroAddress, 0n);
+    const [ruleset, metadata] = (await read(controller, "currentRulesetOf", [
+        projectId,
+    ]));
+    const rulesetId = BigInt(ruleset.id);
+    const dataHook = (0, viem_1.getAddress)(metadata.dataHook);
+    /** The buyback hook behind one data hook, without unwrapping the omnichain deployer. */
+    const behind = async (hook) => {
+        if (is(hook, "JBBuybackHook")) {
+            return { hook, via: "direct", registry: null };
+        }
+        const revnet = is(hook, "REVOwner");
+        if (!revnet && !is(hook, "JBBuybackHookRegistry")) {
+            return { hook: null, via: "none", registry: null };
+        }
+        const registry = revnet
+            ? (0, viem_1.getAddress)((await read(hook, "BUYBACK_HOOK")))
+            : hook;
+        const resolved = (await read(registry, "hookOf", [projectId]));
+        return {
+            hook: resolved === viem_1.zeroAddress ? null : (0, viem_1.getAddress)(resolved),
+            via: revnet ? "revnet" : "registry",
+            registry,
+        };
+    };
+    if (dataHook === viem_1.zeroAddress || !used(metadata)) {
+        return none(dataHook, rulesetId);
+    }
+    if (!is(dataHook, "JBOmnichainDeployer")) {
+        return { ...(await behind(dataHook)), dataHook, rulesetId };
+    }
+    if (direction === "cashOut") {
+        const [hook721, handlesCashOut] = (await read(dataHook, "tiered721HookOf", [
+            projectId,
+            rulesetId,
+        ]));
+        if (hook721 !== viem_1.zeroAddress && handlesCashOut) {
+            return none(dataHook, rulesetId);
+        }
+    }
+    const extra = (await read(dataHook, "extraDataHookOf", [
+        projectId,
+        rulesetId,
+    ]));
+    if (extra.dataHook === viem_1.zeroAddress || !used(extra)) {
+        return none(dataHook, rulesetId);
+    }
+    const found = await behind((0, viem_1.getAddress)(extra.dataHook));
+    return {
+        ...found,
+        // The deployer is how the hook is reached; the registry field still names what resolved it.
+        via: found.hook ? "omnichain" : "none",
+        dataHook,
+        rulesetId,
+    };
+}
+//# sourceMappingURL=projectHooks.js.map

package/dist/cjs/v6/projectHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projectHooks.js","sourceRoot":"","sources":["../../../src/v6/projectHooks.ts"],"names":[],"mappings":";;AAwJA,8DAmHC;AA3QD,+BAAgF;AAEhF,yCAAuD;AAEvD,2EAA2E;AAC3E,MAAM,UAAU,GAAG;IACjB,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;IACrC,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE;IAC3C,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,EAAE;CACvC,CAAC;AACX,MAAM,eAAe,GAAG;IACtB;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,cAAc;QACpB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAChD,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KACzC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,kBAAkB;QACxB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAChD,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,OAAO;gBACb,UAAU,EAAE;oBACV,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACvC,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC9B,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACrC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACjC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACpC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE;oBACnC,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC5C,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,SAAS,EAAE;oBACzC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;iBACtC;aACF;YACD;gBACE,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,OAAO;gBACb,UAAU,EAAE;oBACV,EAAE,IAAI,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC3C,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC1C,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE;oBAClC,EAAE,IAAI,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC9C,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC3C,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC7C,EAAE,IAAI,EAAE,wBAAwB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAChD,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC3C,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC5C,EAAE,IAAI,EAAE,2BAA2B,EAAE,IAAI,EAAE,MAAM,EAAE;oBACnD,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC3C,EAAE,IAAI,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC9C,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE;oBAClC,EAAE,IAAI,EAAE,8BAA8B,EAAE,IAAI,EAAE,MAAM,EAAE;oBACtD,EAAE,IAAI,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC3C,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC/C,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,SAAS,EAAE;oBACrC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE;iBACrC;aACF;SACF;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,iBAAiB;QACvB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;YACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;SACvC;QACD,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;KACnE;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,iBAAiB;QACvB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;YACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;SACvC;QACD,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE;YACjC,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,MAAM,EAAE;SAChD;KACF;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,cAAc;QACpB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,EAAE;QACV,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KACzC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,QAAQ;QACd,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAChD,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;KACzC;CACO,CAAC;AA0BX;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,UAAU,yBAAyB,CAC7C,MAAoB,EACpB,EACE,OAAO,EACP,SAAS,EACT,SAAS,GAAG,KAAK,GAKlB;IAED,MAAM,IAAI,GAAG,CACX,OAAgB,EAChB,YAAkB,EAClB,OAA0B,EAAE,EAC5B,EAAE,CACF,MAAM,CAAC,YAAY,CAAC;QAClB,OAAO;QACP,GAAG,EAAE,eAAe;QACpB,YAAY;QACZ,IAAI;KACI,CAAqB,CAAC;IAClC,MAAM,IAAI,GAAG,CAAC,IAGb,EAAE,EAAE,CACH,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC;IAC5E,MAAM,EAAE,GAAG,CACT,OAAgB,EAChB,QAA8C,EAC9C,EAAE,CAAC,IAAA,yBAAc,EAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,CAAC,MAAM,IAAI,CAC5B,IAAA,oBAAS,EAAC,aAAa,EAAE,OAAO,CAAC,EACjC,cAAc,EACd,CAAC,SAAS,CAAC,CACZ,CAAY,CAAC;IACd,MAAM,IAAI,GAAG,CAAC,QAAiB,EAAE,SAAiB,EAAE,EAAE,CAAC,CAAC;QACtD,IAAI,EAAE,IAAI;QACV,GAAG,EAAE,MAAe;QACpB,QAAQ;QACR,SAAS;QACT,QAAQ,EAAE,IAAI;KACf,CAAC,CAAC;IACH,IAAI,UAAU,KAAK,kBAAW;QAAE,OAAO,IAAI,CAAC,kBAAW,EAAE,EAAE,CAAC,CAAC;IAC7D,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,EAAE,kBAAkB,EAAE;QACtE,SAAS;KACV,CAAC,CAOD,CAAC;IACF,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,IAAA,iBAAU,EAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE/C,wFAAwF;IACxF,MAAM,MAAM,GAAG,KAAK,EAClB,IAAa,EAC2D,EAAE;QAC1E,IAAI,EAAE,CAAC,IAAI,EAAE,eAAe,CAAC,EAAE,CAAC;YAC9B,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACjD,CAAC;QACD,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,uBAAuB,CAAC,EAAE,CAAC;YAClD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACrD,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM;YACrB,CAAC,CAAC,IAAA,iBAAU,EAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAAY,CAAC;YAC3D,CAAC,CAAC,IAAI,CAAC;QACT,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAY,CAAC;QAC1E,OAAO;YACL,IAAI,EAAE,QAAQ,KAAK,kBAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,iBAAU,EAAC,QAAQ,CAAC;YAC5D,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU;YACnC,QAAQ;SACT,CAAC;IACJ,CAAC,CAAC;IAEF,IAAI,QAAQ,KAAK,kBAAW,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChD,OAAO,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,qBAAqB,CAAC,EAAE,CAAC;QACzC,OAAO,EAAE,GAAG,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;IAC9D,CAAC;IACD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,CAAC,OAAO,EAAE,cAAc,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,iBAAiB,EAAE;YACzE,SAAS;YACT,SAAS;SACV,CAAC,CAAuB,CAAC;QAC1B,IAAI,OAAO,KAAK,kBAAW,IAAI,cAAc,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,iBAAiB,EAAE;QACrD,SAAS;QACT,SAAS;KACV,CAAC,CAID,CAAC;IACF,IAAI,KAAK,CAAC,QAAQ,KAAK,kBAAW,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACnD,OAAO,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAA,iBAAU,EAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACvD,OAAO;QACL,GAAG,KAAK;QACR,4FAA4F;QAC5F,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM;QACtC,QAAQ;QACR,SAAS;KACV,CAAC;AACJ,CAAC"}

package/dist/cjs/v6/revnets.d.ts

@@ -4483,5 +4483,47 @@ export declare function getRevnetTiered721Hook(client: PublicClient, args: {
     chainId: JBChainId;
     revnetId: bigint;
 }): Promise<Address>;
+/**
+ * Whether a revnet takes its 2.5% fee from a cash out, as
+ * `REVOwner.beforeCashOutRecordedWith` decides it. The fee is skipped when the
+ * ruleset's cash out tax rate is zero, when the fee revnet has no primary
+ * terminal for the reclaimed token, when the beneficiary is feeless, and for a
+ * sucker moving tokens between chains.
+ *
+ * `undefined` while the tax rate is unknown: an unknown fee is not shown as
+ * either extreme. This answers for revnets only; a project whose data hook is
+ * not a `REVOwner` pays no such fee.
+ *
+ * @param args.feeTerminalExists From {@link revnetCashOutFeeTerminalExists}.
+ * Defaults to true, the deployed fee revnet's state for the tokens it accepts.
+ * @link https://github.com/rev-net/revnet-core-v6/blob/main/src/REVOwner.sol (`beforeCashOutRecordedWith`)
+ */
+export declare function revnetCashOutFeeApplies({ cashOutTaxRate, feeTerminalExists, beneficiaryIsFeeless, holderIsSucker, }: {
+    cashOutTaxRate: bigint | number | undefined;
+    feeTerminalExists?: boolean;
+    beneficiaryIsFeeless?: boolean;
+    holderIsSucker?: boolean;
+}): boolean | undefined;
+/**
+ * The token count a revnet cash out reclaims against once its fee is taken:
+ * `count - count / 40`, the contract's own rounding. The other fortieth is
+ * cashed out for the fee revnet. The terminal's protocol fee then comes out of
+ * what this count reclaims (see `cashOutProtocolFee`).
+ *
+ * @param applies From {@link revnetCashOutFeeApplies}, once it is known; false returns the count unchanged.
+ */
+export declare function cashOutCountAfterRevnetFee(cashOutCount: bigint, applies: boolean): bigint;
+/**
+ * Whether the fee revnet can be paid in `token`: `REVOwner` charges its cash
+ * out fee only when `JBDirectory.primaryTerminalOf(FEE_REVNET_ID, token)` is set.
+ *
+ * @param args.revOwner The revnet's data hook. Defaults to the current `REVOwner`.
+ * @param args.token The token the cash out reclaims.
+ */
+export declare function revnetCashOutFeeTerminalExists(client: PublicClient, args: {
+    chainId: JBChainId;
+    token: Address;
+    revOwner?: Address;
+}): Promise<boolean>;
 export {};
 //# sourceMappingURL=revnets.d.ts.map