@cowprotocol/cow-sdk 7.1.2-beta.0 → 7.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -10
- package/dist/CHANGELOG.md +250 -0
- package/dist/README.md +12 -10
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +13 -13
- package/dist/index.mjs +3 -3
- package/dist/package.json +1 -1
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -25,6 +25,8 @@ The SDK supports all CoW Protocol enabled networks:
|
|
|
25
25
|
- **Avalanche** (43114) - `SupportedChainId.AVALANCHE`
|
|
26
26
|
- **Lens** (232) - `SupportedChainId.LENS`
|
|
27
27
|
- **BNB** (56) - `SupportedChainId.BNB`
|
|
28
|
+
- **Linea** (59144) - `SupportedChainId.LINEA` (Under development)
|
|
29
|
+
- **Plasma** (9745) - `SupportedChainId.PLASMA` (Under development)
|
|
28
30
|
- **Sepolia** (11155111) - `SupportedChainId.SEPOLIA` (Testnet)
|
|
29
31
|
|
|
30
32
|
## 🔗 **Related Resources**
|
|
@@ -32,7 +34,7 @@ The SDK supports all CoW Protocol enabled networks:
|
|
|
32
34
|
- **[CoW Protocol Documentation](https://docs.cow.fi/)**
|
|
33
35
|
- **[API Reference](https://api.cow.fi/docs/)**
|
|
34
36
|
- **[CoW Protocol Website](https://cow.fi/)**
|
|
35
|
-
- **[Examples Repository](
|
|
37
|
+
- **[Examples Repository](https://github.com/cowprotocol/cow-sdk/tree/main/examples)**
|
|
36
38
|
- **Issues**: [GitHub Issues](https://github.com/cowprotocol/cow-sdk/issues)
|
|
37
39
|
- **Discord**: [CoW Protocol Discord](https://discord.com/invite/cowprotocol)
|
|
38
40
|
- **Documentation**: [docs.cow.fi](https://docs.cow.fi/)
|
|
@@ -67,20 +69,20 @@ yarn add @cowprotocol/cow-sdk
|
|
|
67
69
|
Using CoW Protocol, you can perform swaps, limit orders, TWAP orders, and many other operations.
|
|
68
70
|
The `@cowprotocol/cow-sdk` provides tools at different abstraction levels, allowing you to conveniently implement basic scenarios while maintaining the flexibility to control all possible cases.
|
|
69
71
|
|
|
70
|
-
> In most cases, you will only need to use the **[Trading SDK](
|
|
72
|
+
> In most cases, you will only need to use the **[Trading SDK](https://github.com/cowprotocol/cow-sdk/tree/main/packages/trading/README.md)**
|
|
71
73
|
|
|
72
74
|
## SDK Components
|
|
73
75
|
|
|
74
76
|
### Core
|
|
75
|
-
- **[`TradingSdk`](
|
|
76
|
-
- **[`OrderSigningUtils`](
|
|
77
|
-
- **[`OrderBookApi`](
|
|
78
|
-
- **[`MetadataApi`](
|
|
77
|
+
- **[`TradingSdk`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/trading/README.md)** - Main tool for swap and limit orders with built-in quote fetching, order signing, and posting
|
|
78
|
+
- **[`OrderSigningUtils`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/order-signing/README.md)** - Utilities for signing orders and cancellations using cryptographic algorithms
|
|
79
|
+
- **[`OrderBookApi`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/order-book/README.md)** - Provides the ability to retrieve orders and trades from the CoW Protocol order book, as well as add and cancel them
|
|
80
|
+
- **[`MetadataApi`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/app-data/README.md)** - API for accessing order metadata and additional information
|
|
79
81
|
|
|
80
82
|
### Advanced
|
|
81
|
-
- **[`BridgingSdk`](
|
|
82
|
-
- **[`ConditionalOrder`](
|
|
83
|
-
- **[`CowShedSdk`](
|
|
83
|
+
- **[`BridgingSdk`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/bridging/README.md)** - Cross-chain token transfers and bridging functionality
|
|
84
|
+
- **[`ConditionalOrder`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/composable/README.md)** - SDK for Programmatic Orders such as TWAP ([Read more](https://docs.cow.fi/cow-protocol/concepts/order-types/programmatic-orders))
|
|
85
|
+
- **[`CowShedSdk`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/cow-shed/README.md)** - Account abstraction that leverages EOA with smart contract capabilities
|
|
84
86
|
|
|
85
87
|
## v6 → v7 Migration Guide
|
|
86
88
|
The versions are 99% backward compatible. The only difference is that in v7 you need to set an adapter corresponding to the library you use: `Viem`, `Ethers6`, or `Ethers5`.
|
|
@@ -232,7 +234,7 @@ if (confirm(`You will receive at least: ${buyAmount}. Proceed?`)) {
|
|
|
232
234
|
This example demonstrates the simplest way to trade on CoW Protocol.
|
|
233
235
|
|
|
234
236
|
For more advanced use cases, you can use additional parameters such as `receiver`, `partiallyFillable`, `validTo`, and others.
|
|
235
|
-
Refer to the [Trading SDK documentation](packages/trading/README.md) for comprehensive details.
|
|
237
|
+
Refer to the [Trading SDK documentation](https://github.com/cowprotocol/cow-sdk/tree/main/packages/trading/README.md) for comprehensive details.
|
|
236
238
|
|
|
237
239
|
|
|
238
240
|
## Adapters
|
package/dist/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,255 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [7.1.2](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.1.1...cow-sdk-v7.1.2) (2025-11-24)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Dependencies
|
|
7
|
+
|
|
8
|
+
* The following workspace dependencies were updated
|
|
9
|
+
* dependencies
|
|
10
|
+
* @cowprotocol/sdk-app-data bumped to 4.2.0
|
|
11
|
+
* @cowprotocol/sdk-common bumped to 0.4.0
|
|
12
|
+
* @cowprotocol/sdk-config bumped to 0.4.0
|
|
13
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.6.0
|
|
14
|
+
* @cowprotocol/sdk-order-book bumped to 0.3.0
|
|
15
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.12
|
|
16
|
+
* @cowprotocol/sdk-trading bumped to 0.5.0
|
|
17
|
+
|
|
18
|
+
## [7.1.1](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.1.0...cow-sdk-v7.1.1) (2025-11-07)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Dependencies
|
|
22
|
+
|
|
23
|
+
* The following workspace dependencies were updated
|
|
24
|
+
* dependencies
|
|
25
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.5.0
|
|
26
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.11
|
|
27
|
+
* @cowprotocol/sdk-trading bumped to 0.4.6
|
|
28
|
+
|
|
29
|
+
## [7.1.0](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.13...cow-sdk-v7.1.0) (2025-11-05)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### ✨ Features
|
|
33
|
+
|
|
34
|
+
* **new-chains:** add q4 chains ([#606](https://github.com/cowprotocol/cow-sdk/issues/606)) ([2501382](https://github.com/cowprotocol/cow-sdk/commit/2501382e80acb7f6bb0f87adbb5a9325de2c56cc))
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Dependencies
|
|
38
|
+
|
|
39
|
+
* The following workspace dependencies were updated
|
|
40
|
+
* dependencies
|
|
41
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.6
|
|
42
|
+
* @cowprotocol/sdk-config bumped to 0.3.0
|
|
43
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.4.4
|
|
44
|
+
* @cowprotocol/sdk-order-book bumped to 0.2.0
|
|
45
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.10
|
|
46
|
+
* @cowprotocol/sdk-trading bumped to 0.4.5
|
|
47
|
+
|
|
48
|
+
## [7.0.13](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.12...cow-sdk-v7.0.13) (2025-10-30)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Dependencies
|
|
52
|
+
|
|
53
|
+
* The following workspace dependencies were updated
|
|
54
|
+
* dependencies
|
|
55
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.4.3
|
|
56
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.9
|
|
57
|
+
* @cowprotocol/sdk-trading bumped to 0.4.4
|
|
58
|
+
|
|
59
|
+
## [7.0.12](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.11...cow-sdk-v7.0.12) (2025-10-29)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### 🔧 Miscellaneous
|
|
63
|
+
|
|
64
|
+
* release main ([#620](https://github.com/cowprotocol/cow-sdk/issues/620)) ([b36394a](https://github.com/cowprotocol/cow-sdk/commit/b36394a2ba38957edb47ffc4451ea6624d66737b))
|
|
65
|
+
* revert release ([#634](https://github.com/cowprotocol/cow-sdk/issues/634)) ([fc7bf61](https://github.com/cowprotocol/cow-sdk/commit/fc7bf61444619d4b2c3a3dd55b7ce52c197b1878))
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### Dependencies
|
|
69
|
+
|
|
70
|
+
* The following workspace dependencies were updated
|
|
71
|
+
* dependencies
|
|
72
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.5
|
|
73
|
+
* @cowprotocol/sdk-common bumped to 0.3.0
|
|
74
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.4.2
|
|
75
|
+
* @cowprotocol/sdk-order-book bumped to 0.1.4
|
|
76
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.8
|
|
77
|
+
* @cowprotocol/sdk-trading bumped to 0.4.3
|
|
78
|
+
|
|
79
|
+
## [7.0.11](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.10...cow-sdk-v7.0.11) (2025-10-24)
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Dependencies
|
|
83
|
+
|
|
84
|
+
* The following workspace dependencies were updated
|
|
85
|
+
* dependencies
|
|
86
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.4
|
|
87
|
+
* @cowprotocol/sdk-common bumped to 0.2.2
|
|
88
|
+
* @cowprotocol/sdk-config bumped to 0.2.0
|
|
89
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.4.1
|
|
90
|
+
* @cowprotocol/sdk-order-book bumped to 0.1.3
|
|
91
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.7
|
|
92
|
+
* @cowprotocol/sdk-trading bumped to 0.4.2
|
|
93
|
+
|
|
94
|
+
## [7.0.10](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.9...cow-sdk-v7.0.10) (2025-10-17)
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
### 🔧 Miscellaneous
|
|
98
|
+
|
|
99
|
+
* release main ([#592](https://github.com/cowprotocol/cow-sdk/issues/592)) ([e4d7212](https://github.com/cowprotocol/cow-sdk/commit/e4d7212af322beced743e985bd1fbedaef66cdcb))
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
### Dependencies
|
|
103
|
+
|
|
104
|
+
* The following workspace dependencies were updated
|
|
105
|
+
* dependencies
|
|
106
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.3
|
|
107
|
+
* @cowprotocol/sdk-trading bumped to 0.4.1
|
|
108
|
+
|
|
109
|
+
## [7.0.9](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.8...cow-sdk-v7.0.9) (2025-10-15)
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Dependencies
|
|
113
|
+
|
|
114
|
+
* The following workspace dependencies were updated
|
|
115
|
+
* dependencies
|
|
116
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.2
|
|
117
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.4.0
|
|
118
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.6
|
|
119
|
+
* @cowprotocol/sdk-trading bumped to 0.4.0
|
|
120
|
+
|
|
121
|
+
## [7.0.8](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.7...cow-sdk-v7.0.8) (2025-10-08)
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
### Dependencies
|
|
125
|
+
|
|
126
|
+
* The following workspace dependencies were updated
|
|
127
|
+
* dependencies
|
|
128
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.1
|
|
129
|
+
* @cowprotocol/sdk-common bumped to 0.2.1
|
|
130
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.3.1
|
|
131
|
+
* @cowprotocol/sdk-order-book bumped to 0.1.2
|
|
132
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.5
|
|
133
|
+
* @cowprotocol/sdk-trading bumped to 0.3.2
|
|
134
|
+
|
|
135
|
+
## [7.0.7](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.6...cow-sdk-v7.0.7) (2025-10-08)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### Dependencies
|
|
139
|
+
|
|
140
|
+
* The following workspace dependencies were updated
|
|
141
|
+
* dependencies
|
|
142
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.0
|
|
143
|
+
* @cowprotocol/sdk-trading bumped to 0.3.1
|
|
144
|
+
|
|
145
|
+
## [7.0.6](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.5...cow-sdk-v7.0.6) (2025-10-07)
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
### Dependencies
|
|
149
|
+
|
|
150
|
+
* The following workspace dependencies were updated
|
|
151
|
+
* dependencies
|
|
152
|
+
* @cowprotocol/sdk-trading bumped to 0.3.0
|
|
153
|
+
|
|
154
|
+
## [7.0.5](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.4...cow-sdk-v7.0.5) (2025-10-07)
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
### Dependencies
|
|
158
|
+
|
|
159
|
+
* The following workspace dependencies were updated
|
|
160
|
+
* dependencies
|
|
161
|
+
* @cowprotocol/sdk-trading bumped to 0.2.1
|
|
162
|
+
|
|
163
|
+
## [7.0.4](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.3...cow-sdk-v7.0.4) (2025-10-06)
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
### Dependencies
|
|
167
|
+
|
|
168
|
+
* The following workspace dependencies were updated
|
|
169
|
+
* dependencies
|
|
170
|
+
* @cowprotocol/sdk-app-data bumped to 4.0.1
|
|
171
|
+
* @cowprotocol/sdk-common bumped to 0.2.0
|
|
172
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.3.0
|
|
173
|
+
* @cowprotocol/sdk-order-book bumped to 0.1.1
|
|
174
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.4
|
|
175
|
+
* @cowprotocol/sdk-trading bumped to 0.2.0
|
|
176
|
+
|
|
177
|
+
## [7.0.3](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.2...cow-sdk-v7.0.3) (2025-09-24)
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
### Dependencies
|
|
181
|
+
|
|
182
|
+
* The following workspace dependencies were updated
|
|
183
|
+
* dependencies
|
|
184
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.2.1
|
|
185
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.3
|
|
186
|
+
* @cowprotocol/sdk-trading bumped to 0.1.3
|
|
187
|
+
|
|
188
|
+
## [7.0.2](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.1...cow-sdk-v7.0.2) (2025-09-23)
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
### Dependencies
|
|
192
|
+
|
|
193
|
+
* The following workspace dependencies were updated
|
|
194
|
+
* dependencies
|
|
195
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.2.0
|
|
196
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.2
|
|
197
|
+
* @cowprotocol/sdk-trading bumped to 0.1.2
|
|
198
|
+
|
|
199
|
+
## [7.0.1](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.0.0...cow-sdk-v7.0.1) (2025-09-22)
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
### Dependencies
|
|
203
|
+
|
|
204
|
+
* The following workspace dependencies were updated
|
|
205
|
+
* dependencies
|
|
206
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.1.1
|
|
207
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.1
|
|
208
|
+
* @cowprotocol/sdk-trading bumped to 0.1.1
|
|
209
|
+
|
|
210
|
+
## [7.0.0](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.1.3-beta.0...cow-sdk-v7.0.0) (2025-09-17)
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### ⚠ BREAKING CHANGES
|
|
214
|
+
|
|
215
|
+
* release cow-sdk v7
|
|
216
|
+
|
|
217
|
+
### ✨ Features
|
|
218
|
+
|
|
219
|
+
* release cow-sdk v7 ([6cd3e57](https://github.com/cowprotocol/cow-sdk/commit/6cd3e573687b1ffdbc0fdcb8cdbb414d88546e38))
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
### Dependencies
|
|
223
|
+
|
|
224
|
+
* The following workspace dependencies were updated
|
|
225
|
+
* dependencies
|
|
226
|
+
* @cowprotocol/sdk-app-data bumped to 4.0.0
|
|
227
|
+
* @cowprotocol/sdk-common bumped to 0.1.0
|
|
228
|
+
* @cowprotocol/sdk-config bumped to 0.1.0
|
|
229
|
+
* @cowprotocol/sdk-contracts-ts bumped to 0.1.0
|
|
230
|
+
* @cowprotocol/sdk-order-book bumped to 0.1.0
|
|
231
|
+
* @cowprotocol/sdk-order-signing bumped to 0.1.0
|
|
232
|
+
* @cowprotocol/sdk-trading bumped to 0.1.0
|
|
233
|
+
|
|
234
|
+
## [7.1.3-beta.0](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.1.2-beta.0...cow-sdk-v7.1.3-beta.0) (2025-09-17)
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### 🔧 Miscellaneous
|
|
238
|
+
|
|
239
|
+
* make doc links absolute ([f03aabb](https://github.com/cowprotocol/cow-sdk/commit/f03aabb745e0cf51e3c9d5d8464f733e2668d544))
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
### Dependencies
|
|
243
|
+
|
|
244
|
+
* The following workspace dependencies were updated
|
|
245
|
+
* dependencies
|
|
246
|
+
* @cowprotocol/sdk-app-data bumped to 4.1.7-beta.0
|
|
247
|
+
* @cowprotocol/sdk-common bumped to 0.5.0-beta.0
|
|
248
|
+
* @cowprotocol/sdk-contracts-ts bumped to 2.3.0-beta.0
|
|
249
|
+
* @cowprotocol/sdk-order-book bumped to 0.3.1-beta.0
|
|
250
|
+
* @cowprotocol/sdk-order-signing bumped to 0.2.8-beta.0
|
|
251
|
+
* @cowprotocol/sdk-trading bumped to 0.3.2-beta.0
|
|
252
|
+
|
|
3
253
|
## [7.1.2-beta.0](https://github.com/cowprotocol/cow-sdk/compare/cow-sdk-v7.1.1-beta.0...cow-sdk-v7.1.2-beta.0) (2025-09-16)
|
|
4
254
|
|
|
5
255
|
|
package/dist/README.md
CHANGED
|
@@ -25,6 +25,8 @@ The SDK supports all CoW Protocol enabled networks:
|
|
|
25
25
|
- **Avalanche** (43114) - `SupportedChainId.AVALANCHE`
|
|
26
26
|
- **Lens** (232) - `SupportedChainId.LENS`
|
|
27
27
|
- **BNB** (56) - `SupportedChainId.BNB`
|
|
28
|
+
- **Linea** (59144) - `SupportedChainId.LINEA` (Under development)
|
|
29
|
+
- **Plasma** (9745) - `SupportedChainId.PLASMA` (Under development)
|
|
28
30
|
- **Sepolia** (11155111) - `SupportedChainId.SEPOLIA` (Testnet)
|
|
29
31
|
|
|
30
32
|
## 🔗 **Related Resources**
|
|
@@ -32,7 +34,7 @@ The SDK supports all CoW Protocol enabled networks:
|
|
|
32
34
|
- **[CoW Protocol Documentation](https://docs.cow.fi/)**
|
|
33
35
|
- **[API Reference](https://api.cow.fi/docs/)**
|
|
34
36
|
- **[CoW Protocol Website](https://cow.fi/)**
|
|
35
|
-
- **[Examples Repository](
|
|
37
|
+
- **[Examples Repository](https://github.com/cowprotocol/cow-sdk/tree/main/examples)**
|
|
36
38
|
- **Issues**: [GitHub Issues](https://github.com/cowprotocol/cow-sdk/issues)
|
|
37
39
|
- **Discord**: [CoW Protocol Discord](https://discord.com/invite/cowprotocol)
|
|
38
40
|
- **Documentation**: [docs.cow.fi](https://docs.cow.fi/)
|
|
@@ -67,20 +69,20 @@ yarn add @cowprotocol/cow-sdk
|
|
|
67
69
|
Using CoW Protocol, you can perform swaps, limit orders, TWAP orders, and many other operations.
|
|
68
70
|
The `@cowprotocol/cow-sdk` provides tools at different abstraction levels, allowing you to conveniently implement basic scenarios while maintaining the flexibility to control all possible cases.
|
|
69
71
|
|
|
70
|
-
> In most cases, you will only need to use the **[Trading SDK](
|
|
72
|
+
> In most cases, you will only need to use the **[Trading SDK](https://github.com/cowprotocol/cow-sdk/tree/main/packages/trading/README.md)**
|
|
71
73
|
|
|
72
74
|
## SDK Components
|
|
73
75
|
|
|
74
76
|
### Core
|
|
75
|
-
- **[`TradingSdk`](
|
|
76
|
-
- **[`OrderSigningUtils`](
|
|
77
|
-
- **[`OrderBookApi`](
|
|
78
|
-
- **[`MetadataApi`](
|
|
77
|
+
- **[`TradingSdk`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/trading/README.md)** - Main tool for swap and limit orders with built-in quote fetching, order signing, and posting
|
|
78
|
+
- **[`OrderSigningUtils`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/order-signing/README.md)** - Utilities for signing orders and cancellations using cryptographic algorithms
|
|
79
|
+
- **[`OrderBookApi`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/order-book/README.md)** - Provides the ability to retrieve orders and trades from the CoW Protocol order book, as well as add and cancel them
|
|
80
|
+
- **[`MetadataApi`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/app-data/README.md)** - API for accessing order metadata and additional information
|
|
79
81
|
|
|
80
82
|
### Advanced
|
|
81
|
-
- **[`BridgingSdk`](
|
|
82
|
-
- **[`ConditionalOrder`](
|
|
83
|
-
- **[`CowShedSdk`](
|
|
83
|
+
- **[`BridgingSdk`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/bridging/README.md)** - Cross-chain token transfers and bridging functionality
|
|
84
|
+
- **[`ConditionalOrder`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/composable/README.md)** - SDK for Programmatic Orders such as TWAP ([Read more](https://docs.cow.fi/cow-protocol/concepts/order-types/programmatic-orders))
|
|
85
|
+
- **[`CowShedSdk`](https://github.com/cowprotocol/cow-sdk/tree/main/packages/cow-shed/README.md)** - Account abstraction that leverages EOA with smart contract capabilities
|
|
84
86
|
|
|
85
87
|
## v6 → v7 Migration Guide
|
|
86
88
|
The versions are 99% backward compatible. The only difference is that in v7 you need to set an adapter corresponding to the library you use: `Viem`, `Ethers6`, or `Ethers5`.
|
|
@@ -232,7 +234,7 @@ if (confirm(`You will receive at least: ${buyAmount}. Proceed?`)) {
|
|
|
232
234
|
This example demonstrates the simplest way to trade on CoW Protocol.
|
|
233
235
|
|
|
234
236
|
For more advanced use cases, you can use additional parameters such as `receiver`, `partiallyFillable`, `validTo`, and others.
|
|
235
|
-
Refer to the [Trading SDK documentation](packages/trading/README.md) for comprehensive details.
|
|
237
|
+
Refer to the [Trading SDK documentation](https://github.com/cowprotocol/cow-sdk/tree/main/packages/trading/README.md) for comprehensive details.
|
|
236
238
|
|
|
237
239
|
|
|
238
240
|
## Adapters
|
package/dist/index.d.mts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export * from '@cowprotocol/sdk-common';
|
|
2
2
|
export { Address } from '@cowprotocol/sdk-common';
|
|
3
3
|
export * from '@cowprotocol/sdk-config';
|
|
4
|
-
export * from '@cowprotocol/sdk-
|
|
5
|
-
export * from '@cowprotocol/sdk-order-book';
|
|
4
|
+
export * from '@cowprotocol/sdk-order-signing';
|
|
6
5
|
export * from '@cowprotocol/sdk-contracts-ts';
|
|
6
|
+
export * from '@cowprotocol/sdk-order-book';
|
|
7
|
+
export * from '@cowprotocol/sdk-app-data';
|
|
7
8
|
export * from '@cowprotocol/sdk-trading';
|
|
8
|
-
export * from '@cowprotocol/sdk-order-signing';
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export * from '@cowprotocol/sdk-common';
|
|
2
2
|
export { Address } from '@cowprotocol/sdk-common';
|
|
3
3
|
export * from '@cowprotocol/sdk-config';
|
|
4
|
-
export * from '@cowprotocol/sdk-
|
|
5
|
-
export * from '@cowprotocol/sdk-order-book';
|
|
4
|
+
export * from '@cowprotocol/sdk-order-signing';
|
|
6
5
|
export * from '@cowprotocol/sdk-contracts-ts';
|
|
6
|
+
export * from '@cowprotocol/sdk-order-book';
|
|
7
|
+
export * from '@cowprotocol/sdk-app-data';
|
|
7
8
|
export * from '@cowprotocol/sdk-trading';
|
|
8
|
-
export * from '@cowprotocol/sdk-order-signing';
|
package/dist/index.js
CHANGED
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
var sdkCommon = require('@cowprotocol/sdk-common');
|
|
4
4
|
var sdkConfig = require('@cowprotocol/sdk-config');
|
|
5
|
-
var
|
|
6
|
-
var sdkOrderBook = require('@cowprotocol/sdk-order-book');
|
|
5
|
+
var sdkOrderSigning = require('@cowprotocol/sdk-order-signing');
|
|
7
6
|
var sdkContractsTs = require('@cowprotocol/sdk-contracts-ts');
|
|
7
|
+
var sdkOrderBook = require('@cowprotocol/sdk-order-book');
|
|
8
|
+
var sdkAppData = require('@cowprotocol/sdk-app-data');
|
|
8
9
|
var sdkTrading = require('@cowprotocol/sdk-trading');
|
|
9
|
-
var sdkOrderSigning = require('@cowprotocol/sdk-order-signing');
|
|
10
10
|
|
|
11
11
|
|
|
12
12
|
|
|
@@ -22,33 +22,33 @@ Object.keys(sdkConfig).forEach(function (k) {
|
|
|
22
22
|
get: function () { return sdkConfig[k]; }
|
|
23
23
|
});
|
|
24
24
|
});
|
|
25
|
-
Object.keys(
|
|
25
|
+
Object.keys(sdkOrderSigning).forEach(function (k) {
|
|
26
26
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
27
27
|
enumerable: true,
|
|
28
|
-
get: function () { return
|
|
28
|
+
get: function () { return sdkOrderSigning[k]; }
|
|
29
29
|
});
|
|
30
30
|
});
|
|
31
|
-
Object.keys(
|
|
31
|
+
Object.keys(sdkContractsTs).forEach(function (k) {
|
|
32
32
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
33
33
|
enumerable: true,
|
|
34
|
-
get: function () { return
|
|
34
|
+
get: function () { return sdkContractsTs[k]; }
|
|
35
35
|
});
|
|
36
36
|
});
|
|
37
|
-
Object.keys(
|
|
37
|
+
Object.keys(sdkOrderBook).forEach(function (k) {
|
|
38
38
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
39
39
|
enumerable: true,
|
|
40
|
-
get: function () { return
|
|
40
|
+
get: function () { return sdkOrderBook[k]; }
|
|
41
41
|
});
|
|
42
42
|
});
|
|
43
|
-
Object.keys(
|
|
43
|
+
Object.keys(sdkAppData).forEach(function (k) {
|
|
44
44
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
45
45
|
enumerable: true,
|
|
46
|
-
get: function () { return
|
|
46
|
+
get: function () { return sdkAppData[k]; }
|
|
47
47
|
});
|
|
48
48
|
});
|
|
49
|
-
Object.keys(
|
|
49
|
+
Object.keys(sdkTrading).forEach(function (k) {
|
|
50
50
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
51
51
|
enumerable: true,
|
|
52
|
-
get: function () { return
|
|
52
|
+
get: function () { return sdkTrading[k]; }
|
|
53
53
|
});
|
|
54
54
|
});
|
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export * from '@cowprotocol/sdk-common';
|
|
2
2
|
export * from '@cowprotocol/sdk-config';
|
|
3
|
-
export * from '@cowprotocol/sdk-
|
|
4
|
-
export * from '@cowprotocol/sdk-order-book';
|
|
3
|
+
export * from '@cowprotocol/sdk-order-signing';
|
|
5
4
|
export * from '@cowprotocol/sdk-contracts-ts';
|
|
5
|
+
export * from '@cowprotocol/sdk-order-book';
|
|
6
|
+
export * from '@cowprotocol/sdk-app-data';
|
|
6
7
|
export * from '@cowprotocol/sdk-trading';
|
|
7
|
-
export * from '@cowprotocol/sdk-order-signing';
|
package/dist/package.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cowprotocol/cow-sdk",
|
|
3
|
-
"version": "7.1.2
|
|
3
|
+
"version": "7.1.2",
|
|
4
4
|
"license": "(MIT OR Apache-2.0)",
|
|
5
5
|
"description": "CoW Protocol SDK - get quote, configure your order, and trade",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -30,13 +30,13 @@
|
|
|
30
30
|
"@cow-sdk/typescript-config": "0.0.0-beta.0"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@cowprotocol/sdk-
|
|
34
|
-
"@cowprotocol/sdk-
|
|
35
|
-
"@cowprotocol/sdk-
|
|
36
|
-
"@cowprotocol/sdk-
|
|
37
|
-
"@cowprotocol/sdk-
|
|
38
|
-
"@cowprotocol/sdk-
|
|
39
|
-
"@cowprotocol/sdk-order-signing": "0.
|
|
33
|
+
"@cowprotocol/sdk-config": "0.4.0",
|
|
34
|
+
"@cowprotocol/sdk-app-data": "4.2.0",
|
|
35
|
+
"@cowprotocol/sdk-contracts-ts": "0.6.0",
|
|
36
|
+
"@cowprotocol/sdk-order-book": "0.3.0",
|
|
37
|
+
"@cowprotocol/sdk-common": "0.4.0",
|
|
38
|
+
"@cowprotocol/sdk-trading": "0.5.0",
|
|
39
|
+
"@cowprotocol/sdk-order-signing": "0.1.12"
|
|
40
40
|
},
|
|
41
41
|
"peerDependencies": {
|
|
42
42
|
"@openzeppelin/merkle-tree": "^1.x",
|