Skip to content

Commit 320c1c4

Browse files
MantisCloneclaude
andcommitted
docs: Fix token list structure documentation
- Add missing fields: id, network, type, hash - Remove non-existent logoURI field - Add field descriptions table - Link to SDK source for supported networks and types Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 1e01e54 commit 320c1c4

File tree

2 files changed

+88
-7
lines changed

2 files changed

+88
-7
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# PR #134 Code Review - Advocate Welcome Kit and SDK Docs Update - 2026-01-21
2+
3+
## PR Summary
4+
- **Title**: docs: add advocate welcome kit and update SDK quickstart
5+
- **Author**: AllenAJ
6+
- **Description**: Added an Advocates Welcome Kit for community onboarding, enhanced the "Updating a Request" guide with functional code examples, updated the Node.js Quickstart with viem integration and request update logic, and updated FAQ and navigation.
7+
8+
## File Groups
9+
10+
### Group 1: SDK Documentation (Code Examples) - High Priority
11+
- [ ] `docs/advanced/request-network-sdk/get-started/quickstart-node.js.md`
12+
- [ ] `docs/advanced/request-network-sdk/sdk-guides/request-client/updating-a-request.md`
13+
**Status**: Not Started
14+
15+
### Group 2: Advocate Program Documentation - Medium Priority
16+
- [ ] `docs/general/advocates-welcome-kit.md`
17+
**Status**: Not Started
18+
19+
### Group 3: Navigation Updates - Low Priority
20+
- [ ] `docs/SUMMARY.md`
21+
- [ ] `docs/faq.md`
22+
**Status**: Not Started
23+
24+
## Review Updates
25+
- **2026-01-21 21:55 UTC**: Posted reply comments for issues #2 and #4
26+
- **2026-01-21 21:56 UTC**: Pushed fix commit (087dc01) to contributor's branch - replaced viem tab with note, restored addStakeholders row
27+
- **2026-01-21 22:00 UTC**: Pushed fix commit (26bd317) - changed Discord link to use consistent format (request.network/discord)
28+
29+
## Issues Identified
30+
31+
| Index | File | Issue | Severity | Source | Comment Status | Validation | Resolution | Comment |
32+
|-------|------|-------|----------|--------|----------------|------------|------------|---------|
33+
| 1 | quickstart-node.js.md | Viem integration uses `mainnet` chain instead of `sepolia` (inconsistent with rest of quickstart) | High | Greptile | POSTED | VALID | FIXED | Covered by #2 fix - replaced viem tab entirely |
34+
| 2 | quickstart-node.js.md | Viem `http()` transport is NOT EIP-1193 compatible - Web3Provider conversion will fail at runtime | Critical | CodeRabbit | POSTED | VALID | FIXED | Replaced viem tab with note pointing to ethers v5 |
35+
| 3 | quickstart-node.js.md | Viem-to-ethers conversion pattern differs from browser quickstart's working implementation | High | Greptile | POSTED | VALID | FIXED | Same as #2 |
36+
| 4 | updating-a-request.md | Missing `addStakeholders` action from the summary table (was in original) | Low | Greptile | POSTED | VALID | FIXED | Added addStakeholders row back to table |
37+
38+
## Review Progress
39+
40+
### Group 1: SDK Documentation (Code Examples) - Not Started
41+
**General Description**: TBD
42+
43+
**Files**: quickstart-node.js.md, updating-a-request.md
44+
45+
**Issues Found**: See Issues Identified table (indices 1, 2, 3, 4)
46+
47+
---
48+
49+
### Group 2: Advocate Program Documentation - Not Started
50+
**General Description**: TBD
51+
52+
**Files**: advocates-welcome-kit.md
53+
54+
**Issues Found**: None identified yet
55+
56+
---
57+
58+
### Group 3: Navigation Updates - Not Started
59+
**General Description**: TBD
60+
61+
**Files**: SUMMARY.md, faq.md
62+
63+
**Issues Found**: None identified yet
64+
65+
---

docs/general/request-network-token-list.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,32 @@ Each token in the list contains the following information:
2020

2121
```json
2222
{
23-
"id": "TKN-mainnet"
24-
"name": "Token Name",
25-
"address": "0x...",
26-
"symbol": "TKN",
27-
"decimals": 18,
28-
"chainId": 1,
29-
"logoURI": "https://..."
23+
"id": "USDC-mainnet",
24+
"name": "USD Coin",
25+
"symbol": "USDC",
26+
"decimals": 6,
27+
"address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
28+
"network": "mainnet",
29+
"type": "ERC20",
30+
"hash": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
31+
"chainId": 1
3032
}
3133
```
3234

35+
| Field | Description |
36+
|-------|-------------|
37+
| `id` | Unique identifier, typically `SYMBOL-network` (e.g., `USDC-mainnet`) |
38+
| `name` | Human-readable token name |
39+
| `symbol` | Token symbol |
40+
| `decimals` | Number of decimal places |
41+
| `address` | Token contract address |
42+
| `network` | Network name (e.g., `mainnet`, `matic`, `bsc`) |
43+
| `type` | Currency type (e.g., `ERC20`, `ETH`, `ISO4217`) |
44+
| `hash` | For ERC20 tokens, same as `address`. For native tokens, a calculated hash. |
45+
| `chainId` | Chain ID of the network |
46+
47+
See the [SDK source code](https://github.com/RequestNetwork/requestNetwork/blob/master/packages/types/src/currency-types.ts) for the full list of supported networks and types.
48+
3349
## Adding a New Token
3450

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

0 commit comments

Comments
 (0)