@bananapus/nana-sdk-core 2.41.2 → 3.0.0

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

@@ -59,39 +59,16 @@ export interface PayPreview {
      */
     reservedTokenCount: bigint;
 }
-export type PaySettlement = "issuance" | "swap";
-export interface PayRouteCandidate extends PayPreview {
-    kind: "pay";
-    settlement: PaySettlement;
-}
-export interface DirectSwapRouteCandidate extends PayPreview {
-    kind: "direct-swap";
-    settlement: "swap";
-    quotedTokenCount: bigint;
-}
-export type BestPayRoute = PayRouteCandidate | DirectSwapRouteCandidate;
-/**
- * Pick the executable route which guarantees the beneficiary the most tokens.
- *
- * A direct pool swap bypasses the terminal, so its reserved token count is always
- * zero. Its quote is reduced by `slippageBps` before comparison: a route is only
- * selected when its on-chain minimum beats the terminal preview, not merely when
- * its optimistic quote does.
- */
-export declare function chooseBestPayRoute({ pay, paySettlement, directSwapQuote, slippageBps, }: {
-    pay: PayPreview;
-    paySettlement: PaySettlement;
-    directSwapQuote?: bigint | null;
-    slippageBps?: bigint;
-}): BestPayRoute;
 /**
- * Preview the project tokens minted by a payment, via the terminal's
- * `previewPayFor(projectId, token, amount, beneficiary, metadata)`.
+ * Preview the project tokens a payment puts in the beneficiary's hands, via the
+ * terminal's `previewPayFor(projectId, token, amount, beneficiary, metadata)`.
  *
- * The terminal's `previewPayFor` is used (rather than
- * `JBTerminalStore.previewPayFrom`) because it takes exactly the data a `pay` caller
- * already has — the store variant additionally requires a full `JBTokenAmount` tuple
- * (token, decimals, currency, value), forcing an extra accounting-context lookup.
+ * When the buyback hook wins the route, the terminal mints nothing itself and
+ * 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.
  *
  * @param client A viem public client on the given chain.
  * @param args.chainId The chain to preview on.
@@ -100,19 +77,71 @@ export declare function chooseBestPayRoute({ pay, paySettlement, directSwapQuote
  * @param args.token The token being paid.
  * @param args.amount The amount being paid, as a fixed point number with the token's
  * decimals.
- * @param args.beneficiary The address that would receive the minted project tokens.
+ * @param args.beneficiary The address that would receive the project tokens.
  * @param args.metadata Hook metadata. Defaults to "0x".
  * @returns The previewed token counts.
  */
-export declare function previewPay(client: PublicClient, { terminal, projectId, token, amount, beneficiary, metadata, }: {
+export declare function previewPay(client: PublicClient, args: PayArgs & {
+    metadata?: Hex;
+}): Promise<PayPreview>;
+interface PayArgs {
     chainId: JBChainId;
     terminal: Address;
     projectId: bigint;
     token: Address;
     amount: bigint;
     beneficiary: Address;
-    metadata?: Hex;
-}): Promise<PayPreview>;
+}
+type PayHookSpecification = {
+    hook: Address;
+    noop: boolean;
+    metadata: Hex;
+};
+/**
+ * Fold the buyback hook's pay specification into a terminal preview, with the
+ * rule `JBPayRouteResolver._effectivePreviewPayTokenCounts` scores routes by.
+ * The swap leg uses the hook's raw quote: the TWAP price times the amount, with
+ * no pool fee or price impact. It is a ranking figure, not a minimum.
+ */
+export declare function effectivePayPreview({ buybackHook, beneficiaryTokenCount, reservedTokenCount, weight, reservedPercent, hookSpecifications, }: {
+    buybackHook: Address | null;
+    beneficiaryTokenCount: bigint;
+    reservedTokenCount: bigint;
+    weight: bigint;
+    /** The ruleset's reserved percent, for 1.1.1 specs. */
+    reservedPercent?: bigint;
+    hookSpecifications: readonly PayHookSpecification[];
+}): PayPreview;
+/** A pay card's whole payment: what to send, what to show, what to require. */
+export interface PreparedUserPay {
+    metadata: Hex;
+    preview: PayPreview;
+    minReturnedTokens: bigint;
+}
+/**
+ * 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.
+ *
+ * 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.
+ *
+ * @param args.slippageBps Tolerance on the pool quote and on the fallback
+ * minimum. Defaults to 100 (1%).
+ */
+export declare function prepareUserPay(client: PublicClient, { tiers, slippageBps, ...args }: PayArgs & {
+    tiers?: UserPayTiers;
+    slippageBps?: bigint;
+}): Promise<PreparedUserPay>;
 /**
  * Build pay metadata instructing a project's JB721 tiers hook to mint specific tiers.
  *
@@ -152,4 +181,29 @@ export declare function buildBuybackPayMetadata({ hook, amountToSwapWith, minimu
     minimumSwapAmountOut: bigint;
     skipSplits?: boolean;
 }): Hex;
+/** The 721 tiers a payment buys. */
+export interface UserPayTiers {
+    metadataIdTarget: Address;
+    tierIdsToMint: bigint[];
+    allowOverspending?: boolean;
+}
+/**
+ * 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.
+ *
+ * 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
+ * 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, }: {
+    chainId: JBChainId;
+    tiers?: UserPayTiers;
+    minimumSwapAmountOut?: bigint;
+}): Hex;
+export {};
 //# sourceMappingURL=pay.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"pay.d.ts","sourceRoot":"","sources":["../../../src/v6/pay.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAuB,MAAM,MAAM,CAAC;AAEvE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC;;;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,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,MAAM,CAAC;AAEhD,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,IAAI,EAAE,KAAK,CAAC;IACZ,UAAU,EAAE,aAAa,CAAC;CAC3B;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,IAAI,EAAE,aAAa,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,wBAAwB,CAAC;AAExE;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,EACjC,GAAG,EACH,aAAa,EACb,eAAe,EACf,WAAkB,GACnB,EAAE;IACD,GAAG,EAAE,UAAU,CAAC;IAChB,aAAa,EAAE,aAAa,CAAC;IAC7B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,YAAY,CAsBf;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,UAAU,CAC9B,MAAM,EAAE,YAAY,EACpB,EACE,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,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,QAAQ,CAAC,EAAE,GAAG,CAAC;CAChB,GACA,OAAO,CAAC,UAAU,CAAC,CAUrB;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"}
+{"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,CA0BN"}

package/dist/cjs/v6/pay.js

@@ -1,14 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildPayTx = buildPayTx;
-exports.chooseBestPayRoute = chooseBestPayRoute;
 exports.previewPay = previewPay;
+exports.effectivePayPreview = effectivePayPreview;
+exports.prepareUserPay = prepareUserPay;
 exports.build721PayMetadata = build721PayMetadata;
 exports.buildBuybackPayMetadata = buildBuybackPayMetadata;
+exports.buildUserPayMetadata = buildUserPayMetadata;
 const viem_1 = require("viem");
 const constants_js_1 = require("../constants.js");
 const juicebox_js_1 = require("../generated/juicebox.js");
+const contracts_js_1 = require("../utils/contracts.js");
 const hook_js_1 = require("../utils/hook.js");
+const cashOut_js_1 = require("./cashOut.js");
+const uniswapV4_js_1 = require("./uniswapV4.js");
 /**
  * Build a `pay(projectId, token, amount, beneficiary, minReturnedTokens, memo,
  * metadata)` transaction request for a v6 terminal.
@@ -51,43 +56,15 @@ function buildPayTx({ chainId, terminal, projectId, token, amount, beneficiary,
     };
 }
 /**
- * Pick the executable route which guarantees the beneficiary the most tokens.
+ * Preview the project tokens a payment puts in the beneficiary's hands, via the
+ * terminal's `previewPayFor(projectId, token, amount, beneficiary, metadata)`.
  *
- * A direct pool swap bypasses the terminal, so its reserved token count is always
- * zero. Its quote is reduced by `slippageBps` before comparison: a route is only
- * selected when its on-chain minimum beats the terminal preview, not merely when
- * its optimistic quote does.
- */
-function chooseBestPayRoute({ pay, paySettlement, directSwapQuote, slippageBps = 100n, }) {
-    if (slippageBps < 0n || slippageBps >= 10000n) {
-        throw new Error("slippageBps must be between 0 and 9,999.");
-    }
-    const payRoute = {
-        kind: "pay",
-        settlement: paySettlement,
-        ...pay,
-    };
-    if (!directSwapQuote || directSwapQuote <= 0n)
-        return payRoute;
-    const minimum = (directSwapQuote * (10000n - slippageBps)) / 10000n;
-    if (minimum <= pay.beneficiaryTokenCount)
-        return payRoute;
-    return {
-        kind: "direct-swap",
-        settlement: "swap",
-        quotedTokenCount: directSwapQuote,
-        beneficiaryTokenCount: minimum,
-        reservedTokenCount: 0n,
-    };
-}
-/**
- * Preview the project tokens minted by a payment, via the terminal's
- * `previewPayFor(projectId, token, amount, beneficiary, metadata)`.
- *
- * The terminal's `previewPayFor` is used (rather than
- * `JBTerminalStore.previewPayFrom`) because it takes exactly the data a `pay` caller
- * already has — the store variant additionally requires a full `JBTokenAmount` tuple
- * (token, decimals, currency, value), forcing an extra accounting-context lookup.
+ * When the buyback hook wins the route, the terminal mints nothing itself and
+ * 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.
  *
  * @param client A viem public client on the given chain.
  * @param args.chainId The chain to preview on.
@@ -96,18 +73,256 @@ function chooseBestPayRoute({ pay, paySettlement, directSwapQuote, slippageBps =
  * @param args.token The token being paid.
  * @param args.amount The amount being paid, as a fixed point number with the token's
  * decimals.
- * @param args.beneficiary The address that would receive the minted project tokens.
+ * @param args.beneficiary The address that would receive the project tokens.
  * @param args.metadata Hook metadata. Defaults to "0x".
  * @returns The previewed token counts.
  */
-async function previewPay(client, { terminal, projectId, token, amount, beneficiary, metadata = "0x", }) {
-    const [, beneficiaryTokenCount, reservedTokenCount] = await client.readContract({
+async function previewPay(client, args) {
+    return (await readPay(client, args)).preview;
+}
+/**
+ * Decode a buyback pay specification: 17 words on 1.4, 15 on 1.1.1, which
+ * share the first 15. 1.1.1 has no `skipSplits` and reports no reserved
+ * percent, so the ruleset's is used.
+ */
+function decodeBuybackPaySpec(spec, rulesetReservedPercent) {
+    const words = (spec.metadata.length - 2) / 64;
+    if (words !== 15 && words < 17)
+        return null;
+    const word = (i) => `0x${spec.metadata.slice(2 + i * 64, 2 + (i + 1) * 64)}`;
+    const uint = (i) => BigInt(word(i));
+    return {
+        hook: spec.hook,
+        noop: spec.noop,
+        projectTokenIs0: uint(0) !== 0n,
+        amountToMintWith: uint(1),
+        minimumSwapAmountOut: uint(2),
+        tokenCountWithoutHook: uint(5),
+        weightRatio: uint(6),
+        amountToSwapWith: uint(7),
+        poolId: word(10),
+        rawSwapQuote: uint(13),
+        oracleUnseeded: uint(14) !== 0n,
+        skipSplits: words >= 17 && uint(15) !== 0n,
+        reservedPercent: words >= 17 ? uint(16) : rulesetReservedPercent,
+    };
+}
+/** The controller's beneficiary share of a split mint, rounded the same way. */
+function splitOf(tokenCount, reservedPercent) {
+    const max = BigInt(constants_js_1.MAX_RESERVED_PERCENT);
+    const beneficiaryTokenCount = (tokenCount * (max - reservedPercent)) / max;
+    return {
+        beneficiaryTokenCount,
+        reservedTokenCount: tokenCount - beneficiaryTokenCount,
+    };
+}
+/** Tokens the hook's direct-mint leg issues, as the hook computes them. */
+function directMintOf(spec, weight) {
+    return spec.amountToMintWith !== 0n && spec.weightRatio !== 0n
+        ? (spec.amountToMintWith * weight) / spec.weightRatio
+        : 0n;
+}
+/**
+ * Fold the buyback hook's pay specification into a terminal preview, with the
+ * rule `JBPayRouteResolver._effectivePreviewPayTokenCounts` scores routes by.
+ * The swap leg uses the hook's raw quote: the TWAP price times the amount, with
+ * no pool fee or price impact. It is a ranking figure, not a minimum.
+ */
+function effectivePayPreview({ buybackHook, beneficiaryTokenCount, reservedTokenCount, weight, reservedPercent = 0n, hookSpecifications, }) {
+    let best = { beneficiaryTokenCount, reservedTokenCount };
+    if (!buybackHook ||
+        beneficiaryTokenCount !== 0n ||
+        reservedTokenCount !== 0n) {
+        return best;
+    }
+    for (const spec of hookSpecifications) {
+        if (spec.noop || spec.hook.toLowerCase() !== buybackHook.toLowerCase()) {
+            continue;
+        }
+        const decoded = decodeBuybackPaySpec(spec, reservedPercent);
+        if (!decoded)
+            continue;
+        const directMintTokenCount = directMintOf(decoded, weight);
+        const swapTokenCount = !decoded.oracleUnseeded &&
+            decoded.rawSwapQuote > decoded.minimumSwapAmountOut
+            ? decoded.rawSwapQuote
+            : decoded.minimumSwapAmountOut;
+        const candidate = splitOf(decoded.skipSplits
+            ? directMintTokenCount
+            : swapTokenCount + directMintTokenCount, decoded.reservedPercent);
+        if (decoded.skipSplits)
+            candidate.beneficiaryTokenCount += swapTokenCount;
+        if (candidate.beneficiaryTokenCount > best.beneficiaryTokenCount ||
+            (candidate.beneficiaryTokenCount === best.beneficiaryTokenCount &&
+                candidate.reservedTokenCount > best.reservedTokenCount)) {
+            best = candidate;
+        }
+    }
+    return best;
+}
+/**
+ * What the payer receives if the hook mints instead of swapping. The hook
+ * swaps only while the pool beats this rate, and unwinds to it when a swap
+ * underfills, so every honest settlement clears it.
+ */
+function mintEntitlementOf(spec, weight) {
+    const swapLeg = spec.skipSplits
+        ? spec.tokenCountWithoutHook
+        : splitOf(spec.tokenCountWithoutHook, spec.reservedPercent)
+            .beneficiaryTokenCount;
+    return (swapLeg +
+        splitOf(directMintOf(spec, weight), spec.reservedPercent)
+            .beneficiaryTokenCount);
+}
+/** One terminal preview, with the project's buyback spec decoded. */
+async function readPay(client, { chainId, terminal, projectId, token, amount, beneficiary, metadata = "0x", }) {
+    const [ruleset, beneficiaryTokenCount, reservedTokenCount, hookSpecifications,] = await client.readContract({
         address: terminal,
         abi: juicebox_js_1.jbMultiTerminalAbi,
         functionName: "previewPayFor",
         args: [projectId, token, amount, beneficiary, metadata],
     });
-    return { beneficiaryTokenCount, reservedTokenCount };
+    // Only a payment with hook specs needs to know which one is the buyback hook.
+    const buybackHook = hookSpecifications.length > 0
+        ? await resolvedBuybackHookOf(client, chainId, projectId)
+        : null;
+    const reservedPercent = (ruleset.metadata >> 4n) & 0xffffn;
+    const spec = buybackHook
+        ? hookSpecifications.find((s) => s.hook.toLowerCase() === buybackHook.toLowerCase())
+        : undefined;
+    return {
+        preview: effectivePayPreview({
+            buybackHook,
+            beneficiaryTokenCount,
+            reservedTokenCount,
+            weight: ruleset.weight,
+            reservedPercent,
+            hookSpecifications,
+        }),
+        terminalBeneficiaryTokenCount: beneficiaryTokenCount,
+        weight: ruleset.weight,
+        buyback: spec ? decodeBuybackPaySpec(spec, reservedPercent) : null,
+        unreadableSwap: !!spec && !spec.noop && !decodeBuybackPaySpec(spec, reservedPercent),
+    };
+}
+/** The buyback hook the registry resolves for a project, or null. */
+async function resolvedBuybackHookOf(client, chainId, projectId) {
+    let registry;
+    try {
+        registry = (0, contracts_js_1.getJBContractAddress)("JBBuybackHookRegistry", 6, chainId);
+    }
+    catch {
+        return null;
+    }
+    // A failed read throws: guessing "no hook" would drop the payment's minimum.
+    const hook = await client.readContract({
+        address: registry,
+        abi: juicebox_js_1.jbBuybackHookRegistryAbi,
+        functionName: "hookOf",
+        args: [projectId],
+    });
+    return hook === viem_1.zeroAddress ? null : hook;
+}
+const maxBigInt = (a, b) => (a > b ? a : b);
+const poolKeyOfAbi = [
+    {
+        type: "function",
+        name: "poolKeyOf",
+        stateMutability: "view",
+        inputs: [
+            { name: "projectId", type: "uint256" },
+            { name: "terminalToken", type: "address" },
+        ],
+        outputs: [
+            {
+                name: "key",
+                type: "tuple",
+                components: [
+                    { name: "currency0", type: "address" },
+                    { name: "currency1", type: "address" },
+                    { name: "fee", type: "uint24" },
+                    { name: "tickSpacing", type: "int24" },
+                    { name: "hooks", type: "address" },
+                ],
+            },
+        ],
+    },
+];
+/**
+ * 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.
+ *
+ * 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.
+ *
+ * @param args.slippageBps Tolerance on the pool quote and on the fallback
+ * minimum. Defaults to 100 (1%).
+ */
+async function prepareUserPay(client, { tiers, slippageBps = 100n, ...args }) {
+    const { chainId, projectId, token } = args;
+    const metadata = buildUserPayMetadata({ chainId, tiers });
+    const { preview, terminalBeneficiaryTokenCount, weight, buyback, unreadableSwap, } = await readPay(client, { ...args, metadata });
+    if (unreadableSwap) {
+        throw new Error("The project's buyback hook swaps with an unknown specification, so no safe minimum can be set.");
+    }
+    const fallback = {
+        metadata,
+        preview,
+        minReturnedTokens: (0, cashOut_js_1.slippageFloor)(buyback && !buyback.noop
+            ? // The swap and the leftover mint each round down once.
+                maxBigInt(mintEntitlementOf(buyback, weight) - 2n, 0n)
+            : terminalBeneficiaryTokenCount, slippageBps),
+    };
+    if (!buyback?.skipSplits || buyback.amountToSwapWith === 0n)
+        return fallback;
+    try {
+        const poolKey = await client.readContract({
+            address: buyback.hook,
+            abi: poolKeyOfAbi,
+            functionName: "poolKeyOf",
+            args: [
+                projectId,
+                token.toLowerCase() === constants_js_1.NATIVE_TOKEN.toLowerCase()
+                    ? viem_1.zeroAddress
+                    : token,
+            ],
+        });
+        // A router converts the paid token first, so its pool is a different one.
+        if ((0, uniswapV4_js_1.uniswapV4PoolId)(poolKey) !== buyback.poolId)
+            return fallback;
+        const quote = await (0, uniswapV4_js_1.quoteUniswapV4ExactInputSingle)(client, {
+            chainId,
+            poolKey,
+            zeroForOne: !buyback.projectTokenIs0,
+            amountIn: buyback.amountToSwapWith,
+        });
+        const minimumSwapAmountOut = (0, cashOut_js_1.slippageFloor)(quote, slippageBps);
+        // The pool loses to minting: leave the payment on the mint path.
+        if (minimumSwapAmountOut <= buyback.tokenCountWithoutHook)
+            return fallback;
+        const directMint = splitOf(directMintOf(buyback, weight), buyback.reservedPercent);
+        return {
+            metadata: buildUserPayMetadata({ chainId, tiers, minimumSwapAmountOut }),
+            preview: {
+                beneficiaryTokenCount: quote + directMint.beneficiaryTokenCount,
+                reservedTokenCount: directMint.reservedTokenCount,
+            },
+            minReturnedTokens: minimumSwapAmountOut,
+        };
+    }
+    catch {
+        return fallback;
+    }
 }
 /**
  * Build pay metadata instructing a project's JB721 tiers hook to mint specific tiers.
@@ -148,4 +363,33 @@ function buildBuybackPayMetadata({ hook, amountToSwapWith, minimumSwapAmountOut,
         (0, viem_1.encodeAbiParameters)([{ type: "uint256" }, { type: "uint256" }, { type: "bool" }], [amountToSwapWith, minimumSwapAmountOut, skipSplits]),
     ]);
 }
+/**
+ * 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.
+ *
+ * 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
+ * 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.
+ */
+function buildUserPayMetadata({ chainId, tiers, minimumSwapAmountOut = 0n, }) {
+    const ids = [
+        (0, hook_js_1.hookMetadataId)((0, contracts_js_1.getJBContractAddress)("JBBuybackHookRegistry", 6, chainId), "pay"),
+    ];
+    const data = [
+        (0, viem_1.encodeAbiParameters)([{ type: "uint256" }, { type: "uint256" }, { type: "bool" }], [0n, minimumSwapAmountOut, true]),
+    ];
+    if (tiers && tiers.tierIdsToMint.length > 0) {
+        ids.push((0, hook_js_1.hookMetadataId)(tiers.metadataIdTarget, "pay"));
+        data.push((0, viem_1.encodeAbiParameters)([{ type: "bool" }, { type: "uint16[]" }], [
+            tiers.allowOverspending ?? constants_js_1.DEFAULT_ALLOW_OVERSPENDING,
+            tiers.tierIdsToMint.map(Number),
+        ]));
+    }
+    return (0, hook_js_1.createHookMetadata)(ids, data);
+}
 //# sourceMappingURL=pay.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"pay.js","sourceRoot":"","sources":["../../../src/v6/pay.ts"],"names":[],"mappings":";;AAyCA,gCAuCC;AAuCD,gDAgCC;AAsBD,gCA4BC;AAsBD,kDA0BC;AAQD,0DAoBC;AArRD,+BAAuE;AACvE,kDAA2E;AAC3E,0DAA8D;AAE9D,8CAAsE;AAetE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,UAAU,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,iBAAiB,GAAG,EAAE,EACtB,IAAI,GAAG,EAAE,EACT,QAAQ,GAAG,IAAI,GAWhB;IACC,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,KAAK,2BAAY,CAAC,WAAW,EAAE,CAAC;IAEpE,OAAO;QACL,OAAO;QACP,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,gCAAkB;QACvB,YAAY,EAAE,KAAK;QACnB,IAAI,EAAE;YACJ,SAAS;YACT,KAAK;YACL,MAAM;YACN,WAAW;YACX,iBAAiB;YACjB,IAAI;YACJ,QAAQ;SACT;QACD,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;KAC9B,CAAC;AACJ,CAAC;AA+BD;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAAC,EACjC,GAAG,EACH,aAAa,EACb,eAAe,EACf,WAAW,GAAG,IAAI,GAMnB;IACC,IAAI,WAAW,GAAG,EAAE,IAAI,WAAW,IAAI,MAAO,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC9D,CAAC;IAED,MAAM,QAAQ,GAAsB;QAClC,IAAI,EAAE,KAAK;QACX,UAAU,EAAE,aAAa;QACzB,GAAG,GAAG;KACP,CAAC;IACF,IAAI,CAAC,eAAe,IAAI,eAAe,IAAI,EAAE;QAAE,OAAO,QAAQ,CAAC;IAE/D,MAAM,OAAO,GAAG,CAAC,eAAe,GAAG,CAAC,MAAO,GAAG,WAAW,CAAC,CAAC,GAAG,MAAO,CAAC;IACtE,IAAI,OAAO,IAAI,GAAG,CAAC,qBAAqB;QAAE,OAAO,QAAQ,CAAC;IAE1D,OAAO;QACL,IAAI,EAAE,aAAa;QACnB,UAAU,EAAE,MAAM;QAClB,gBAAgB,EAAE,eAAe;QACjC,qBAAqB,EAAE,OAAO;QAC9B,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,UAAU,CAC9B,MAAoB,EACpB,EACE,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,QAAQ,GAAG,IAAI,GAShB;IAED,MAAM,CAAC,EAAE,qBAAqB,EAAE,kBAAkB,CAAC,GACjD,MAAM,MAAM,CAAC,YAAY,CAAC;QACxB,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,gCAAkB;QACvB,YAAY,EAAE,eAAe;QAC7B,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC;KACxD,CAAC,CAAC;IAEL,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC;AACvD,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,mBAAmB,CAAC,EAClC,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,iBAAiB,GAAG,yCAA0B,GAO/C;IACC,MAAM,MAAM,GAAG,gBAAgB,IAAI,WAAW,CAAC;IAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,0BAAmB,EACrC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EACxC,CAAC,iBAAiB,EAAE,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAC/C,CAAC;IAEF,OAAO,IAAA,4BAAkB,EACvB,CAAC,IAAA,wBAAc,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAC/B,CAAC,WAAW,CAAC,CACP,CAAC;AACX,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,EACtC,IAAI,EACJ,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,GAAG,KAAK,GAMnB;IACC,OAAO,IAAA,4BAAkB,EACvB,CAAC,IAAA,wBAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAC7B;QACE,IAAA,0BAAmB,EACjB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAC5D,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,UAAU,CAAC,CACrD;KACF,CACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"pay.js","sourceRoot":"","sources":["../../../src/v6/pay.ts"],"names":[],"mappings":";;AA4DA,gCAuCC;AAsCD,gCAKC;AAwFD,kDAsDC;AA0JD,wCAyEC;AAsBD,kDA0BC;AAQD,0DAoBC;AAsBD,oDAkCC;AAnoBD,+BAMc;AACd,kDAIyB;AACzB,0DAGkC;AAElC,wDAA6D;AAC7D,8CAAsE;AACtE,6CAA6C;AAC7C,iDAGwB;AAexB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,UAAU,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,iBAAiB,GAAG,EAAE,EACtB,IAAI,GAAG,EAAE,EACT,QAAQ,GAAG,IAAI,GAWhB;IACC,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,KAAK,2BAAY,CAAC,WAAW,EAAE,CAAC;IAEpE,OAAO;QACL,OAAO;QACP,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,gCAAkB;QACvB,YAAY,EAAE,KAAK;QACnB,IAAI,EAAE;YACJ,SAAS;YACT,KAAK;YACL,MAAM;YACN,WAAW;YACX,iBAAiB;YACjB,IAAI;YACJ,QAAQ;SACT;QACD,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE;KAC9B,CAAC;AACJ,CAAC;AAgBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACI,KAAK,UAAU,UAAU,CAC9B,MAAoB,EACpB,IAAkC;IAElC,OAAO,CAAC,MAAM,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;AAC/C,CAAC;AAkCD;;;;GAIG;AACH,SAAS,oBAAoB,CAC3B,IAA0B,EAC1B,sBAA8B;IAE9B,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;IAC9C,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IAC5C,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CACzB,KAAK,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAS,CAAC;IAClE,MAAM,IAAI,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5C,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE;QAC/B,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC;QACzB,oBAAoB,EAAE,IAAI,CAAC,CAAC,CAAC;QAC7B,qBAAqB,EAAE,IAAI,CAAC,CAAC,CAAC;QAC9B,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;QACpB,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC;QACzB,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;QAChB,YAAY,EAAE,IAAI,CAAC,EAAE,CAAC;QACtB,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE;QAC/B,UAAU,EAAE,KAAK,IAAI,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE;QAC1C,eAAe,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,sBAAsB;KACjE,CAAC;AACJ,CAAC;AAED,gFAAgF;AAChF,SAAS,OAAO,CAAC,UAAkB,EAAE,eAAuB;IAC1D,MAAM,GAAG,GAAG,MAAM,CAAC,mCAAoB,CAAC,CAAC;IACzC,MAAM,qBAAqB,GAAG,CAAC,UAAU,GAAG,CAAC,GAAG,GAAG,eAAe,CAAC,CAAC,GAAG,GAAG,CAAC;IAC3E,OAAO;QACL,qBAAqB;QACrB,kBAAkB,EAAE,UAAU,GAAG,qBAAqB;KACvD,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,SAAS,YAAY,CAAC,IAAoB,EAAE,MAAc;IACxD,OAAO,IAAI,CAAC,gBAAgB,KAAK,EAAE,IAAI,IAAI,CAAC,WAAW,KAAK,EAAE;QAC5D,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW;QACrD,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,EAClC,WAAW,EACX,qBAAqB,EACrB,kBAAkB,EAClB,MAAM,EACN,eAAe,GAAG,EAAE,EACpB,kBAAkB,GASnB;IACC,IAAI,IAAI,GAAe,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,CAAC;IACrE,IACE,CAAC,WAAW;QACZ,qBAAqB,KAAK,EAAE;QAC5B,kBAAkB,KAAK,EAAE,EACzB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,kBAAkB,EAAE,CAAC;QACtC,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,WAAW,EAAE,EAAE,CAAC;YACvE,SAAS;QACX,CAAC;QACD,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAC5D,IAAI,CAAC,OAAO;YAAE,SAAS;QAEvB,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,cAAc,GAClB,CAAC,OAAO,CAAC,cAAc;YACvB,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,oBAAoB;YACjD,CAAC,CAAC,OAAO,CAAC,YAAY;YACtB,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;QACnC,MAAM,SAAS,GAAG,OAAO,CACvB,OAAO,CAAC,UAAU;YAChB,CAAC,CAAC,oBAAoB;YACtB,CAAC,CAAC,cAAc,GAAG,oBAAoB,EACzC,OAAO,CAAC,eAAe,CACxB,CAAC;QACF,IAAI,OAAO,CAAC,UAAU;YAAE,SAAS,CAAC,qBAAqB,IAAI,cAAc,CAAC;QAE1E,IACE,SAAS,CAAC,qBAAqB,GAAG,IAAI,CAAC,qBAAqB;YAC5D,CAAC,SAAS,CAAC,qBAAqB,KAAK,IAAI,CAAC,qBAAqB;gBAC7D,SAAS,CAAC,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAAC,EACzD,CAAC;YACD,IAAI,GAAG,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,SAAS,iBAAiB,CAAC,IAAoB,EAAE,MAAc;IAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU;QAC7B,CAAC,CAAC,IAAI,CAAC,qBAAqB;QAC5B,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,eAAe,CAAC;aACtD,qBAAqB,CAAC;IAC7B,OAAO,CACL,OAAO;QACP,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,eAAe,CAAC;aACtD,qBAAqB,CACzB,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,KAAK,UAAU,OAAO,CACpB,MAAoB,EACpB,EACE,OAAO,EACP,QAAQ,EACR,SAAS,EACT,KAAK,EACL,MAAM,EACN,WAAW,EACX,QAAQ,GAAG,IAAI,GACc;IAS/B,MAAM,CACJ,OAAO,EACP,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EACnB,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QAC5B,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,gCAAkB;QACvB,YAAY,EAAE,eAAe;QAC7B,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC;KACxD,CAAC,CAAC;IACH,8EAA8E;IAC9E,MAAM,WAAW,GACf,kBAAkB,CAAC,MAAM,GAAG,CAAC;QAC3B,CAAC,CAAC,MAAM,qBAAqB,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC;QACzD,CAAC,CAAC,IAAI,CAAC;IACX,MAAM,eAAe,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC;IAC3D,MAAM,IAAI,GAAG,WAAW;QACtB,CAAC,CAAC,kBAAkB,CAAC,IAAI,CACrB,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,WAAW,EAAE,CAC1D;QACH,CAAC,CAAC,SAAS,CAAC;IACd,OAAO;QACL,OAAO,EAAE,mBAAmB,CAAC;YAC3B,WAAW;YACX,qBAAqB;YACrB,kBAAkB;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,eAAe;YACf,kBAAkB;SACnB,CAAC;QACF,6BAA6B,EAAE,qBAAqB;QACpD,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI;QAClE,cAAc,EACZ,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,eAAe,CAAC;KACvE,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,KAAK,UAAU,qBAAqB,CAClC,MAAoB,EACpB,OAAkB,EAClB,SAAiB;IAEjB,IAAI,QAAiB,CAAC;IACtB,IAAI,CAAC;QACH,QAAQ,GAAG,IAAA,mCAAoB,EAAC,uBAAuB,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;IACD,6EAA6E;IAC7E,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;QACrC,OAAO,EAAE,QAAQ;QACjB,GAAG,EAAE,sCAAwB;QAC7B,YAAY,EAAE,QAAQ;QACtB,IAAI,EAAE,CAAC,SAAS,CAAC;KAClB,CAAC,CAAC;IACH,OAAO,IAAI,KAAK,kBAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;AAC5C,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAS5D,MAAM,YAAY,GAAG;IACnB;QACE,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,WAAW;QACjB,eAAe,EAAE,MAAM;QACvB,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;YACtC,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE;SAC3C;QACD,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE,OAAO;gBACb,UAAU,EAAE;oBACV,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;oBACtC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,SAAS,EAAE;oBACtC,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,OAAO,EAAE;oBACtC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE;iBACnC;aACF;SACF;KACF;CACO,CAAC;AAEX;;;;;;;;;;;;;;;;;;;GAmBG;AACI,KAAK,UAAU,cAAc,CAClC,MAAoB,EACpB,EACE,KAAK,EACL,WAAW,GAAG,IAAI,EAClB,GAAG,IAAI,EACkD;IAE3D,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC;IAC3C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC1D,MAAM,EACJ,OAAO,EACP,6BAA6B,EAC7B,MAAM,EACN,OAAO,EACP,cAAc,GACf,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;IACjD,IAAI,cAAc,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,gGAAgG,CACjG,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAoB;QAChC,QAAQ;QACR,OAAO;QACP,iBAAiB,EAAE,IAAA,0BAAa,EAC9B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI;YACtB,CAAC,CAAC,uDAAuD;gBACvD,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,CAAC;YACxD,CAAC,CAAC,6BAA6B,EACjC,WAAW,CACZ;KACF,CAAC;IACF,IAAI,CAAC,OAAO,EAAE,UAAU,IAAI,OAAO,CAAC,gBAAgB,KAAK,EAAE;QAAE,OAAO,QAAQ,CAAC;IAE7E,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;YACxC,OAAO,EAAE,OAAO,CAAC,IAAI;YACrB,GAAG,EAAE,YAAY;YACjB,YAAY,EAAE,WAAW;YACzB,IAAI,EAAE;gBACJ,SAAS;gBACT,KAAK,CAAC,WAAW,EAAE,KAAK,2BAAY,CAAC,WAAW,EAAE;oBAChD,CAAC,CAAC,kBAAW;oBACb,CAAC,CAAC,KAAK;aACV;SACF,CAAC,CAAC;QACH,0EAA0E;QAC1E,IAAI,IAAA,8BAAe,EAAC,OAAO,CAAC,KAAK,OAAO,CAAC,MAAM;YAAE,OAAO,QAAQ,CAAC;QACjE,MAAM,KAAK,GAAG,MAAM,IAAA,6CAA8B,EAAC,MAAM,EAAE;YACzD,OAAO;YACP,OAAO;YACP,UAAU,EAAE,CAAC,OAAO,CAAC,eAAe;YACpC,QAAQ,EAAE,OAAO,CAAC,gBAAgB;SACnC,CAAC,CAAC;QACH,MAAM,oBAAoB,GAAG,IAAA,0BAAa,EAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAC/D,iEAAiE;QACjE,IAAI,oBAAoB,IAAI,OAAO,CAAC,qBAAqB;YAAE,OAAO,QAAQ,CAAC;QAC3E,MAAM,UAAU,GAAG,OAAO,CACxB,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,EAC7B,OAAO,CAAC,eAAe,CACxB,CAAC;QACF,OAAO;YACL,QAAQ,EAAE,oBAAoB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,CAAC;YACxE,OAAO,EAAE;gBACP,qBAAqB,EAAE,KAAK,GAAG,UAAU,CAAC,qBAAqB;gBAC/D,kBAAkB,EAAE,UAAU,CAAC,kBAAkB;aAClD;YACD,iBAAiB,EAAE,oBAAoB;SACxC,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,QAAQ,CAAC;IAClB,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,mBAAmB,CAAC,EAClC,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,iBAAiB,GAAG,yCAA0B,GAO/C;IACC,MAAM,MAAM,GAAG,gBAAgB,IAAI,WAAW,CAAC;IAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,0BAAmB,EACrC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EACxC,CAAC,iBAAiB,EAAE,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAC/C,CAAC;IAEF,OAAO,IAAA,4BAAkB,EACvB,CAAC,IAAA,wBAAc,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAC/B,CAAC,WAAW,CAAC,CACP,CAAC;AACX,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,EACtC,IAAI,EACJ,gBAAgB,EAChB,oBAAoB,EACpB,UAAU,GAAG,KAAK,GAMnB;IACC,OAAO,IAAA,4BAAkB,EACvB,CAAC,IAAA,wBAAc,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,EAC7B;QACE,IAAA,0BAAmB,EACjB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAC5D,CAAC,gBAAgB,EAAE,oBAAoB,EAAE,UAAU,CAAC,CACrD;KACF,CACF,CAAC;AACJ,CAAC;AASD;;;;;;;;;;;;GAYG;AACH,SAAgB,oBAAoB,CAAC,EACnC,OAAO,EACP,KAAK,EACL,oBAAoB,GAAG,EAAE,GAK1B;IACC,MAAM,GAAG,GAAG;QACV,IAAA,wBAAc,EACZ,IAAA,mCAAoB,EAAC,uBAAuB,EAAE,CAAC,EAAE,OAAO,CAAC,EACzD,KAAK,CACN;KACF,CAAC;IACF,MAAM,IAAI,GAAU;QAClB,IAAA,0BAAmB,EACjB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAC5D,CAAC,EAAE,EAAE,oBAAoB,EAAE,IAAI,CAAC,CACjC;KACF,CAAC;IACF,IAAI,KAAK,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5C,GAAG,CAAC,IAAI,CAAC,IAAA,wBAAc,EAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,IAAI,CACP,IAAA,0BAAmB,EACjB,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EACxC;YACE,KAAK,CAAC,iBAAiB,IAAI,yCAA0B;YACrD,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC;SAChC,CACF,CACF,CAAC;IACJ,CAAC;IACD,OAAO,IAAA,4BAAkB,EAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC"}

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

@@ -287,7 +287,7 @@ export declare const stickySourceCollectorAbi: readonly [{
     }];
 }];
 /**
- * A reviewed, actually deployed collector and fee child on one source chain.
+ * A reviewed, actually deployed collector and fee payer on one source chain.
  * Obtain hashes and bindings from verified deployment artifacts, never predictions
  * or the target's own getters. A destination family has one address across sources.
  */
@@ -303,7 +303,7 @@ export interface StickySourceCollectorDeployment {
     directory: Address;
     receiverFactory: Address;
 }
-/** No new collector family has been published as a verified live deployment yet. */
+/** Verified source/home families generated from the pinned Sticky release. */
 export declare const STICKY_SOURCE_COLLECTOR_DEPLOYMENTS: readonly StickySourceCollectorDeployment[];
 /**
  * Find a deployed source/home pair. Unknown or conflicting family records fail

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

@@ -1 +1 @@
-{"version":3,"file":"sticky.d.ts","sourceRoot":"","sources":["../../../src/v6/sticky.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAMP,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAUd,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAGvD;;;;;;;;;;;;;;;;GAgBG;AAEH,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,yEAAyE;AACzE,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAE1C,mEAAmE;AACnE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3D,8EAA8E;AAC9E,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAEpE;AAED,yDAAyD;AACzD,wBAAgB,aAAa,CAC3B,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,SAAS,GACjB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAoBpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,MAAM,CAoBT;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAShE;AAMD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,MAAM,CAgB7E;AAED,kFAAkF;AAClF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwS3B,CAAC;AA2EX;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,EAAE,SAAS,CAAC;IACzB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,GAAG,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,uBAAuB,EAAE,GAAG,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,oFAAoF;AACpF,eAAO,MAAM,mCAAmC,EAAE,SAAS,+BAA+B,EACtF,CAAC;AAEL;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,aAAa,EAAE,MAAM,EACrB,kBAAkB,EAAE,MAAM,EAC1B,WAAW,6CAAsC,GAChD,+BAA+B,GAAG,SAAS,CAiB7C;AAED,iFAAiF;AACjF,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,EAChB,WAAW,6CAAsC,GAChD,+BAA+B,GAAG,SAAS,CAa7C;AAED,uFAAuF;AACvF,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,+BAA+B,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAYD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,yBAAyB,GAAG;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,OAAO,CAeT;AAED,0FAA0F;AAC1F,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,MAAM,CAAC,CASjB;AAUD;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,yBAAyB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf,GACA;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,wBAAwB,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,KAAK,EAAE,MAAM,CAAC;CACf,CA2BA;AAED,wFAAwF;AACxF,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,yBAAyB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GACnD;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,wBAAwB,CAAC;IACrC,YAAY,EAAE,QAAQ,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD,CAgBA;AAiED;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,+BAA+B,GAC1C,OAAO,CAAC,IAAI,CAAC,CA+Df;AAED,qFAAqF;AACrF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,wBAAsB,0BAA0B,CAC9C,YAAY,EAAE,YAAY,EAC1B,iBAAiB,EAAE,YAAY,EAC/B,IAAI,EAAE,yBAAyB,GAAG;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACA,OAAO,CAAC,oBAAoB,CAAC,CAgR/B"}
+{"version":3,"file":"sticky.d.ts","sourceRoot":"","sources":["../../../src/v6/sticky.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAMP,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,MAAM,CAAC;AAUd,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAc,KAAK,OAAO,EAAE,MAAM,aAAa,CAAC;AAIvD;;;;;;;;;;;;;;;;GAgBG;AAEH,kFAAkF;AAClF,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAE1C,yEAAyE;AACzE,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAE1C,mEAAmE;AACnE,eAAO,MAAM,yBAAyB,MAAM,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,IAAI,EAAE,SAAS,CAAA;CAAE,GACnB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3D,8EAA8E;AAC9E,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,SAAS,GAAG,OAAO,CAEpE;AAED,yDAAyD;AACzD,wBAAgB,aAAa,CAC3B,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAC5B,OAAO,EAAE,SAAS,GACjB,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAoBpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,GAAG,MAAM,CAoBT;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,WAAW,CAShE;AAMD;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,MAAM,CAgB7E;AAED,kFAAkF;AAClF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAwS3B,CAAC;AA2EX;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,aAAa,EAAE,SAAS,CAAC;IACzB,kBAAkB,EAAE,SAAS,CAAC;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,GAAG,CAAC;IACrB,QAAQ,EAAE,OAAO,CAAC;IAClB,uBAAuB,EAAE,GAAG,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED,8EAA8E;AAC9E,eAAO,MAAM,mCAAmC,EAAE,SAAS,+BAA+B,EACxD,CAAC;AAEnC;;;GAGG;AACH,wBAAgB,+BAA+B,CAC7C,aAAa,EAAE,MAAM,EACrB,kBAAkB,EAAE,MAAM,EAC1B,WAAW,6CAAsC,GAChD,+BAA+B,GAAG,SAAS,CAiB7C;AAED,iFAAiF;AACjF,wBAAgB,uBAAuB,CACrC,aAAa,EAAE,MAAM,EACrB,OAAO,EAAE,OAAO,EAChB,WAAW,6CAAsC,GAChD,+BAA+B,GAAG,SAAS,CAa7C;AAED,uFAAuF;AACvF,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,+BAA+B,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,OAAO,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB;AAYD;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,yBAAyB,GAAG;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,GACA,OAAO,CAeT;AAED,0FAA0F;AAC1F,wBAAsB,yBAAyB,CAC7C,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,MAAM,CAAC,CASjB;AAUD;;;;GAIG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,yBAAyB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf,GACA;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,wBAAwB,CAAC;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACnE,KAAK,EAAE,MAAM,CAAC;CACf,CA2BA;AAED,wFAAwF;AACxF,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,yBAAyB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,GACnD;IACD,OAAO,EAAE,SAAS,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,OAAO,wBAAwB,CAAC;IACrC,YAAY,EAAE,QAAQ,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD,CAgBA;AAiED;;;GAGG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,YAAY,EACpB,UAAU,EAAE,+BAA+B,GAC1C,OAAO,CAAC,IAAI,CAAC,CA+Df;AAED,qFAAqF;AACrF,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;GAQG;AACH,wBAAsB,0BAA0B,CAC9C,YAAY,EAAE,YAAY,EAC1B,iBAAiB,EAAE,YAAY,EAC/B,IAAI,EAAE,yBAAyB,GAAG;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,GACA,OAAO,CAAC,oBAAoB,CAAC,CAgR/B"}

package/dist/cjs/v6/sticky.js

@@ -53,6 +53,7 @@ const juicebox_js_1 = require("../generated/juicebox.js");
 const pureConstants_js_1 = require("../pureConstants.js");
 const splits_js_1 = require("./splits.js");
 const types_js_1 = require("./types.js");
+const stickySourceCollectors_js_1 = require("../generated/stickySourceCollectors.js");
 /**
  * A split routes funds to Sticky holders when its `hook` is the chain's
  * `StickyDistributor`. The distributor reads the rest of the split this way:
@@ -543,8 +544,8 @@ const stickySuckerIdentityAbi = [
         ],
     },
 ];
-/** No new collector family has been published as a verified live deployment yet. */
-exports.STICKY_SOURCE_COLLECTOR_DEPLOYMENTS = [];
+/** Verified source/home families generated from the pinned Sticky release. */
+exports.STICKY_SOURCE_COLLECTOR_DEPLOYMENTS = stickySourceCollectors_js_1.stickySourceCollectorDeployments;
 /**
  * Find a deployed source/home pair. Unknown or conflicting family records fail
  * closed, including different addresses for the same destination on other sources.
@@ -923,8 +924,8 @@ async function verifyStickyCollectorRoute(sourceClient, destinationClient, args)
         if (returnChain !== BigInt(deployment.sourceChainId) ||
             !(0, viem_1.isAddressEqual)(suckerBytes32ToAddress(returnPeer), sucker))
             throw new Error("Sticky destination peer does not match the source route.");
-        // The fee child can return only same-call refunds. Native Arbitrum L1
-        // retryables refund later on L2, where the child cannot attribute or return
+        // The fee payer can return only same-call refunds. Native Arbitrum L1
+        // retryables refund later on L2, where the fee payer cannot attribute or return
         // that caller's payment. This is a qualification mitigation, not a contract
         // restriction or a fix to the upstream asynchronous refund destination.
         const transport = await classifySuckerTransport(sourceClient, sucker);