Release v11.1.1

Origin-SHA: 8dd7759cfc6e11592de1f9058fa2d31ec9a13678

Author: ryanio

CHANGELOG.md

@@ -1,5 +1,11 @@
 # @opensea/sdk
 
+## 11.1.1
+
+### Patch Changes
+
+- fix: correct `GetSwapQuoteArgs` to match the swap quote endpoint. `getSwapQuote` now takes `{ fromChain, fromAddress, toChain, toAddress, quantity, address, slippage?, recipient? }`, matching `GET /api/v2/swap/quote` (the previous `{ tokenIn, tokenOut, amount, chain }` shape did not map to the endpoint's query params).
+
 ## 11.1.0
 
 ### Minor Changes

developerDocs/api-reference.md

@@ -1185,27 +1185,32 @@ Get a swap quote for exchanging tokens.
 
 ```typescript
 const quote = await openseaSDK.api.getSwapQuote({
-  token_in: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
-  token_out: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
-  amount: "1000000000000000000", // 1 WETH in wei
-  chain: "ethereum",
-  taker_address: "0x...", // Optional
-  slippage: 0.5, // Optional: slippage tolerance
+  fromChain: "ethereum",
+  fromAddress: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", // WETH
+  toChain: "ethereum",
+  toAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
+  quantity: "1000000000000000000", // 1 WETH in wei
+  address: "0x...", // Wallet executing the swap
+  slippage: 0.05, // Optional: slippage tolerance (0.0 to 0.5)
 });
 ```
 
 **Parameters:**
 
-| Parameter       | Type   | Required | Description                 |
-| --------------- | ------ | -------- | --------------------------- |
-| `token_in`      | string | Yes      | Address of the input token  |
-| `token_out`     | string | Yes      | Address of the output token |
-| `amount`        | string | Yes      | Amount of input token       |
-| `chain`         | string | Yes      | Chain for the swap          |
-| `taker_address` | string | No       | Address of the taker        |
-| `slippage`      | number | No       | Slippage tolerance          |
+| Parameter     | Type   | Required | Description                                       |
+| ------------- | ------ | -------- | ------------------------------------------------- |
+| `fromChain`   | string | Yes      | Chain of the token to swap from                   |
+| `fromAddress` | string | Yes      | Contract address of the token to swap from        |
+| `toChain`     | string | Yes      | Chain of the token to swap to                     |
+| `toAddress`   | string | Yes      | Contract address of the token to swap to          |
+| `quantity`    | string | Yes      | Amount to swap in the token's smallest unit (wei) |
+| `address`     | string | Yes      | Wallet address executing the swap                 |
+| `slippage`    | number | No       | Slippage tolerance, 0.0 to 0.5 (default 0.01)     |
+| `recipient`   | string | No       | Recipient address (defaults to sender)            |
+
+Set `fromChain` and `toChain` to different chains for cross-chain swaps.
 
-**Returns:** `GetSwapQuoteResponse` with swap quote data.
+**Returns:** `GetSwapQuoteResponse` with the swap quote and the transactions to execute.
 
 ---
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensea/sdk",
-  "version": "11.1.0",
+  "version": "11.1.1",
   "description": "TypeScript SDK for the OpenSea marketplace helps developers build new experiences using NFTs, tokens, and our marketplace data",
   "license": "MIT",
   "author": "OpenSea Developers",

src/api/types.ts

@@ -759,18 +759,22 @@ export interface GetTokensArgs {
  * @category API Query Args
  */
 export interface GetSwapQuoteArgs {
-  /** Address of the input token */
-  tokenIn: string
-  /** Address of the output token */
-  tokenOut: string
-  /** Amount of input token */
-  amount: string
-  /** Chain for the swap */
-  chain: string
-  /** Address of the taker */
-  takerAddress?: string
-  /** Slippage tolerance */
+  /** Chain of the token to swap from */
+  fromChain: string
+  /** Contract address of the token to swap from */
+  fromAddress: string
+  /** Chain of the token to swap to */
+  toChain: string
+  /** Contract address of the token to swap to */
+  toAddress: string
+  /** Amount to swap in the smallest unit of the token (e.g. wei for ETH) */
+  quantity: string
+  /** Wallet address executing the swap */
+  address: string
+  /** Slippage tolerance, 0.0 to 0.5 (default 0.01) */
   slippage?: number
+  /** Recipient address (defaults to the sender address) */
+  recipient?: string
 }
 
 /**

test/api/tokens.spec.ts

@@ -202,10 +202,12 @@ describe("API: TokensAPI", () => {
       mockGet.mockResolvedValue(mockResponse)
 
       const args = {
-        tokenIn: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
-        tokenOut: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-        amount: "1000000000000000000",
-        chain: "ethereum",
+        fromChain: "ethereum",
+        fromAddress: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+        toChain: "ethereum",
+        toAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        quantity: "1000000000000000000",
+        address: "0x1234567890123456789012345678901234567890",
       }
 
       const result = await tokensAPI.getSwapQuote(args)
@@ -224,12 +226,14 @@ describe("API: TokensAPI", () => {
       mockGet.mockResolvedValue(mockResponse)
 
       const args = {
-        tokenIn: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
-        tokenOut: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-        amount: "1000000000000000000",
-        chain: "ethereum",
-        takerAddress: "0x1234567890123456789012345678901234567890",
+        fromChain: "ethereum",
+        fromAddress: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+        toChain: "base",
+        toAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        quantity: "1000000000000000000",
+        address: "0x1234567890123456789012345678901234567890",
         slippage: 0.5,
+        recipient: "0x9876543210987654321098765432109876543210",
       }
 
       await tokensAPI.getSwapQuote(args)
@@ -242,10 +246,12 @@ describe("API: TokensAPI", () => {
 
       try {
         await tokensAPI.getSwapQuote({
-          tokenIn: "0x123",
-          tokenOut: "0x456",
-          amount: "1000",
-          chain: "ethereum",
+          fromChain: "ethereum",
+          fromAddress: "0x123",
+          toChain: "ethereum",
+          toAddress: "0x456",
+          quantity: "1000",
+          address: "0x789",
         })
         throw new Error("Expected error to be thrown")
       } catch (error) {