@sun-protocol/sun-sdk-sunswap-v3 0.1.0-beta.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 +30 -0
- package/dist/index.cjs +3126 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1236 -0
- package/dist/index.d.ts +1236 -0
- package/dist/index.js +3024 -0
- package/dist/index.js.map +1 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# @sun-protocol/sun-sdk-sunswap-v3
|
|
2
|
+
|
|
3
|
+
SunSwap V3 pool, position, trade, read, and transaction action primitives.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @sun-protocol/sun-sdk-sunswap-v3
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { computeV3PoolAddress } from '@sun-protocol/sun-sdk-sunswap-v3'
|
|
15
|
+
|
|
16
|
+
const pool = computeV3PoolAddress({
|
|
17
|
+
network: 'mainnet',
|
|
18
|
+
tokenA,
|
|
19
|
+
tokenB,
|
|
20
|
+
fee: 3000,
|
|
21
|
+
})
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Primary exports include `Pool`, `Position`, `Route`, `Trade`, tick math, pool-address calculation, position-manager calldata helpers, contract read specifications, and V3 action builders.
|
|
25
|
+
|
|
26
|
+
This package performs deterministic protocol math and builds reads or actions. It does not own a wallet, sign, broadcast, or manage a transaction lifecycle. Use the liquidity and positions clients in `@sun-protocol/sun-sdk-protocols` for orchestration.
|
|
27
|
+
|
|
28
|
+
Requires Node.js 20 or a compatible JavaScript runtime.
|
|
29
|
+
|
|
30
|
+
[Full API documentation](https://github.com/sun-protocol/sun-sdk/blob/main/docs/sdk/api/sunswap-v3.md)
|