@floorlaunchpad/sdk-evm 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,61 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+        "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+        "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+        "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+        "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+        "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+        "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+        "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+        "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+        "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+        "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+    2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+    3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+    4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+        (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+        (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+        (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+        (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+        You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+    5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+    6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+    7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+    8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+    9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,155 @@
-# Temporary Holding Version
+# @floorlaunchpad/sdk-evm
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+FLOOR on EVM chains: the ABIs, where the contracts are on each chain, and [viem](https://viem.sh) code to read FLOOR
+launches, quote trades and build unsigned trade transactions. It implements `@floorlaunchpad/sdk`'s `FloorChainAdapter`, so the
+same `FloorClient` serves EVM and Solana launches.
+
+`buildTrade` never signs: it returns `{ family: 'evm', chainId, calls }` — every call the action needs, in order (any
+approval the trader has not yet granted, then the trade). `sendEvmCalls` sends them with as few wallet prompts as the wallet
+allows.
+
+## Install
+
+```sh
+npm install @floorlaunchpad/sdk @floorlaunchpad/sdk-evm viem
+```
+
+`@floorlaunchpad/sdk` and `viem` (^2.56.3) are peer dependencies.
+
+## Example
+
+```ts
+import { FloorClient, evmRef } from '@floorlaunchpad/sdk';
+import { createEvmAdapter, sendEvmCalls } from '@floorlaunchpad/sdk-evm';
+
+const evm = createEvmAdapter({ chains: [11155111], rpcUrls: { 11155111: 'https://your-sepolia-rpc' } });
+const floor = new FloorClient([evm]);
+
+// One registry page, newest first.
+const { launches, cursor } = await floor.listLaunches(evmRef(11155111), { limit: 20 });
+const launch = launches[0]!;
+
+// A quote lists the trader's whole take: LP fee, floor skim, creator fee, holder tax, FLOOR Platform fee.
+const q = await evm.quote(launch.ref, 'buy', 10n ** 16n);
+
+// The approvals still missing (read now) and the trade, as one batch.
+const tx = await evm.buildTrade({ launch: launch.ref, side: 'buy', amountIn: 10n ** 16n, minAmountOut: (q.amountOut * 99n) / 100n, trader: account.address });
+const sent = await sendEvmCalls(walletClient, tx, {
+  onSubmitted: (id) => saveBatchId(id), // a 5792 batch id, handed over before any wait
+  onSent: (hash) => saveHash(hash),     // each transaction on the one-per-call path
+}); // { path: 'eip5792', id, hashes } or { path: 'transactions', hashes }
+```
+
+### When sending fails
+
+A rejection after something was submitted is not proof that nothing was sent. `sendEvmCalls` throws a `FloorEvmError`
+whose `code` says which case it is:
+
+| `code` | Meaning | `id` / `hashes` |
+|---|---|---|
+| `wrong_chain` | The wallet is on another chain. Nothing was sent. | — |
+| `pending` | Something was submitted, but the wait timed out or the status read failed. Keep waiting on what was submitted; do not send the action again. | the batch id / every hash sent |
+| `batch_failed` | The wallet reports the 5792 batch as failed. | the batch id, any receipts' hashes |
+| `reverted` | A transaction on the one-per-call path reverted; the calls after it were not sent. | every hash sent |
+
+The waits are explicit options: `batchTimeoutMs` (default `DEFAULT_BATCH_TIMEOUT_MS`, 60 s) for a batch's final status,
+`receiptTimeoutMs` (default `DEFAULT_RECEIPT_TIMEOUT_MS`, 180 s) for each receipt. `wait: false` returns at the batch id.
+
+## Wallet prompts per action
+
+| Wallet | Prompts |
+|---|---|
+| Supports an atomic EIP-5792 batch on the chain (`wallet_getCapabilities` → `atomic.status` `supported` / `ready`, or an older wallet's `atomicBatch.supported`; the chain's own entry, else the chain-agnostic `"0x0"` entry) | **1** — one `wallet_sendCalls` (atomic required), the approvals and the trade land together or not at all; the receipts are awaited with `waitForCallsStatus` |
+| No EIP-5792 (`getCapabilities` throws — Privy's embedded wallet did not implement `wallet_sendCalls`), no atomic batch on that chain, or a `wallet_sendCalls` refused as unsupported before anything was sent (codes 4200, -32601, 5700, 5710, 5760) | **one per call** — each call is its own transaction, sent in order, each receipt awaited before the next; a reverted call stops the rest |
+
+A first sell of a FloorToken through the UniversalRouter is two calls: Permit2's approval of the router, then the swap. A
+FloorToken reports Permit2 as approved for unlimited by default, so the token's own approval of Permit2 is not needed;
+it is three calls only when the holder has turned that default off, and for a buy paid in an ERC-20 quote (the quote's
+approval of Permit2, Permit2's approval of the router, the swap). After that a trade is one call. A native-quote buy and a
+sell-back are always one call; a bonding buy paid in an ERC-20 quote is two (the approval of the sale, the buy). No action
+ever asks for an off-chain signature (a Permit2 `signTypedData`): Permit2 is approved ON CHAIN, inside the same batch.
+
+### Approvals
+
+`buildTrade(params, { approvalAmount })` chooses how much each missing approval grants: `'exact'` (the amount this trade
+spends) or `'unlimited'` (2^255 to a token's spender, Permit2's maximum to a Permit2 spender). The default is `'exact'` for
+a bonding buy, whose spender is the launch's own sale contract, and `'unlimited'` for a pool swap (Permit2, then the
+UniversalRouter or `FloorSwapRatchet`). An ERC-20 allowance that is above 0 but short is set to 0 first, then to the new
+amount, for tokens (USDT among them) that refuse to move an allowance between two non-zero values.
+
+### Gas
+
+Every bonding buy carries `gas: BOND_BUY_GAS_FLOOR` (5.1M): any buy while the sale is open can become the one that sells
+it out, and that buy graduates the launch in the same transaction. The limit is honoured on the one-per-call path. On the
+EIP-5792 path calls carry no gas limit and the wallet estimates the batch, so the floor is dropped there.
+
+Zero prompts happen only with an embedded wallet the integrator itself controls and signs with; a user's own wallet always
+asks.
+
+A local chain (Anvil) or a set not yet in the committed table is passed as a row:
+
+```ts
+createEvmAdapter({ chains: [31337], rpcUrls: { 31337: 'http://127.0.0.1:8545' }, deployments: { 31337: { chainId: 31337, ... } } });
+```
+
+## What it covers
+
+- **ABIs** (`abi/`): the singleton hook (and the per-pool views called through `execute`), launch / sale, token, factory,
+  registry, PoolManager `extsload`, UniversalRouter, V4Router, V4Quoter, v3 QuoterV2, Permit2, PoolSwapTest, holder rewards,
+  recipient claims, vesting, preset registry, platform treasury, trader referrals, `FloorSwapRatchet`, `FloorZap`, team steps,
+  and `FLOOR_ERRORS_ABI` (every error the FLOOR contracts declare, for decoding a revert that bubbled out of a nested call).
+  FLOOR's own ABIs are generated from the contracts' build artifacts by `scripts/gen-abi.mjs` (`src/abi/generated.ts`).
+- **Deployments** (`deployments.ts`): per chain id, FLOOR's addresses and Uniswap's v4 addresses, start blocks, router kinds
+  and releases. A chain with no FLOOR set is refused by name (`floorDeploymentFor`), never given a zero address. Six chains
+  carry a FLOOR set: the mainnets Ethereum (1), Base (8453), BSC (56), Robinhood Chain (4663) and Arc (5042), which share
+  one set of contract addresses (deployment `0x…1a`), and the Sepolia test set (11155111). Base also carries
+  `zapAerodrome` (a `FloorZap` over Aerodrome's UniversalRouter). Ethereum has no `FloorSwapRatchet`: a ratchet costs about
+  1.4M gas there, so a pool trade goes straight through the UniversalRouter.
+- **Reads**: `getLaunch`, `listLaunches` (one registry page per call), the pool state (`readPoolState`, width-checked), the
+  published floor (`floorPriceX18`, off the pool's `floorTick`), and every rate read per launch or per pool.
+- **Quotes**: a bonding buy (the sale's tranche walk), a sell-back (`quoteSellBack`, less the FLOOR Platform fee), each in
+  the contract version's own rounding (see "Limits worth knowing"), and a pool trade (Uniswap's V4Quoter, or off-chain with
+  `simulateSwap`).
+- **Trades**: bonding buy, sell-back, pool buy / sell through the UniversalRouter (a token input pulled through Permit2,
+  approved on chain in the same batch), and the same through `FloorSwapRatchet` (`buildTrade(params, { swapRatchet })`).
+- **Sending**: `sendEvmCalls(walletClient, tx)` — EIP-5792 where atomic, else one transaction per call.
+- **Simulating a pool swap off-chain** (`simulate.ts`): `readSwapSnapshot(client, chainId, poolId)` reads one FLOOR pool
+  (the hook's rates and floor, the cushion, slot0, liquidity, the whole tick bitmap and every initialized tick), and
+  `simulateSwap(snapshot, side, amountIn)` gives the exact output and its fee parts with no network: Uniswap v4's swap,
+  ported from v4-core, with the FLOOR hook's fees around it (exact input only; on a buy the hook's fees come off the quote
+  paid in at the pre-swap price's skim, on a sell off the quote paid out at the post-swap price's). Tested against the
+  V4Quoter, every amount equal to the wei, two ways (`test/fixtures/simulate/`): on pools created on a fork of Base, a
+  native and an ERC-20 quote on each side of the pool, at six pool states (`scripts/fork-parity.mts`); and on the live
+  graduated pools of Ethereum, BSC, Base, Robinhood Chain and Arc (Arc's quote is its 18-decimal native USDC), read at one
+  block each (`scripts/live-parity.mts`, which also re-records their fixtures). Not yet met on a pool: a non-zero Uniswap
+  protocol fee (none of these pools has one; the unit tests cover it). Re-read the snapshot after any swap; `reachedBand`
+  marks a sell after which the hook re-places its bid.
+- **Events** (`events.ts`): `decodeFloorLog` / `decodeFloorLogs` decode any log of any contract whose ABI is here, by its
+  first topic (`FLOOR_EVENTS`, one layout per selector), and refuse a log whose topics or data do not fit the layout.
+  `floorEventTopics(name)` gives an event's selectors for an `eth_getLogs` filter. The twin of `@floorlaunchpad/sdk-solana`'s
+  `events.ts`. What the events mean as trades: [`docs/evm-events.md`](../../docs/evm-events.md).
+
+## What it does not cover
+
+- Creating launches, claims (creator fees, holder rewards, referrals), vesting, team steps, the zap (paying a stock-quoted
+  sale in ETH) and multi-hop routes: the ABIs are here, the builders are not.
+- History, charts and indexer reads.
+- Solana: see `@floorlaunchpad/sdk-solana`.
+
+## Limits worth knowing
+
+- A bonding buy and a sell-back carry **no on-chain minimum** (the sale takes none). `buildTrade` refuses a trade whose
+  quote, read just before, is under `minAmountOut`; a buy racing another buy can still fill at a later tranche's price.
+- A pool quote's `amountOut` is the V4Quoter's simulation; its fee parts are computed from the pool's own rates at the
+  pre-trade tick (`feesExact: false`). A sell's skim is charged at the post-swap tick, so its skim part is a minimum.
+- PoolSwapTest (a testnet harness with no minimum received) is refused as a trade route.
+- Contract versions differ, and a quote models the version its deployment row names (`Deployment.rules`, read with
+  `rulesOf`; a row that names none gets `CURRENT_RULES`):
+  | rule | current contracts (every row here) | older contracts (`OLDER_RULES`) |
+  |---|---|---|
+  | `saleCost` — a sale tranche's cost | rounded up | rounded down |
+  | `sellBack` — what a sell-back pays | the tokens at the sale price, rounded down, capped at what the position paid | the position's pro-rata share of what it paid |
+  | `gapSkim` — a pool buy's floor skim | scaled by how far the price stands above the staircase cushion (1× up to 2,232 ticks, rising linearly to 1.5× at 5,109, capped at 15%; `gapSkimBps`) | not scaled |
+  A caller's row for a set built from other sources should name its rules.
+
+Apache-2.0.