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

Create EVM contract metadata package #1

Merged
merged 21 commits into from
Nov 7, 2024
Merged

Conversation

devpavan04
Copy link
Member

@devpavan04 devpavan04 commented Nov 4, 2024

Summary of changes

Initial version of the @tangle-network/evm-contract-metadata package 📦

  • EVM token addresses
  • Hyperlane bridge contract addresses, warp routes, and configurations
  • Router protocol addresses on the Tangle mainnet (e.g., USDC, USDT)
  • Type definitions and enums for supported chains and tokens
  • Formatting and lint checks workflow
  • NPM publish and release workflow

What is included and why?

This package includes two core components for easy access to EVM configurations and token information for the Tangle Network.

  1. Bridge Configurations (Hyperlane):
    • Provides configuration files (e.g., warp route deployment config, relayer agent config, etc.) used to deploy Hyperlane.
    • While not all configurations are exported, this structure enables quick access to locate and utilize Hyperlane bridge configurations essential for deployment. Non-exported files are intentionally left out, as these configurations are specific to deployment needs rather than direct use within the dapp (e.g., core config files can be reused to deploy Hyperlane on new chains).
    • As we extend bridge support, such as integrating protocols like Router Protocol, this list will grow to include new configurations.
    • Exported items are focused on the configurations necessary for Tangle dapp functionality, such as tokens, chains, warp routes, and contract addresses, making them readily available for direct use within the dapp.
  2. EVM Token Metadata:
    • Provides a collection of EVM tokens with their respective contract addresses on supported chains.
    • Includes tokens bridged via Hyperlane and Router, as well as those used for Liquid Staking and Restaking.
    • This simplifies access to token details across multiple chains, ensuring easy integration on the dapp’s account page for displaying token balances.

@devpavan04 devpavan04 changed the title Add Hyperlane configs Create EVM contract metadata package Nov 6, 2024
@devpavan04 devpavan04 self-assigned this Nov 6, 2024
@devpavan04 devpavan04 marked this pull request as draft November 6, 2024 19:36
@devpavan04 devpavan04 marked this pull request as ready for review November 7, 2024 09:02
@drewstone drewstone merged commit 5a406c1 into main Nov 7, 2024
2 checks passed
@drewstone drewstone deleted the PS/add-hyperlane-configs branch November 7, 2024 10:11
Copy link

github-actions bot commented Nov 7, 2024

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants