@speculite/clob-client 0.1.0 → 0.1.1
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 +2 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,25 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
Official TypeScript SDK for Speculite market data and developer trading APIs.
|
|
4
4
|
|
|
5
|
+
Documentation: https://docs.speculite.com/developer-guide/trading-api-quickstart/
|
|
6
|
+
|
|
5
7
|
## Install
|
|
6
8
|
|
|
7
9
|
```bash
|
|
8
10
|
npm install @speculite/clob-client ethers viem
|
|
9
11
|
```
|
|
10
12
|
|
|
11
|
-
## SDK Architecture
|
|
12
|
-
|
|
13
|
-
The SDK is now split by concern so it is easier to maintain and extend:
|
|
14
|
-
|
|
15
|
-
- `src/types.ts`: public types and enums
|
|
16
|
-
- `src/errors.ts`: API error types
|
|
17
|
-
- `src/internal/*`: reusable constants and pure helpers
|
|
18
|
-
- `src/client/baseClient.ts`: transport/auth/signing shared logic
|
|
19
|
-
- `src/client/publicClient.ts`: public + developer REST methods
|
|
20
|
-
- `src/client/tradingClient.ts`: order creation/signing flow
|
|
21
|
-
- `src/client/lifecycleClient.ts`: on-chain lifecycle transaction helpers
|
|
22
|
-
- `src/speculiteClobClient.ts`: public facade class + re-exports
|
|
23
|
-
|
|
24
13
|
## Quickstart
|
|
25
14
|
|
|
26
15
|
```ts
|