clanker-sdk 4.2.10 → 4.2.12

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 (40) hide show
  1. package/README.md +42 -9
  2. package/dist/{deploy-BvFgwMVl.d.ts → clankerTokenV4-DoIzm6GW.d.ts} +1822 -9
  3. package/dist/cli/cli.js +10456 -7324
  4. package/dist/cli/commands/airdrop.d.ts +8 -0
  5. package/dist/cli/commands/airdrop.js +8524 -0
  6. package/dist/cli/commands/deploy.d.ts +14 -0
  7. package/dist/cli/commands/deploy.js +9883 -0
  8. package/dist/cli/commands/presale.d.ts +5 -0
  9. package/dist/cli/commands/presale.js +9340 -0
  10. package/dist/cli/commands/rewards.d.ts +5 -0
  11. package/dist/cli/commands/rewards.js +8235 -0
  12. package/dist/cli/commands/setup.d.ts +5 -0
  13. package/dist/cli/commands/setup.js +314 -0
  14. package/dist/cli/commands/token.d.ts +5 -0
  15. package/dist/cli/commands/token.js +8120 -0
  16. package/dist/cli/commands/vault.d.ts +5 -0
  17. package/dist/cli/commands/vault.js +8128 -0
  18. package/dist/cli/create-clanker.js +29 -2
  19. package/dist/cli/utils/chains.d.ts +6 -0
  20. package/dist/cli/utils/chains.js +51 -0
  21. package/dist/cli/utils/config.d.ts +10 -0
  22. package/dist/cli/utils/config.js +31 -0
  23. package/dist/cli/utils/output.d.ts +14 -0
  24. package/dist/cli/utils/output.js +209 -0
  25. package/dist/cli/utils/style.d.ts +49 -0
  26. package/dist/cli/utils/style.js +129 -0
  27. package/dist/cli/utils/wallet.d.ts +22 -0
  28. package/dist/cli/utils/wallet.js +108 -0
  29. package/dist/deploy-BUDlDPzt.d.ts +6 -0
  30. package/dist/index.d.ts +25 -16
  31. package/dist/index.js +36 -2
  32. package/dist/legacyFeeClaims/index.js +25 -1
  33. package/dist/merkleTree-BNYdIOkH.d.ts +15 -0
  34. package/dist/v3/index.d.ts +4 -4
  35. package/dist/v3/index.js +28 -1
  36. package/dist/v4/extensions/index.d.ts +2 -1
  37. package/dist/v4/extensions/index.js +28 -1
  38. package/dist/v4/index.d.ts +5 -4
  39. package/dist/v4/index.js +28 -1
  40. package/package.json +2 -1
package/README.md CHANGED
@@ -11,23 +11,56 @@ yarn add clanker-sdk viem
11
11
  # or
12
12
  pnpm add clanker-sdk viem
13
13
  ```
14
- npm run create-clanker
15
- node --loader ts-node/esm examples/deploy.ts
16
14
 
17
- ## Quick Start
15
+ ## CLI
18
16
 
19
- There are two ways to deploy tokens using the Clanker SDK:
17
+ The Clanker SDK ships a CLI for deploying and managing tokens directly from your terminal.
20
18
 
21
- ### 1. Using the CLI
19
+ ### Install globally
22
20
 
23
- Run the following command to use our interactive CLI tool:
24
21
  ```bash
25
- npm run create-clanker
22
+ npm install -g clanker-sdk
26
23
  ```
27
24
 
28
- This will guide you through the token deployment process step by step.
25
+ Then run commands with:
29
26
 
30
- ### 2. Using the TypeScript SDK
27
+ ```bash
28
+ clanker-sdk deploy --name "MyToken" --symbol "MTK" --chain base
29
+ clanker-sdk rewards claim --token 0x...
30
+ clanker-sdk vault claim --token 0x...
31
+ ```
32
+
33
+ ### Or use npx (no install)
34
+
35
+ ```bash
36
+ npx clanker-sdk deploy --name "MyToken" --symbol "MTK" --chain base
37
+ ```
38
+
39
+ ### Available commands
40
+
41
+ | Command | Description |
42
+ |---------|-------------|
43
+ | `setup` | Save default wallet & chain config |
44
+ | `deploy` | Deploy a new token (V3 or V4) |
45
+ | `rewards` | Claim rewards, update recipients/admins |
46
+ | `vault` | Claim vaulted tokens |
47
+
48
+ | `airdrop` | Generate Merkle trees, register & claim airdrops |
49
+ | `token` | Update token image & metadata |
50
+
51
+ ### Global options
52
+
53
+ ```
54
+ --chain <name> Target chain (base, base-sepolia, bsc, etc.)
55
+ --rpc <url> Custom RPC URL
56
+ --private-key <key> Wallet private key (or set PRIVATE_KEY env)
57
+ --json Output machine-readable JSON
58
+ --dry-run Simulate transaction without sending
59
+ ```
60
+
61
+ Run `clanker-sdk <command> --help` for details on any command.
62
+
63
+ ## TypeScript SDK
31
64
 
32
65
  1. Create a `.env` file with your configuration:
33
66
  ```env