Skip to content
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.

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

Chore: Add AUSD token metadata #195

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

0xDirmes
Copy link

@0xDirmes 0xDirmes commented Dec 24, 2024

Summary by CodeRabbit

  • New Features
    • Added support for the new token AUSD, including its metadata and mainnet configuration.
    • Expanded the list of available tokens in the token factory.

Copy link

coderabbitai bot commented Dec 24, 2024

Walkthrough

The pull request introduces a new token, AUSD, to the project's token metadata and token factory configurations. This involves adding a new entry to the symbolMeta object in symbolMeta.ts with details about the AUSD token, such as its name, logo, symbol, decimal places, and CoinGecko ID. Correspondingly, a new token entry is added to the mainnetTokens array in tokenFactory.ts, which includes the token's metadata and a specific creator address.

Changes

File Change Summary
ts-scripts/data/symbolMeta.ts Added new AUSD token metadata with properties: name, logo, symbol, decimals, and CoinGecko ID
ts-scripts/data/tokenFactory.ts Expanded mainnetTokens array with new AUSD token entry, including metadata and creator address

Poem

🐰 A new token hops into view,
AUSD joins our crypto crew!
Six decimals, a logo bright,
On mainnet's stage, a token's might.
Rabbit's whiskers twitch with glee,
Another asset sets us free! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8780bf9 and d4a2b1a.

⛔ Files ignored due to path filters (1)
  • ts-scripts/images/tokens/AUSD.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • ts-scripts/data/symbolMeta.ts (1 hunks)
  • ts-scripts/data/tokenFactory.ts (1 hunks)
🔇 Additional comments (1)
ts-scripts/data/tokenFactory.ts (1)

465-468: Ensure deployment address correctness and test coverage.

The new AUSD token entry looks good. However, please verify that:

  1. The creator address (inj1n636d9gzrqggdk66n2f97th0x8yuhfrtx520e7) is correct and controlled by the intended entity.
  2. The token is properly tested or validated in your codebase and any relevant test environment(s).

Comment on lines +2114 to +2119
AUSD: {
name: 'AUSD',
logo: 'AUSD.png',
symbol: 'AUSD',
decimals: 6,
coinGeckoId: 'agora-dollar'
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Update needed: CoinGecko ID inconsistency detected

The AUSD decimal count (6) is consistently defined across all configuration files and matches the on-chain specifications. However, there's an important inconsistency in the CoinGecko ID:

  • symbolMeta.ts defines coinGeckoId: 'agora-dollar'
  • All token configuration files have empty CoinGecko IDs (coinGeckoId: "")

This suggests either:

  • The CoinGecko ID in symbolMeta.ts is outdated and should be empty
  • The token configuration files need to be updated with the correct CoinGecko ID

Since this affects price fetching functionality, this needs to be resolved to ensure proper token price tracking.

🔗 Analysis chain

Confirm metadata consistency and CoinGecko listing.

These properties for AUSD look fine. Double-check the decimal count (6) matches real on-chain specs, and verify the coinGeckoId (agora-dollar) for correct listing.


AUSD metadata consistency verified with on-chain data

The verification shows consistent decimal places (6) across all references to AUSD in the codebase, matching the on-chain specifications found in:

  • Bank metadata (mainnet and testnet): decimals: 6
  • Token metadata in various configuration files

However, there's a discrepancy in the CoinGecko ID:

  • The symbolMeta.ts file specifies coinGeckoId: 'agora-dollar'
  • But all token configuration files (mainnet.json, testnet.json, factoryTokens) have coinGeckoId: ""

Let's verify if the CoinGecko ID is correct:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential references to AUSD metadata or mismatched decimals.
rg -A3 'AUSD'

Length of output: 6514


Script:

#!/bin/bash
# Search for other potential CoinGecko IDs for AUSD
rg -i "agora.*dollar" 

Length of output: 85

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.

1 participant