changing native token address standard [SLT-210]

Defi-Moses commented 2 months ago

Changes the native gas token address from 0x00... to 0xEe

Summary by CodeRabbit

New Features
- Introduced a new constant for the native token address, enhancing clarity across multiple blockchain networks.
- Added middleware for normalizing native token addresses in various routes, improving request handling.
Improvements
- Updated token address references for various chains (Ethereum, Moonriver, Avalanche, etc.) to use the new native token address, improving accuracy in token assignments.
- Adjusted test cases to reflect the new native token address, ensuring consistent testing outcomes.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve the introduction of a new constant, NativeTokenAddress, in the bridgeable.ts file, which is assigned a specific Ethereum address. This constant replaces instances of ZeroAddress in the addresses property of several BridgeableToken exports, ensuring accurate token address assignments across multiple blockchain networks. Additionally, various test files were updated to utilize these constants instead of hardcoded values, enhancing the clarity and maintainability of the tests.

Changes

File Path	Change Summary
packages/rest-api/src/constants/bridgeable.ts	Added `NativeTokenAddress` constant; modified `addresses` for `ETH`, `MOVR`, `AVAX`, `JEWEL`, `KLAY`, `MATIC`, `FTM` to replace `ZeroAddress` with `NativeTokenAddress`.
packages/rest-api/src/tests/destinationTokensRoute.test.ts	Updated `fromToken` parameter in tests to use constants instead of hardcoded addresses, including `ZeroAddress`.
packages/rest-api/src/tests/bridgeRoute.test.ts	Modified token parameters in tests to utilize constants; added new test cases for `ZeroAddress` and `NativeGasAddress`.
packages/rest-api/src/tests/bridgeTxInfoRoute.test.ts	Updated token addresses in tests to use constants instead of hardcoded values.
packages/rest-api/src/tests/swapRoute.test.ts	Updated swap tests to use constants for token addresses; added tests for `ZeroAddress` and `NativeGasAddress`.
packages/rest-api/src/tests/swapTxInfoRoute.test.ts	Replaced hardcoded token addresses with constants in multiple test cases.
packages/rest-api/src/middleware/normalizeNativeTokenAddress.ts	Introduced `normalizeNativeTokenAddress` middleware to validate and normalize token addresses in requests.
packages/rest-api/src/routes/*.ts	Added `normalizeNativeTokenAddress` middleware to various routes to process token address normalization.
packages/rest-api/src/utils/tokenAddressToToken.ts	Simplified logic by removing checks for `ZeroAddress` and directly assigning `chainData[tokenAddress]`.

Possibly related PRs

#3126: This PR involves refactoring the REST API, which includes changes to how token addresses are handled in various controllers, potentially impacting the functionality related to the NativeTokenAddress introduced in the main PR.
#3133: This PR modifies the bridgeTxInfoController and swapTxInfoController to enhance token address handling, which aligns with the changes made in the main PR regarding the use of NativeTokenAddress.
#3151: The introduction of the /destinationTokens route involves query parameters that include fromToken, which is relevant to the changes made in the main PR regarding token address handling.
#3159: This PR adds Swagger documentation for the API, including the /destinationTokens endpoint, which is directly related to the changes in the main PR that enhance token address handling across multiple routes.

Suggested labels

size/m, M-deps

Suggested reviewers

Defi-Moses
bigboydiamonds
trajan0x
ChiTimesChi

In the meadow where tokens play,
A new address brightens the day.
No more placeholders, clear and true,
For bridges to cross, and dreams to pursue.
Hopping along, we celebrate this feat,
With every change, our code's more neat! 🐇✨

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`a415529`
Status:	✅ Deploy successful!
Preview URL:	https://93fb17aa.sanguine-fe.pages.dev
Branch Preview URL:	https://feat-rest-api-native-token.sanguine-fe.pages.dev

View logs

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 37.95009%. Comparing base (49cf94d) to head (a415529). Report is 12 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #3157 +/- ## ============================================= Coverage 37.95009% 37.95009% ============================================= Files 418 418 Lines 24245 24245 Branches 82 82 ============================================= Hits 9201 9201 Misses 14306 14306 Partials 738 738 ``` | [Flag](https://app.codecov.io/gh/synapsecns/sanguine/pull/3157/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | Coverage Δ | | |---|---|---| | [packages](https://app.codecov.io/gh/synapsecns/sanguine/pull/3157/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns) | `90.96267% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=synapsecns#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

synapsecns / sanguine