@floorlaunchpad/sdk-evm 0.0.0-stage → 0.1.0

package/dist/sale.js

@@ -0,0 +1,123 @@
+import { MalformedSale } from './errors.js';
+import { MAX_SALE_TEAM_FEE_BPS, saleGrossFor, saleNetOf, teamFeeOf } from './fees.js';
+export const MAX_TRANCHES = 255;
+export function validTranches(n) {
+    return typeof n === 'number' && Number.isInteger(n) && n >= 1 && n <= MAX_TRANCHES;
+}
+/** The getters' answers, checked: tranches in 1..255, the fee a rate under the sale's cap. Throws `MalformedSale`. */
+export function saleReadsFrom(raw) {
+    const t = raw.tranches;
+    const tranches = typeof t === 'bigint' ? (t >= 1n && t <= BigInt(MAX_TRANCHES) ? Number(t) : NaN) : t;
+    if (!validTranches(tranches))
+        throw new MalformedSale(`tranches() returned ${String(t)}, outside 1..${MAX_TRANCHES}`);
+    if (!Number.isInteger(raw.teamFeeBps) || raw.teamFeeBps < 0)
+        throw new MalformedSale(`teamFeeBps ${String(raw.teamFeeBps)} is not a rate`);
+    if (raw.teamFeeBps > MAX_SALE_TEAM_FEE_BPS)
+        throw new MalformedSale(`teamFeeBps ${raw.teamFeeBps} is above the sale's cap ${MAX_SALE_TEAM_FEE_BPS} — refused, never walked`);
+    return { ...raw, tranches };
+}
+export function trancheSize(s) {
+    return validTranches(s.tranches) ? s.saleTokens / BigInt(s.tranches) : 0n;
+}
+/** Tranche `i`'s price: raw quote per WHOLE (1e18-unit) token, linear from `p0` to `p1`. */
+export function tranchePrice(s, i) {
+    if (!validTranches(s.tranches) || s.tranches === 1)
+        return s.p0;
+    return s.p0 + ((s.p1 - s.p0) * BigInt(i)) / BigInt(s.tranches - 1);
+}
+export function currentTranche(s) {
+    const size = trancheSize(s);
+    if (size === 0n)
+        return 0;
+    return Math.min(Number(s.sold / size), Math.max(s.tranches - 1, 0));
+}
+/** A tranche slice's cost: `tokens × price / unit`, rounded as `rounding` says. */
+export function trancheCost(tokens, price, unit, rounding) {
+    const n = tokens * price;
+    return rounding === 'ceil' ? (n + unit - 1n) / unit : n / unit;
+}
+/** The whole raise: what buying every sale token costs (before the FLOOR Platform fee). */
+export function saleTargetWei(s, rounding = 'ceil') {
+    if (!validTranches(s.tranches))
+        return 0n;
+    const size = trancheSize(s);
+    if (size === 0n)
+        return 0n;
+    const E18 = 10n ** 18n;
+    let total = 0n;
+    for (let t = 0; t < s.tranches; t++) {
+        const end = t === s.tranches - 1 ? s.saleTokens : BigInt(t + 1) * size;
+        total += trancheCost(end - BigInt(t) * size, tranchePrice(s, t), E18, rounding);
+    }
+    return total;
+}
+const UINT256_MAX = (1n << 256n) - 1n;
+/** `FloorLaunch._walk(budget)`: tokens received and quote spent, from the book's current `sold`. */
+function walkBuy(s, amountIn, unit, rounding) {
+    const size = trancheSize(s);
+    if (size === 0n || amountIn <= 0n)
+        return { got: 0n, spent: 0n };
+    const costOf = (tokens, price) => trancheCost(tokens, price, unit, rounding);
+    let sold = s.sold, left = amountIn, got = 0n;
+    while (left > 0n && sold < s.saleTokens) {
+        const t = Math.min(Number(sold / size), s.tranches - 1);
+        const end = t === s.tranches - 1 ? s.saleTokens : BigInt(t + 1) * size;
+        const capacity = end - sold;
+        const price = tranchePrice(s, t);
+        const costAll = costOf(capacity, price);
+        if (left >= costAll && costAll > 0n) {
+            sold += capacity;
+            got += capacity;
+            left -= costAll;
+        }
+        else {
+            if (price === 0n)
+                break;
+            let amt = (left * unit) / price;
+            if (amt === 0n)
+                break;
+            if (amt > capacity)
+                amt = capacity;
+            const cost = costOf(amt, price);
+            sold += amt;
+            got += amt;
+            left -= cost;
+            break;
+        }
+    }
+    return { got, spent: amountIn - left };
+}
+/**
+ * A bonding buy of GROSS `amountInWei` (the fee rides on top). `tokenDecimals` is 18 on every EVM launch. `rounding` is the
+ * deployment's `ContractRules.saleCost` (default: the current contracts, `ceil`). `fillWei` is the least gross whose net
+ * walks to the end of the sale in that rounding.
+ */
+export function saleBuyQuote(s, amountInWei, tokenDecimals, rounding = 'ceil') {
+    const unit = 10n ** BigInt(tokenDecimals);
+    const all = walkBuy(s, UINT256_MAX, unit, rounding);
+    const fillWei = saleGrossFor(all.spent, s.teamFeeBps);
+    const q = walkBuy(s, saleNetOf(amountInWei, s.teamFeeBps), unit, rounding);
+    return { got: q.got, spent: q.spent, fee: teamFeeOf(q.spent, s.teamFeeBps), maxGot: all.got, fillWei, overfills: amountInWei > fillWei };
+}
+/**
+ * A sell-back of `tokens` (`FloorLaunch._sell`), less the sale's FLOOR Platform fee (`floor(payout × bps / 10_000)`).
+ * - `stateless` (the current contracts, default): `payout = tokens × p0 / 1e18` — the tokens at the sale's one price,
+ *   rounded down — capped at the position's `contributed`.
+ * - `proRata` (older contracts): `payout = contributed × tokens / allocation`, rounded down.
+ * The position (`allocation` tokens bought for `contributed` quote) bounds both: `null` where the sale would revert
+ * (`tokens` zero or above the allocation).
+ */
+export function sellBackQuote(p0, contributed, allocation, tokens, teamFeeBps, rule = 'stateless') {
+    if (tokens <= 0n || allocation <= 0n || tokens > allocation)
+        return null;
+    let payout;
+    if (rule === 'proRata')
+        payout = (contributed * tokens) / allocation;
+    else {
+        const atPrice = (tokens * p0) / 10n ** 18n;
+        payout = atPrice > contributed ? contributed : atPrice;
+    }
+    const fee = teamFeeOf(payout, teamFeeBps);
+    return { payout, fee, paid: payout - fee };
+}
+//# sourceMappingURL=sale.js.map

package/dist/sale.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sale.js","sourceRoot":"","sources":["../src/sale.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtF,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC;AAmBhC,MAAM,UAAU,aAAa,CAAC,CAAU;IACtC,OAAO,OAAO,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC;AACrF,CAAC;AAED,sHAAsH;AACtH,MAAM,UAAU,aAAa,CAAC,GAAgE;IAC5F,MAAM,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;IACvB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,uBAAuB,MAAM,CAAC,CAAC,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC;IACtH,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,GAAG,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,cAAc,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAC3I,IAAI,GAAG,CAAC,UAAU,GAAG,qBAAqB;QAAE,MAAM,IAAI,aAAa,CAAC,cAAc,GAAG,CAAC,UAAU,4BAA4B,qBAAqB,0BAA0B,CAAC,CAAC;IAC7K,OAAO,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,CAAW;IACrC,OAAO,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,YAAY,CAAC,CAAW,EAAE,CAAS;IACjD,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,KAAK,CAAC;QAAE,OAAO,CAAC,CAAC,EAAE,CAAC;IAChE,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,CAAW;IACxC,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,CAAC,CAAC;IAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC;AAKD,mFAAmF;AACnF,MAAM,UAAU,WAAW,CAAC,MAAc,EAAE,KAAa,EAAE,IAAY,EAAE,QAA0B;IACjG,MAAM,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;IACzB,OAAO,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;AACjE,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,aAAa,CAAC,CAAW,EAAE,WAA6B,MAAM;IAC5E,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAC;IAC1C,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAI,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IAC3B,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,CAAC;IACvB,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;QACvE,KAAK,IAAI,WAAW,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;AAEtC,oGAAoG;AACpG,SAAS,OAAO,CAAC,CAAW,EAAE,QAAgB,EAAE,IAAY,EAAE,QAA0B;IACtF,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,IAAI,KAAK,EAAE,IAAI,QAAQ,IAAI,EAAE;QAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACjE,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,KAAa,EAAU,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACrG,IAAI,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,EAAE,GAAG,GAAG,EAAE,CAAC;IAC7C,OAAO,IAAI,GAAG,EAAE,IAAI,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,CAAC;QACxC,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;QACxD,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;QACvE,MAAM,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC;QAC5B,MAAM,KAAK,GAAG,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACjC,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACxC,IAAI,IAAI,IAAI,OAAO,IAAI,OAAO,GAAG,EAAE,EAAE,CAAC;YACpC,IAAI,IAAI,QAAQ,CAAC;YAAC,GAAG,IAAI,QAAQ,CAAC;YAAC,IAAI,IAAI,OAAO,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,IAAI,KAAK,KAAK,EAAE;gBAAE,MAAM;YACxB,IAAI,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC;YAChC,IAAI,GAAG,KAAK,EAAE;gBAAE,MAAM;YACtB,IAAI,GAAG,GAAG,QAAQ;gBAAE,GAAG,GAAG,QAAQ,CAAC;YACnC,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAChC,IAAI,IAAI,GAAG,CAAC;YAAC,GAAG,IAAI,GAAG,CAAC;YAAC,IAAI,IAAI,IAAI,CAAC;YACtC,MAAM;QACR,CAAC;IACH,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI,EAAE,CAAC;AACzC,CAAC;AAiBD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,CAAW,EAAE,WAAmB,EAAE,aAAqB,EAAE,WAA6B,MAAM;IACvH,MAAM,IAAI,GAAG,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;IAC1C,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3E,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,GAAG,OAAO,EAAE,CAAC;AAC3I,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,EAAU,EAAE,WAAmB,EAAE,UAAkB,EAAE,MAAc,EAAE,UAAkB,EAAE,OAAkC,WAAW;IAClK,IAAI,MAAM,IAAI,EAAE,IAAI,UAAU,IAAI,EAAE,IAAI,MAAM,GAAG,UAAU;QAAE,OAAO,IAAI,CAAC;IACzE,IAAI,MAAc,CAAC;IACnB,IAAI,IAAI,KAAK,SAAS;QAAE,MAAM,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC;SAChE,CAAC;QACJ,MAAM,OAAO,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC;QAC3C,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC;IACzD,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAC1C,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;AAC7C,CAAC"}

package/dist/send.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Sending one action's calls with as few wallet prompts as the wallet allows.
+ *
+ * - EIP-5792: `wallet_getCapabilities` (for the account, at the chain id; the chain-agnostic `"0x0"` entry is read too,
+ *   and the chain's own entry wins) says the wallet runs an ATOMIC batch there (`atomic.status` `supported` or `ready`; an
+ *   older wallet's `atomicBatch.supported`) → ONE `wallet_sendCalls` with `atomicRequired`: one prompt, the approvals and
+ *   the trade land or fail together. The batch id is handed to `onSubmitted` BEFORE any wait, then `waitForCallsStatus`
+ *   waits for the receipts (`wait: false` returns at the id).
+ * - Otherwise (no 5792, no atomic batch on this chain, or the capabilities call fails): each call is sent in order with
+ *   `eth_sendTransaction`, and its receipt awaited before the next — one prompt per call. A reverted call stops the sequence.
+ * - A `wallet_sendCalls` the wallet refuses as UNSUPPORTED (EIP-1193 4200, JSON-RPC -32601, EIP-5792 5700 / 5710 / 5760)
+ *   has sent nothing, so the calls go the per-call way instead. Any other refusal (a user rejection, say) is thrown.
+ * ⛔ THE FALLBACK IS REQUIRED: some embedded wallets (Privy's, among them) do not implement `wallet_sendCalls`; a wallet
+ *    that throws on `getCapabilities` (method not found) is sent the calls one by one.
+ * ⛔ A non-atomic 5792 batch is not used by default (`allowNonAtomic`): an approval could land without its trade.
+ * ⛔ AFTER A SUBMISSION, A FAILED WAIT IS NOT "NOTHING HAPPENED": a timeout or a failed status read throws
+ *    `FloorEvmError('pending')` carrying the batch `id` / the `hashes` sent; keep waiting on those instead of re-sending.
+ * ⚠ Zero prompts happen only with an embedded wallet the integrator itself controls (it signs without asking); no
+ *   browser wallet sends anything without the user's approval.
+ */
+import { type Account, type Address, type Chain, type Client, type Hex, type Transport } from 'viem';
+import type { UnsignedTx } from '@floorlaunchpad/sdk';
+/** How long `sendEvmCalls` waits for a batch's final status by default, ms. */
+export declare const DEFAULT_BATCH_TIMEOUT_MS = 60000;
+/** How long `sendEvmCalls` waits for each transaction's receipt on the per-call path by default, ms. */
+export declare const DEFAULT_RECEIPT_TIMEOUT_MS = 180000;
+/** Error codes with which a wallet refuses `wallet_sendCalls` as unsupported, before sending anything. */
+export declare const SEND_CALLS_UNSUPPORTED_CODES: ReadonlySet<number>;
+export interface SendEvmCallsOptions {
+    /** The sender. Defaults to the wallet client's own account. */
+    readonly account?: Account | Address;
+    /** Use a 5792 batch even where the wallet cannot make it atomic. Default false. */
+    readonly allowNonAtomic?: boolean;
+    /** Called once a 5792 batch is submitted, with its id, before any wait. Keep it: it is how to follow the batch. */
+    readonly onSubmitted?: (id: string) => void;
+    /** Called after each call on the per-call path, with its hash, before its receipt is awaited. */
+    readonly onSent?: (hash: Hex, index: number) => void;
+    /** Wait for the 5792 batch's receipts (`waitForCallsStatus`). Default true. */
+    readonly wait?: boolean;
+    /** How long to wait for the batch's final status, ms. Default `DEFAULT_BATCH_TIMEOUT_MS`. */
+    readonly batchTimeoutMs?: number;
+    /** How long to wait for each receipt on the per-call path, ms. Default `DEFAULT_RECEIPT_TIMEOUT_MS`. */
+    readonly receiptTimeoutMs?: number;
+}
+export type SendEvmCallsResult = 
+/** One prompt: the wallet's batch id (`wallet_getCallsStatus` / viem `waitForCallsStatus` follow it). */
+{
+    readonly path: 'eip5792';
+    readonly id: string;
+    readonly atomic: boolean;
+    readonly hashes: readonly Hex[] | null;
+}
+/** One prompt per call: every transaction hash, in order, each mined successfully before the next was sent. */
+ | {
+    readonly path: 'transactions';
+    readonly hashes: readonly Hex[];
+};
+type Wallet = Client<Transport, Chain | undefined, Account | undefined>;
+/** True when `e` is the wallet refusing `wallet_sendCalls` as unsupported (nothing was sent). */
+export declare function isSendCallsUnsupported(e: unknown): boolean;
+/** Sends `tx`'s calls in one EIP-5792 batch where the wallet supports an atomic one, else one transaction at a time. */
+export declare function sendEvmCalls(wallet: Wallet, tx: UnsignedTx, opts?: SendEvmCallsOptions): Promise<SendEvmCallsResult>;
+export {};
+//# sourceMappingURL=send.d.ts.map

package/dist/send.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.d.ts","sourceRoot":"","sources":["../src/send.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAuC,KAAK,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,EAAE,KAAK,GAAG,EAAE,KAAK,SAAS,EAAE,MAAM,MAAM,CAAC;AAG1I,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,+EAA+E;AAC/E,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAC/C,wGAAwG;AACxG,eAAO,MAAM,0BAA0B,SAAU,CAAC;AAElD,0GAA0G;AAC1G,eAAO,MAAM,4BAA4B,EAAE,WAAW,CAAC,MAAM,CAA6C,CAAC;AAE3G,MAAM,WAAW,mBAAmB;IAClC,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACrC,mFAAmF;IACnF,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;IAClC,mHAAmH;IACnH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAC5C,iGAAiG;IACjG,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACrD,+EAA+E;IAC/E,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IACxB,6FAA6F;IAC7F,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,wGAAwG;IACxG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CACpC;AAED,MAAM,MAAM,kBAAkB;AAC5B,yGAAyG;AACvG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,EAAE,GAAG,IAAI,CAAA;CAAE;AACrH,+GAA+G;GAC7G;IAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,EAAE,CAAA;CAAE,CAAC;AAEvE,KAAK,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,KAAK,GAAG,SAAS,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC;AAmBxE,iGAAiG;AACjG,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAI1D;AAED,wHAAwH;AACxH,wBAAsB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,GAAE,mBAAwB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAgD9H"}

package/dist/send.js

@@ -0,0 +1,137 @@
+/**
+ * Sending one action's calls with as few wallet prompts as the wallet allows.
+ *
+ * - EIP-5792: `wallet_getCapabilities` (for the account, at the chain id; the chain-agnostic `"0x0"` entry is read too,
+ *   and the chain's own entry wins) says the wallet runs an ATOMIC batch there (`atomic.status` `supported` or `ready`; an
+ *   older wallet's `atomicBatch.supported`) → ONE `wallet_sendCalls` with `atomicRequired`: one prompt, the approvals and
+ *   the trade land or fail together. The batch id is handed to `onSubmitted` BEFORE any wait, then `waitForCallsStatus`
+ *   waits for the receipts (`wait: false` returns at the id).
+ * - Otherwise (no 5792, no atomic batch on this chain, or the capabilities call fails): each call is sent in order with
+ *   `eth_sendTransaction`, and its receipt awaited before the next — one prompt per call. A reverted call stops the sequence.
+ * - A `wallet_sendCalls` the wallet refuses as UNSUPPORTED (EIP-1193 4200, JSON-RPC -32601, EIP-5792 5700 / 5710 / 5760)
+ *   has sent nothing, so the calls go the per-call way instead. Any other refusal (a user rejection, say) is thrown.
+ * ⛔ THE FALLBACK IS REQUIRED: some embedded wallets (Privy's, among them) do not implement `wallet_sendCalls`; a wallet
+ *    that throws on `getCapabilities` (method not found) is sent the calls one by one.
+ * ⛔ A non-atomic 5792 batch is not used by default (`allowNonAtomic`): an approval could land without its trade.
+ * ⛔ AFTER A SUBMISSION, A FAILED WAIT IS NOT "NOTHING HAPPENED": a timeout or a failed status read throws
+ *    `FloorEvmError('pending')` carrying the batch `id` / the `hashes` sent; keep waiting on those instead of re-sending.
+ * ⚠ Zero prompts happen only with an embedded wallet the integrator itself controls (it signs without asking); no
+ *   browser wallet sends anything without the user's approval.
+ */
+import { BaseError, defineChain, numberToHex } from 'viem';
+import { parseAccount } from 'viem/accounts';
+import { getChainId, sendCalls, sendTransaction, waitForCallsStatus, waitForTransactionReceipt } from 'viem/actions';
+import { FloorEvmError } from './errors.js';
+/** How long `sendEvmCalls` waits for a batch's final status by default, ms. */
+export const DEFAULT_BATCH_TIMEOUT_MS = 60_000;
+/** How long `sendEvmCalls` waits for each transaction's receipt on the per-call path by default, ms. */
+export const DEFAULT_RECEIPT_TIMEOUT_MS = 180_000;
+/** Error codes with which a wallet refuses `wallet_sendCalls` as unsupported, before sending anything. */
+export const SEND_CALLS_UNSUPPORTED_CODES = new Set([4200, -32601, 5700, 5710, 5760]);
+/** The wallet's capabilities for `chainId`: its chain-agnostic `"0x0"` entry with the chain's own entry over it. */
+async function capabilitiesFor(wallet, account, chainId) {
+    const raw = (await wallet.request({ method: 'wallet_getCapabilities', params: [parseAccount(account).address, [numberToHex(chainId)]] }));
+    if (!raw || typeof raw !== 'object')
+        return undefined;
+    let any, own;
+    for (const [k, v] of Object.entries(raw)) {
+        let n;
+        try {
+            n = Number(BigInt(k));
+        }
+        catch {
+            continue;
+        }
+        if (n === 0)
+            any = v;
+        else if (n === chainId)
+            own = v;
+    }
+    if (!any && !own)
+        return undefined;
+    return { ...(any ?? {}), ...(own ?? {}) };
+}
+/** True when `e` is the wallet refusing `wallet_sendCalls` as unsupported (nothing was sent). */
+export function isSendCallsUnsupported(e) {
+    const hit = (x) => typeof x?.code === 'number' && SEND_CALLS_UNSUPPORTED_CODES.has(x.code);
+    if (e instanceof BaseError)
+        return e.walk(hit) !== null;
+    return hit(e);
+}
+/** Sends `tx`'s calls in one EIP-5792 batch where the wallet supports an atomic one, else one transaction at a time. */
+export async function sendEvmCalls(wallet, tx, opts = {}) {
+    if (tx.family !== 'evm')
+        throw new FloorEvmError('bad_params', `sendEvmCalls sends EVM calls, not ${tx.family}`);
+    if (tx.calls.length === 0)
+        throw new FloorEvmError('bad_params', 'sendEvmCalls: no calls');
+    const account = opts.account ?? wallet.account;
+    if (!account)
+        throw new FloorEvmError('bad_params', 'sendEvmCalls: no account');
+    const on = await getChainId(wallet);
+    if (on !== tx.chainId)
+        throw new FloorEvmError('wrong_chain', `the wallet is on chain ${on}; these calls are for chain ${tx.chainId}`);
+    const chain = wallet.chain?.id === tx.chainId ? wallet.chain : defineChain({
+        id: tx.chainId, name: `chain ${tx.chainId}`, nativeCurrency: { name: 'native', symbol: 'native', decimals: 18 }, rpcUrls: { default: { http: [] } },
+    });
+    const calls = tx.calls.map((c) => ({ to: c.to, data: c.data, value: c.value, gas: c.gas }));
+    let atomic = null;
+    try {
+        const caps = await capabilitiesFor(wallet, account, tx.chainId);
+        const status = caps?.atomic?.status;
+        const can = status === 'supported' || status === 'ready' || caps?.atomicBatch?.supported === true;
+        atomic = can ? true : opts.allowNonAtomic && caps !== undefined ? false : null;
+    }
+    catch {
+        atomic = null; // no EIP-5792 here
+    }
+    if (atomic !== null) {
+        let id = null;
+        try {
+            /* EIP-5792 calls carry no gas limit: the wallet estimates the batch. */
+            ({ id } = await sendCalls(wallet, { account, chain, calls: calls.map(({ gas: _gas, ...c }) => c), forceAtomic: atomic }));
+        }
+        catch (e) {
+            if (!isSendCallsUnsupported(e))
+                throw e;
+            id = null; // refused before sending anything: the per-call way below
+        }
+        if (id !== null)
+            return followBatch(wallet, id, atomic, opts);
+    }
+    const hashes = [];
+    const receiptTimeout = opts.receiptTimeoutMs ?? DEFAULT_RECEIPT_TIMEOUT_MS;
+    for (const [i, c] of calls.entries()) {
+        const hash = await sendTransaction(wallet, { account, chain, to: c.to, data: c.data, value: c.value, ...(c.gas !== undefined ? { gas: c.gas } : {}) });
+        hashes.push(hash);
+        opts.onSent?.(hash, i);
+        let status;
+        try {
+            ({ status } = await waitForTransactionReceipt(wallet, { hash, timeout: receiptTimeout }));
+        }
+        catch (e) {
+            throw new FloorEvmError('pending', `call ${i + 1} of ${calls.length} (${hash}) was sent but has no receipt yet; the rest were not sent. Keep waiting on it before sending again`, { cause: e, hashes: [...hashes] });
+        }
+        if (status !== 'success')
+            throw new FloorEvmError('reverted', `call ${i + 1} of ${calls.length} (${hash}) reverted; the rest were not sent`, { hashes: [...hashes] });
+    }
+    return { path: 'transactions', hashes };
+}
+async function followBatch(wallet, id, atomic, opts) {
+    opts.onSubmitted?.(id);
+    if (opts.wait === false)
+        return { path: 'eip5792', id, atomic, hashes: null };
+    let res;
+    try {
+        res = await waitForCallsStatus(wallet, { id, timeout: opts.batchTimeoutMs ?? DEFAULT_BATCH_TIMEOUT_MS });
+    }
+    catch (e) {
+        throw new FloorEvmError('pending', `the batch ${id} was submitted; its outcome is not known yet. Keep waiting on it before sending again`, { cause: e, id });
+    }
+    const hashes = (res.receipts ?? []).map((r) => r.transactionHash);
+    if (res.status === 'success')
+        return { path: 'eip5792', id, atomic, hashes };
+    if (res.status === 'failure')
+        throw new FloorEvmError('batch_failed', `the batch ${id} ended failure`, { id, hashes });
+    throw new FloorEvmError('pending', `the batch ${id} is still ${res.status ?? 'unknown'}`, { id, hashes });
+}
+//# sourceMappingURL=send.js.map

package/dist/send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"send.js","sourceRoot":"","sources":["../src/send.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAiF,MAAM,MAAM,CAAC;AAC1I,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAErH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,+EAA+E;AAC/E,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAC/C,wGAAwG;AACxG,MAAM,CAAC,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAElD,0GAA0G;AAC1G,MAAM,CAAC,MAAM,4BAA4B,GAAwB,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AA6B3G,oHAAoH;AACpH,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,OAA0B,EAAE,OAAe;IACxF,MAAM,GAAG,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAW,CAAC,CAA4C,CAAC;IAC9L,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IACtD,IAAI,GAAqB,EAAE,GAAqB,CAAC;IACjD,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACzC,IAAI,CAAS,CAAC;QACd,IAAI,CAAC;YAAC,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,CAAC;QAAC,MAAM,CAAC;YAAC,SAAS;QAAC,CAAC;QAClD,IAAI,CAAC,KAAK,CAAC;YAAE,GAAG,GAAG,CAAC,CAAC;aAChB,IAAI,CAAC,KAAK,OAAO;YAAE,GAAG,GAAG,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG;QAAE,OAAO,SAAS,CAAC;IACnC,OAAO,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,CAAC;AAC5C,CAAC;AAED,iGAAiG;AACjG,MAAM,UAAU,sBAAsB,CAAC,CAAU;IAC/C,MAAM,GAAG,GAAG,CAAC,CAAU,EAAE,EAAE,CAAC,OAAQ,CAAwB,EAAE,IAAI,KAAK,QAAQ,IAAI,4BAA4B,CAAC,GAAG,CAAE,CAAsB,CAAC,IAAI,CAAC,CAAC;IAClJ,IAAI,CAAC,YAAY,SAAS;QAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;IACxD,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC;AAChB,CAAC;AAED,wHAAwH;AACxH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,EAAc,EAAE,OAA4B,EAAE;IAC/F,IAAI,EAAE,CAAC,MAAM,KAAK,KAAK;QAAE,MAAM,IAAI,aAAa,CAAC,YAAY,EAAE,qCAAqC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;IACjH,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,aAAa,CAAC,YAAY,EAAE,wBAAwB,CAAC,CAAC;IAC3F,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,CAAC;IAC/C,IAAI,CAAC,OAAO;QAAE,MAAM,IAAI,aAAa,CAAC,YAAY,EAAE,0BAA0B,CAAC,CAAC;IAChF,MAAM,EAAE,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACpC,IAAI,EAAE,KAAK,EAAE,CAAC,OAAO;QAAE,MAAM,IAAI,aAAa,CAAC,aAAa,EAAE,0BAA0B,EAAE,+BAA+B,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;IACvI,MAAM,KAAK,GAAU,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;QAChF,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,OAAO,EAAE,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE;KACpJ,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAa,EAAE,IAAI,EAAE,CAAC,CAAC,IAAW,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE9G,IAAI,MAAM,GAAmB,IAAI,CAAC;IAClC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC;QACpC,MAAM,GAAG,GAAG,MAAM,KAAK,WAAW,IAAI,MAAM,KAAK,OAAO,IAAI,IAAI,EAAE,WAAW,EAAE,SAAS,KAAK,IAAI,CAAC;QAClG,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IACjF,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,GAAG,IAAI,CAAC,CAAC,mBAAmB;IACpC,CAAC;IACD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,IAAI,EAAE,GAAkB,IAAI,CAAC;QAC7B,IAAI,CAAC;YACH,wEAAwE;YACxE,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAC5H,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC;gBAAE,MAAM,CAAC,CAAC;YACxC,EAAE,GAAG,IAAI,CAAC,CAAC,0DAA0D;QACvE,CAAC;QACD,IAAI,EAAE,KAAK,IAAI;YAAE,OAAO,WAAW,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC;IAED,MAAM,MAAM,GAAU,EAAE,CAAC;IACzB,MAAM,cAAc,GAAG,IAAI,CAAC,gBAAgB,IAAI,0BAA0B,CAAC;IAC3E,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,MAAM,eAAe,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACvJ,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACvB,IAAI,MAAc,CAAC;QACnB,IAAI,CAAC;YACH,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,yBAAyB,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC;QAC5F,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,IAAI,oGAAoG,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;QACvN,CAAC;QACD,IAAI,MAAM,KAAK,SAAS;YAAE,MAAM,IAAI,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,IAAI,oCAAoC,EAAE,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC;IACxK,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC;AAC1C,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,EAAU,EAAE,MAAe,EAAE,IAAyB;IAC/F,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;IACvB,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC9E,IAAI,GAAmD,CAAC;IACxD,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,kBAAkB,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,cAAc,IAAI,wBAAwB,EAAE,CAAC,CAAC;IAC3G,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,MAAM,IAAI,aAAa,CAAC,SAAS,EAAE,aAAa,EAAE,uFAAuF,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/J,CAAC;IACD,MAAM,MAAM,GAAG,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;IAClE,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAC7E,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;QAAE,MAAM,IAAI,aAAa,CAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACvH,MAAM,IAAI,aAAa,CAAC,SAAS,EAAE,aAAa,EAAE,aAAa,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAC5G,CAAC"}

package/dist/simulate.d.ts

@@ -0,0 +1,180 @@
+/**
+ * An off-chain simulator of a swap on a FLOOR pool: Uniswap v4's swap, ported from v4-core statement for statement, with the
+ * FLOOR hook's fees around it. It needs no network once it has a `SwapSnapshot` (`readSwapSnapshot`), and the same snapshot
+ * and amount always give the same answer, so an aggregator's router can call it as often as it likes.
+ *
+ * What the hook does to a trader's swap (`SingletonFloorEngine._beforeSwap` / `_afterSwap`):
+ * - Exact input only, both directions (`ExactOutNotSupported`).
+ * - A BUY (quote in): before the swap the hook takes its four fees off the quote paid in, at the skim rate of the PRE-swap
+ *   price (the gap buy skim included where the set has it); the pool swaps what is left.
+ * - A SELL (tokens in): the pool swaps the tokens; after the swap the hook takes its four fees off the quote paid out, at the
+ *   skim rate of the POST-swap price.
+ * - The LP fee is the pool's override, 0.25%, on every swap; v4's protocol fee, if any, composes with it as v4 does.
+ * The staircase, the cushion, the seed and the bid are ordinary positions in the pool; the walk below crosses them like any
+ * other liquidity. The in-swap bid re-place that follows a sell into the bid happens after the trader's amounts are settled,
+ * so it changes nothing here; it does change the pool for the NEXT swap, which is why a snapshot must be re-read after a sell
+ * that reached the band (`SwapResult.reachedBand`).
+ */
+import type { Hex, PublicClient } from 'viem';
+import { type CushionEdge, type PoolRates } from './fees.js';
+/** `SqrtPriceMath.getAmount0Delta(a, b, liquidity, roundUp)`. */
+export declare function getAmount0Delta(a: bigint, b: bigint, liquidity: bigint, roundUp: boolean): bigint;
+/** `SqrtPriceMath.getAmount1Delta(a, b, liquidity, roundUp)`. */
+export declare function getAmount1Delta(a: bigint, b: bigint, liquidity: bigint, roundUp: boolean): bigint;
+/** `SqrtPriceMath.getNextSqrtPriceFromInput`. */
+export declare function getNextSqrtPriceFromInput(sqrtP: bigint, liquidity: bigint, amountIn: bigint, zeroForOne: boolean): bigint;
+/** `SwapMath.computeSwapStep`, exact input only (an exact-output swap never reaches a FLOOR pool). */
+export declare function computeSwapStepExactIn(sqrtCurrent: bigint, sqrtTarget: bigint, liquidity: bigint, amountRemaining: bigint, feePips: bigint): {
+    sqrtNext: bigint;
+    amountIn: bigint;
+    amountOut: bigint;
+    feeAmount: bigint;
+};
+/** `TickMath.getTickAtSqrtPrice`, exactly. */
+export declare function getTickAtSqrtPrice(sqrtPriceX96: bigint): number;
+/** A v4 pool as the swap walk reads it. Ticks are the PoolManager's own (raw, not the engine frame). */
+export interface V4PoolState {
+    sqrtPriceX96: bigint;
+    tick: number;
+    liquidity: bigint;
+    tickSpacing: number;
+    /** v4's packed protocol fee (`Slot0.protocolFee`): zeroForOne in the low 12 bits, oneForZero in the next 12. */
+    protocolFee: number;
+    /** The tick bitmap, word position → word. A word left out is read as empty. */
+    bitmap: ReadonlyMap<number, bigint>;
+    /** `liquidityNet` of every initialized tick. */
+    liquidityNet: ReadonlyMap<number, bigint>;
+}
+export interface V4SwapResult {
+    /** The input the pool consumed, LP and protocol fees included. Less than asked only when the pool ran out of liquidity. */
+    amountIn: bigint;
+    amountOut: bigint;
+    /** The LP fee and v4's protocol fee charged, in the input token. */
+    lpFee: bigint;
+    protocolFee: bigint;
+    sqrtPriceX96: bigint;
+    tick: number;
+    liquidity: bigint;
+}
+/**
+ * `Pool.swap`, exact input, with the price limit the V4Quoter and the UniversalRouter use when none is given (the edge of
+ * the price range). `lpFeePips` is the swap's LP fee (a FLOOR pool overrides it to 2,500 on every swap).
+ */
+export declare function v4SwapExactIn(pool: V4PoolState, zeroForOne: boolean, amountIn: bigint, lpFeePips: bigint, sqrtPriceLimitX96?: bigint): V4SwapResult;
+/** Everything a FLOOR pool swap is computed from. Read it with `readSwapSnapshot`; refresh it after any swap on the pool. */
+export interface SwapSnapshot {
+    pool: V4PoolState;
+    /** The quote is currency1 (an ERC-20 quote that sorts above the token); false for a native quote. */
+    quoteIsCurrency1: boolean;
+    /** `poolState.floorTick`, engine frame. */
+    floorTick: number;
+    rates: PoolRates;
+    cushion: CushionEdge;
+    /** The set has the gap buy skim (`ContractRules.gapSkim`). */
+    gapSkim: boolean;
+}
+export interface FloorSwapFees {
+    /** The v4 LP fee, in the swap's input token (the quote on a buy, the launch token on a sell). */
+    lp: bigint;
+    /** v4's protocol fee, in the input token; 0 unless the PoolManager's owner set one. */
+    protocol: bigint;
+    /** The hook's four takes, in the quote. */
+    floorSkim: bigint;
+    creator: bigint;
+    holder: bigint;
+    floorPlatform: bigint;
+}
+export interface FloorSwapResult {
+    side: 'buy' | 'sell';
+    amountIn: bigint;
+    amountOut: bigint;
+    /** The skim rate charged, bps. */
+    skimBps: number;
+    fees: FloorSwapFees;
+    /** The pool's price and tick after the swap (before any bid re-place). */
+    sqrtPriceX96After: bigint;
+    tickAfter: number;
+    /** A sell whose walk reached the bid band's dear edge: the hook re-places the bid after it, so re-read the snapshot. */
+    reachedBand: boolean;
+}
+/**
+ * Quote an exact-input swap on a FLOOR pool. `side` is the trader's: `buy` pays `amountIn` of the quote for launch tokens,
+ * `sell` pays `amountIn` launch tokens for the quote. Throws `no_quote` when the pool cannot fill the whole
+ * input (the V4Quoter refuses such a swap too).
+ */
+export declare function simulateSwap(s: SwapSnapshot, side: 'buy' | 'sell', amountIn: bigint): FloorSwapResult;
+/** Uniswap v4's StateView: the four reads a snapshot needs. */
+export declare const STATE_VIEW_ABI: readonly [{
+    readonly type: "function";
+    readonly name: "getSlot0";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "poolId";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "sqrtPriceX96";
+        readonly type: "uint160";
+    }, {
+        readonly name: "tick";
+        readonly type: "int24";
+    }, {
+        readonly name: "protocolFee";
+        readonly type: "uint24";
+    }, {
+        readonly name: "lpFee";
+        readonly type: "uint24";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "getLiquidity";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "poolId";
+        readonly type: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "liquidity";
+        readonly type: "uint128";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "getTickBitmap";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "poolId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "tick";
+        readonly type: "int16";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "tickBitmap";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly type: "function";
+    readonly name: "getTickLiquidity";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "poolId";
+        readonly type: "bytes32";
+    }, {
+        readonly name: "tick";
+        readonly type: "int24";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "liquidityGross";
+        readonly type: "uint128";
+    }, {
+        readonly name: "liquidityNet";
+        readonly type: "int128";
+    }];
+}];
+/**
+ * Read everything `simulateSwap` needs for one pool: the hook's `poolState` (rates, floor, orientation), the cushion, the
+ * PoolManager's slot0 and liquidity through StateView, the whole tick bitmap and every initialized tick's `liquidityNet`.
+ * About 120 bitmap reads plus one per initialized tick; batch them with a viem client that has `batch.multicall` set.
+ */
+export declare function readSwapSnapshot(client: PublicClient, chainId: number, poolId: Hex): Promise<SwapSnapshot>;
+//# sourceMappingURL=simulate.d.ts.map

package/dist/simulate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"simulate.d.ts","sourceRoot":"","sources":["../src/simulate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,KAAK,EAAW,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAGvD,OAAO,EAAoC,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,WAAW,CAAC;AAiB/F,iEAAiE;AACjE,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAMjG;AAED,iEAAiE;AACjE,wBAAgB,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,MAAM,CAIjG;AAoBD,iDAAiD;AACjD,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,MAAM,CAGzH;AAED,sGAAsG;AACtG,wBAAgB,sBAAsB,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG;IAC5I,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;CAC1E,CAgBA;AAKD,8CAA8C;AAC9C,wBAAgB,kBAAkB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAgB/D;AAID,wGAAwG;AACxG,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,gHAAgH;IAChH,WAAW,EAAE,MAAM,CAAC;IACpB,+EAA+E;IAC/E,MAAM,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,gDAAgD;IAChD,YAAY,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3C;AA0BD,MAAM,WAAW,YAAY;IAC3B,2HAA2H;IAC3H,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,YAAY,CA8CnJ;AAID,6HAA6H;AAC7H,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,WAAW,CAAC;IAClB,qGAAqG;IACrG,gBAAgB,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,OAAO,EAAE,WAAW,CAAC;IACrB,8DAA8D;IAC9D,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,iGAAiG;IACjG,EAAE,EAAE,MAAM,CAAC;IACX,uFAAuF;IACvF,QAAQ,EAAE,MAAM,CAAC;IACjB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,KAAK,GAAG,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,aAAa,CAAC;IACpB,0EAA0E;IAC1E,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,wHAAwH;IACxH,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,eAAe,CA8BrG;AAID,+DAA+D;AAC/D,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKjB,CAAC;AAEX;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,CAqChH"}