@bananapus/nana-sdk-core 3.1.0 → 3.3.0

package/dist/esm/v6/executionErrors.d.ts

@@ -0,0 +1,49 @@
+import { Hex } from "viem";
+/** Why a payment reverted, as a stable code apps and agents branch on. */
+export type PayFailureReason = "TERMINAL_UNDER_MIN" | "BUYBACK_SLIPPAGE_EXCEEDED" | "BUYBACK_DERIVED_FLOOR_NOT_MET" | "BUYBACK_SWAP_AMOUNT_TOO_HIGH" | "ROUTER_SLIPPAGE_EXCEEDED" | "ROUTER_NO_ROUTE" | "TOKEN_NOT_ACCEPTED" | "PAYMENTS_PAUSED" | "NO_RULESET" | "ALLOWANCE_TOO_LOW" | "ALLOWANCE_EXPIRED" | "BALANCE_TOO_LOW" | "UNEXPECTED_ETH" | "NFT_SOLD_OUT" | "NFT_UNAVAILABLE" | "NFT_PRICE_ABOVE_PAYMENT" | "NFT_OVERSPENDING";
+/**
+ * A decoded payment revert. `received` and `minimum` are set when the
+ * payment fell short of a minimum: the payer can lower `minReturnedTokens`
+ * (or raise the slippage it was floored by) and retry.
+ */
+export interface PayFailure {
+    reason: PayFailureReason;
+    /** What the payment would have settled, in the minimum's units. */
+    received?: bigint;
+    /** The minimum it fell short of. */
+    minimum?: bigint;
+    /** One plain sentence to show the payer. */
+    message: string;
+}
+interface KnownRevert {
+    reason: PayFailureReason;
+    name: string;
+    selector: Hex;
+    params: readonly ("uint256" | "address")[];
+    /** Argument positions of the settled amount and the minimum it missed. */
+    shortfall?: readonly [number, number];
+    message: string;
+}
+/**
+ * The first known revert in an error. Revert data, in its own field or quoted
+ * in the error's text, counts only as a bare selector or a selector with
+ * exactly its arguments, never as the start of a longer value such as an
+ * address or calldata, and the call or request viem quotes is left out. Amounts come
+ * from revert data or a decoded error; otherwise a selector or a whole error
+ * name names the reason alone.
+ */
+export declare function matchKnownRevert(error: unknown, reasons?: readonly PayFailureReason[]): {
+    known: KnownRevert;
+    args?: readonly unknown[];
+} | null;
+/**
+ * Decode why a payment reverted, from a simulation or transaction error
+ * (viem or wallet, however nested) or raw revert data. Covers the terminal's
+ * minimum, the buyback hook's minimum and floor, the router's conversion,
+ * paused or unready projects, token approvals and balances, and NFT tiers.
+ * A shortfall carries `received` and `minimum`, so the payer can lower the
+ * minimum and retry. Unknown reverts return null.
+ */
+export declare function decodePayFailure(error: unknown): PayFailure | null;
+export {};
+//# sourceMappingURL=executionErrors.d.ts.map

package/dist/esm/v6/executionErrors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"executionErrors.d.ts","sourceRoot":"","sources":["../../../src/v6/executionErrors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAuB,MAAM,MAAM,CAAC;AAyDhD,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GACxB,oBAAoB,GACpB,2BAA2B,GAC3B,+BAA+B,GAC/B,8BAA8B,GAC9B,0BAA0B,GAC1B,iBAAiB,GACjB,oBAAoB,GACpB,iBAAiB,GACjB,YAAY,GACZ,mBAAmB,GACnB,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,iBAAiB,GACjB,yBAAyB,GACzB,kBAAkB,CAAC;AAEvB;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,gBAAgB,CAAC;IACzB,mEAAmE;IACnE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,WAAW;IACnB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;IACd,MAAM,EAAE,SAAS,CAAC,SAAS,GAAG,SAAS,CAAC,EAAE,CAAC;IAC3C,0EAA0E;IAC1E,SAAS,CAAC,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAiMD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,SAAS,gBAAgB,EAAE,GACpC;IAAE,KAAK,EAAE,WAAW,CAAC;IAAC,IAAI,CAAC,EAAE,SAAS,OAAO,EAAE,CAAA;CAAE,GAAG,IAAI,CA2C1D;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,GAAG,IAAI,CAUlE"}

package/dist/esm/v6/executionErrors.js

@@ -0,0 +1,284 @@
+import { decodeAbiParameters } from "viem";
+const HEX = /^0x[0-9a-f]*$/i;
+function collectEvidence(value, evidence, asMessage = false, seen = new Set(), depth = 0) {
+    if (depth > 8 || value === null || value === undefined || seen.has(value)) {
+        return evidence;
+    }
+    if (typeof value === "string") {
+        (!asMessage && HEX.test(value)
+            ? evidence.payloads
+            : evidence.messages).push(value);
+        return evidence;
+    }
+    if (typeof value !== "object")
+        return evidence;
+    seen.add(value);
+    const record = value;
+    if (typeof record.errorName === "string") {
+        evidence.decoded.push({
+            name: record.errorName,
+            ...(Array.isArray(record.args) ? { args: record.args } : {}),
+        });
+    }
+    const next = (item, message) => collectEvidence(item, evidence, message, seen, depth + 1);
+    for (const item of [record.raw, record.data, record.signature]) {
+        next(item, false);
+    }
+    // A viem error's full message repeats the call it made, arguments and all;
+    // its short message and details are the error itself.
+    const message = typeof record.shortMessage === "string" ? undefined : record.message;
+    for (const item of [record.shortMessage, message, record.details]) {
+        next(item, true);
+    }
+    next(record.cause, false);
+    next(record.error, false);
+    return evidence;
+}
+const LOWER_MINIMUM = "so lower your minimum or try again.";
+const ALLOWANCE_MESSAGE = "The token approval is less than the payment, so approve the full amount and try again.";
+const UNEXPECTED_ETH_MESSAGE = "A payment in this token cannot also send ETH.";
+const KNOWN_REVERTS = [
+    {
+        reason: "BUYBACK_SLIPPAGE_EXCEEDED",
+        name: "JBBuybackHook_SpecifiedSlippageExceeded",
+        selector: "0xe2d708a9",
+        params: ["uint256", "uint256"],
+        shortfall: [0, 1],
+        message: `The price moved and this payment would get fewer tokens than your minimum, ${LOWER_MINIMUM}`,
+    },
+    {
+        reason: "TERMINAL_UNDER_MIN",
+        name: "JBMultiTerminal_UnderMin",
+        selector: "0x6b2bb382",
+        params: ["uint256", "uint256"],
+        shortfall: [0, 1],
+        message: `This payment would get fewer tokens than your minimum, ${LOWER_MINIMUM}`,
+    },
+    {
+        reason: "BUYBACK_DERIVED_FLOOR_NOT_MET",
+        name: "JBBuybackHook_DerivedFloorNotMet",
+        selector: "0xe490a239",
+        params: ["uint256", "uint256"],
+        shortfall: [0, 1],
+        message: "The token's price moved too fast to buy safely, so wait a few minutes and try again.",
+    },
+    {
+        reason: "ROUTER_SLIPPAGE_EXCEEDED",
+        name: "JBRouterTerminal_SlippageExceeded",
+        selector: "0x1dbd2ab5",
+        params: ["uint256", "uint256"],
+        shortfall: [0, 1],
+        message: "The price moved while converting your payment, so raise your slippage or try again.",
+    },
+    {
+        reason: "BUYBACK_SWAP_AMOUNT_TOO_HIGH",
+        name: "JBBuybackHook_InsufficientPayAmount",
+        selector: "0xcc8704dd",
+        params: ["uint256", "uint256"],
+        message: "The amount set aside to buy tokens is more than the payment.",
+    },
+    {
+        reason: "ROUTER_NO_ROUTE",
+        name: "JBRouterTerminal_NoRouteFound",
+        selector: "0x52027b4a",
+        params: ["uint256", "address"],
+        message: "This token cannot be converted into one the project accepts.",
+    },
+    {
+        reason: "ROUTER_NO_ROUTE",
+        name: "JBRouterTerminal_NoPoolFound",
+        selector: "0x04400f4a",
+        params: ["address", "address"],
+        message: "This token cannot be converted into one the project accepts.",
+    },
+    {
+        reason: "TOKEN_NOT_ACCEPTED",
+        name: "JBMultiTerminal_TokenNotAccepted",
+        selector: "0xecb6c1d6",
+        params: ["address"],
+        message: "This project does not accept this token.",
+    },
+    {
+        reason: "PAYMENTS_PAUSED",
+        name: "JBTerminalStore_RulesetPaymentPaused",
+        selector: "0x8dc14446",
+        params: ["uint256", "uint256"],
+        message: "This project is not accepting payments right now.",
+    },
+    {
+        reason: "NO_RULESET",
+        name: "JBTerminalStore_RulesetNotFound",
+        selector: "0x453ebd8f",
+        params: ["uint256"],
+        message: "This project is not set up to accept payments yet.",
+    },
+    {
+        reason: "ALLOWANCE_TOO_LOW",
+        name: "JBMultiTerminal_PermitAllowanceNotEnough",
+        selector: "0xc7e994ba",
+        params: ["uint256", "uint256"],
+        message: ALLOWANCE_MESSAGE,
+    },
+    {
+        reason: "ALLOWANCE_TOO_LOW",
+        name: "ERC20InsufficientAllowance",
+        selector: "0xfb8f41b2",
+        params: ["address", "uint256", "uint256"],
+        message: ALLOWANCE_MESSAGE,
+    },
+    ...[
+        ["JBRouterTerminal_PermitAllowanceNotEnough", "0x7686b38a"],
+        ["JBRouterTerminalRegistry_PermitAllowanceNotEnough", "0x3a521783"],
+        ["JBRouterTerminalGateway_PermitAllowanceNotEnough", "0x0f420d6e"],
+    ].map(([name, selector]) => ({
+        reason: "ALLOWANCE_TOO_LOW",
+        name,
+        selector,
+        params: ["uint256", "uint256"],
+        message: ALLOWANCE_MESSAGE,
+    })),
+    {
+        reason: "ALLOWANCE_TOO_LOW",
+        name: "InsufficientAllowance",
+        selector: "0xf96fb071",
+        params: ["uint256"],
+        message: ALLOWANCE_MESSAGE,
+    },
+    {
+        reason: "ALLOWANCE_EXPIRED",
+        name: "AllowanceExpired",
+        selector: "0xd81b2f2e",
+        params: ["uint256"],
+        message: "The token approval has expired, so approve it again and retry.",
+    },
+    {
+        reason: "BALANCE_TOO_LOW",
+        name: "ERC20InsufficientBalance",
+        selector: "0xe450d38c",
+        params: ["address", "uint256", "uint256"],
+        message: "Your token balance is less than the payment.",
+    },
+    {
+        reason: "UNEXPECTED_ETH",
+        name: "JBMultiTerminal_NoMsgValueAllowed",
+        selector: "0x3ad385fd",
+        params: ["uint256"],
+        message: UNEXPECTED_ETH_MESSAGE,
+    },
+    ...[
+        ["JBRouterTerminal_NoMsgValueAllowed", "0x90b2b3e2"],
+        ["JBRouterTerminalRegistry_NoMsgValueAllowed", "0x0fa1a882"],
+        ["JBRouterTerminalGateway_NoMsgValueAllowed", "0x49ce25f0"],
+    ].map(([name, selector]) => ({
+        reason: "UNEXPECTED_ETH",
+        name,
+        selector,
+        params: ["uint256"],
+        message: UNEXPECTED_ETH_MESSAGE,
+    })),
+    {
+        reason: "NFT_SOLD_OUT",
+        name: "JB721TiersHookStore_InsufficientSupplyRemaining",
+        selector: "0x90a08e24",
+        params: ["uint256"],
+        message: "One of the NFTs you picked is sold out.",
+    },
+    {
+        reason: "NFT_UNAVAILABLE",
+        name: "JB721TiersHookStore_TierRemoved",
+        selector: "0x8145a027",
+        params: ["uint256"],
+        message: "One of the NFTs you picked is no longer available.",
+    },
+    {
+        reason: "NFT_UNAVAILABLE",
+        name: "JB721TiersHookStore_UnrecognizedTier",
+        selector: "0xa6fe1eee",
+        params: ["uint256"],
+        message: "One of the NFTs you picked is no longer available.",
+    },
+    {
+        reason: "NFT_PRICE_ABOVE_PAYMENT",
+        name: "JB721TiersHookStore_PriceExceedsAmount",
+        selector: "0xee890b46",
+        params: ["uint256", "uint256"],
+        message: "The payment is less than the price of the NFTs you picked.",
+    },
+    {
+        reason: "NFT_OVERSPENDING",
+        name: "JB721TiersHook_Overspending",
+        selector: "0x42b9988e",
+        params: ["uint256"],
+        message: "This project takes only the exact price of the NFTs you pick.",
+    },
+];
+/**
+ * The first known revert in an error. Revert data, in its own field or quoted
+ * in the error's text, counts only as a bare selector or a selector with
+ * exactly its arguments, never as the start of a longer value such as an
+ * address or calldata, and the call or request viem quotes is left out. Amounts come
+ * from revert data or a decoded error; otherwise a selector or a whole error
+ * name names the reason alone.
+ */
+export function matchKnownRevert(error, reasons) {
+    const known = reasons
+        ? KNOWN_REVERTS.filter((k) => reasons.includes(k.reason))
+        : KNOWN_REVERTS;
+    const { payloads, decoded, messages } = collectEvidence(error, {
+        payloads: [],
+        decoded: [],
+        messages: [],
+    });
+    // A revert is its selector alone, or its selector and exactly its arguments.
+    const exact = (hex) => {
+        const lower = hex.toLowerCase();
+        const match = known.find((k) => lower.startsWith(k.selector));
+        if (!match)
+            return null;
+        if (lower.length === 10)
+            return { known: match };
+        if (lower.length !== 10 + 64 * match.params.length)
+            return null;
+        const args = decodeAbiParameters(match.params.map((type) => ({ type })), `0x${lower.slice(10)}`);
+        return { known: match, args };
+    };
+    // An HTTP error's details can quote the request body.
+    const text = messages.join("\n").replace(/request body:[^\n]*/gi, "");
+    const quoted = [
+        ...text.matchAll(/(?<![0-9a-fx])0x[0-9a-f]{8}(?:[0-9a-f]{64})*(?![0-9a-f])/gi),
+    ].map(([hex]) => hex);
+    const found = [...payloads, ...quoted].map(exact).filter((m) => !!m);
+    const withArgs = found.find((m) => m.args);
+    if (withArgs)
+        return withArgs;
+    for (const { name, args } of decoded) {
+        const match = known.find((k) => k.name.toLowerCase() === name.toLowerCase());
+        if (match)
+            return { known: match, ...(args ? { args } : {}) };
+    }
+    if (found[0])
+        return found[0];
+    const match = known.find((k) => new RegExp(`\\b${k.name}\\b`, "i").test(text));
+    return match ? { known: match } : null;
+}
+/**
+ * Decode why a payment reverted, from a simulation or transaction error
+ * (viem or wallet, however nested) or raw revert data. Covers the terminal's
+ * minimum, the buyback hook's minimum and floor, the router's conversion,
+ * paused or unready projects, token approvals and balances, and NFT tiers.
+ * A shortfall carries `received` and `minimum`, so the payer can lower the
+ * minimum and retry. Unknown reverts return null.
+ */
+export function decodePayFailure(error) {
+    const matched = matchKnownRevert(error);
+    if (!matched)
+        return null;
+    const { known, args } = matched;
+    const failure = { reason: known.reason, message: known.message };
+    if (known.shortfall && args) {
+        failure.received = args[known.shortfall[0]];
+        failure.minimum = args[known.shortfall[1]];
+    }
+    return failure;
+}
+//# sourceMappingURL=executionErrors.js.map

package/dist/esm/v6/executionErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"executionErrors.js","sourceRoot":"","sources":["../../../src/v6/executionErrors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAYhD,MAAM,GAAG,GAAG,gBAAgB,CAAC;AAE7B,SAAS,eAAe,CACtB,KAAc,EACd,QAAwB,EACxB,SAAS,GAAG,KAAK,EACjB,OAAO,IAAI,GAAG,EAAW,EACzB,KAAK,GAAG,CAAC;IAET,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1E,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;YAC5B,CAAC,CAAC,QAAQ,CAAC,QAAQ;YACnB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CACpB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACd,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC/C,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAChB,MAAM,MAAM,GAAG,KAAgC,CAAC;IAChD,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;QACzC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,MAAM,CAAC,SAAS;YACtB,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,IAAa,EAAE,OAAgB,EAAE,EAAE,CAC/C,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;IAC5D,KAAK,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;QAC/D,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpB,CAAC;IACD,2EAA2E;IAC3E,sDAAsD;IACtD,MAAM,OAAO,GACX,OAAO,MAAM,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACvE,KAAK,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAClE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC1B,OAAO,QAAQ,CAAC;AAClB,CAAC;AA+CD,MAAM,aAAa,GAAG,qCAAqC,CAAC;AAC5D,MAAM,iBAAiB,GACrB,wFAAwF,CAAC;AAC3F,MAAM,sBAAsB,GAAG,+CAA+C,CAAC;AAE/E,MAAM,aAAa,GAA2B;IAC5C;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,yCAAyC;QAC/C,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACjB,OAAO,EAAE,8EAA8E,aAAa,EAAE;KACvG;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,IAAI,EAAE,0BAA0B;QAChC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACjB,OAAO,EAAE,0DAA0D,aAAa,EAAE;KACnF;IACD;QACE,MAAM,EAAE,+BAA+B;QACvC,IAAI,EAAE,kCAAkC;QACxC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACjB,OAAO,EACL,sFAAsF;KACzF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,mCAAmC;QACzC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACjB,OAAO,EACL,qFAAqF;KACxF;IACD;QACE,MAAM,EAAE,8BAA8B;QACtC,IAAI,EAAE,qCAAqC;QAC3C,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,8DAA8D;KACxE;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,+BAA+B;QACrC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,8DAA8D;KACxE;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,8BAA8B;QACpC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,8DAA8D;KACxE;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,IAAI,EAAE,kCAAkC;QACxC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,0CAA0C;KACpD;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,sCAAsC;QAC5C,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,mDAAmD;KAC7D;IACD;QACE,MAAM,EAAE,YAAY;QACpB,IAAI,EAAE,iCAAiC;QACvC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,oDAAoD;KAC9D;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,0CAA0C;QAChD,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,iBAAiB;KAC3B;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,4BAA4B;QAClC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;QACzC,OAAO,EAAE,iBAAiB;KAC3B;IACD,GACE;QACE,CAAC,2CAA2C,EAAE,YAAY,CAAC;QAC3D,CAAC,mDAAmD,EAAE,YAAY,CAAC;QACnE,CAAC,kDAAkD,EAAE,YAAY,CAAC;KAErE,CAAC,GAAG,CACH,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAe,EAAE,CAAC,CAAC;QAClC,MAAM,EAAE,mBAAmB;QAC3B,IAAI;QACJ,QAAQ;QACR,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,iBAAiB;KAC3B,CAAC,CACH;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,uBAAuB;QAC7B,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,iBAAiB;KAC3B;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,kBAAkB;QACxB,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,gEAAgE;KAC1E;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,0BAA0B;QAChC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;QACzC,OAAO,EAAE,8CAA8C;KACxD;IACD;QACE,MAAM,EAAE,gBAAgB;QACxB,IAAI,EAAE,mCAAmC;QACzC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,sBAAsB;KAChC;IACD,GACE;QACE,CAAC,oCAAoC,EAAE,YAAY,CAAC;QACpD,CAAC,4CAA4C,EAAE,YAAY,CAAC;QAC5D,CAAC,2CAA2C,EAAE,YAAY,CAAC;KAE9D,CAAC,GAAG,CACH,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAe,EAAE,CAAC,CAAC;QAClC,MAAM,EAAE,gBAAgB;QACxB,IAAI;QACJ,QAAQ;QACR,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,sBAAsB;KAChC,CAAC,CACH;IACD;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,iDAAiD;QACvD,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,yCAAyC;KACnD;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,iCAAiC;QACvC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,oDAAoD;KAC9D;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,sCAAsC;QAC5C,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,oDAAoD;KAC9D;IACD;QACE,MAAM,EAAE,yBAAyB;QACjC,IAAI,EAAE,wCAAwC;QAC9C,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;QAC9B,OAAO,EAAE,4DAA4D;KACtE;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,6BAA6B;QACnC,QAAQ,EAAE,YAAY;QACtB,MAAM,EAAE,CAAC,SAAS,CAAC;QACnB,OAAO,EAAE,+DAA+D;KACzE;CACF,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAc,EACd,OAAqC;IAErC,MAAM,KAAK,GAAG,OAAO;QACnB,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACzD,CAAC,CAAC,aAAa,CAAC;IAClB,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC,KAAK,EAAE;QAC7D,QAAQ,EAAE,EAAE;QACZ,OAAO,EAAE,EAAE;QACX,QAAQ,EAAE,EAAE;KACb,CAAC,CAAC;IACH,6EAA6E;IAC7E,MAAM,KAAK,GAAG,CAAC,GAAW,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAChC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE;YAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QACjD,IAAI,KAAK,CAAC,MAAM,KAAK,EAAE,GAAG,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAChE,MAAM,IAAI,GAAG,mBAAmB,CAC9B,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EACtC,KAAK,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CACvB,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAChC,CAAC,CAAC;IACF,sDAAsD;IACtD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IACtE,MAAM,MAAM,GAAG;QACb,GAAG,IAAI,CAAC,QAAQ,CACd,4DAA4D,CAC7D;KACF,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IACtB,MAAM,KAAK,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3C,IAAI,QAAQ;QAAE,OAAO,QAAQ,CAAC;IAC9B,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,OAAO,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CACtB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CACnD,CAAC;QACF,IAAI,KAAK;YAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAChE,CAAC;IACD,IAAI,KAAK,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAC7B,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAC9C,CAAC;IACF,OAAO,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACzC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,OAAO,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAC1B,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAChC,MAAM,OAAO,GAAe,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;IAC7E,IAAI,KAAK,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAC5B,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAW,CAAC;QACtD,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAW,CAAC;IACvD,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/esm/v6/index.d.ts

@@ -13,6 +13,7 @@ export * from "./priceFeeds.js";
 export * from "./permit2.js";
 export * from "./projectPayers.js";
 export * from "./cashOut.js";
+export { decodePayFailure, type PayFailure, type PayFailureReason, } from "./executionErrors.js";
 export * from "./nft.js";
 export * from "./nftInventory.js";
 export * from "./defifa.js";

package/dist/esm/v6/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v6/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,iBAAiB,EACjB,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACnB,MAAM,qBAAqB,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v6/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,OAAO,EACL,gBAAgB,EAChB,KAAK,UAAU,EACf,KAAK,gBAAgB,GACtB,MAAM,sBAAsB,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,iBAAiB,EACjB,KAAK,kBAAkB,EACvB,KAAK,aAAa,GACnB,MAAM,qBAAqB,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC"}

package/dist/esm/v6/index.js

@@ -13,6 +13,7 @@ export * from "./priceFeeds.js";
 export * from "./permit2.js";
 export * from "./projectPayers.js";
 export * from "./cashOut.js";
+export { decodePayFailure, } from "./executionErrors.js";
 export * from "./nft.js";
 export * from "./nftInventory.js";
 export * from "./defifa.js";

package/dist/esm/v6/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v6/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,iBAAiB,GAGlB,MAAM,qBAAqB,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/v6/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,WAAW,CAAC;AAC1B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,OAAO,EACL,gBAAgB,GAGjB,MAAM,sBAAsB,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,mBAAmB,CAAC;AAClC,cAAc,aAAa,CAAC;AAC5B,OAAO,EACL,iBAAiB,GAGlB,MAAM,qBAAqB,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC"}

package/dist/esm/v6/pay.d.ts

@@ -67,8 +67,12 @@ export interface PayPreview {
  * reports zero; the hook's pay specification carries the swap quote. This folds
  * it in with the router terminal's scoring rule (see
  * {@link effectivePayPreview}), for the hook the buyback registry resolves for
- * the project, 1.4 or 1.1.1. The swap figure ignores pool fees and price
- * impact, so use {@link prepareUserPay} for a payment's minimum.
+ * the project, 1.4 or 1.1.1, or for buyback 1.4 when the ruleset calls it
+ * directly. It only recognizes that hook's spec: it sends `metadata` as given,
+ * and a direct hook reads only an entry keyed to its own address, so
+ * registry-keyed metadata is ignored there. {@link prepareUserPay} rekeys it.
+ * The swap figure ignores pool fees and price impact, so use
+ * {@link prepareUserPay} for a payment's minimum.
  *
  * @param client A viem public client on the given chain.
  * @param args.chainId The chain to preview on.
@@ -122,25 +126,40 @@ export interface PreparedUserPay {
  * Prepare a person's payment with {@link buildUserPayMetadata}: preview it,
  * and set the minimum the terminal enforces on the beneficiary's balance.
  *
- * When the project's buyback hook honors `skipSplits` and its pool is in the
- * paid token, this quotes that pool (fee and price impact included) and sends
- * the slippage-floored quote as an explicit minimum. The hook then swaps
- * whenever the pool beats the payer's share of a mint, and reverts below the
- * floor. Without it the hook routes by its TWAP floor, which reaches zero on
- * large buys against a thin pool and sends them to minting even when the pool
- * pays far more.
+ * When the project's buyback hook has a pool in the paid token, this quotes
+ * that pool (fee and price impact included) and sends the slippage-floored
+ * quote as an explicit minimum, so the payer gets the pool's rate whenever it
+ * beats minting. The hook compares that minimum to the swap output plus the
+ * leftover mint: the whole leftover mint when the swapped tokens go through
+ * the reserved split (`skipSplits` false, and always on hook 1.1.1, which
+ * ignores `skipSplits`), its beneficiary share when they skip it. The
+ * terminal minimum is the beneficiary's part of that guarantee, plus what the
+ * terminal issues itself (such as for NFT splits). The quoted payment is
+ * previewed again first, and stays on the mint path if the hook would not
+ * swap with that minimum. Without a quote the hook routes by its TWAP floor,
+ * which reaches zero on large buys against a thin pool and sends them to
+ * minting even when the pool pays far more.
  *
- * Otherwise (no pool, hook 1.1.1, a router converting the token first, or a
- * failed quote) the hook routes by TWAP. The minimum is then the payer's mint
- * entitlement when the hook would swap, since the hook never settles below it,
- * and the terminal's own issuance when it would not.
+ * Otherwise (no pool, a router converting the token first, or a failed quote)
+ * the minimum is the payer's mint entitlement when the hook would swap, since
+ * the hook never settles below it, and the terminal's own issuance when it
+ * would not. If the payment then reverts, {@link decodePayFailure} says why.
+ *
+ * When the ruleset calls buyback hook 1.4 directly (or through the omnichain
+ * deployer) instead of through the registry, the metadata is keyed to the hook,
+ * which reads nothing else.
  *
  * @param args.slippageBps Tolerance on the pool quote and on the fallback
  * minimum. Defaults to 100 (1%).
+ * @param args.skipSplits Whether the beneficiary keeps the swapped tokens
+ * without the reserved split. Defaults to true, as a person's pay card does;
+ * pass false for payments that should honor the project's splits, such as
+ * fees or revenue routed into a project.
  */
-export declare function prepareUserPay(client: PublicClient, { tiers, slippageBps, ...args }: PayArgs & {
+export declare function prepareUserPay(client: PublicClient, { tiers, slippageBps, skipSplits, ...args }: PayArgs & {
     tiers?: UserPayTiers;
     slippageBps?: bigint;
+    skipSplits?: boolean;
 }): Promise<PreparedUserPay>;
 /**
  * Build pay metadata instructing a project's JB721 tiers hook to mint specific tiers.
@@ -189,21 +208,26 @@ export interface UserPayTiers {
 }
 /**
  * The pay metadata a person's pay card sends: the buyback registry's quote
- * `(0, minimumSwapAmountOut, skipSplits=true)`, plus the 721 tiers when the
- * payment buys NFTs. Prefer {@link prepareUserPay}, which picks the minimum.
+ * `(0, minimumSwapAmountOut, skipSplits)`, plus the 721 tiers when the
+ * payment buys NFTs. Prefer {@link prepareUserPay}, which picks the minimum
+ * and the hook. `hook` keys the quote to a buyback hook the ruleset calls
+ * directly instead of to the registry.
  *
  * The registry rekeys its quote to the project's resolved hook. On buyback 1.4
  * the hook buys from the pool only when that gives the payer more than their
- * share of a mint, and hands the swapped tokens over without the reserved
- * split. Minting still goes through the split. A zero swap amount swaps the
+ * share of a mint. With `skipSplits` true (the default) it hands the swapped
+ * tokens over without the reserved split; with false they go through the
+ * split. Minting always goes through the split. A zero swap amount swaps the
  * whole payment. A zero minimum routes by the hook's TWAP floor; a nonzero one
  * replaces it and reverts below it. The terminal's `minReturnedTokens` checks
  * the beneficiary's balance change, which counts the swapped tokens.
  */
-export declare function buildUserPayMetadata({ chainId, tiers, minimumSwapAmountOut, }: {
+export declare function buildUserPayMetadata({ chainId, tiers, minimumSwapAmountOut, skipSplits, hook, }: {
     chainId: JBChainId;
     tiers?: UserPayTiers;
     minimumSwapAmountOut?: bigint;
+    skipSplits?: boolean;
+    hook?: Address;
 }): Hex;
 export {};
 //# sourceMappingURL=pay.d.ts.map

package/dist/esm/v6/pay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pay.d.ts","sourceRoot":"","sources":["../../../src/v6/pay.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,GAAG,EACH,YAAY,EAGb,MAAM,MAAM,CAAC;AAMd,OAAO,EAEL,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AASxC;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,kBAAkB,CAAC;IAC/B,YAAY,EAAE,KAAK,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,UAAU,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,iBAAsB,EACtB,IAAS,EACT,QAAe,GAChB,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;CAChB,GAAG,cAAc,CAmBjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,OAAO,GAAG;IAAE,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,GACjC,OAAO,CAAC,UAAU,CAAC,CAErB;AAED,UAAU,OAAO;IACf,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;CACtB;AAmBD,KAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;CACf,CAAC;AAkDF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,EACN,eAAoB,EACpB,kBAAkB,GACnB,EAAE;IACD,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,SAAS,oBAAoB,EAAE,CAAC;CACrD,GAAG,UAAU,CAuCb;AAsGD,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,UAAU,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AA2BD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,YAAY,EACpB,EACE,KAAK,EACL,WAAkB,EAClB,GAAG,IAAI,EACR,EAAE,OAAO,GAAG;IAAE,KAAK,CAAC,EAAE,YAAY,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC1D,OAAO,CAAC,eAAe,CAAC,CAkE1B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,iBAA8C,GAC/C,EAAE;IACD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,GAAG,GAAG,CAeN;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,IAAI,EACJ,gBAAgB,EAChB,oBAAoB,EACpB,UAAkB,GACnB,EAAE;IACD,IAAI,EAAE,OAAO,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,GAAG,GAAG,CAUN;AAED,oCAAoC;AACpC,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,OAAO,EACP,KAAK,EACL,oBAAyB,GAC1B,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,GAAG,GAAG,CAuBN"}
+{"version":3,"file":"pay.d.ts","sourceRoot":"","sources":["../../../src/v6/pay.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,GAAG,EACH,YAAY,EAIb,MAAM,MAAM,CAAC;AAMd,OAAO,EAEL,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AASxC;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,kBAAkB,CAAC;IAC/B,YAAY,EAAE,KAAK,CAAC;IACpB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACvE,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,UAAU,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,iBAAsB,EACtB,IAAS,EACT,QAAe,GAChB,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,GAAG,CAAC;CAChB,GAAG,cAAc,CAmBjB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,OAAO,GAAG;IAAE,QAAQ,CAAC,EAAE,GAAG,CAAA;CAAE,GACjC,OAAO,CAAC,UAAU,CAAC,CAErB;AAED,UAAU,OAAO;IACf,OAAO,EAAE,SAAS,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;CACtB;AAmBD,KAAK,oBAAoB,GAAG;IAC1B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,GAAG,CAAC;CACf,CAAC;AAkDF;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,EACN,eAAoB,EACpB,kBAAkB,GACnB,EAAE;IACD,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,uDAAuD;IACvD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,EAAE,SAAS,oBAAoB,EAAE,CAAC;CACrD,GAAG,UAAU,CAuCb;AA0KD,+EAA+E;AAC/E,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,UAAU,CAAC;IACpB,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AA2BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,YAAY,EACpB,EACE,KAAK,EACL,WAAkB,EAClB,UAAiB,EACjB,GAAG,IAAI,EACR,EAAE,OAAO,GAAG;IACX,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,GACA,OAAO,CAAC,eAAe,CAAC,CAgH1B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,iBAA8C,GAC/C,EAAE;IACD,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,0CAA0C;IAC1C,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,GAAG,GAAG,CAeN;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,EACtC,IAAI,EACJ,gBAAgB,EAChB,oBAAoB,EACpB,UAAkB,GACnB,EAAE;IACD,IAAI,EAAE,OAAO,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,GAAG,GAAG,CAUN;AAED,oCAAoC;AACpC,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,OAAO,EACP,KAAK,EACL,oBAAyB,EACzB,UAAiB,EACjB,IAAkD,GACnD,EAAE;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GAAG,GAAG,CAqBN"}