Skip to content

Commit c8766c4

Browse files
just-a-nodegitbook-bot
authored andcommitted
GITBOOK-44: change request with no subject merged in GitBook
1 parent d77476f commit c8766c4

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

usecases/xerc20/setup-guide.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Hello! 👋 This document will guide you through the process of setting up your
44

55
## Prerequisites
66

7-
Let's begin by getting a comprehensive understanding of the steps to follow based on your token's current situation.
7+
Let's begin by getting a comprehensive understanding of the required steps based on your token's current situation.
88

99
#### 1. Categorize your token
1010

@@ -14,6 +14,12 @@ Determine which of the following categories best describes your token's current
1414
* **Category B**: The token already exists on one chain.
1515
* **Category C**: The token already exists on multiple chains.
1616

17+
{% hint style="info" %}
18+
If you want to spin up an `xERC20` on testnet, the category may be different from your mainnet token. We recommend emulating your mainnet token setup if your goal is to testrun the process on testnet.\
19+
\
20+
For example: on mainnet, your token `TKN`is deployed to Ethereum already (**Category B**). Then on testnet, you should deploy a `TKN` to Goerli and follow the steps for a **Category B** token.
21+
{% endhint %}
22+
1723
#### 2. Define your token's "home" chain
1824

1925
Based on your token's category:
@@ -59,15 +65,33 @@ Bridging from Arbitrum to Ethereum:
5965

6066
## Deploying Contracts
6167

62-
{% hint style="info" %}
63-
The [ERC-7281](https://github.com/ethereum/EIPs/pull/7281) specification requires compliant tokens to implement the ERC-20 interface along with some additional rate limit interfaces.
64-
{% endhint %}
65-
6668
Now that you have an idea of how your tokens should be set up, let's move on to the actual deployment procedures. 
6769

6870
#### xERC20s and Lockboxes
6971

70-
Connext provides an [xERC20 Github repository](https://github.com/connext/xERC20) that contains implementations of `xERC20`, `Lockbox`, and scripts to deploy them. We suggest you deploy from a fork of this repo. See the `README` for instructions. You will configure the scripts based on which chains you need to have Lockbox setups.
72+
Connext provides an [xERC20 Github repository](https://github.com/connext/xERC20) that contains fully compliant implementations of `xERC20`, `Lockbox`, and scripts to deploy them. We suggest you deploy from a fork of this repo. See the `README` for instructions. You will configure the scripts based on which chains you need to have Lockbox setups.
73+
74+
{% hint style="info" %}
75+
The [ERC-7281](https://github.com/ethereum/EIPs/pull/7281) specification requires compliant tokens to implement ERC-20 along with mint/burn and some additional rate limit interfaces. The absolute _minimal_ interface needed is the ERC-20 interface plus mint/burn:
76+
77+
```solidity
78+
/**
79+
* @notice Mints tokens for a user
80+
* @dev Can only be called by a bridge
81+
* @param _user The address of the user who needs tokens minted
82+
* @param _amount The amount of tokens being minted
83+
*/
84+
function mint(address _user, uint256 _amount) external;
85+
86+
/**
87+
* @notice Burns tokens for a user
88+
* @dev Can only be called by a bridge
89+
* @param _user The address of the user who needs tokens burned
90+
* @param _amount The amount of tokens being burned
91+
*/
92+
function burn(address _user, uint256 _amount) external;
93+
```
94+
{% endhint %}
7195

7296
#### LockboxAdapter
7397

0 commit comments

Comments
 (0)