@meteora-ag/zap-sdk 1.3.1 → 2.0.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Meteora
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -6,6 +6,17 @@ A Typescript SDK for interacting with the Zap program on Meteora.
 
 This SDK provides a set of tools and methods to interact with the Zap Program on Meteora. It enables developers to easily zap out of their positions on different AMMs on Solana.
 
+## Disclaimer: quotes, Direct routes, and examples
+
+Zap In is a **multi-step** flow. Intermediate **swap** transactions are Jupiter (or pool) quotes that the SDK does **not** economically validate.
+
+- `simulateTransaction` with no `err` only means the swap will land. It does **not** mean `outAmount` is a reasonable market vs the input size.
+- Jupiter `slippageBps` bounds fill vs **that quote / that route**, not input-vs-output fair value. See [Jupiter customer support](https://developers.jup.ag/docs/resources/support#customer-support).
+- Direct zap-in helpers (`estimateDlmmDirectSwap`, and examples using `maxAccounts: 50`) currently call Jupiter with `onlyDirectRoutes=true` and `maxAccounts=50`. That can return a much thinner route than the Jupiter UI, which does not set those limits.
+- The Meteora **UI** applies extra output-amount / USD / extreme-impact checks. This SDK does not. Examples are starting points for specific pools and sizes, not production-safe defaults for every token.
+
+Before sending: compare quoted output to a reference price, reject extreme impact, simulate **wallet token deltas**, and if Direct is far worse than a multi-hop quote, pass `onlyDirectRoutes=false` / raise `maxAccounts` or skip the zap.
+
 ## Installation
 
 ```bash
@@ -18,7 +29,11 @@ yarn add @meteora-ag/zap-sdk
 
 ## Jupiter API Setup
 
-All Jupiter-related functions (`getJupiterQuote`, `getJupiterSwapInstruction`, and estimate functions) support custom API configuration.
+All Jupiter-related functions (`getJupiterQuote`, `getJupiterSwapInstruction`, `getJupAndDammV2Quotes`, and the DLMM estimate functions) support custom API configuration.
+
+### API Version
+
+The SDK uses Jupiter Swap API v2 (`GET /swap/v2/build`) by default. v1 api support is deprecated in this SDK.
 
 ### Getting Your Jupiter API Key
 
@@ -28,10 +43,11 @@ For detailed setup instructions, see [Jupiter's Setup Guide](https://dev.jup.ag/
 
 ### API Parameters
 
-All Jupiter functions accept optional `jupiterApiUrl` and `jupiterApiKey` parameters:
+All Jupiter functions accept an optional `config: ZapConfig`:
 
 - `jupiterApiUrl` (optional): The Jupiter API endpoint. Default: `"https://api.jup.ag"`
 - `jupiterApiKey` (optional): Your Jupiter API key. Default: `""` (empty string)
+- `jupiterApiVersion` (optional): `JupiterApiVersion.V2` (default) or `JupiterApiVersion.V1` (deprecated)
 
 **Note**: While the API key parameter is optional in the function signature, Jupiter requires an API key for all requests. Using the default empty string may result in API errors.
 
@@ -42,17 +58,27 @@ import { Connection } from "@solana/web3.js";
 import { Zap } from "@meteora-ag/zap-sdk";
 
 const connection = new Connection("https://api.mainnet-beta.solana.com");
-const jupiterApiUrl = "https://api.jup.ag";
-const jupiterApiKey = "YOUR_API_KEY_HERE";
 
-const zap = new Zap(connection, jupiterApiUrl, jupiterApiKey);
+const zap = new Zap(connection, {
+  jupiterApiUrl: "https://api.jup.ag",
+  jupiterApiKey: "YOUR_API_KEY_HERE",
+  // jupiterApiVersion: JupiterApiVersion.V1, // deprecated, defaults to V2 if unset
+});
 ```
 
 ## Usage
 
 Refer to the [docs](./docs.md) for how to use the functions.
 
+The zap methods return an ordered list of instructions and the address lookup tables they use, not transactions, so you can build legacy or v0 transactions and decide how to split them. See [Building Transactions](./docs.md#building-transactions) for the instruction order, compute budget and lookup table details.
+
 ### Program Address
 
 - Mainnet-beta: zapvX9M3uf5pvy4wRPAbQgdQsM1xmuiFnkfHKPvwMiz
 - Devnet: zapvX9M3uf5pvy4wRPAbQgdQsM1xmuiFnkfHKPvwMiz
+
+## License
+
+This SDK is released under the [MIT License](./LICENSE).
+
+The on-chain Zap program is licensed separately and is not covered by this MIT license.