liquid-sdk 1.5.6 → 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.
Files changed (2) hide show
  1. package/README.md +39 -39
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,13 +2,50 @@
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% 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).
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.
12
49
 
13
50
  ### Default Liquidity Positions
14
51
 
@@ -163,7 +200,7 @@ console.log("Locker:", info.deployment.locker);
163
200
  const rewards = await liquid.getTokenRewards(tokenAddress);
164
201
  await liquid.collectRewards(tokenAddress);
165
202
 
166
- // Fee claims
203
+ // Fee claims (all fees converted to ETH by default)
167
204
  const claimable = await liquid.getFeesToClaim(ownerAddress, tokenAddress);
168
205
  await liquid.claimFees(ownerAddress, tokenAddress);
169
206
  ```
@@ -176,43 +213,6 @@ const claimable = await liquid.getVaultClaimable(tokenAddress);
176
213
  await liquid.claimVault(tokenAddress);
177
214
  ```
178
215
 
179
- ## Agent Skills
180
-
181
- 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.
182
-
183
- | Skill | File | What it teaches |
184
- |-------|------|-----------------|
185
- | **Deploy Token** | `skills/deploy-token.md` | Full deployment workflows — minimal deploy, dev buy, custom fees, custom positions, reward splits, validation rules |
186
- | **Bid in Auction** | `skills/bid-in-auction.md` | MEV sniper auction — WETH handling, gas price encoding, block timing, automated sniper example |
187
- | **Index Tokens** | `skills/index-tokens.md` | Token discovery — bulk queries, single lookup, pagination, real-time monitoring, data enrichment |
188
-
189
- ### Using Skills with Your Agent
190
-
191
- ```python
192
- # Python — load a skill into your agent's context
193
- with open("node_modules/liquid-sdk/skills/deploy-token.md") as f:
194
- agent.system_prompt += f.read()
195
- ```
196
-
197
- ```typescript
198
- // TypeScript — read skill for an MCP server or agent framework
199
- import { readFileSync } from "fs";
200
- const skill = readFileSync("node_modules/liquid-sdk/skills/bid-in-auction.md", "utf-8");
201
- ```
202
-
203
- For Claude Code, reference skills in your `CLAUDE.md`:
204
- ```
205
- For token deployment, follow the instructions in node_modules/liquid-sdk/skills/deploy-token.md
206
- ```
207
-
208
- ### Additional Agent Docs
209
-
210
- | File | Purpose |
211
- |------|---------|
212
- | `AGENT_README.md` | Complete API reference with every method, type, and default (700+ lines) |
213
- | `llms.txt` | Compact summary for LLM context windows |
214
- | `CLAUDE.md` | Agent guide with architecture, defaults, and invariants |
215
-
216
216
  ## Constants & ABIs
217
217
 
218
218
  All production addresses, fee parameters, and contract ABIs are exported:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "liquid-sdk",
3
- "version": "1.5.6",
3
+ "version": "1.5.7",
4
4
  "description": "TypeScript SDK to deploy ERC-20 tokens with Uniswap V4 liquidity on Base — zero API keys, one dependency (viem)",
5
5
  "author": "Liquid Protocol",
6
6
  "homepage": "https://github.com/craigbots/liquid-sdk#readme",