Skip to content

Commit 93ca6fb

Browse files
Merge pull request #1125 from bz-hashtag-0780/brian-doyle/add-tutorial-section
add token listing guide
2 parents cbb6fb6 + eb1d00a commit 93ca6fb

File tree

5 files changed

+80
-5
lines changed

5 files changed

+80
-5
lines changed

docs/tutorials/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebar_position: 1
3+
title: Tutorials
4+
description: Learn cutting edge techniques to take advantage of the power of Flow with EVM and Cadence.
5+
---
6+
7+
In this section, you'll find our most complicated and advanced tutorials. Check out the list below to find information on how to power up your apps.

docs/tutorials/token-launch/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 1
3+
title: Token Launch
4+
description: Learn how to register your tokens on Flow to ensure visibility in wallets and ecosystem projects.
5+
---
6+
7+
# Token Launch
8+
9+
This section covers the process of registering your tokens on Flow.
10+
11+
### Guides:
12+
13+
- **[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.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Register Your Token on Flow
3+
description: 'Register tokens to get listed on Flow Wallet, IncrementFi, and other Flow Apps.'
4+
sidebar_label: Register Token
5+
sidebar_position: 2
6+
---
7+
8+
# Register Your Token on Flow
9+
10+
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.
11+
12+
There are two ways to register your token: **manually** via a web interface or **programmatically** during token deployment.
13+
14+
---
15+
16+
## Manual Registration (~1 min)
17+
18+
The following works for both fungible tokens on Flow Cadence and ERC20 tokens on Flow EVM.
19+
20+
1. **Go to** [Token List Registration](https://token-list.fixes.world/).
21+
2. **Enter your contract address** in the **"Quick Register"** field and press **Enter**.
22+
3. **Click "Register"** and sign the transaction.
23+
- If your token is **already registered to VM Bridge**, you're done.
24+
- Otherwise, the **first transaction** registers the token to **VM Bridge** (costs **1 $FLOW**).
25+
- After that, click **"Register"** again and sign the **second transaction** to finalize the process.
26+
27+
---
28+
29+
## Programmatic Registration (~1-2 hrs)
30+
31+
For seamless automation, you can integrate token registration into your token deployment workflow.
32+
33+
### Register ERC-20 Tokens automatically on Flow EVM
34+
35+
- Use this **Cadence transaction**: [register-evm-asset.cdc](https://github.com/fixes-world/token-list/blob/main/cadence/transactions/register-evm-asset.cdc)
36+
- This transaction should be executed **right after deploying your ERC-20 contract**.
37+
- **Note:** Similar to manual registration:
38+
- If the token **is not bridged** to **VM Bridge**, you will need to **send the transaction twice**.
39+
- The **first transaction** deploys a **VM Bridged Cadence contract** for the ERC-20.
40+
- The **second transaction** registers it on the Token List.
41+
42+
---
43+
44+
### Next Steps
45+
46+
- Verify your token listing in Flow Wallet.
47+
48+
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).

docusaurus.config.js

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,11 @@ const config = {
205205
},
206206
...(process.env.GTAG
207207
? {
208-
gtag: {
209-
trackingID: process.env.GTAG,
210-
anonymizeIP: true,
211-
},
212-
}
208+
gtag: {
209+
trackingID: process.env.GTAG,
210+
anonymizeIP: true,
211+
},
212+
}
213213
: {}),
214214
}),
215215
],
@@ -302,6 +302,12 @@ const config = {
302302
label: 'Growth',
303303
activeBasePath: '/growth',
304304
},
305+
{
306+
to: 'tutorials',
307+
position: 'left',
308+
label: 'Tutorials',
309+
activeBasePath: '/tutorials',
310+
},
305311
{
306312
type: 'custom-connectButton',
307313
position: 'right',

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const sidebars = {
1818
evm: [{ type: 'autogenerated', dirName: 'evm' }],
1919
tools: [{ type: 'autogenerated', dirName: 'tools' }],
2020
ecosystem: [{ type: 'autogenerated', dirName: 'ecosystem' }],
21+
tutorials: [{ type: 'autogenerated', dirName: 'tutorials' }],
2122
};
2223

2324
module.exports = sidebars;

0 commit comments

Comments
 (0)