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

package/skills/four-meme-integration/references/create-token-scripts.md

@@ -1,21 +1,34 @@
 # Create Token Scripts (Four.meme)
 
-## One-shot (create-token-instant)
+**Recommended:** Use `fourmeme create-instant` for one-shot token creation (API + on-chain in one command). Use the step-by-step flow only when you need to inspect or modify the API output before submitting on-chain.
+
+## One-shot (create-instant) — recommended
 
 **create-token-instant.ts** runs API create + on-chain submit in one command. Same args as create-token-api; on success submits createToken and outputs `txHash`.
 
+- All options as `--key=value`; no positionals.
+- **Required**: `--image=`, `--name=`, `--short-name=`, `--desc=`, `--label=`.
+- **Optional**: `--web-url=`, `--twitter-url=`, `--telegram-url=` (only sent when non-empty); `--pre-sale=0` (**presale in ether units**, e.g. `0.001` for 0.001 BNB, not wei); `--fee-plan=false`, `--tax-options=<path>`; `--value=<wei>` (default to be auto calculated, override BNB value sent; otherwise API output `creationFeeWei` is used).
+- **Tax token**: `--tax-options=tax.json` or `--tax-token` with `--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).
+- **Label** (exactly one): `Meme` | `AI` | `Defi` | `Games` | `Infra` | `De-Sci` | `Social` | `Depin` | `Charity` | `Others`.
+- **Env**: `PRIVATE_KEY`; RPC via `BSC_RPC_URL`.
+- **Flow**: nonce → login → upload image → GET public config → POST create → submit `TokenManager2.createToken` on BSC.
+- **Output**: JSON `{ "txHash" }`.
+
 ```bash
-# Same as create-token-api, all --key=value
-npx tsx .../create-token-instant.ts --image=./logo.png --name=MyToken --short-name=MTK --desc="My desc" --label=AI
-# Or via CLI
+# Via CLI (recommended)
 fourmeme create-instant --image=./logo.png --name=MyToken --short-name=MTK --desc="My desc" --label=AI
-```
 
-Optional `--value=wei` overrides the value; otherwise API output `creationFeeWei` is used. Env: `PRIVATE_KEY`, optional `BSC_RPC_URL`.
+# With presale (BNB, ether units)
+fourmeme create-instant --image=./logo.png --name=MyToken --short-name=MTK --desc="My desc" --label=AI --pre-sale=0.001
+
+# Tax token
+fourmeme create-instant --image=./logo.png --name=TaxToken --short-name=TAX --desc="Tax" --label=Meme --tax-options=tax.json
+```
 
 ---
 
-## Step-by-step flow
+## Step-by-step flow (create-api → create-chain)
 
 1. **get-public-config.ts** (optional)  
    Fetches `raisedToken` from `https://four.meme/meme-api/v1/public/config`. Use when building the create body manually.
@@ -54,6 +67,13 @@ Optional `--value=wei` overrides the value; otherwise API output `creationFeeWei
 - `fee_rate` from TokenManager2 `_tradingFeeRate()` (basis points).  
 - If the contract enforces a minimum fee per trade, use `max(computed trading_fee, minimum_fee)`.
 
+## Example (instant, recommended)
+
+```bash
+export PRIVATE_KEY=your_hex_private_key
+fourmeme create-instant --image=./logo.png --name=MyToken --short-name=MTK --desc="My desc" --label=AI
+```
+
 ## Example (piped)
 
 ```bash

package/skills/four-meme-integration/references/token-query-api.md

@@ -4,19 +4,21 @@ Base: `https://four.meme/meme-api/v1`. Requests need `Accept: application/json`;
 
 ## 1. Token list (filter / paginate)
 
-**GET** `/private/token/query`
-
-| Parameter | Description | Example |
-|-----------|-------------|---------|
-| orderBy | Sort order | Hot, Time, ... |
-| tokenName | Filter by token name | Empty or name |
-| symbol | Filter by symbol | Empty or symbol |
-| labels | Filter by label | Empty or label |
-| listedPancake | Listed on Pancake | false / true |
-| pageIndex | Page number | 1 |
-| pageSize | Page size | 30 |
-
-CLI: `fourmeme token-list [--orderBy=Hot] [--pageIndex=1] [--pageSize=30] [--tokenName=] [--symbol=] [--labels=] [--listedPancake=false]`
+**POST** `/public/token/search`  
+JSON body: `type`, `listType`, `pageIndex`, `pageSize`, `status`, `sort`, optional `keyword`, `symbol`, `tag` (array), `version`.
+
+| Parameter | Description |
+|-----------|-------------|
+| type | Ranking sort context: NEW, HOT, PROGRESS, VOL, LAST, CAP, DEX, BURN, … |
+| listType | NOR, NOR_DEX, BIN, USD1, BIN_DEX, USD1_DEX, ADV |
+| status | PUBLISH, TRADE, ALL |
+| sort | DESC, ASC |
+| keyword | Search keyword |
+| symbol | Quote symbol (e.g. BNB, USDT) |
+| tag | Label filters (e.g. Meme, AI) |
+| version | V9 (tax), V10 (AI); omit for all |
+
+CLI: `fourmeme token-list` — legacy flags still map to the above (e.g. `--orderBy` → `type`, `--tokenName` → `keyword`, `--labels` → `tag`, `--listedPancake=false` → `status=PUBLISH`). See script header for full list.
 
 ## 2. Token detail and trading info
 
@@ -24,17 +26,19 @@ CLI: `fourmeme token-list [--orderBy=Hot] [--pageIndex=1] [--pageSize=30] [--tok
 
 CLI: `fourmeme token-get <tokenAddress>`
 
-## 3. Rankings (advanced)
+## 3. Rankings
+
+**POST** `/public/token/ranking`  
+JSON body: `type` (required RankingType), `pageSize`, optional `rankingKind`, `version`, `symbol`, `minCap`, `maxCap`, `minVol`, `maxVol`, `minHold`, `maxHold`.
 
-**POST** `/private/token/query/advanced`  
-Body (JSON): `{ "orderBy": "<value>" }` or `{ "orderBy": "TradingDesc", "barType": "HOUR24" }`
+| Legacy CLI orderBy | Maps to type |
+|--------------------|--------------|
+| Time | NEW |
+| ProgressDesc | PROGRESS |
+| TradingDesc | VOL_DAY_1 (default); `--barType` selects VOL_HOUR_1, VOL_HOUR_4, VOL_MIN_30, VOL_MIN_5, … |
+| Hot | HOT |
+| Graduated | DEX |
 
-| orderBy | Description |
-|---------|-------------|
-| Time | Newest tokens |
-| ProgressDesc | Fundraise progress ranking |
-| TradingDesc | 24h trading volume (can use barType: HOUR24) |
-| Hot | Hot ranking |
-| Graduated | Recently graduated / launched |
+You may also pass a native `type` as the first argument (e.g. `VOL_DAY_1`, `CAP`, `BURN`).
 
-CLI: `fourmeme token-rankings <orderBy> [--barType=HOUR24]`
+CLI: `fourmeme token-rankings <orderBy|type> [--barType=HOUR24] [--pageSize=20] [--symbol=] [--version=] …`

package/skills/four-meme-integration/scripts/8004-balance.ts

@@ -1,52 +1,52 @@
-#!/usr/bin/env node
-/**
- * EIP-8004 NFT – query balance (number of identity NFTs owned by address).
- *
- * Usage:
- *   npx tsx 8004-balance.ts <ownerAddress>
- *
- * Optional env: BSC_RPC_URL, 8004_NFT_ADDRESS.
- * Default contract: 0x8004A169FB4a3325136EB29fA0ceB6D2e539a432 (BSC).
- */
-
-import { createPublicClient, http, parseAbi } from 'viem';
-import { bsc } from 'viem/chains';
-
-const DEFAULT_8004_NFT = '0x8004A169FB4a3325136EB29fA0ceB6D2e539a432' as const;
-
-const ABI = parseAbi(['function balanceOf(address owner) view returns (uint256)']);
-
-function isAddress(s: string): boolean {
-  return /^0x[0-9a-fA-F]{40}$/.test(s);
-}
-
-async function main() {
-  const ownerAddress = process.argv[2];
-  if (!ownerAddress || !isAddress(ownerAddress)) {
-    console.error('Usage: 8004-balance.ts <ownerAddress>');
-    console.error('  ownerAddress: 0x... wallet address');
-    process.exit(1);
-  }
-
-  const contractAddress = (process.env['8004_NFT_ADDRESS'] || process.env.EIP8004_NFT_ADDRESS || DEFAULT_8004_NFT) as `0x${string}`;
-  const rpcUrl = process.env.BSC_RPC_URL || 'https://bsc-dataseed.binance.org';
-
-  const client = createPublicClient({
-    chain: bsc,
-    transport: http(rpcUrl),
-  });
-
-  const balance = await client.readContract({
-    address: contractAddress,
-    abi: ABI,
-    functionName: 'balanceOf',
-    args: [ownerAddress as `0x${string}`],
-  });
-
-  console.log(JSON.stringify({ owner: ownerAddress, balance: Number(balance) }, null, 2));
-}
-
-main().catch((e) => {
-  console.error(e.message || e);
-  process.exit(1);
-});
+#!/usr/bin/env node
+/**
+ * EIP-8004 NFT – query balance (number of identity NFTs owned by address).
+ *
+ * Usage:
+ *   npx tsx 8004-balance.ts <ownerAddress>
+ *
+ * Optional env: BSC_RPC_URL, 8004_NFT_ADDRESS.
+ * Default contract: 0x8004A169FB4a3325136EB29fA0ceB6D2e539a432 (BSC).
+ */
+
+import { createPublicClient, http, parseAbi } from 'viem';
+import { bsc } from 'viem/chains';
+
+const DEFAULT_8004_NFT = '0x8004A169FB4a3325136EB29fA0ceB6D2e539a432' as const;
+
+const ABI = parseAbi(['function balanceOf(address owner) view returns (uint256)']);
+
+function isAddress(s: string): boolean {
+  return /^0x[0-9a-fA-F]{40}$/.test(s);
+}
+
+async function main() {
+  const ownerAddress = process.argv[2];
+  if (!ownerAddress || !isAddress(ownerAddress)) {
+    console.error('Usage: 8004-balance.ts <ownerAddress>');
+    console.error('  ownerAddress: 0x... wallet address');
+    process.exit(1);
+  }
+
+  const contractAddress = (process.env['8004_NFT_ADDRESS'] || process.env.EIP8004_NFT_ADDRESS || DEFAULT_8004_NFT) as `0x${string}`;
+  const rpcUrl = process.env.BSC_RPC_URL || 'https://bsc-dataseed.binance.org';
+
+  const client = createPublicClient({
+    chain: bsc,
+    transport: http(rpcUrl),
+  });
+
+  const balance = await client.readContract({
+    address: contractAddress,
+    abi: ABI,
+    functionName: 'balanceOf',
+    args: [ownerAddress as `0x${string}`],
+  });
+
+  console.log(JSON.stringify({ owner: ownerAddress, balance: Number(balance) }, null, 2));
+}
+
+main().catch((e) => {
+  console.error(e.message || e);
+  process.exit(1);
+});

package/skills/four-meme-integration/scripts/8004-register.ts

@@ -1,108 +1,108 @@
-#!/usr/bin/env node
-/**
- * EIP-8004 NFT – register agent (mint identity NFT).
- * Builds agentURI as data:application/json;base64,<payload> and calls contract.register(agentURI).
- *
- * Usage:
- *   npx tsx 8004-register.ts <name> [imageUrl] [description]
- *   - name: required
- *   - imageUrl: optional (URL string)
- *   - description: optional
- *
- * Env: PRIVATE_KEY. Optional: BSC_RPC_URL, 8004_NFT_ADDRESS.
- * Default contract: 0x8004A169FB4a3325136EB29fA0ceB6D2e539a432 (BSC).
- */
-
-import { createPublicClient, createWalletClient, decodeEventLog, http, parseAbi } from 'viem';
-import { privateKeyToAccount } from 'viem/accounts';
-import { bsc } from 'viem/chains';
-
-const DEFAULT_8004_NFT = '0x8004A169FB4a3325136EB29fA0ceB6D2e539a432' as const;
-
-const REGISTRATION_TYPE = 'https://eips.ethereum.org/EIPS/eip-8004#registration-v1';
-
-const ABI = parseAbi([
-  'function register(string agentURI) returns (uint256 agentId)',
-  'event Registered(uint256 indexed agentId, string agentURI, address indexed owner)',
-]);
-
-function buildAgentURI(name: string, imageUrl: string, description: string): string {
-  const payload = {
-    type: REGISTRATION_TYPE,
-    name: name || '',
-    description: description || 'I\'m four.meme trading agent',
-    image: imageUrl || '',
-    active: true,
-    supportedTrust: [''],
-  };
-  const json = JSON.stringify(payload);
-  const base64 = Buffer.from(json, 'utf8').toString('base64');
-  return `data:application/json;base64,${base64}`;
-}
-
-async function main() {
-  const privateKey = process.env.PRIVATE_KEY;
-  if (!privateKey) {
-    console.error('Set PRIVATE_KEY');
-    process.exit(1);
-  }
-  const pk = privateKey.startsWith('0x') ? (privateKey as `0x${string}`) : (`0x${privateKey}` as `0x${string}`);
-  const account = privateKeyToAccount(pk);
-
-  const name = process.argv[2];
-  const imageUrl = process.argv[3] ?? '';
-  const description = process.argv[4] ?? '';
-
-  if (!name || name.trim() === '') {
-    console.error('Usage: 8004-register.ts <name> [imageUrl] [description]');
-    console.error('  name: required. imageUrl and description are optional.');
-    process.exit(1);
-  }
-
-  const agentURI = buildAgentURI(name.trim(), imageUrl.trim(), description.trim());
-  const contractAddress = (process.env['8004_NFT_ADDRESS'] || process.env.EIP8004_NFT_ADDRESS || DEFAULT_8004_NFT) as `0x${string}`;
-  const rpcUrl = process.env.BSC_RPC_URL || 'https://bsc-dataseed.binance.org';
-
-  const wallet = createWalletClient({
-    account,
-    chain: bsc,
-    transport: http(rpcUrl),
-  });
-  const publicClient = createPublicClient({
-    chain: bsc,
-    transport: http(rpcUrl),
-  });
-
-  const txHash = await wallet.writeContract({
-    address: contractAddress,
-    abi: ABI,
-    functionName: 'register',
-    args: [agentURI],
-  });
-
-  const receipt = await publicClient.waitForTransactionReceipt({ hash: txHash });
-  let agentId: number | null = null;
-  for (const l of receipt.logs) {
-    if (l.address.toLowerCase() !== contractAddress.toLowerCase()) continue;
-    try {
-      const d = decodeEventLog({
-        abi: ABI,
-        data: l.data,
-        topics: l.topics,
-      });
-      if (d.eventName === 'Registered') {
-        agentId = Number((d.args as { agentId: bigint }).agentId);
-        break;
-      }
-    } catch {
-      /* ignore */
-    }
-  }
-
-  console.log(JSON.stringify({ txHash, agentId, agentURI }, null, 2));
-}
-
-main().catch((e) => {
-  console.error(e.message || e);
-  process.exit(1);
-});
+#!/usr/bin/env node
+/**
+ * EIP-8004 NFT – register agent (mint identity NFT).
+ * Builds agentURI as data:application/json;base64,<payload> and calls contract.register(agentURI).
+ *
+ * Usage:
+ *   npx tsx 8004-register.ts <name> [imageUrl] [description]
+ *   - name: required
+ *   - imageUrl: optional (URL string)
+ *   - description: optional
+ *
+ * Env: PRIVATE_KEY. Optional: BSC_RPC_URL, 8004_NFT_ADDRESS.
+ * Default contract: 0x8004A169FB4a3325136EB29fA0ceB6D2e539a432 (BSC).
+ */
+
+import { createPublicClient, createWalletClient, decodeEventLog, http, parseAbi } from 'viem';
+import { privateKeyToAccount } from 'viem/accounts';
+import { bsc } from 'viem/chains';
+
+const DEFAULT_8004_NFT = '0x8004A169FB4a3325136EB29fA0ceB6D2e539a432' as const;
+
+const REGISTRATION_TYPE = 'https://eips.ethereum.org/EIPS/eip-8004#registration-v1';
+
+const ABI = parseAbi([
+  'function register(string agentURI) returns (uint256 agentId)',
+  'event Registered(uint256 indexed agentId, string agentURI, address indexed owner)',
+]);
+
+function buildAgentURI(name: string, imageUrl: string, description: string): string {
+  const payload = {
+    type: REGISTRATION_TYPE,
+    name: name || '',
+    description: description || 'I\'m four.meme trading agent',
+    image: imageUrl || '',
+    active: true,
+    supportedTrust: [''],
+  };
+  const json = JSON.stringify(payload);
+  const base64 = Buffer.from(json, 'utf8').toString('base64');
+  return `data:application/json;base64,${base64}`;
+}
+
+async function main() {
+  const privateKey = process.env.PRIVATE_KEY;
+  if (!privateKey) {
+    console.error('Set PRIVATE_KEY');
+    process.exit(1);
+  }
+  const pk = privateKey.startsWith('0x') ? (privateKey as `0x${string}`) : (`0x${privateKey}` as `0x${string}`);
+  const account = privateKeyToAccount(pk);
+
+  const name = process.argv[2];
+  const imageUrl = process.argv[3] ?? '';
+  const description = process.argv[4] ?? '';
+
+  if (!name || name.trim() === '') {
+    console.error('Usage: 8004-register.ts <name> [imageUrl] [description]');
+    console.error('  name: required. imageUrl and description are optional.');
+    process.exit(1);
+  }
+
+  const agentURI = buildAgentURI(name.trim(), imageUrl.trim(), description.trim());
+  const contractAddress = (process.env['8004_NFT_ADDRESS'] || process.env.EIP8004_NFT_ADDRESS || DEFAULT_8004_NFT) as `0x${string}`;
+  const rpcUrl = process.env.BSC_RPC_URL || 'https://bsc-dataseed.binance.org';
+
+  const wallet = createWalletClient({
+    account,
+    chain: bsc,
+    transport: http(rpcUrl),
+  });
+  const publicClient = createPublicClient({
+    chain: bsc,
+    transport: http(rpcUrl),
+  });
+
+  const txHash = await wallet.writeContract({
+    address: contractAddress,
+    abi: ABI,
+    functionName: 'register',
+    args: [agentURI],
+  });
+
+  const receipt = await publicClient.waitForTransactionReceipt({ hash: txHash });
+  let agentId: number | null = null;
+  for (const l of receipt.logs) {
+    if (l.address.toLowerCase() !== contractAddress.toLowerCase()) continue;
+    try {
+      const d = decodeEventLog({
+        abi: ABI,
+        data: l.data,
+        topics: l.topics,
+      });
+      if (d.eventName === 'Registered') {
+        agentId = Number((d.args as { agentId: bigint }).agentId);
+        break;
+      }
+    } catch {
+      /* ignore */
+    }
+  }
+
+  console.log(JSON.stringify({ txHash, agentId, agentURI }, null, 2));
+}
+
+main().catch((e) => {
+  console.error(e.message || e);
+  process.exit(1);
+});