skillpp 0.1.0

package/skills/four-meme/four-guard/API-Contract-TaxToken.md

@@ -0,0 +1,277 @@
+# Tax Token Contract API Documentation
+
+## Overview
+
+Tax Token is an advanced ERC20 token contract supporting transaction fees, reward distribution, and multiple allocation modes.
+
+**Key Features:**
+- Transaction fee mechanism: Charges a certain percentage of fees on buy/sell transactions
+- Reward distribution mechanism: Token holders receive reward distributions based on their holdings
+- Multiple allocation modes: Fees can be allocated to founder, holders, burn, and liquidity
+- Anti-sniper protection: Prevents malicious addresses from participating in rewards through blacklist mechanism
+
+---
+
+## Constants
+
+### Transfer Modes
+
+| Name | Type | Value | Description |
+|------|------|-------|-------------|
+| `MODE_NORMAL` | `uint` | 0 | Normal transfer mode - allows all transfers |
+| `MODE_TRANSFER_RESTRICTED` | `uint` | 1 | Restricted transfer mode - prohibits all transfers |
+| `MODE_TRANSFER_CONTROLLED` | `uint` | 2 | Controlled transfer mode - only allows transfers related to owner |
+
+---
+
+## State Variables
+
+### Configuration Variables
+
+| Name | Type | Visibility | Description |
+|------|------|------------|-------------|
+| `_mode` | `uint` | public | Current transfer mode |
+| `quote` | `address` | public | Quote token address (e.g., USDT, BUSD, etc.) |
+| `pair` | `address` | public | PancakeSwap pair address (lazily initialized when mode is NORMAL) |
+| `founder` | `address` | public | Founder address, receives founder rewards |
+| `feeRate` | `uint256` | public | Transaction fee rate (basis points, 10000 = 100%) |
+| `rateFounder` | `uint256` | public | Founder allocation rate (percentage, 100 = 100%) |
+| `rateHolder` | `uint256` | public | Holder allocation rate (percentage, 100 = 100%) |
+| `rateBurn` | `uint256` | public | Burn allocation rate (percentage, 100 = 100%) |
+| `rateLiquidity` | `uint256` | public | Liquidity allocation rate (percentage, 100 = 100%) |
+| `minDispatch` | `uint256` | public | Minimum dispatch threshold, fees are only dispatched when accumulated fees reach this value |
+| `minShare` | `uint256` | public | Minimum holding amount, addresses below this value do not participate in rewards |
+
+### Reward System Variables
+
+| Name | Type | Visibility | Description |
+|------|------|------------|-------------|
+| `userInfo` | `mapping(address => UserInfo)` | public | User reward information mapping |
+| `totalShares` | `uint256` | public | Total token holding shares (sum of all user shares, excluding addresses below minShare) |
+| `feePerShare` | `uint256` | public | Cumulative reward amount per share (using MAGNITUDE precision, accumulates with each dispatch) |
+| `feeAccumulated` | `uint256` | public | Total accumulated fees (not yet dispatched). May contain remainder due to rounding errors after dispatch |
+| `feeDispatched` | `uint256` | public | Total dispatched fees |
+| `feeFounder` | `uint256` | public | Total fees allocated to founder |
+| `feeHolder` | `uint256` | public | Total fees allocated to holders |
+| `feeBurn` | `uint256` | public | Total fees burned |
+| `feeLiquidity` | `uint256` | public | Total fees added to liquidity |
+| `quoteFounder` | `uint256` | public | Total quote tokens allocated to founder |
+| `quoteHolder` | `uint256` | public | Total quote tokens allocated to holders |
+| `quoteClaimed` | `uint256` | public | Total quote tokens claimed |
+
+---
+
+## Structs
+
+### UserInfo
+
+User reward information structure.
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `share` | `uint256` | User token holding share (0 if balance is below minShare) |
+| `rewardDebt` | `uint256` | Calculated reward debt, used to track already accounted rewards |
+| `claimable` | `uint256` | Claimable reward amount (in quote tokens) |
+| `claimed` | `uint256` | Claimed reward amount (in quote tokens) |
+
+---
+
+## Events
+
+### FeeDispatched
+
+Emitted when fees are dispatched and allocated.
+
+```solidity
+event FeeDispatched(
+    uint256 amountFounder,
+    uint256 amountHolder,
+    uint256 amountBurn,
+    uint256 amountLiquidity,
+    uint256 quoteFounder,
+    uint256 quoteHolder
+);
+```
+
+**Parameters:**
+- `amountFounder`: Token amount allocated to founder (in token units)
+- `amountHolder`: Token amount allocated to holders (in token units)
+- `amountBurn`: Token amount burned (in token units)
+- `amountLiquidity`: Token amount added to liquidity (in token units)
+- `quoteFounder`: Quote token amount allocated to founder in this dispatch (0 if rateFounder is 0)
+- `quoteHolder`: Quote token amount allocated to holders in this dispatch (0 if rateHolder is 0 or totalShares is 0)
+
+### FeeClaimed
+
+Emitted when rewards are claimed by a user.
+
+```solidity
+event FeeClaimed(
+    address account,
+    uint256 amount
+);
+```
+
+**Parameters:**
+- `account`: Address claiming rewards
+- `amount`: Amount of quote tokens claimed
+
+---
+
+## Public Functions
+
+### setMode
+
+Set transfer mode. 
+
+```solidity
+function setMode(uint256 v) public onlyOwner
+```
+
+**Parameters:**
+- `v`: Target mode:
+  - `0`: MODE_NORMAL (normal mode)
+  - `1`: MODE_TRANSFER_RESTRICTED (restricted mode)
+  - `2`: MODE_TRANSFER_CONTROLLED (controlled mode)
+
+**Note:** Once mode is set to `MODE_NORMAL` when migrated to DEX, it cannot be changed.
+
+### claimableFee
+
+Query the claimable reward amount for an account.
+
+```solidity
+function claimableFee(address account) view public returns (uint256)
+```
+
+**Parameters:**
+- `account`: Account address
+
+**Returns:**
+- `uint256`: Claimable quote token amount
+
+**Description:**
+Calculates the total claimable rewards for an account, including:
+- Previously accumulated claimable rewards (`info.claimable`)
+- New rewards calculated from current share and feePerShare
+
+### claimedFee
+
+Query the claimed reward amount for an account.
+
+```solidity
+function claimedFee(address account) view public returns (uint256)
+```
+
+**Parameters:**
+- `account`: Account address
+
+**Returns:**
+- `uint256`: Claimed quote token amount
+
+### claimFee
+
+Claim rewards for the caller.
+
+```solidity
+function claimFee() external
+```
+
+**Effects:**
+- Updates caller's share
+- Transfers claimable quote tokens to caller
+- Updates `claimed` and `quoteClaimed` counters
+- Emits `FeeClaimed` event
+
+**Requirements:**
+- Caller must not be blacklisted
+- Caller must have claimable rewards > 0
+
+---
+
+## View Functions
+
+### userInfo
+
+Get user reward information.
+
+```solidity
+function userInfo(address) view public returns (
+    uint256 share,
+    uint256 rewardDebt,
+    uint256 claimable,
+    uint256 claimed
+)
+```
+
+**Parameters:**
+- User address
+
+**Returns:**
+- `share`: User token holding share
+- `rewardDebt`: Calculated reward debt
+- `claimable`: Claimable reward amount
+- `claimed`: Claimed reward amount
+
+---
+
+### Reward Claiming
+
+Users can claim their accumulated rewards by calling `claimFee()`:
+
+1. Updates user's share (if changed)
+2. Calculates claimable amount using `claimableFee()`
+3. Checks if user is blacklisted (if yes, returns early)
+4. Transfers quote tokens to user
+5. Updates `claimed` counters
+6. Emits `FeeClaimed` event
+
+---
+
+
+## Important Notes
+
+1. **Rate Sum**: The sum of `rateFounder`, `rateHolder`, `rateBurn`, and `rateLiquidity` must equal 100.
+
+2. **Minimum Share**: Addresses with token balance below `minShare` do not participate in rewards (their `share` is set to 0).
+
+3. **Blacklist**: Blacklisted addresses cannot claim rewards, even if they have claimable amounts.
+
+4. **Fee Accumulation**: Due to rounding errors, `feeAccumulated` may contain a small remainder after dispatch.
+
+---
+
+## Example Usage
+
+### Query User Rewards
+
+```solidity
+// Get claimable rewards
+uint256 claimable = token.claimableFee(userAddress);
+
+// Get claimed rewards
+uint256 claimed = token.claimedFee(userAddress);
+
+// Get user info
+(uint256 share, uint256 rewardDebt, uint256 claimable, uint256 claimed) = token.userInfo(userAddress);
+```
+
+### Claim Rewards
+
+```solidity
+// User calls claimFee() to claim their rewards
+token.claimFee();
+```
+
+### Monitor Fee Distribution
+
+```solidity
+// Listen for FeeDispatched events
+token.FeeDispatched().watch((event) => {
+    console.log("Founder allocated:", event.returnValues.amountFounder);
+    console.log("Holder allocated:", event.returnValues.amountHolder);
+    console.log("Quote tokens for founder:", event.returnValues.quoteFounder);
+    console.log("Quote tokens for holders:", event.returnValues.quoteHolder);
+});
+```
+

package/skills/four-meme/four-guard/API-CreateToken.02-02-2026.md

@@ -0,0 +1,285 @@
+## API Endpoint Overview
+
+| Endpoint | Method | Description |
+|----------|--------|-------------|
+| `/v1/private/user/nonce/generate` | POST | Generate nonce for login |
+| `/v1/private/user/login/dex` | POST | User login to get access token |
+| `/v1/private/token/upload` | POST | Upload token image |
+| `/v1/private/token/create` | POST | Create token and get signature parameters |
+
+## Complete API Flow
+
+### 1. Get Nonce
+**Endpoint**: `https://four.meme/meme-api/v1/private/user/nonce/generate`  
+**Method**: POST  
+**Parameters**:
+```json
+{
+  "accountAddress": "user wallet address",
+  "verifyType": "LOGIN",
+  "networkCode": "BSC"
+}
+```
+**Response**:
+```json
+{
+  "code": "0",
+  "data": "generated nonce value"
+}
+```
+
+### 2. User Login
+**Endpoint**: `https://four.meme/meme-api/v1/private/user/login/dex`  
+**Method**: POST  
+**Parameters**:
+```json
+{
+  "region": "WEB",
+  "langType": "EN",
+  "loginIp": "",
+  "inviteCode": "",
+  "verifyInfo": {
+    "address": "user wallet address",
+    "networkCode": "BSC",
+    "signature": "signature of 'You are sign in Meme {nonce}' signed with private key",
+    "verifyType": "LOGIN"
+  },
+  "walletName": "MetaMask"
+}
+```
+**Response**:
+```json
+{
+  "code": "0",
+  "data": "access_token"
+}
+```
+
+### 3. Upload Token Image
+**Endpoint**: `https://four.meme/meme-api/v1/private/token/upload`  
+**Method**: POST  
+**Headers**:
+```
+Content-Type: multipart/form-data
+meme-web-access: {access_token}
+```
+**Parameters**:
+- `file`: Image file data (supports jpeg, png, gif, bmp, webp formats)
+
+**Response**:
+```json
+{
+  "code": "0",
+  "data": "uploaded image URL"
+}
+```
+
+### 4. Create Token
+**Endpoint**: `https://four.meme/meme-api/v1/private/token/create`  
+**Method**: POST  
+**Headers**:
+```
+meme-web-access: {access_token}
+Content-Type: application/json
+```
+
+**Request Body Example**:
+```json
+{
+  "name": "RELEASE",
+  "shortName": "RELS",
+  "desc": "RELEASE DESC",
+  "imgUrl": "https://static.four.meme/market/...",
+  "launchTime": 1740708849097,
+  "label": "AI",
+  "lpTradingFee": 0.0025,
+  "webUrl": "https://example.com",
+  "twitterUrl": "https://x.com/example",
+  "telegramUrl": "https://telegram.com/example",
+  "preSale": "0.1",
+  "onlyMPC": false,
+  "feePlan": false,
+  "tokenTaxInfo": {
+    "burnRate": 20,
+    "divideRate": 30,
+    "feeRate": 5,
+    "liquidityRate": 40,
+    "minSharing": 100000,
+    "recipientAddress": "0x1234567890123456789012345678901234567890",
+    "recipientRate": 10
+  },
+  "raisedToken": {
+    "symbol": "BNB",
+    "nativeSymbol": "BNB",
+    "symbolAddress": "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
+    "deployCost": "0",
+    "buyFee": "0.01",
+    "sellFee": "0.01",
+    "minTradeFee": "0",
+    "b0Amount": "8",
+    "totalBAmount": "24",
+    "totalAmount": "1000000000",
+    "logoUrl": "https://static.four.meme/market/68b871b6-96f7-408c-b8d0-388d804b34275092658264263839640.png",
+    "tradeLevel": ["0.1", "0.5", "1"],
+    "status": "PUBLISH",
+    "buyTokenLink": "https://pancakeswap.finance/swap",
+    "reservedNumber": 10,
+    "saleRate": "0.8",
+    "networkCode": "BSC",
+    "platform": "MEME"
+  }
+}
+```
+
+**Response**:
+```json
+{
+  "code": "0",
+  "data": {
+    "createArg": "encoded parameters for blockchain",
+    "signature": "signature for blockchain transaction"
+  }
+}
+```
+
+## Parameter Explanation (Distinguishing Fixed and Customizable Parameters)
+
+### Customizable Parameters
+
+| Parameter | Description | Example Value | Limitations |
+|-----------|-------------|---------------|-------------|
+| name | Token name | "RELEASE" | Customizable |
+| shortName | Token symbol/ticker | "RELS" | Customizable |
+| desc | Token description | "RELEASE DESC" | Customizable |
+| imgUrl | Token image URL | "https://static.four.meme/market/..." | Must be uploaded to the platform |
+| launchTime | Launch timestamp | 1740708849097 | Customizable |
+| label | Token category | "AI" | Must be one of the platform-supported categories: Meme/AI/Defi/Games/Infra/De-Sci/Social/Depin/Charity/Others |
+| lpTradingFee | Trading fee rate | 0.0025 | Fixed as 0.0025 |
+| webUrl | Project website | "https://example.com" | Customizable |
+| twitterUrl | Project Twitter | "https://x.com/example" | Customizable |
+| telegramUrl | Project Telegram | "https://telegram.com/example" | Customizable |
+| preSale | Presale amount | "0.1" | Pre-purchased BNB amount by the creator; "0" if not purchased |
+| onlyMPC | X Mode Token | false | Whether to create a token in X Mode | Customizable
+| feePlan | AntiSniperFeeMode | false | Anti-sniper fee mode switch for opening block high tax. Set to true to enable dynamic fee system (fees automatically decrease block by block after token creation), false to disable. See [Product Update](https://four-meme.gitbook.io/four.meme/product-update/6-product-update-25-10-30) for detailed block-by-block fee rates | Customizable
+| tokenTaxInfo | Tax Token Configuration | See below | Configuration object for creating tax-type tokens | Customizable
+
+### Fixed Parameters (Cannot be Adjusted or Customized by Thirdparties)
+
+| Parameter | Fixed Value | Description |
+|-----------|-------------|-------------|
+| totalSupply | 1000000000 | Total token supply is fixed at 1 billion |
+| raisedAmount | 24 | Raised amount is fixed at 24 BNB |
+| saleRate | 0.8 | Sale ratio is fixed at 80% |
+| reserveRate | 0 | Reserved ratio is fixed at 0 |
+| funGroup | false | Fixed parameter |
+| clickFun | false | Fixed parameter |
+| symbol | "BNB" | Fixed use of BNB as base currency |
+
+### feePlan Parameter Details
+
+The `feePlan` parameter enables **AntiSniperFeeMode** (also known as **X Mode Dynamic Fee System**), which implements a dynamic fee mechanism that automatically decreases transaction fees block by block after token creation.
+
+**How it works:**
+- When `feePlan` is set to `true`, the token will use a dynamic fee system
+- Transaction fees start at a higher rate at the opening blocks
+- Fees automatically decrease block by block after token creation
+- This mechanism ensures fair launches and helps counter sniper bots
+
+**Block-by-block fee rates:**
+For detailed information about the specific fee rates applied at different block intervals, please refer to the [Product Update documentation](https://four-meme.gitbook.io/four.meme/product-update/6-product-update-25-10-30).
+
+**Note:** The fee rate parameters may be adjusted for future launches.
+
+### tokenTaxInfo Parameter Details
+
+The `tokenTaxInfo` parameter is an object used to configure tax-type tokens. Rate values represent percentages directly (e.g., 5 = 5%, 10 = 10%).
+
+| Parameter | Description | Example Value | Notes |
+|-----------|-------------|---------------|-------|
+| feeRate | Trading fee rate | 5 | Fixed options: 1, 3, 5, or 10 (representing 1%, 3%, 5%, or 10%) |
+| burnRate | Burn rate | 20 | Customizable rate value (20 = 20%) |
+| divideRate | Dividend distribution rate | 30 | Customizable rate value (30 = 30%) |
+| liquidityRate | Liquidity pool rate | 0 | Customizable rate value (0 = 0%) |
+| minSharing | Minimum sharing threshold | 100000 | Minimum token amount required to participate in dividends (in ether). Must satisfy: minSharing = d × 10ⁿ (n ≥ 5, 1 ≤ d ≤ 9). Examples: 100000 (1×10⁵), 200000 (2×10⁵), 500000 (5×10⁵), 1000000 (1×10⁶), 9000000 (9×10⁶) |
+| recipientAddress | Recipient address | "0x..." | Address to receive allocated tokens (can be empty string if not used) |
+| recipientRate | Recipient allocation rate | 50 | Customizable rate value (50 = 50%) |
+
+**Example tokenTaxInfo object:**
+
+```json
+{
+  "tokenTaxInfo": {
+    "burnRate": 20,
+    "divideRate": 30,
+    "feeRate": 5,
+    "liquidityRate": 40,
+    "minSharing": 100000,
+    "recipientAddress": "0x1234567890123456789012345678901234567890",
+    "recipientRate": 10
+  }
+}
+```
+
+**Note:** In this example, `burnRate` (20) + `divideRate` (30) + `liquidityRate` (40) + `recipientRate` (10) = 100, which satisfies the requirement that the sum of burnRate, divideRate, liquidityRate, and recipientRate must equal 100.
+
+**Notes:**
+- `feeRate` is a fixed option: must be one of 1, 3, 5, or 10 (representing 1%, 3%, 5%, or 10%)
+- Other rate values (`burnRate`, `divideRate`, `liquidityRate`, `recipientRate`) are customizable and represent percentages directly (e.g., 5 = 5%, 10 = 10%)
+- The sum of `burnRate`, `divideRate`, `liquidityRate`, and `recipientRate` must equal 100
+- If `recipientAddress` is not used, set it to empty string `""` and `recipientRate` to 0
+- `minSharing` is specified in ether, must satisfy: minSharing = d × 10ⁿ (n ≥ 5, 1 ≤ d ≤ 9). Examples: 100000 (1×10⁵), 200000 (2×10⁵), 500000 (5×10⁵), 1000000 (1×10⁶), 9000000 (9×10⁶), 10000000 (1×10⁷)
+
+### Fixed Parameters for raisedToken. Different raised token configs can be queried by https://four.meme/meme-api/v1/public/config (Cannot modify internal params)
+
+```json
+"raisedToken": {
+  "symbol": "BNB",
+  "nativeSymbol": "BNB",
+  "symbolAddress": "0xbb4cdb9cbd36b01bd1cbaebf2de08d9173bc095c",
+  "deployCost": "0",
+  "buyFee": "0.01",
+  "sellFee": "0.01",
+  "minTradeFee": "0",
+  "b0Amount": "8",
+  "totalBAmount": "24",
+  "totalAmount": "1000000000",
+  "logoUrl": "https://static.four.meme/market/68b871b6-96f7-408c-b8d0-388d804b34275092658264263839640.png",
+  "tradeLevel": ["0.1", "0.5", "1"],
+  "status": "PUBLISH",
+  "buyTokenLink": "https://pancakeswap.finance/swap",
+  "reservedNumber": 10,
+  "saleRate": "0.8",
+  "networkCode": "BSC",
+  "platform": "MEME"
+}
+```
+
+## Blockchain Interaction
+
+After obtaining the API signature, you need to call the chain contract `TokenManager2`'s `createToken` method:
+
+```java
+TokenManager2 contract = TokenManager2.load(tokenManagerAddress, web3j, credentials, gasProvider);
+TransactionReceipt receipt = contract.createToken(createArg, sign).send();
+```
+
+Where:
+- `createArg`: The `createArg` returned by the API converted into byte array
+- `sign`: The `signature` returned by the API converted into byte array
+
+## Notes
+
+1. Token creation requires meeting the minimum BNB balance requirement. The latest creation fee is 0.01 BNB.
+2. Images must be uploaded to the four.meme platform.
+3. There are certain creation fees for creating tokens (which are currently free).
+4. Most technical parameters are fixed and cannot be adjusted (including total supply, raised amount, sale ratio, etc.).
+5. Only display information like token name, symbol, description, and image can be customized.
+6. The token label must be one of the platform-supported categories.
+7. The trading fee rate can only be 0.0025.
+8. **feePlan**: Set to `true` to enable AntiSniperFeeMode (dynamic fee adjustment with high tax at opening blocks), or `false` to disable. When enabled, transaction fees automatically decrease block by block after token creation to ensure fair launches and counter bots. For detailed block-by-block fee rate information, refer to the [Product Update](https://four-meme.gitbook.io/four.meme/product-update/6-product-update-25-10-30).
+9. **tokenTaxInfo**: When creating a tax-type token:
+   - `feeRate` must be one of the fixed options: 1, 3, 5, or 10 (representing 1%, 3%, 5%, or 10%)
+   - Other rate values (`burnRate`, `divideRate`, `liquidityRate`, `recipientRate`) represent percentages directly (e.g., 5 = 5%, 10 = 10%)
+   - The sum of `burnRate`, `divideRate`, `liquidityRate`, and `recipientRate` must equal 100 
+
+With the above API flow, users can complete the entire process of logging in and creating tokens on the four.meme platform, but they should note that most technical parameters are preset and fixed by the platform.