@four-meme/four-meme-ai 1.0.5 → 1.0.6

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 (3) hide show
  1. package/README.md +27 -10
  2. package/bin/fourmeme.cjs +72 -32
  3. package/package.json +2 -1
package/README.md CHANGED
@@ -20,16 +20,33 @@ When the user needs to create or trade meme tokens on four.meme (BSC), use the *
20
20
  - **Tax token fee/tax info**: `fourmeme tax-info <tokenAddress>`. See `references/tax-token-query.md` and `token-tax-info.md`.
21
21
  - **Send BNB/ERC20**: `fourmeme send <toAddress> <amountWei> [tokenAddress]` to transfer from the trading wallet.
22
22
  - **EIP‑8004 identity NFT**: `fourmeme 8004-register <name> [imageUrl] [description]` and `fourmeme 8004-balance <ownerAddress>`.
23
- - **CLI** (after `npm install`): use **`npx fourmeme <command> [args]`**. Run `npx fourmeme --help` for all commands, including:
24
- - Config: `npx fourmeme config`
25
- - Create (one-shot): `npx fourmeme create-instant --image=... --name=... --short-name=... --desc=... --label=...` (same args as create-api; optional `--pre-sale=0.001` in BNB)
26
- - Create (two steps): `npx fourmeme create-api ...` → `npx fourmeme create-chain ...`
27
- - Trade/info: `npx fourmeme token-info <tokenAddress>`, `npx fourmeme quote-buy`, `npx fourmeme quote-sell`
28
- - Execute trade: `npx fourmeme buy <token> amount|funds ...`, `npx fourmeme sell <token> <amountWei> [minFundsWei]` (needs PRIVATE_KEY)
29
- - Events: `npx fourmeme events <fromBlock> [toBlock]`
30
- - Tax: `npx fourmeme tax-info <tokenAddress>`
31
- - EIP‑8004: `npx fourmeme 8004-register ...`, `npx fourmeme 8004-balance ...`
32
- - Verify: `npx fourmeme verify`
23
+ - **CLI**: `npx fourmeme <command> [args]`. Run `npx fourmeme --help` for the full list. See **Commands and parameters** below.
24
+
25
+ ## Commands and parameters
26
+
27
+ | Command | Parameters | Description |
28
+ |--------|------------|-------------|
29
+ | `config` | *(none)* | Public config (raisedToken). No auth. |
30
+ | `create-api` | `--image=` `--name=` `--short-name=` `--desc=` `--label=` `[--web-url=]` `[--twitter-url=]` `[--telegram-url=]` `[--pre-sale=<BNB>]` `[--fee-plan=false]` `[--tax-options=<path>]` or `[--tax-token --tax-fee-rate=5 ...]` | Create token API only. Label: `Meme|AI|Defi|Games|Infra|De-Sci|Social|Depin|Charity|Others`. Env: PRIVATE_KEY. |
31
+ | `create-chain` | `<createArgHex>` `<signatureHex>` `[--value=<wei>]` or `--` (stdin JSON) | Submit createToken on BSC. Env: PRIVATE_KEY. |
32
+ | `create-instant` | `--image=` `--name=` `--short-name=` `--desc=` `--label=` `[--web-url=]` `[--twitter-url=]` `[--telegram-url=]` `[--pre-sale=<BNB>]` `[--fee-plan=false]` `[--value=<wei>]` `[--tax-options=<path>]` or `[--tax-token --tax-fee-rate=5 ...]` | One-shot create (API + chain). Same options as create-api plus `--value=` override. Env: PRIVATE_KEY. |
33
+ | `token-info` | `<tokenAddress>` | On-chain token info (Helper3). |
34
+ | `token-list` | `[--orderBy=Hot]` `[--pageIndex=1]` `[--pageSize=30]` `[--tokenName=]` `[--symbol=]` `[--labels=]` `[--listedPancake=false]` | REST token list. |
35
+ | `token-get` | `<tokenAddress>` | REST token detail + trading info. |
36
+ | `token-rankings` | `<orderBy>` `[--barType=HOUR24]` | Rankings. orderBy: `Time|ProgressDesc|TradingDesc|Hot|Graduated`. |
37
+ | `quote-buy` | `<tokenAddress>` `<amountWei>` `[fundsWei]` | Estimate buy (no tx). Use 0 for amount or funds. |
38
+ | `quote-sell` | `<tokenAddress>` `<amountWei>` | Estimate sell (no tx). |
39
+ | `buy` | `<token>` `amount` `<amountWei>` `<maxFundsWei>` | Buy fixed amount. Env: PRIVATE_KEY. |
40
+ | `buy` | `<token>` `funds` `<fundsWei>` `<minAmountWei>` | Buy with fixed quote. Env: PRIVATE_KEY. |
41
+ | `sell` | `<tokenAddress>` `<amountWei>` `[minFundsWei]` | Execute sell. Env: PRIVATE_KEY. |
42
+ | `send` | `<toAddress>` `<amountWei>` `[tokenAddress]` | Send BNB or ERC20. Omit tokenAddress for BNB. Env: PRIVATE_KEY. |
43
+ | `8004-register` | `<name>` `[imageUrl]` `[description]` | EIP-8004 register NFT. Env: PRIVATE_KEY. |
44
+ | `8004-balance` | `<ownerAddress>` | EIP-8004 query balance. |
45
+ | `events` | `<fromBlock>` `[toBlock]` | TokenManager2 events (BSC). |
46
+ | `tax-info` | `<tokenAddress>` | TaxToken fee/tax config. |
47
+ | `verify` | *(none)* | Config + events (last 50 blocks). Read-only. |
48
+
49
+ Create token optional (omit if empty): `--web-url=`, `--twitter-url=`, `--telegram-url=`. Presale: `--pre-sale=<BNB>` in ether (e.g. `0.001`). Tax: `--tax-options=<path>` or `--tax-token --tax-fee-rate=5 --tax-burn-rate=0 --tax-divide-rate=0 --tax-liquidity-rate=100 --tax-recipient-rate=0 --tax-recipient-address= --tax-min-sharing=100000` (burn+divide+liquidity+recipient=100).
33
50
 
34
51
  ## Install (project)
35
52
 
package/bin/fourmeme.cjs CHANGED
@@ -50,47 +50,87 @@ function printHelp() {
50
50
 
51
51
  Usage: npx fourmeme <command> [args...]
52
52
 
53
- (In project dir, use npx fourmeme; npm install does not add fourmeme to PATH.)
54
-
55
- Commands:
56
- config Get public config (raisedToken). No auth.
57
- create-api --image= --name= --short-name= --desc= --label= [options]
58
- Create token API flow. Env: PRIVATE_KEY.
59
- create-chain <createArgHex> <signatureHex>
60
- Submit createToken tx on BSC. Or: fourmeme create-chain -- (stdin JSON)
61
- create-instant --image= --name= --short-name= --desc= --label= [options]
62
- One-shot: create-api + create-chain (same args as create-api).
53
+ Commands and parameters:
54
+
55
+ config
56
+ (no args) Get public config (raisedToken). No auth.
57
+
58
+ create-api
59
+ Required: --image=<path> --name=<name> --short-name=<symbol> --desc=<text> --label=<label>
60
+ Optional: --web-url= --twitter-url= --telegram-url= (omit if empty)
61
+ --pre-sale=<BNB> (ether units, e.g. 0.001)
62
+ --fee-plan=false
63
+ --tax-options=<path> OR --tax-token --tax-fee-rate=5 --tax-burn-rate=0
64
+ --tax-divide-rate=0 --tax-liquidity-rate=100 --tax-recipient-rate=0
65
+ --tax-recipient-address= --tax-min-sharing=100000
66
+ Label: Meme|AI|Defi|Games|Infra|De-Sci|Social|Depin|Charity|Others
67
+ Env: PRIVATE_KEY.
68
+
69
+ create-chain
70
+ <createArgHex> <signatureHex> [--value=<wei>]
71
+ Or: fourmeme create-chain -- (read createArg, signature, creationFeeWei from stdin JSON)
72
+ Env: PRIVATE_KEY, optional CREATION_FEE_WEI.
73
+
74
+ create-instant
75
+ Required: --image=<path> --name=<name> --short-name=<symbol> --desc=<text> --label=<label>
76
+ Optional: --web-url= --twitter-url= --telegram-url= (omit if empty)
77
+ --pre-sale=<BNB> (ether units, e.g. 0.001)
78
+ --fee-plan=false
79
+ --value=<wei> (override computed creation fee; default from API)
80
+ --tax-options=<path> OR --tax-token --tax-fee-rate=5 --tax-burn-rate=0
81
+ --tax-divide-rate=0 --tax-liquidity-rate=100 --tax-recipient-rate=0
82
+ --tax-recipient-address= --tax-min-sharing=100000
83
+ Label: Meme|AI|Defi|Games|Infra|De-Sci|Social|Depin|Charity|Others
84
+ One-shot: API + submit createToken. Env: PRIVATE_KEY.
85
+
63
86
  token-info <tokenAddress>
64
- Get token info from Helper3 (BSC, on-chain).
65
- token-list [--orderBy=Hot] [--pageIndex=1] [--pageSize=30] [--tokenName=] [--symbol=] [--labels=] [--listedPancake=false]
66
- Token list (REST API, filter/query).
87
+ On-chain token info (Helper3). No auth.
88
+
89
+ token-list
90
+ [--orderBy=Hot] [--pageIndex=1] [--pageSize=30] [--tokenName=] [--symbol=] [--labels=] [--listedPancake=false]
91
+ REST token list. No auth.
92
+
67
93
  token-get <tokenAddress>
68
- Token detail + trading info (REST API get/v2).
94
+ REST token detail + trading info. No auth.
95
+
69
96
  token-rankings <orderBy> [--barType=HOUR24]
70
- Rankings: orderBy=Time|ProgressDesc|TradingDesc|Hot|Graduated. barType only for TradingDesc.
71
- quote-buy <token> <amountWei> [fundsWei]
72
- Estimate buy (no tx). Use 0 for amount or funds.
73
- quote-sell <token> <amountWei>
74
- Estimate sell (no tx).
75
- buy <token> amount <amountWei> <maxFundsWei>
76
- Execute buy: fixed token amount. Env: PRIVATE_KEY.
77
- buy <token> funds <fundsWei> <minAmountWei>
78
- Execute buy: spend fixed quote (e.g. BNB). Env: PRIVATE_KEY.
79
- sell <token> <amountWei> [minFundsWei]
80
- Execute sell. Env: PRIVATE_KEY.
97
+ orderBy: Time|ProgressDesc|TradingDesc|Hot|Graduated. barType for TradingDesc. No auth.
98
+
99
+ quote-buy <tokenAddress> <amountWei> [fundsWei]
100
+ Estimate buy. Use 0 for amount or funds. No tx.
101
+
102
+ quote-sell <tokenAddress> <amountWei>
103
+ Estimate sell. No tx.
104
+
105
+ buy <tokenAddress> amount <amountWei> <maxFundsWei>
106
+ Buy fixed token amount. Env: PRIVATE_KEY.
107
+
108
+ buy <tokenAddress> funds <fundsWei> <minAmountWei>
109
+ Spend fixed quote (e.g. BNB). Env: PRIVATE_KEY.
110
+
111
+ sell <tokenAddress> <amountWei> [minFundsWei]
112
+ Execute sell. Env: PRIVATE_KEY.
113
+
81
114
  send <toAddress> <amountWei> [tokenAddress]
82
- Send BNB or ERC20 to address. Omit tokenAddress for BNB. Env: PRIVATE_KEY.
115
+ Send BNB or ERC20. Omit tokenAddress for BNB. Env: PRIVATE_KEY.
116
+
83
117
  8004-register <name> [imageUrl] [description]
84
- EIP-8004: register identity NFT. Env: PRIVATE_KEY.
118
+ EIP-8004 register identity NFT. Env: PRIVATE_KEY.
119
+
85
120
  8004-balance <ownerAddress>
86
- EIP-8004: query NFT balance of address (read-only).
121
+ EIP-8004 query NFT balance. Read-only.
122
+
87
123
  events <fromBlock> [toBlock]
88
- TokenManager2 events (BSC). Default toBlock: latest.
124
+ TokenManager2 events (BSC). toBlock default: latest.
125
+
89
126
  tax-info <tokenAddress>
90
- TaxToken fee/tax config (BSC, creatorType 5 only).
91
- verify Run config + events for last 50 blocks (read-only check).
127
+ TaxToken fee/tax config (creatorType 5). Read-only.
128
+
129
+ verify
130
+ (no args) Config + events last 50 blocks. Read-only.
92
131
 
93
- Env: PRIVATE_KEY, BSC_RPC_URL. See SKILL.md for full docs.
132
+ Env: PRIVATE_KEY (required for create-api, create-chain, create-instant, buy, sell, send, 8004-register).
133
+ BSC_RPC_URL, CREATION_FEE_WEI optional. See SKILL.md.
94
134
  `);
95
135
  }
96
136
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@four-meme/four-meme-ai",
3
- "version": "1.0.5",
3
+ "version": "1.0.6",
4
4
  "description": "Four.meme AI skills for creating and trading meme tokens (BSC only)",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -43,6 +43,7 @@
43
43
  "openclaw"
44
44
  ],
45
45
  "dependencies": {
46
+ "@four-meme/four-meme-ai": "^1.0.5",
46
47
  "dotenv": "^16.0.0"
47
48
  },
48
49
  "devDependencies": {