@steerprotocol/sdk 3.3.0 → 3.4.0
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 +11 -3
- package/dist/index.browser.mjs +4002 -82
- package/dist/index.browser.mjs.map +1 -1
- package/dist/index.cjs +4089 -80
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +1679 -20
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +4002 -82
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -82,6 +82,14 @@ for (const chain of supported) {
|
|
|
82
82
|
- **Pool Data**: Fetch pool information and statistics
|
|
83
83
|
- **Smart Rewards**: Manage reward campaigns and claims
|
|
84
84
|
|
|
85
|
+
## Pool Creation and Initialization
|
|
86
|
+
|
|
87
|
+
Pool lifecycle support is exposed as signer-neutral primitives rather than methods on `PoolClient`. Lifecycle capability is explicit and fail-closed; protocol discovery alone never enables a write path.
|
|
88
|
+
|
|
89
|
+
The explicit lifecycle registry covers all currently configured Uniswap V3-compatible, Uniswap V4, and Algebra-family chain/protocol pairs: 104 deployments in total. It includes exact bigint price encoding, block-pinned preflight inspection, family-specific unsigned builders, sender-aware simulation, and receipt/postcondition verification. V3 factory-only and Algebra standard-pool flows remain explicitly two-step where no atomic initializer is proven.
|
|
90
|
+
|
|
91
|
+
See the [detailed pool-lifecycle guide](https://github.com/SteerProtocol/sdk/blob/master/src/pool-lifecycle/README.md) for the complete flow and API boundaries.
|
|
92
|
+
|
|
85
93
|
## Staking Client
|
|
86
94
|
|
|
87
95
|
The StakingClient provides functionality for interacting with Steer Protocol staking pools. It supports both single and dual reward staking pools.
|
|
@@ -328,7 +336,7 @@ const preparedTx = await client.prepareDepositTx(params);
|
|
|
328
336
|
client.validateDepositParams(params);
|
|
329
337
|
```
|
|
330
338
|
|
|
331
|
-
### Supported AMM Types
|
|
339
|
+
### SingleAssetDepositClient Supported AMM Types
|
|
332
340
|
|
|
333
341
|
```typescript
|
|
334
342
|
enum AMMType {
|
|
@@ -340,7 +348,7 @@ enum AMMType {
|
|
|
340
348
|
}
|
|
341
349
|
```
|
|
342
350
|
|
|
343
|
-
|
|
351
|
+
Within `SingleAssetDepositClient`, only **UniswapV3** is fully implemented. This does not limit the separate pool-lifecycle APIs described above. Other single-asset-deposit AMM types will be added in future releases.
|
|
344
352
|
|
|
345
353
|
### Error Handling
|
|
346
354
|
|
|
@@ -367,7 +375,7 @@ console.log('LP tokens:', result.data.lpEstimation.lpTokens);
|
|
|
367
375
|
|
|
368
376
|
### Common Error Cases
|
|
369
377
|
|
|
370
|
-
- **Invalid AMM Type**:
|
|
378
|
+
- **Invalid AMM Type**: `SingleAssetDepositClient` currently supports only UniswapV3
|
|
371
379
|
- **Insufficient Liquidity**: Pool doesn't have enough liquidity for the swap
|
|
372
380
|
- **Slippage Too High**: Price moved beyond acceptable limits
|
|
373
381
|
- **Invalid Addresses**: Zero addresses or invalid contract addresses
|