From dd28e5b141249092d505e3c1293e363bc312d0be Mon Sep 17 00:00:00 2001 From: Tang Bo Hao Date: Thu, 24 Apr 2025 20:23:56 +0800 Subject: [PATCH 01/11] docs: Refactor token registration documentation - Updated the main token registration guide to include separate links for registering Cadence assets and ERC20 tokens. - Added a new document for registering Cadence assets, detailing both manual and programmatic registration processes. - Removed the old token registration document to streamline the content. --- docs/tutorials/token-launch/index.md | 8 +- .../token-launch/register-cadence-assets.md | 85 +++++++++++++++++++ docs/tutorials/token-launch/register-token.md | 48 ----------- 3 files changed, 91 insertions(+), 50 deletions(-) create mode 100644 docs/tutorials/token-launch/register-cadence-assets.md delete mode 100644 docs/tutorials/token-launch/register-token.md diff --git a/docs/tutorials/token-launch/index.md b/docs/tutorials/token-launch/index.md index f528babd67..be11374730 100644 --- a/docs/tutorials/token-launch/index.md +++ b/docs/tutorials/token-launch/index.md @@ -8,6 +8,10 @@ description: Learn how to register your tokens on Flow to ensure visibility in w This section covers the process of registering your tokens on Flow. -### Guides: +## Guides -- **[Register Your Token](register-token.md)**: Steps to register your Fungible Token on Flow Cadence or ERC20 on Flow EVM so it appears in Flow Wallet, IncrementFi, and other ecosystem apps. +- **[Register Your Cadence Assets]**: Steps to register your Fungible Token on Flow Cadence so it appears in Flow Wallet, IncrementFi, and other ecosystem apps. +- **[Register Your ERC20 Token]**: Steps to register your ERC20 token on Flow EVM so it appears in Flow Wallet, MetaMask, and other ecosystem apps. + +[Register Your Cadence Assets]: ./register-cadence-assets.md +[Register Your ERC20 Token]: ./register-erc20-token.md diff --git a/docs/tutorials/token-launch/register-cadence-assets.md b/docs/tutorials/token-launch/register-cadence-assets.md new file mode 100644 index 0000000000..2a46f8bbd4 --- /dev/null +++ b/docs/tutorials/token-launch/register-cadence-assets.md @@ -0,0 +1,85 @@ +--- +title: Register Your Assets on Flow +description: 'Register your Fungible Token or Non-Fungible Token on Flow so it appears in Flow Wallet, IncrementFi, and other ecosystem apps.' +sidebar_label: Register Cadence Assets +sidebar_position: 2 +--- + +# Register Your Assets on Flow + +To make your fungible token or non-fungible token visible in Flow ecosystem projects like **Flow Wallet** and **IncrementFi**, you need to register it on the Flow Token List. This process will generate JSON files based on Uniswap TokenList Standard and ensures that wallets, explorers, and onchain apps can recognize and display your token correctly. + +There are two ways to register your token: **manually** via a web interface or **programmatically** during token deployment. + +--- + +## Manual Registration (~1 min) + +The following works for both fungible and non-fungible tokens on Flow Cadence or Flow EVM. + +1. **Go to** [Token List Registration]. +2. **Enter your contract address** in the **"Quick Register"** field and press **Enter**. + - Both Fungible and Non-Fungible tokens are supported. + - Both EVM and Cadence contracts are supported. +3. **Click "Register"** and sign the transaction. + - If your token is **already registered to VM Bridge**, you're done. + - Otherwise, the **first transaction** registers the token to **VM Bridge** (costs **1 $FLOW**). + - After that, click **"Register"** again and sign the **second transaction** to finalize the process. + +--- + +## Programmatic Registration + +For seamless automation, you can integrate token registration into your token deployment workflow. + +You can use the following Cadence transaction to register your Fungible or Non-Fungible token on Flow Cadence or Flow EVM. + +### Register Fungible Token or Non-Fungible Token automatically on Flow Cadence + +Use a standalone Cadence transaction to register your Fungible Token or Non-Fungible Token on Flow Cadence. + +- Use this **Cadence transaction**: [register-standard-asset.cdc]. +- This transaction should be executed **right after deploying your Fungible Token or Non-Fungible Token contract**. + +Or you can also pick up some code from the [register-standard-asset.cdc] file to make your own Cadence transaction with the same logic for more seamless integration. Here is an example: + +```cadence +import "TokenList" +import "NFTList" + +transaction( + address: Address, + contractName: String, +) { + execute { + if TokenList.isValidToRegister(address, contractName) { + TokenList.ensureFungibleTokenRegistered(address, contractName) + } else if NFTList.isValidToRegister(address, contractName) { + NFTList.ensureNFTCollectionRegistered(address, contractName) + } + } +} +``` + +### Register ERC-20 or ERC-721 Tokens automatically on Flow EVM + +- Use this **Cadence transaction**: [register-evm-asset.cdc] +- This transaction should be executed **right after deploying your ERC-20 or ERC-721 contract**. +- **Note:** Similar to manual registration: + - If the token **is not bridged** to **VM Bridge**, you will need to **send the transaction twice**. + - The **first transaction** deploys a **VM Bridged Cadence contract** for the ERC-20. + - The **second transaction** registers it on the Token List. + +--- + +### Next Steps + +- Verify your token listing in Flow Wallet. + +For any issues, refer to the [Token List GitHub Repository] or reach out to the [Flow developer community]. + +[Token List Registration]: https://token-list.fixes.world/ +[register-standard-asset.cdc]: https://github.com/fixes-world/token-list/blob/main/cadence/transactions/register-standard-asset.cdc +[register-evm-asset.cdc]: https://github.com/fixes-world/token-list/blob/main/cadence/transactions/register-evm-asset.cdc +[Token List GitHub Repository]: https://github.com/fixes-world/token-list +[Flow developer community]: https://discord.gg/flow diff --git a/docs/tutorials/token-launch/register-token.md b/docs/tutorials/token-launch/register-token.md deleted file mode 100644 index 6feffabf3c..0000000000 --- a/docs/tutorials/token-launch/register-token.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Register Your Token on Flow -description: 'Register tokens to get listed on Flow Wallet, IncrementFi, and other Flow Apps.' -sidebar_label: Register Token -sidebar_position: 2 ---- - -# Register Your Token on Flow - -To make your token visible in Flow ecosystem projects like **Flow Wallet** and **IncrementFi**, you need to register it on the Flow Token List. This process will generate JSON files based on Uniswap TokenList Standard and ensures that wallets, explorers, and onchain apps can recognize and display your token correctly. - -There are two ways to register your token: **manually** via a web interface or **programmatically** during token deployment. - ---- - -## Manual Registration (~1 min) - -The following works for both fungible tokens on Flow Cadence and ERC20 tokens on Flow EVM. - -1. **Go to** [Token List Registration](https://token-list.fixes.world/). -2. **Enter your contract address** in the **"Quick Register"** field and press **Enter**. -3. **Click "Register"** and sign the transaction. - - If your token is **already registered to VM Bridge**, you're done. - - Otherwise, the **first transaction** registers the token to **VM Bridge** (costs **1 $FLOW**). - - After that, click **"Register"** again and sign the **second transaction** to finalize the process. - ---- - -## Programmatic Registration (~1-2 hrs) - -For seamless automation, you can integrate token registration into your token deployment workflow. - -### Register ERC-20 Tokens automatically on Flow EVM - -- Use this **Cadence transaction**: [register-evm-asset.cdc](https://github.com/fixes-world/token-list/blob/main/cadence/transactions/register-evm-asset.cdc) -- This transaction should be executed **right after deploying your ERC-20 contract**. -- **Note:** Similar to manual registration: - - If the token **is not bridged** to **VM Bridge**, you will need to **send the transaction twice**. - - The **first transaction** deploys a **VM Bridged Cadence contract** for the ERC-20. - - The **second transaction** registers it on the Token List. - ---- - -### Next Steps - -- Verify your token listing in Flow Wallet. - -For any issues, refer to the [Token List GitHub Repository](https://github.com/fixes-world/token-list) or reach out to the [Flow developer community](https://discord.gg/flow). From 7c0aee44029d90f11e9f0258f30d8df0a2ab3765 Mon Sep 17 00:00:00 2001 From: Tang Bo Hao Date: Thu, 24 Apr 2025 21:02:27 +0800 Subject: [PATCH 02/11] docs: Update token registration guides - Revised the token registration documentation to clarify the process for registering ERC20 tokens on Flow EVM, including a new guide for submitting PRs. - Enhanced the Cadence assets registration section with updated links and additional notes regarding logo customization. - Added a new document specifically for registering ERC20 tokens, detailing the GitHub Pull Request process. --- docs/tutorials/token-launch/index.md | 6 +- .../token-launch/register-cadence-assets.md | 4 ++ .../token-launch/register-erc20-token.md | 68 +++++++++++++++++++ 3 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 docs/tutorials/token-launch/register-erc20-token.md diff --git a/docs/tutorials/token-launch/index.md b/docs/tutorials/token-launch/index.md index be11374730..7b2de46ca6 100644 --- a/docs/tutorials/token-launch/index.md +++ b/docs/tutorials/token-launch/index.md @@ -10,8 +10,8 @@ This section covers the process of registering your tokens on Flow. ## Guides -- **[Register Your Cadence Assets]**: Steps to register your Fungible Token on Flow Cadence so it appears in Flow Wallet, IncrementFi, and other ecosystem apps. -- **[Register Your ERC20 Token]**: Steps to register your ERC20 token on Flow EVM so it appears in Flow Wallet, MetaMask, and other ecosystem apps. +- **[Register Your ERC20 Token]**: Steps to register your ERC20 token on Flow EVM based on Github Pull Request process so it appears in Flow standard Token List which is used by Flow Wallet, MetaMask, and other ecosystem apps. +- **[Register Your Assets in Cadence]**: Steps to register your Fungible Token or Non-Fungible Token on Flow so it appears in Flow Wallet, IncrementFi, and other ecosystem apps. -[Register Your Cadence Assets]: ./register-cadence-assets.md +[Register Your Assets in Cadence]: ./register-cadence-assets.md [Register Your ERC20 Token]: ./register-erc20-token.md diff --git a/docs/tutorials/token-launch/register-cadence-assets.md b/docs/tutorials/token-launch/register-cadence-assets.md index 2a46f8bbd4..dcb7cc3aaf 100644 --- a/docs/tutorials/token-launch/register-cadence-assets.md +++ b/docs/tutorials/token-launch/register-cadence-assets.md @@ -26,6 +26,9 @@ The following works for both fungible and non-fungible tokens on Flow Cadence or - Otherwise, the **first transaction** registers the token to **VM Bridge** (costs **1 $FLOW**). - After that, click **"Register"** again and sign the **second transaction** to finalize the process. +Note: the ERC-20 token registered with this method will use the default logo of Flow Official Assets. +If you want to register your ERC-20 token on Flow EVM with your customized logo, you should follow the [Register ERC-20 Token on Flow EVM] guide. + --- ## Programmatic Registration @@ -79,6 +82,7 @@ transaction( For any issues, refer to the [Token List GitHub Repository] or reach out to the [Flow developer community]. [Token List Registration]: https://token-list.fixes.world/ +[Register ERC-20 Token on Flow EVM]: ./register-erc20-token.md [register-standard-asset.cdc]: https://github.com/fixes-world/token-list/blob/main/cadence/transactions/register-standard-asset.cdc [register-evm-asset.cdc]: https://github.com/fixes-world/token-list/blob/main/cadence/transactions/register-evm-asset.cdc [Token List GitHub Repository]: https://github.com/fixes-world/token-list diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md new file mode 100644 index 0000000000..0c13a9dc22 --- /dev/null +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -0,0 +1,68 @@ +--- +title: Register Your ERC20 Token on Flow EVM +description: 'Register your ERC20 token on Flow EVM so it appears in Flow Wallet, MetaMask, and other ecosystem apps.' +sidebar_label: Register ERC20 Token +sidebar_position: 2 +--- + +# Register Your ERC20 Token on Flow EVM + +## Overview + +This section covers the process of registering your ERC20 token on Flow EVM based on Github Pull Request process so it appears in Flow standard Token List which is used by Flow Wallet, MetaMask, and other ecosystem apps. + +We will use the [Flow Official Assets] repository as the standard token list repository for updating the token list for the whole Flow ecosystem. +The repository is open to the public and you can submit your PRs to add your token to the list. +Note: The logic of the registration is based on the [Register Assets in Cadence] backend process. + +## Guides for submitting your PRs + +Steps to submit your PRs: + +1. **Fork the [Flow Official Assets] repository** + - Click the `Fork` button in the top right corner of the repository. + - Create a new fork of the repository in your own Github account. +2. **Create a new branch** + - Clone your forked repository to your local development environment by `git clone https://github.com/your-github-username/assets` + - Create a new branch for your token by `git checkout -b new-token-branch` +3. **Add/Update your token to the list** + - For new Tokens: + - Create the token folders in the `tokens/registry` directory. + - The name of the token folders should be the same as the token's contract address. + - e.g. `tokens/registry/0x1234567890123456789012345678901234567890` + - for Testnet tokens, the folder should be `tokens/registry/testnet:0x1234567890123456789012345678901234567890` + - Put the required metadata file in the token folder, at least one of the following files should be included: + - `logo.png`: PNG format token logo (256x256px recommended) + - `logo.svg`: SVG format token logo, optimized and viewboxed + - You can also add extra optional metadata file: + - `mods.json`: Mods JSON file for token metadata, you can adjust the `symbol`, `name`, `description` for the final output in the `token.json` file. + - For existing Tokens: + - Identify the token folder in the `tokens/registry` directory by the token's contract address. + - Update the token metadata in the `tokens/registry/${token_address}` directory. +4. **Submit a Pull Request** + - Commit your changes and push to your forked repository. + - Create a new Pull Request for your changes in the [Flow Official Assets] repository. + - A Github Action will be triggered to verify the on-chain status of the token and update the report in the PR's comment. + - If there is any issue, you will see some warnings and suggestions in the PR's comment. So please check the report and update the token metadata if needed. + - You may see a comment from the Github Action that you need to send 1 $FLOW to the registry address for the token registration because there is a VM Bridge onboarding fee. + +Learn more about the registration process in the [Assets Registry] README.md file of the repository. + +## What's next? + +After submitting your PR, you just need to wait for the Flow team to review your token and merge your PR. +Once the PR is merged, your token will be registered by the Github Actions in the [Flow Official Assets] repository automatically and a new PR will be created automatically by Github Actions to update the token list. Flow team will regularly merge the token list updates PR to the main branch. + +## How to verify the token is registered? + +As the registration and token list generation is executed by Github Actions, you can check the status of the PRs and the token list JSON files in the [Flow Official Assets] repository. +Here are the URLs for the token list JSON files: + +- Mainnet: `https://raw.githubusercontent.com/onflow/assets/refs/heads/main/tokens/outputs/mainnet/token-list.json` +- Testnet: `https://raw.githubusercontent.com/onflow/assets/refs/heads/main/tokens/outputs/testnet/token-list.json` + +You can check the token list JSON files to verify the token is registered in the `token-list.json` file. + +[Flow Official Assets]: https://github.com/onflow/assets +[Register Assets in Cadence]: ./register-cadence-assets.md +[Assets Registry]: https://github.com/onflow/assets/tree/main/tokens From 783912506d981381e81cde26d3866d2a7e54d626 Mon Sep 17 00:00:00 2001 From: Tang Bo Hao Date: Thu, 24 Apr 2025 21:10:12 +0800 Subject: [PATCH 03/11] docs: Enhance token registration guides - Updated the index to include detailed descriptions for registering ERC20 tokens and Cadence assets on Flow. - Added keywords to the new documents for better searchability and clarity. - Adjusted sidebar positions for improved navigation within the token launch section. --- docs/tutorials/index.md | 6 ++++-- .../tutorials/token-launch/register-cadence-assets.md | 10 ++++++++++ docs/tutorials/token-launch/register-erc20-token.md | 11 ++++++++++- 3 files changed, 24 insertions(+), 3 deletions(-) diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index 374f26ccb9..3d38e23ee1 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -59,7 +59,8 @@ Learn how to leverage AI tools to enhance your Flow development experience. Thes Learn how to launch your own token on Flow using Cadence and EVM. This guide covers the process of registering and deploying tokens that can be used across both virtual machines. -- [Register a Token] - Step-by-step guide to registering and deploying your token on Flow +- [Register Your ERC20 Token] - Learn how to register your ERC20 token on Flow EVM based on Github Pull Request process so it appears in Flow standard Token List which is used by Flow Wallet, MetaMask, and other ecosystem apps. +- [Register Your Assets in Cadence] - Learn how to register your Fungible Token or Non-Fungible Token on Flow through Cadence transaction so it appears in Flow Wallet, IncrementFi, and other ecosystem apps. ## Cross-VM Applications @@ -88,7 +89,6 @@ Explore Flow's unique capabilities through fun benchmark applications that showc [Use Flow Knowledge Base in ChatGPT]: ai-plus-flow/chatgpt/index.md [Flow Data Sources]: ai-plus-flow/flow-data-sources.md [Build AI Agents with AgentKit]: ai-plus-flow/agentkit-flow-guide.md -[Register a Token]: token-launch/register-token.md [Introduction to Cross-VM Applications]: cross-vm-apps/introduction.md [Interacting with COAs]: cross-vm-apps/interacting-with-coa.md [Batched EVM Transactions]: cross-vm-apps/batched-evm-transactions.md @@ -97,3 +97,5 @@ Explore Flow's unique capabilities through fun benchmark applications that showc [Secure Randomness with Commit-Reveal in Cadence]: native-vrf/commit-reveal-cadence.md [Deploy a Solidity Contract Using Cadence]: native-vrf/deploy-solidity-contract.md [Add Flow Cadence to Your wagmi App]: ./cross-vm-apps/add-to-wagmi.md +[Register Your Assets in Cadence]: ./token-launch/register-cadence-assets.md +[Register Your ERC20 Token]: ./token-launch/register-erc20-token.md diff --git a/docs/tutorials/token-launch/register-cadence-assets.md b/docs/tutorials/token-launch/register-cadence-assets.md index dcb7cc3aaf..d5e0fe0063 100644 --- a/docs/tutorials/token-launch/register-cadence-assets.md +++ b/docs/tutorials/token-launch/register-cadence-assets.md @@ -3,6 +3,16 @@ title: Register Your Assets on Flow description: 'Register your Fungible Token or Non-Fungible Token on Flow so it appears in Flow Wallet, IncrementFi, and other ecosystem apps.' sidebar_label: Register Cadence Assets sidebar_position: 2 +keywords: + - Fungible Token + - Non-Fungible Token + - Flow + - Flow Wallet + - IncrementFi + - Token List + - Register Fungible Token + - Register Non-Fungible Token + - Flow Official Assets --- # Register Your Assets on Flow diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md index 0c13a9dc22..2e537b2480 100644 --- a/docs/tutorials/token-launch/register-erc20-token.md +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -2,7 +2,16 @@ title: Register Your ERC20 Token on Flow EVM description: 'Register your ERC20 token on Flow EVM so it appears in Flow Wallet, MetaMask, and other ecosystem apps.' sidebar_label: Register ERC20 Token -sidebar_position: 2 +sidebar_position: 1 +keywords: + - ERC20 + - Fungible Token + - Flow EVM + - Flow Wallet + - MetaMask + - Token List + - Register ERC20 Token + - Flow Official Assets --- # Register Your ERC20 Token on Flow EVM From 45100a4e7f41d5d56ee2c516800d0f224c3464f4 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:20:17 -0400 Subject: [PATCH 04/11] Update docs/tutorials/token-launch/register-cadence-assets.md --- docs/tutorials/token-launch/register-cadence-assets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-cadence-assets.md b/docs/tutorials/token-launch/register-cadence-assets.md index d5e0fe0063..a5f7f2bdf7 100644 --- a/docs/tutorials/token-launch/register-cadence-assets.md +++ b/docs/tutorials/token-launch/register-cadence-assets.md @@ -17,7 +17,7 @@ keywords: # Register Your Assets on Flow -To make your fungible token or non-fungible token visible in Flow ecosystem projects like **Flow Wallet** and **IncrementFi**, you need to register it on the Flow Token List. This process will generate JSON files based on Uniswap TokenList Standard and ensures that wallets, explorers, and onchain apps can recognize and display your token correctly. +To make your fungible token or non-fungible token visible in Flow ecosystem projects like **Flow Wallet** and **IncrementFi**, you need to register it on the Flow Token List. This process will generate JSON files based on the Uniswap TokenList Standard and ensures that wallets, explorers, and onchain apps can recognize and display your token correctly. There are two ways to register your token: **manually** via a web interface or **programmatically** during token deployment. From e11d38e60f8f91a04893e29678df5a2f7f9fe3f9 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:20:24 -0400 Subject: [PATCH 05/11] Update docs/tutorials/token-launch/register-cadence-assets.md --- docs/tutorials/token-launch/register-cadence-assets.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-cadence-assets.md b/docs/tutorials/token-launch/register-cadence-assets.md index a5f7f2bdf7..02ddb387d0 100644 --- a/docs/tutorials/token-launch/register-cadence-assets.md +++ b/docs/tutorials/token-launch/register-cadence-assets.md @@ -36,9 +36,14 @@ The following works for both fungible and non-fungible tokens on Flow Cadence or - Otherwise, the **first transaction** registers the token to **VM Bridge** (costs **1 $FLOW**). - After that, click **"Register"** again and sign the **second transaction** to finalize the process. -Note: the ERC-20 token registered with this method will use the default logo of Flow Official Assets. +:::warning + +ERC-20 tokens registered with this method will use the default logo of Flow Official Assets. + If you want to register your ERC-20 token on Flow EVM with your customized logo, you should follow the [Register ERC-20 Token on Flow EVM] guide. +::: + --- ## Programmatic Registration From d74e01872c0b2482bac0deda68b7f65f4c6d0f00 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:20:31 -0400 Subject: [PATCH 06/11] Update docs/tutorials/token-launch/register-cadence-assets.md --- docs/tutorials/token-launch/register-cadence-assets.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-cadence-assets.md b/docs/tutorials/token-launch/register-cadence-assets.md index 02ddb387d0..2f563831e1 100644 --- a/docs/tutorials/token-launch/register-cadence-assets.md +++ b/docs/tutorials/token-launch/register-cadence-assets.md @@ -83,10 +83,15 @@ transaction( - Use this **Cadence transaction**: [register-evm-asset.cdc] - This transaction should be executed **right after deploying your ERC-20 or ERC-721 contract**. -- **Note:** Similar to manual registration: + +:::warning + +Similar to manual registration: - If the token **is not bridged** to **VM Bridge**, you will need to **send the transaction twice**. - The **first transaction** deploys a **VM Bridged Cadence contract** for the ERC-20. - The **second transaction** registers it on the Token List. + +::: --- From 9b1231538f71a6abe435180eae439b6367d73cb5 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:20:38 -0400 Subject: [PATCH 07/11] Update docs/tutorials/token-launch/register-erc20-token.md --- docs/tutorials/token-launch/register-erc20-token.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md index 2e537b2480..77a980310a 100644 --- a/docs/tutorials/token-launch/register-erc20-token.md +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -22,6 +22,7 @@ This section covers the process of registering your ERC20 token on Flow EVM base We will use the [Flow Official Assets] repository as the standard token list repository for updating the token list for the whole Flow ecosystem. The repository is open to the public and you can submit your PRs to add your token to the list. + Note: The logic of the registration is based on the [Register Assets in Cadence] backend process. ## Guides for submitting your PRs From f0d54042e5eb6a394fac1b9486f361a73ab5677a Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:20:45 -0400 Subject: [PATCH 08/11] Update docs/tutorials/token-launch/register-erc20-token.md --- docs/tutorials/token-launch/register-erc20-token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md index 77a980310a..85c611575a 100644 --- a/docs/tutorials/token-launch/register-erc20-token.md +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -18,7 +18,7 @@ keywords: ## Overview -This section covers the process of registering your ERC20 token on Flow EVM based on Github Pull Request process so it appears in Flow standard Token List which is used by Flow Wallet, MetaMask, and other ecosystem apps. +This section covers the process of registering your ERC20 token on Flow EVM via a Github Pull Request process so it appears in Flow standard Token List which is used by Flow Wallet, MetaMask, and other ecosystem apps. We will use the [Flow Official Assets] repository as the standard token list repository for updating the token list for the whole Flow ecosystem. The repository is open to the public and you can submit your PRs to add your token to the list. From b58aae915c2ed05c1e7ab1bd5a051bc8bdc0fd14 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:20:51 -0400 Subject: [PATCH 09/11] Update docs/tutorials/token-launch/register-erc20-token.md --- docs/tutorials/token-launch/register-erc20-token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md index 85c611575a..fb15bac4b8 100644 --- a/docs/tutorials/token-launch/register-erc20-token.md +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -38,7 +38,7 @@ Steps to submit your PRs: 3. **Add/Update your token to the list** - For new Tokens: - Create the token folders in the `tokens/registry` directory. - - The name of the token folders should be the same as the token's contract address. + - The name of the token folders must be the same as the token's contract address. - e.g. `tokens/registry/0x1234567890123456789012345678901234567890` - for Testnet tokens, the folder should be `tokens/registry/testnet:0x1234567890123456789012345678901234567890` - Put the required metadata file in the token folder, at least one of the following files should be included: From 5d0be9a34af8b92882b81ff7e93175e0642b35c0 Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:21:11 -0400 Subject: [PATCH 10/11] Update docs/tutorials/token-launch/register-erc20-token.md --- docs/tutorials/token-launch/register-erc20-token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md index fb15bac4b8..50b3be70f6 100644 --- a/docs/tutorials/token-launch/register-erc20-token.md +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -53,7 +53,7 @@ Steps to submit your PRs: - Commit your changes and push to your forked repository. - Create a new Pull Request for your changes in the [Flow Official Assets] repository. - A Github Action will be triggered to verify the on-chain status of the token and update the report in the PR's comment. - - If there is any issue, you will see some warnings and suggestions in the PR's comment. So please check the report and update the token metadata if needed. + - If there is any issue, you will see some warnings and suggestions in the PR's comment. Please check the report and update the token metadata if needed. - You may see a comment from the Github Action that you need to send 1 $FLOW to the registry address for the token registration because there is a VM Bridge onboarding fee. Learn more about the registration process in the [Assets Registry] README.md file of the repository. From afd9a9b3ff79a8a0cccf80a2f36f13542a04f74d Mon Sep 17 00:00:00 2001 From: Brian Doyle Date: Fri, 25 Apr 2025 12:21:18 -0400 Subject: [PATCH 11/11] Update docs/tutorials/token-launch/register-erc20-token.md --- docs/tutorials/token-launch/register-erc20-token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/token-launch/register-erc20-token.md b/docs/tutorials/token-launch/register-erc20-token.md index 50b3be70f6..26bd8b7258 100644 --- a/docs/tutorials/token-launch/register-erc20-token.md +++ b/docs/tutorials/token-launch/register-erc20-token.md @@ -61,7 +61,7 @@ Learn more about the registration process in the [Assets Registry] README.md fil ## What's next? After submitting your PR, you just need to wait for the Flow team to review your token and merge your PR. -Once the PR is merged, your token will be registered by the Github Actions in the [Flow Official Assets] repository automatically and a new PR will be created automatically by Github Actions to update the token list. Flow team will regularly merge the token list updates PR to the main branch. +Once the PR is merged, your token will be registered by the Github Actions in the [Flow Official Assets] repository automatically and a new PR will be created automatically by Github Actions to update the token list. The Flow team will regularly merge the token list updates PR to the main branch. ## How to verify the token is registered?