Skip to content

fix: Fix token structure documentation #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MantisClone merged 1 commit into from
Jan 22, 2026
Merged

fix: Fix token structure documentation #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 37 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,46 @@ To add a token to the list, ensure it meets the following criteria:

```json
{
"name": "Token Name",
"address": "0x...",
"symbol": "TKN",
"decimals": 18,
"chainId": 1,
"logoURI": "https://..."
"id": "USDC-mainnet",
"name": "USD Coin",
"symbol": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"network": "mainnet",
"type": "ERC20",
"hash": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"chainId": 1
}
```

#### Field Descriptions

| Field | Description |
|-------|-------------|
| `id` | Unique identifier, typically `SYMBOL-network` (e.g., `USDC-mainnet`) |
| `name` | Human-readable token name |
| `symbol` | Token symbol |
| `decimals` | Number of decimal places |
| `address` | Token contract address |
| `network` | Network name (see supported networks below) |
| `type` | Currency type (see supported types below) |
| `hash` | For ERC20 tokens, same as `address`. For native tokens, see [hash calculation](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/currency/src/getHash.ts) |
| `chainId` | Chain ID of the network |

#### Supported Networks

The full list of supported networks can be found in the SDK source code:
https://github.com/RequestNetwork/requestNetwork/blob/master/packages/types/src/currency-types.ts

Common networks: `mainnet`, `sepolia`, `matic`, `bsc`, `xdai`, `avalanche`, `optimism`, `arbitrum-one`, `base`, `zksyncera`

#### Supported Currency Types

The full list of currency types can be found in the SDK source code:
https://github.com/RequestNetwork/requestNetwork/blob/master/packages/types/src/request-logic-types.ts

Common types: `ERC20`, `ETH`, `ISO4217` (fiat currencies)

## Pull Request Process

1. Ensure your PR includes all required token information
Expand Down
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,20 @@ Each token in the list contains the following information:

```json
{
"id": "TKN-mainnet",
"name": "Token Name",
"address": "0x...",
"symbol": "TKN",
"decimals": 18,
"chainId": 1,
"logoURI": "https://..."
"id": "USDC-mainnet",
"name": "USD Coin",
"symbol": "USDC",
"decimals": 6,
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"network": "mainnet",
"type": "ERC20",
"hash": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
"chainId": 1
}
```

See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed field descriptions and supported values.

## Adding a New Token

We welcome community contributions! To add a new token to the list:
Expand Down