liquid-sdk 1.5.5 → 1.5.7
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/AGENT_README.md +2 -2
- package/README.md +49 -39
- package/dist/index.d.mts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +1 -1
- package/llms.txt +1 -1
- package/package.json +1 -1
- package/skills/deploy-token.md +4 -4
package/AGENT_README.md
CHANGED
|
@@ -507,11 +507,11 @@ When calling `deployToken`, all fields except `name` and `symbol` are optional.
|
|
|
507
507
|
| `image` | `""` | Empty string |
|
|
508
508
|
| `metadata` | `""` | Empty string |
|
|
509
509
|
| `context` | `'{"interface":"SDK"}'` | Auto-set via `buildContext()` |
|
|
510
|
-
| `hook` | `ADDRESSES.HOOK_STATIC_FEE_V2` | Static 1% buy
|
|
510
|
+
| `hook` | `ADDRESSES.HOOK_STATIC_FEE_V2` | Static 1% buy + 1% sell |
|
|
511
511
|
| `pairedToken` | `EXTERNAL.WETH` | Base WETH |
|
|
512
512
|
| `tickIfToken0IsLiquid` | `-230400` | ≈10 ETH market cap |
|
|
513
513
|
| `tickSpacing` | `200` | Uniswap V4 tick spacing |
|
|
514
|
-
| `poolData` | `encodeStaticFeePoolData(
|
|
514
|
+
| `poolData` | `encodeStaticFeePoolData(100, 100)` | 1% sell, 1% buy |
|
|
515
515
|
| `locker` | `ADDRESSES.LP_LOCKER_FEE_CONVERSION` | LP locker with fee conversion to ETH |
|
|
516
516
|
| `rewardAdmins` | `[walletAddress]` | Deployer is admin |
|
|
517
517
|
| `rewardRecipients` | `[walletAddress]` | Deployer gets rewards |
|
package/README.md
CHANGED
|
@@ -2,13 +2,60 @@
|
|
|
2
2
|
|
|
3
3
|
TypeScript SDK for the Liquid Protocol token launcher on Base. Deploy tokens, manage pools, and claim fees using [viem](https://viem.sh).
|
|
4
4
|
|
|
5
|
+
## Agent Skills
|
|
6
|
+
|
|
7
|
+
The SDK ships with **agent skill files** — self-contained markdown guides that AI agents can load into their context to autonomously interact with Liquid Protocol on Base.
|
|
8
|
+
|
|
9
|
+
| Skill | File | What it teaches |
|
|
10
|
+
|-------|------|-----------------|
|
|
11
|
+
| **Deploy Token** | `skills/deploy-token.md` | Full deployment workflows — minimal deploy, dev buy, custom fees, custom positions, reward splits, validation rules |
|
|
12
|
+
| **Bid in Auction** | `skills/bid-in-auction.md` | MEV sniper auction — WETH handling, gas price encoding, block timing, automated sniper example |
|
|
13
|
+
| **Index Tokens** | `skills/index-tokens.md` | Token discovery — bulk queries, single lookup, pagination, real-time monitoring, data enrichment |
|
|
14
|
+
|
|
15
|
+
### Using Skills with Your Agent
|
|
16
|
+
|
|
17
|
+
```python
|
|
18
|
+
# Python — load a skill into your agent's context
|
|
19
|
+
with open("node_modules/liquid-sdk/skills/deploy-token.md") as f:
|
|
20
|
+
agent.system_prompt += f.read()
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
// TypeScript — read skill for an MCP server or agent framework
|
|
25
|
+
import { readFileSync } from "fs";
|
|
26
|
+
const skill = readFileSync("node_modules/liquid-sdk/skills/bid-in-auction.md", "utf-8");
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
For Claude Code, reference skills in your `CLAUDE.md`:
|
|
30
|
+
```
|
|
31
|
+
For token deployment, follow the instructions in node_modules/liquid-sdk/skills/deploy-token.md
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Additional Agent Docs
|
|
35
|
+
|
|
36
|
+
| File | Purpose |
|
|
37
|
+
|------|---------|
|
|
38
|
+
| `AGENT_README.md` | Complete API reference with every method, type, and default (700+ lines) |
|
|
39
|
+
| `llms.txt` | Compact summary for LLM context windows |
|
|
40
|
+
| `CLAUDE.md` | Agent guide with architecture, defaults, and invariants |
|
|
41
|
+
|
|
5
42
|
## Installation
|
|
6
43
|
|
|
7
44
|
```bash
|
|
8
45
|
npm install liquid-sdk viem
|
|
9
46
|
```
|
|
10
47
|
|
|
11
|
-
> **Defaults**: Static 1%
|
|
48
|
+
> **Defaults**: Static 1% fee (both buy and sell), 5-position Liquid layout, Sniper Auction MEV (80%→40% over 32s, 5 rounds), tick spacing 200, starting tick -230400 (~10 ETH market cap). All fees converted to ETH before distribution.
|
|
49
|
+
|
|
50
|
+
### Default Liquidity Positions
|
|
51
|
+
|
|
52
|
+
| # | Supply | Tick Range | Market Cap Range (@$2,000/ETH) |
|
|
53
|
+
|---|--------|-----------|-------------------------------|
|
|
54
|
+
| 1 | 10% | -230,400 → -216,000 | ~$20K → ~$83K |
|
|
55
|
+
| 2 | 50% | -216,000 → -155,000 | ~$83K → ~$37M |
|
|
56
|
+
| 3 | 15% | -202,000 → -155,000 | ~$338K → ~$37M |
|
|
57
|
+
| 4 | 20% | -155,000 → -120,000 | ~$37M → ~$1.2B |
|
|
58
|
+
| 5 | 5% | -141,000 → -120,000 | ~$151M → ~$1.2B |
|
|
12
59
|
|
|
13
60
|
## Quick Start
|
|
14
61
|
|
|
@@ -153,7 +200,7 @@ console.log("Locker:", info.deployment.locker);
|
|
|
153
200
|
const rewards = await liquid.getTokenRewards(tokenAddress);
|
|
154
201
|
await liquid.collectRewards(tokenAddress);
|
|
155
202
|
|
|
156
|
-
// Fee claims
|
|
203
|
+
// Fee claims (all fees converted to ETH by default)
|
|
157
204
|
const claimable = await liquid.getFeesToClaim(ownerAddress, tokenAddress);
|
|
158
205
|
await liquid.claimFees(ownerAddress, tokenAddress);
|
|
159
206
|
```
|
|
@@ -166,43 +213,6 @@ const claimable = await liquid.getVaultClaimable(tokenAddress);
|
|
|
166
213
|
await liquid.claimVault(tokenAddress);
|
|
167
214
|
```
|
|
168
215
|
|
|
169
|
-
## Agent Skills
|
|
170
|
-
|
|
171
|
-
The SDK ships with **agent skill files** — self-contained markdown guides that AI agents can load into their context to autonomously use the SDK. Find them in `node_modules/liquid-sdk/skills/` after install.
|
|
172
|
-
|
|
173
|
-
| Skill | File | What it teaches |
|
|
174
|
-
|-------|------|-----------------|
|
|
175
|
-
| **Deploy Token** | `skills/deploy-token.md` | Full deployment workflows — minimal deploy, dev buy, custom fees, custom positions, reward splits, validation rules |
|
|
176
|
-
| **Bid in Auction** | `skills/bid-in-auction.md` | MEV sniper auction — WETH handling, gas price encoding, block timing, automated sniper example |
|
|
177
|
-
| **Index Tokens** | `skills/index-tokens.md` | Token discovery — bulk queries, single lookup, pagination, real-time monitoring, data enrichment |
|
|
178
|
-
|
|
179
|
-
### Using Skills with Your Agent
|
|
180
|
-
|
|
181
|
-
```python
|
|
182
|
-
# Python — load a skill into your agent's context
|
|
183
|
-
with open("node_modules/liquid-sdk/skills/deploy-token.md") as f:
|
|
184
|
-
agent.system_prompt += f.read()
|
|
185
|
-
```
|
|
186
|
-
|
|
187
|
-
```typescript
|
|
188
|
-
// TypeScript — read skill for an MCP server or agent framework
|
|
189
|
-
import { readFileSync } from "fs";
|
|
190
|
-
const skill = readFileSync("node_modules/liquid-sdk/skills/bid-in-auction.md", "utf-8");
|
|
191
|
-
```
|
|
192
|
-
|
|
193
|
-
For Claude Code, reference skills in your `CLAUDE.md`:
|
|
194
|
-
```
|
|
195
|
-
For token deployment, follow the instructions in node_modules/liquid-sdk/skills/deploy-token.md
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
### Additional Agent Docs
|
|
199
|
-
|
|
200
|
-
| File | Purpose |
|
|
201
|
-
|------|---------|
|
|
202
|
-
| `AGENT_README.md` | Complete API reference with every method, type, and default (700+ lines) |
|
|
203
|
-
| `llms.txt` | Compact summary for LLM context windows |
|
|
204
|
-
| `CLAUDE.md` | Agent guide with architecture, defaults, and invariants |
|
|
205
|
-
|
|
206
216
|
## Constants & ABIs
|
|
207
217
|
|
|
208
218
|
All production addresses, fee parameters, and contract ABIs are exported:
|
package/dist/index.d.mts
CHANGED
|
@@ -429,7 +429,7 @@ declare const POOL_POSITIONS: {
|
|
|
429
429
|
/**
|
|
430
430
|
* Liquid protocol defaults.
|
|
431
431
|
*
|
|
432
|
-
* - Hook: Static fee V2, 1% on buys
|
|
432
|
+
* - Hook: Static fee V2, 1% on both buys and sells
|
|
433
433
|
* - MEV: Sniper Auction V2 — 80% → 40% decaying over 32 seconds
|
|
434
434
|
* - Tick spacing: 200
|
|
435
435
|
* - Starting tick: -230400 (≈10 ETH market cap)
|
|
@@ -441,10 +441,10 @@ declare const DEFAULTS: {
|
|
|
441
441
|
readonly LOCKER: `0x${string}`;
|
|
442
442
|
readonly TICK_SPACING: 200;
|
|
443
443
|
readonly TICK_IF_TOKEN0_IS_LIQUID: -230400;
|
|
444
|
-
/** Static fee on buys (ETH → token): 1% (100 bps)
|
|
444
|
+
/** Static fee on buys (ETH → token): 1% (100 bps) */
|
|
445
445
|
readonly PAIRED_FEE_BPS: 100;
|
|
446
|
-
/** Static fee on sells (token → ETH):
|
|
447
|
-
readonly LIQUID_FEE_BPS:
|
|
446
|
+
/** Static fee on sells (token → ETH): 1% (100 bps) */
|
|
447
|
+
readonly LIQUID_FEE_BPS: 100;
|
|
448
448
|
/** MEV module: Sniper Auction V2 */
|
|
449
449
|
readonly MEV_MODULE: `0x${string}`;
|
|
450
450
|
/** Sniper auction starting fee: 80% (800,000 uniBps) */
|
package/dist/index.d.ts
CHANGED
|
@@ -429,7 +429,7 @@ declare const POOL_POSITIONS: {
|
|
|
429
429
|
/**
|
|
430
430
|
* Liquid protocol defaults.
|
|
431
431
|
*
|
|
432
|
-
* - Hook: Static fee V2, 1% on buys
|
|
432
|
+
* - Hook: Static fee V2, 1% on both buys and sells
|
|
433
433
|
* - MEV: Sniper Auction V2 — 80% → 40% decaying over 32 seconds
|
|
434
434
|
* - Tick spacing: 200
|
|
435
435
|
* - Starting tick: -230400 (≈10 ETH market cap)
|
|
@@ -441,10 +441,10 @@ declare const DEFAULTS: {
|
|
|
441
441
|
readonly LOCKER: `0x${string}`;
|
|
442
442
|
readonly TICK_SPACING: 200;
|
|
443
443
|
readonly TICK_IF_TOKEN0_IS_LIQUID: -230400;
|
|
444
|
-
/** Static fee on buys (ETH → token): 1% (100 bps)
|
|
444
|
+
/** Static fee on buys (ETH → token): 1% (100 bps) */
|
|
445
445
|
readonly PAIRED_FEE_BPS: 100;
|
|
446
|
-
/** Static fee on sells (token → ETH):
|
|
447
|
-
readonly LIQUID_FEE_BPS:
|
|
446
|
+
/** Static fee on sells (token → ETH): 1% (100 bps) */
|
|
447
|
+
readonly LIQUID_FEE_BPS: 100;
|
|
448
448
|
/** MEV module: Sniper Auction V2 */
|
|
449
449
|
readonly MEV_MODULE: `0x${string}`;
|
|
450
450
|
/** Sniper auction starting fee: 80% (800,000 uniBps) */
|
package/dist/index.js
CHANGED
|
@@ -164,10 +164,10 @@ var DEFAULTS = {
|
|
|
164
164
|
LOCKER: ADDRESSES.LP_LOCKER_FEE_CONVERSION,
|
|
165
165
|
TICK_SPACING: 200,
|
|
166
166
|
TICK_IF_TOKEN0_IS_LIQUID: -230400,
|
|
167
|
-
/** Static fee on buys (ETH → token): 1% (100 bps)
|
|
167
|
+
/** Static fee on buys (ETH → token): 1% (100 bps) */
|
|
168
168
|
PAIRED_FEE_BPS: 100,
|
|
169
|
-
/** Static fee on sells (token → ETH):
|
|
170
|
-
LIQUID_FEE_BPS:
|
|
169
|
+
/** Static fee on sells (token → ETH): 1% (100 bps) */
|
|
170
|
+
LIQUID_FEE_BPS: 100,
|
|
171
171
|
/** MEV module: Sniper Auction V2 */
|
|
172
172
|
MEV_MODULE: ADDRESSES.SNIPER_AUCTION_V2,
|
|
173
173
|
/** Sniper auction starting fee: 80% (800,000 uniBps) */
|