Skip to content

Conversation

@MantisClone
Copy link
Member

@MantisClone MantisClone commented Jan 22, 2026

Problem

The token list documentation has incomplete/incorrect token structure:

  • Missing required fields: network, type, hash
  • Included non-existent field: logoURI
  • Missing comma after id field in JSON example

Closes RequestNetwork/request-token-list#7

Proposed Solution

  • Complete token structure example using real USDC token
  • Field descriptions table explaining each field
  • Link to SDK source code for supported network and type values

🤖 Generated with Claude Code

@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

Warning

Rate limit exceeded

@MantisClone has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 6 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link

greptile-apps bot commented Jan 22, 2026

Greptile Summary

This PR fixes the token list structure documentation by adding previously missing required fields and correcting the JSON syntax.

Changes made:

  • Added missing required fields: network, type, and hash
  • Removed non-existent logoURI field
  • Fixed missing comma after id field in JSON example
  • Replaced placeholder values with real USDC token data for clarity
  • Added comprehensive field descriptions table
  • Added link to SDK source code for supported network and type values

The updated structure now correctly matches the actual token list format used by the Request Network API, as confirmed by cross-referencing with docs/request-network-api/supported-chains-and-currencies.md which documents the same structure.

Confidence Score: 5/5

  • This PR is safe to merge - it only fixes documentation errors with no code changes
  • The changes are purely documentation fixes that correct factual errors in the token structure example. The new structure matches the API documentation in supported-chains-and-currencies.md, uses a real token (USDC) for the example, and adds helpful context via a field descriptions table and SDK source link. No code or functionality is affected.
  • No files require special attention - the PR_134 tracking file is just metadata

Important Files Changed

Filename Overview
docs/general/request-network-token-list.md Corrected token structure with all required fields (network, type, hash), fixed JSON syntax, added comprehensive field descriptions table, and included link to SDK source

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Docs as Token List Docs
    participant API as Request Network API
    participant SDK as Request Network SDK
    participant User as Documentation Reader

    Note over Dev,Docs: Documentation Fix Process
    Dev->>Docs: Identify missing fields in token structure
    Dev->>API: Cross-reference with API docs
    API-->>Dev: Confirm structure includes network, type, hash
    Dev->>SDK: Check source code for field definitions
    SDK-->>Dev: Verify currency-types.ts structure
    Dev->>Docs: Update JSON example with complete fields
    Dev->>Docs: Add field descriptions table
    Dev->>Docs: Add SDK source code link
    Dev->>Docs: Replace placeholder with real USDC token
    Dev->>Docs: Fix JSON syntax (missing comma)
    
    Note over User,Docs: Documentation Usage
    User->>Docs: Read token structure documentation
    Docs-->>User: Show complete token example
    User->>Docs: Reference field descriptions table
    User->>SDK: Follow link to SDK source for details
    SDK-->>User: Access full type definitions
Loading

- 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>
@MantisClone MantisClone force-pushed the docs/fix-token-list-structure branch from 320c1c4 to 8c72e96 Compare January 22, 2026 20:19
@MantisClone MantisClone merged commit b303612 into main Jan 22, 2026
3 checks passed
@MantisClone MantisClone deleted the docs/fix-token-list-structure branch January 22, 2026 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix errors in README and Documentation for adding a new token

2 participants