Skip to content

Commit 853e360

Browse files
committed
update guide to include UX improvements
1 parent bb42043 commit 853e360

File tree

9 files changed

+48
-24
lines changed

9 files changed

+48
-24
lines changed
262 KB
Loading
184 KB
Loading
215 KB
Loading
291 KB
Loading
219 KB
Loading
259 KB
Loading
98.1 KB
Loading
230 KB
Loading

src/content/ccip/tutorials/token-manager.mdx

Lines changed: 48 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import CcipCommon from "@features/ccip/CcipCommon.astro"
1313
CCIP Contact form](https://chain.link/ccip-contact?v=Token%20Manager%20support).
1414
</Aside>
1515

16-
The Token Manager allows token developers to deploy, configure, and manage Cross-Chain Tokens (CCTs) in a simplified web interface.
16+
The Token Manager allows token developers to deploy, configure, and manage Cross-Chain Tokens (CCTs) in a simplified web interface. The process involves deploying tokens and token pools, registering administrative roles, and configuring token pools to enable secure token transfers using CCIP.
1717

18-
The process involves deploying tokens and token pools, registering administrative roles, and configuring token pools to enable secure token transfers using CCIP. The Token Manager guides you through two workflows:
18+
The Token Manager guides you through two workflows:
1919

2020
- **Deploy a new token from scratch**: This is the more beginner-friendly workflow that guides you through the entire process step-by-step, starting by creating a token from scratch.
2121
- **Enable an existing token to go cross-chain**: This is a more advanced workflow for token developers who have already deployed their token and want to add cross-chain capabilities.
@@ -29,20 +29,28 @@ You can also use the [CCIP JavaScript SDK](/ccip/ccip-javascript-sdk) to add a f
2929
Currently, the following advanced features are not yet supported in Token Manager:
3030

3131
- **Token pool replacements and upgrades for existing tokens**. This capability will be added in a subsequent update. To learn more about the process of replacing and upgrading existing token pools, review the [CCIP token pool upgradability](/ccip/concepts/cross-chain-tokens#token-pool-upgradability) section.
32-
- **Deployment of token pools that use the [Lock and Unlock mechanism](/ccip/concepts/cross-chain-tokens#token-handling-mechanisms-and-token-pool-deployment)**. In this use case, tokens are locked on the source blockchain, and an equivalent amount of tokens are released on the destination blockchain.
32+
- **Deployment of token pools that use the [Lock and Unlock mechanism](/ccip/concepts/cross-chain-tokens#token-handling-mechanisms-and-token-pool-deployment)**. The Token Manager Wizard automatically configures all tokens with the Burn & Mint mechanism. (Refer to the [Burn & Mint token contract](https://github.com/smartcontractkit/chainlink/blob/contracts-ccip/v1.6.0-beta.0/contracts/src/v0.8/ccip/tokenAdminRegistry/TokenPoolFactory/FactoryBurnMintERC20.sol) and [Burn & Mint token pool contract](https://github.com/smartcontractkit/chainlink/blob/contracts-ccip/v1.6.0-beta.0/contracts/src/v0.8/ccip/pools/BurnMintTokenPool.sol) for the Burn & Mint mechanism.)
3333
- Deployment or enablement of custom token pools is not yet supported.
34-
- Adding a new network is currently supported if the Token Admin address is the same for each network. This capability will be expanded in a subsequent update to enable multiple Token Admin addresses across different networks.
3534

3635
## Getting started
3736

38-
1. Open the Token Manager, which has separate links for testnet and mainnet. It is highly recommended to test and perform any operations on testnet before mainnet:
37+
The Token Manager includes both testnet and mainnet functionality. It is highly recommended to test and perform any operations on testnet before mainnet.
38+
39+
Before you can deploy a new token or add an existing token, you need to connect and authorize your wallet.
40+
41+
1. Open the Token Manager using the appropriate link for your use case:
3942

4043
- For testnet, use [https://test.tokenmanager.chain.link](https://test.tokenmanager.chain.link).
4144
- For mainnet, use [https://tokenmanager.chain.link/](https://tokenmanager.chain.link/)
4245

43-
1. Connect your wallet using the **Connect wallet** button in the upper right corner.
46+
1. Connect your wallet using the **Connect wallet** button in the upper right corner. The following wallets are supported:
4447

45-
After your wallet is connected, you'll see the Token Manager homepage.
48+
- Metamask
49+
- Coinbase wallet
50+
- WalletConnect
51+
- Rabby wallet
52+
53+
1. After your wallet is connected, authorize the use of your wallet by clicking **Authorize** and complete the subsequent authorization flow for your wallet type.
4654

4755
## Deploy a new token
4856

@@ -52,51 +60,62 @@ After your wallet is connected, you'll see the Token Manager homepage.
5260
research before engaging with any tokens.
5361
</Aside>
5462

55-
If you haven't deployed your token to any networks yet, you can start here. This Token Manager Wizard automatically configures all tokens with the Burn & Mint mechanism. (Refer to the [Burn & Mint token contract](https://github.com/smartcontractkit/chainlink/blob/contracts-ccip/v1.6.0-beta.0/contracts/src/v0.8/ccip/tokenAdminRegistry/TokenPoolFactory/FactoryBurnMintERC20.sol) and [Burn & Mint token pool contract](https://github.com/smartcontractkit/chainlink/blob/contracts-ccip/v1.6.0-beta.0/contracts/src/v0.8/ccip/pools/BurnMintTokenPool.sol) for the Burn & Mint mechanism.)
63+
1. Once wallet connection and authorization is complete, click **Add new token** under the **My tokens** section of the Token Manager Dashboard.
64+
65+
1. In the Token Manager Wizard, select **Deploy a new token** and click **Continue** in the lower right corner.
66+
67+
<ClickToZoom src="/images/ccip/token-manager/new/start-0.png" alt="Select deploy a new token" />
5668

5769
1. On the **Details** page, enter the details for the first network you're configuring for your token deployment:
5870

5971
- Select the network in the **Network** dropdown field.
60-
- Fill in the **Name** and **Symbol** fields to give your token its name and ticker symbol. For example, "Your Token" and "YOURS" respectively:
72+
- Fill in the **Name** and **Symbol** fields to give your token its name and ticker symbol. For example, "Your Token" and "YOURS" respectively.
73+
- Click **Continue**.
6174

62-
<ClickToZoom src="/images/ccip/token-manager/new/1-details.png" alt="Naming your new token" />- Click **Continue**.
75+
<ClickToZoom src="/images/ccip/token-manager/new/details-1.png" alt="Naming your new token" />
6376

6477
1. On the **Settings** page, configure your token's supply:
6578

6679
- Setting a supply cap is optional &mdash; toggle the button to enable it and specify an amount. The supply cap sets a maximum limit for the total number of tokens that can ever be minted for the token you're creating.
6780
- Specify an amount of tokens to mint during this initial deployment step.
6881
- Click **Continue**.
6982

70-
<ClickToZoom
71-
src="/images/ccip/token-manager/new/2-supply-cap-amount.png"
72-
alt="Setting token supply cap and amount to mint"
73-
/>
83+
<ClickToZoom src="/images/ccip/token-manager/new/settings-2.png" alt="Setting token supply cap and amount to mint" />
84+
85+
1. On the **Networks** page, select the additional blockchain network(s) where you'd like to deploy your new token and click **Continue**.
86+
87+
<ClickToZoom src="/images/ccip/token-manager/new/networks-3.png" alt="Selecting blockchain networks" />
88+
89+
1. On the **Owners** page, confirm the accounts that will be taking actions on each network. Click **Continue**.
90+
91+
<ClickToZoom src="/images/ccip/token-manager/new/owners-4.png" alt="Confirming network accounts" />
92+
93+
The default account is the currently connected wallet. However, you can have different accounts for each network depending on who you want to be the owner.
7494

75-
1. On the **Networks** page, select the additional blockchain network(s) where you'd like to deploy your new token:
76-
<ClickToZoom src="/images/ccip/token-manager/new/3-select-networks.png" alt="Selecting blockchain networks" />
7795
1. On the **Summary** page, you can review your upcoming deployments and transactions. Each network you've selected appears along with an expandable list of the transactions the Token Manager will guide you through to deploy your token for each network:
7896

79-
<ClickToZoom
80-
src="/images/ccip/token-manager/new/4-summary-upcoming-deployments.png"
81-
alt="Summary of upcoming deployments"
82-
/>
97+
<ClickToZoom src="/images/ccip/token-manager/new/summary-5.png" alt="Summary of upcoming deployments" />
8398

8499
Make sure that your wallet contains gas tokens for each network where you're deploying your token, in order to pay for the deployment transactions.
85100

86101
If you selected more than two networks during the previous step, the _Remove_ links are active, allowing you to remove a network before proceeding. If you only have two networks selected, the _Remove_ links are intentionally not active. If you need to add more networks, navigate back to the **Networks** page.
87102

88-
1. The **Deploy** page displays the steps that you need to complete. For each network, the Token Manager guides you through each of these steps in order:
103+
1. The **Deploy** page displays the steps that you need to complete for each network:
89104

90105
- Deploy token and pool
91106
- Accept admin role
92107
- Accept token ownership
93108
- Accept pool ownership
94109

95-
<ClickToZoom src="/images/ccip/token-manager/new/5-deployment-steps.png" alt="Deployment steps" />
110+
<ClickToZoom src="/images/ccip/token-manager/new/deployment-6.png" alt="Deployment steps" />
111+
112+
After the **Deploy token and pool** step is completed, you can initiate the other steps all at the same time by clicking **Accept** under each step. While these steps run concurrently, each step separately prompts you to confirm the corresponding transactions in your wallet.
96113

97-
At each step, you are prompted to confirm the corresponding transactions in your wallet. When each step is complete for all the networks you selected, the Token Manager marks them all as **Done**:
114+
Once all of the steps for one network have been initiated, you can switch to the other network and repeat the same process. You do not have to wait for the first network deploy process to be complete before initiating the second network deploy process.
98115

99-
<ClickToZoom src="/images/ccip/token-manager/new/6-all-networks-done.png" alt="Steps complete for all networks" />
116+
When the deploy process is complete for all the networks you selected, the Token Manager marks them all as **Done**:
117+
118+
<ClickToZoom src="/images/ccip/token-manager/new/done-7.png" alt="Steps complete for all networks" />
100119

101120
Click **Continue**. The Token Manager displays a message showing that your configuration was successful:
102121

@@ -106,6 +125,11 @@ When everything is successfully set up for your token, you can view your new Tok
106125

107126
After enabling your tokens, you can also use Transporter to perform transfers and import tokens with the contract address. Use [test.transporter.io](https://test.transporter.io) for testnet or [transporter.io](https://transporter.io) for mainnet.
108127

128+
<Aside type="note" title="Video Tutorial Available">
129+
Watch as a Chainlink Labs Developer Relations Engineer deploys a new token on multiple networks using a SAFE wallet
130+
with multiple signers! [View Video]()
131+
</Aside>
132+
109133
## Add an existing token
110134

111135
If you have existing token(s) that you've already deployed, you can use the Token Manager to create and configure a token pool for the token, and optionally deploy your token on additional networks. Note that tokens deployed to additional networks are automatically configured to use the Burn and Mint mechanism.

0 commit comments

Comments
 (0)