@cowprotocol/sdk-trading 0.1.0-monorepo.2 → 0.1.0

package/README.md

@@ -64,13 +64,20 @@ You need:
 
 ```typescript
 import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/sdk-trading'
-import { EthersV6Adapter } from '@cowprotocol/sdk-ethers-v6-adapter'
-import { JsonRpcProvider, Wallet } from 'ethers'
-
-// Configure the adapter
-const provider = new JsonRpcProvider('YOUR_RPC_URL')
-const wallet = new Wallet('YOUR_PRIVATE_KEY', provider)
-const adapter = new EthersV6Adapter({ provider, signer: wallet })
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+// There are EthersV5Adapter and EthersV6Adapter as well
+// @cowprotocol/sdk-ethers-v5-adapter, @cowprotocol/sdk-ethers-v6-adapter
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  // You also can set `walletClient` instead of `signer` using `useWalletClient` from wagmi
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Initialize the SDK
 const sdk = new TradingSdk(
@@ -98,65 +105,24 @@ const orderId = await sdk.postSwapOrder(parameters)
 console.log('Order created, id: ', orderId)
 ```
 
-### Usage with Umbrella SDK
-
-```typescript
-import { CowSdk, SupportedChainId, OrderKind, TradeParameters } from '@cowprotocol/cow-sdk'
-import { EthersV6Adapter } from '@cowprotocol/sdk-ethers-v6-adapter'
-import { JsonRpcProvider, Wallet } from 'ethers'
-
-// Configure the adapter
-const provider = new JsonRpcProvider('YOUR_RPC_URL')
-const wallet = new Wallet('YOUR_PRIVATE_KEY', provider)
-const adapter = new EthersV6Adapter({ provider, signer: wallet })
-
-// Initialize the unified SDK
-const sdk = new CowSdk({
-  chainId: SupportedChainId.SEPOLIA,
-  adapter,
-  tradingOptions: {
-    traderParams: {
-      appCode: 'YOUR_APP_CODE',
-    },
-    options: {
-      chainId: SupportedChainId.SEPOLIA,
-    },
-  },
-})
-
-// Define trade parameters
-const parameters: TradeParameters = {
-  kind: OrderKind.BUY,
-  sellToken: '0xfff9976782d46cc05630d1f6ebab18b2324d6b14',
-  sellTokenDecimals: 18,
-  buyToken: '0x0625afb445c3b6b7b929342a04a22599fd5dbb59',
-  buyTokenDecimals: 18,
-  amount: '120000000000000000',
-}
-
-// Post the order
-const orderId = await sdk.trading.postSwapOrder(parameters)
-console.log('Order created, id: ', orderId)
-
-// Or you can just initialize the SDK and import the trading class in another file:
-// you don't necessarily need to use the trading from inside of CowSdk:
-//...
-const sdk = new CowSdk({
-  chainId: SupportedChainId.SEPOLIA,
-  adapter,
-})
-// Other file:
-import { TradingSdk } from '@cowprotocol/cow-sdk'
-// parameters without passing the adapter. the adapter will be controlled by the umbrella
-const trading = TradingSdk(...)
-```
-
 ### Options
 
-For detailed information about trading steps you can enable the SDK logging and configure UTM tracking:
+For detailed information about trading steps you can enable the SDK logging:
 
 ```typescript
 import { SupportedChainId, TradingSdk, TradingSdkOptions } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  // You also can set `walletClient` instead of `signer` using `useWalletClient` from wagmi
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 const traderParams = {
   chainId: SupportedChainId.SEPOLIA,
@@ -166,11 +132,10 @@ const traderParams = {
 
 const sdkOptions: TradingSdkOptions = {
   enableLogging: true, // enables detailed logging of trading steps
-  utmContent: '🐮 moo-ving to defi 🐮', // custom UTM content for tracking
   disableUtm: false, // set to true to disable UTM tracking completely
 }
 
-const sdk = new TradingSdk(traderParams, sdkOptions)
+const sdk = new TradingSdk(traderParams, sdkOptions, adapter)
 ```
 
 ### getQuote
@@ -195,12 +160,24 @@ It can be used to create an order from the received quote.
 
 ```typescript
 import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  // You also can set `walletClient` instead of `signer` using `useWalletClient` from wagmi
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,
@@ -241,12 +218,24 @@ The parameters required are:
 
 ```typescript
 import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  // You also can set `walletClient` instead of `signer` using `useWalletClient` from wagmi
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,
@@ -283,12 +272,24 @@ And optional parameters:
 
 ```typescript
 import { SupportedChainId, OrderKind, LimitTradeParameters, TradingSdk } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  // You also can set `walletClient` instead of `signer` using `useWalletClient` from wagmi
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const limitOrderParameters: LimitTradeParameters = {
   kind: OrderKind.BUY,
@@ -316,12 +317,23 @@ But if you need more flexible way to create an order to sell native token, you c
 
 ```typescript
 import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,
@@ -353,12 +365,23 @@ import {
   SigningScheme,
   TradingSdk,
 } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,
@@ -390,12 +413,23 @@ And then you need to send a transaction from `getPreSignTransaction` result in o
 
 ```typescript
 import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,
@@ -432,12 +466,23 @@ import {
   SigningScheme,
   TradingSdk,
 } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const smartContractWalletAddress = '0x<smartContractWalletAddress>'
 
@@ -486,12 +531,23 @@ See `TradeOptionalParameters` type for more details.
 
 ```typescript
 import { SupportedChainId, OrderKind, TradeParameters, TradingSdk } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,
@@ -532,12 +588,23 @@ import {
   SwapAdvancedSettings,
   PriceQuality,
 } from '@cowprotocol/cow-sdk'
+import { ViemAdapter } from '@cowprotocol/sdk-viem-adapter'
+import { createPublicClient, http, privateKeyToAccount } from 'viem'
+import { sepolia } from 'viem/chains'
+
+const adapter = new ViemAdapter({
+  provider: createPublicClient({
+    chain: sepolia,
+    transport: http('YOUR_RPC_URL')
+  }),
+  signer: privateKeyToAccount('YOUR_PRIVATE_KEY' as `0x${string}`)
+})
 
 // Proper adapter initialization (see setup example above)
 const sdk = new TradingSdk({
   chainId: SupportedChainId.SEPOLIA,
   appCode: '<YOUR_APP_CODE>',
-})
+}, {}, adapter)
 
 const parameters: TradeParameters = {
   kind: OrderKind.BUY,

package/dist/index.d.mts

@@ -240,8 +240,6 @@ type WithPartialTraderParams<T> = T & Partial<TraderParameters>;
 interface TradingSdkOptions {
     enableLogging: boolean;
     orderBookApi: OrderBookApi;
-    utmContent?: string;
-    disableUtm?: boolean;
 }
 declare class TradingSdk {
     traderParams: Partial<TraderParameters>;

package/dist/index.d.ts

@@ -240,8 +240,6 @@ type WithPartialTraderParams<T> = T & Partial<TraderParameters>;
 interface TradingSdkOptions {
     enableLogging: boolean;
     orderBookApi: OrderBookApi;
-    utmContent?: string;
-    disableUtm?: boolean;
 }
 declare class TradingSdk {
     traderParams: Partial<TraderParameters>;

package/dist/index.js

@@ -820,6 +820,14 @@ var TradingSdk = class {
   }
   setTraderParams(params) {
     this.traderParams = { ...this.traderParams, ...params };
+    if (this.options.orderBookApi) {
+      if (params.chainId) {
+        this.options.orderBookApi.context.chainId = params.chainId;
+      }
+      if (params.env) {
+        this.options.orderBookApi.context.env = params.env;
+      }
+    }
     return this;
   }
   async getQuote(params, advancedSettings) {
@@ -836,7 +844,10 @@ var TradingSdk = class {
               tradeParameters: getTradeParametersAfterQuote({
                 quoteParameters: quoteResults.result.tradeParameters,
                 sellToken: params.sellToken
-              })
+              }),
+              // It's important to get a fresh instance of the signer
+              // Because quote might be called with another signer
+              signer: (0, import_sdk_common12.getGlobalAdapter)().signer
             }
           },
           advancedSettings2
@@ -906,7 +917,7 @@ var TradingSdk = class {
     const { chainId, signer, appCode, env } = params;
     const traderParams = {
       chainId: chainId || this.traderParams.chainId,
-      signer: signer || this.traderParams.signer,
+      signer: signer || this.traderParams.signer || (0, import_sdk_common12.getGlobalAdapter)().signer,
       appCode: appCode || this.traderParams.appCode,
       env: env || this.traderParams.env
     };

package/dist/index.mjs

@@ -785,6 +785,14 @@ var TradingSdk = class {
   }
   setTraderParams(params) {
     this.traderParams = { ...this.traderParams, ...params };
+    if (this.options.orderBookApi) {
+      if (params.chainId) {
+        this.options.orderBookApi.context.chainId = params.chainId;
+      }
+      if (params.env) {
+        this.options.orderBookApi.context.env = params.env;
+      }
+    }
     return this;
   }
   async getQuote(params, advancedSettings) {
@@ -801,7 +809,10 @@ var TradingSdk = class {
               tradeParameters: getTradeParametersAfterQuote({
                 quoteParameters: quoteResults.result.tradeParameters,
                 sellToken: params.sellToken
-              })
+              }),
+              // It's important to get a fresh instance of the signer
+              // Because quote might be called with another signer
+              signer: getGlobalAdapter6().signer
             }
           },
           advancedSettings2
@@ -871,7 +882,7 @@ var TradingSdk = class {
     const { chainId, signer, appCode, env } = params;
     const traderParams = {
       chainId: chainId || this.traderParams.chainId,
-      signer: signer || this.traderParams.signer,
+      signer: signer || this.traderParams.signer || getGlobalAdapter6().signer,
       appCode: appCode || this.traderParams.appCode,
       env: env || this.traderParams.env
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cowprotocol/sdk-trading",
-  "version": "0.1.0-monorepo.2",
+  "version": "0.1.0",
   "description": "CowProtocol trading",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -13,21 +13,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "lint": "eslint src/**/*.ts",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage --json --outputFile=jest.results.json && npx coveralls < ./coverage/lcov.info",
-    "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
-  },
   "devDependencies": {
-    "@cow-sdk/typescript-config": "workspace:*",
-    "@cowprotocol/sdk-ethers-v5-adapter": "workspace:*",
-    "@cowprotocol/sdk-ethers-v6-adapter": "workspace:*",
-    "@cowprotocol/sdk-viem-adapter": "workspace:*",
     "@ethersproject/constants": "^5.7.0",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.17.31",
@@ -41,15 +27,29 @@
     "ethers-v6": "npm:ethers@^6.13.7",
     "viem": "^2.28.4",
     "ts-jest": "^29.0.0",
-    "tsx": "^4.19.4"
+    "tsx": "^4.19.4",
+    "@cow-sdk/typescript-config": "0.0.0-beta.0",
+    "@cowprotocol/sdk-ethers-v5-adapter": "0.1.0",
+    "@cowprotocol/sdk-ethers-v6-adapter": "0.1.0",
+    "@cowprotocol/sdk-viem-adapter": "0.1.0"
   },
   "dependencies": {
-    "@cowprotocol/sdk-common": "workspace:*",
-    "@cowprotocol/sdk-config": "workspace:*",
-    "@cowprotocol/sdk-app-data": "workspace:*",
-    "@cowprotocol/sdk-order-book": "workspace:*",
-    "@cowprotocol/sdk-order-signing": "workspace:*",
-    "@cowprotocol/sdk-contracts-ts": "workspace:*",
-    "deepmerge": "^4.3.1"
+    "deepmerge": "^4.3.1",
+    "@cowprotocol/sdk-common": "0.1.0",
+    "@cowprotocol/sdk-app-data": "4.0.0",
+    "@cowprotocol/sdk-config": "0.1.0",
+    "@cowprotocol/sdk-order-signing": "0.1.0",
+    "@cowprotocol/sdk-order-book": "0.1.0",
+    "@cowprotocol/sdk-contracts-ts": "0.1.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "lint": "eslint src/**/*.ts",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage --json --outputFile=jest.results.json && npx coveralls < ./coverage/lcov.info",
+    "test:coverage:html": "jest --silent=false --coverage --coverageReporters html",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
   }
-}
+}