Skip to content

Commit aa51600

Browse files
authored
Merge pull request 0xPolygon#258 from 0xPolygon/mapping-requst-update
PoS - Token mapping
2 parents 2b23f1c + 955dcf7 commit aa51600

File tree

7 files changed

+34
-36
lines changed

7 files changed

+34
-36
lines changed

docs/img/pos/token-mapping-1.png

28.8 KB
Loading

docs/img/pos/token-mapping-2.png

18.5 KB
Loading

docs/img/pos/token-mapping-3.png

19.1 KB
Loading

docs/pos/how-to/bridging/ethereum-polygon/ethereum-to-matic.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
The mechanism to natively read Ethereum data from Polygon EVM chain is that of ‘State Sync’. In other words, this mechanism enables transfer of arbitrary data from Ethereum chain to Polygon chain. The procedure that makes it possible is: Validators on the Heimdall layer are listening for a particular event — `StateSynced` from a Sender contract, as soon as the event is picked, the `data` that was passed in the event is written on the Receiver contract. Read more [here](../../../architecture/bor/state-sync.md).
22

3-
The Sender and Receiver contract are required to be mapped on Ethereum — [StateSender.sol](https://github.com/maticnetwork/contracts/blob/release-betaV2/contracts/root/stateSyncer/StateSender.sol) needs to be aware of each sender and receiver. If you'd like to get the mapping done, please request a mapping [here](https://mapper.polygon.technology/).
3+
The Sender and Receiver contract are required to be mapped on Ethereum — [StateSender.sol](https://github.com/maticnetwork/contracts/blob/release-betaV2/contracts/root/stateSyncer/StateSender.sol) needs to be aware of each sender and receiver.
4+
5+
!!! tip "Custom tokens"
6+
7+
Looking to bridge your custom token to Polygon PoS using the official bridge? Check out the guide on [how to submit a request to get your token mapped](../ethereum-polygon/submit-mapping-request.md).
48

59
---
610

@@ -109,9 +113,9 @@ Deploy your Receiver.sol on Polygon's testnet and keep a note of the address an
109113
110114
### 3. Getting your Sender and Receiver mapped
111115
112-
You can either use the already deployed addresses (mentioned above) for sender and receiver, or deploy your custom contracts and request a mapping done here: [https://mapper.polygon.technology/](https://mapper.polygon.technology/)
116+
You can either use the already deployed addresses (mentioned above) for sender and receiver, or deploy your custom contracts and request a mapping using [the Google form here](https://docs.google.com/forms/d/e/1FAIpQLSeq8HTef2dYpRx35_WWYhyr4C146K9dfhyYJQcoD1RuTTVABg/viewform).
113117
114-
### 4. Sending and Receiving data
118+
### 4. Sending and receiving data
115119
116120
Now that we have our contracts in place and mapping done, we'll be writing a simple node script to send arbitrary hex bytes, receive them on Polygon and interpret the data!
117121
Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
Polygon brings you a trustless two-way transaction channel between Polygon PoS and Ethereum by introducing the cross-chain bridge. With this users can transfer tokens across Polygon PoS without incurring third-party risks and market liquidity limitations.
1+
Polygon brings you a trustless two-way transaction channel between Polygon PoS and Ethereum by introducing the cross-chain bridge. The official bridge allows you to transfer tokens between Ethereum and Polygon PoS without incurring third-party risks and market liquidity limitations.
22

3-
The PoS Bridge is available on both Mumbai Testnet as well as Polygon PoS Mainnet. You can access it and bridge assets over to Polygon PoS using the [Polygon Wallet Suite](https://wallet.polygon.technology/polygon/bridge/deposit).
3+
The official bridge is available on both Mumbai Testnet as well as Polygon PoS Mainnet, and provides a near-instant, low-cost, and flexible bridging option for both users and dApp developers. You can access it and bridge assets from Ethereum over to Polygon PoS using [Polygon Portal](https://portal.polygon.technology).
44

5-
Polygon PoS bridge provides a bridging mechanism that is near-instant, low-cost, and quite flexible.
5+
!!! tip "Polygon Portal"
66

7-
There is no change to the circulating supply of your token when it crosses the bridge;
7+
To learn more about the features that Polygon Portal offers, and a series of step-by-step reference guides that help you with using the platform, check out [the doc available here](../../../../tools/wallets/portal.md).
88

9-
- Tokens that leave the Ethereum network are locked and the same number of tokens are minted on Polygon PoS as a pegged token (1:1).
10-
- To move the tokens back to the Ethereum network, tokens are burned on Polygon PoS network and unlocked on Ethereum network during the process.
9+
There is no change to the circulating supply of your token when it crosses the bridge. This is what goes on in the background when you bridge your tokens over to Polygon PoS from Ethereum:
1110

12-
## Additional Resources
11+
- When depositing, tokens that leave the Ethereum network are locked and the same number of tokens are minted on Polygon PoS as a pegged token (1:1).
12+
- When withdrawing tokens back to the Ethereum network, tokens are burned on Polygon PoS and unlocked on Ethereum during the process.
13+
14+
## Additional resources
1315

1416
- [Introduction to Blockchain Bridges](https://ethereum.org/en/bridges/)
1517
- [What are Cross-Chain Bridges](https://www.alchemy.com/overviews/cross-chain-bridges)
Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,29 @@
1-
Mapping is necessary in order to transfer your assets to and from Ethereum and Polygon PoS. We offer two bridges to do the same. More details on the bridge can be understood [here](index.md).
1+
Token mapping is important in order to enable the transfer mechanism for the said token between Ethereum and Polygon PoS.
22

3-
!!!info
3+
!!! info
44

5-
The Polygon PoS bridge is available for both Polygon Mainnet as well as Mumbai Testnet.
5+
- For more information on how bridging works in the background, see [the doc available here](../index.md).
6+
- Thinking about bridging another popular token? Refer to the [reference guide on Polygon Portal](../../../../tools/wallets/portal.md).
67

78
## Steps to submit a mapping request
89

9-
In order to map tokens between Ethereum and Polygon PoS, you may use the [Polygon Token Mapper](https://mapper.polygon.technology/). Open the link and click on the **Map New Token** button on the top right corner to initiate a new mapping request.
10+
1. To submit a request for mapping your token on Polygon PoS, start by navigating to [the Google form available here](https://docs.google.com/forms/d/e/1FAIpQLSeq8HTef2dYpRx35_WWYhyr4C146K9dfhyYJQcoD1RuTTVABg/viewform).
1011

11-
![image](https://github.com/0xPolygon/wiki/assets/104004697/c530ceed-cf6a-4c5e-a3fe-b493eef1c761)
12+
2. Choose a "Network" option depending upon the chain on which you're looking to map your token. This would be **"Sepolia <> Polygon Amoy"** for testnet, and **"Ethereum <> Polygon PoS"** for mainnet.
1213

13-
Click on Raise Mapping Request (a Google Form pops up).
14+
![](../../../../img/pos/token-mapping-1.png)
1415

15-
![image](https://github.com/0xPolygon/wiki/assets/104004697/0c08656f-3ffd-43ee-819e-722786d7015d)
16+
3. Next, input the contract address for the token contract that you've deployed on Sepolia/Ethereum mainnet in the "Root Contract Address (L1)" field.
1617

17-
**Step 1 &rarr;** Choose the network on which you want to map your token. You may choose **Goerli-Mumbai** for Testnet, and **Ethereum-Polygon PoS** for the Mainnet.
18+
![](../../../../img/pos/token-mapping-2.png)
1819

19-
**Step 2 &rarr;** Select the type of token you are mapping - **ERC20**, **ERC721**, or **ERC1155**.
20+
4. Choose the correct "Token Type" for your token. i.e., [ERC-20](https://eips.ethereum.org/EIPS/eip-20) for a standard token, [ERC-721](https://eips.ethereum.org/EIPS/eip-721) for an NFT, or [ERC-1155](https://eips.ethereum.org/EIPS/eip-1155) for a multi token.
2021

21-
**Step 2 &rarr;** Enter your **Ethereum/Goerli** token address in the **Root Contract Address (L1)** field. Make sure your token contract code has been verified on the **Ethereum/Goerli** blockchain explorers.
22+
![](../../../../img/pos/token-mapping-3.png)
2223

23-
**Step 4 &rarr;** After adding the Select the type of token you are mapping - **ERC20**, **ERC721**, or **ERC1155**.
24+
5. Finally, select "Submit" to send in your request. The Polygon team will review your mapping request, and get back to you with a response. This generally takes up to 7 days.
2425

25-
**Step 5 &rarr;** Now, click on the **Submit** button to initiate the mapping process. Our team will review the mapping request and get back to you in 7 days.
26+
!!! info "Token list"
2627

27-
For a successful Mainnet mapping, you may provide your token details [here](https://github.com/maticnetwork/polygon-token-list/issues/new/choose) to be added on the [**Polygon Token List**](https://api-polygon-tokens.polygon.technology/tokenlists/polygonTokens.tokenlist.json).
28-
29-
## Video Guide
30-
31-
Here is a quick video tutorial on how to map tokens between **Ethereum Goerli &harr; Polygon Mumbai Testnet**:
32-
33-
<video autoplay width="100%" height="100%" controls="true" >
34-
<source type="video/mp4" src="/img/token-mapping/token-mapper.mp4"></source>
35-
<p>Your browser does not support the video element.</p>
36-
</video>
28+
- Check out the list of supported tokens available in JSON format by following this URL: https://api-polygon-tokens.polygon.technology/tokenlists/polygonTokens.tokenlist.json
29+
- Once approved, your token will be added to the above list!

docs/pos/reference/mapped-tokens.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
This document provides examples of token mappings on the Polygon PoS and Mumbai testnet.
22

3-
!!!tip
4-
Mapping
3+
!!!tip "Token mapping"
54

6-
If you want to get your token mapped then please send your mapping request via [<ins>mapper.polygon.technology</ins>](https://mapper.polygon.technology/).
5+
Want to get a custom token mapped to Polygon PoS so it can be bridged over? Send in your mapping request via [this Google form](https://docs.google.com/forms/d/e/1FAIpQLSeq8HTef2dYpRx35_WWYhyr4C146K9dfhyYJQcoD1RuTTVABg/viewform).
76

87

98
### Mumbai
109

11-
| Token Name | Bridge | Parent Chain Address: Goerli | Child Chain: MUMBAI |
10+
| Token name | Bridge | Parent chain address: Goerli | Child chain: MUMBAI |
1211
| ----------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
1312
| PoS\-WETH | PoS | [0x60D4dB9b534EF9260a88b0BED6c486fe13E604Fc](https://goerli.etherscan.io/address/0x60D4dB9b534EF9260a88b0BED6c486fe13E604Fc) | [0xA6FA4fB5f76172d178d61B04b0ecd319C5d1C0aa](https://mumbai.polygonscan.com/address/0xA6FA4fB5f76172d178d61B04b0ecd319C5d1C0aa) |
1413
| DummyERC20Token | PoS | [0x655F2166b0709cd575202630952D71E2bB0d61Af](https://goerli.etherscan.io/address/0x655F2166b0709cd575202630952D71E2bB0d61Af) | [0xfe4F5145f6e09952a5ba9e956ED0C25e3Fa4c7F1](https://mumbai.polygonscan.com/address/0xfe4F5145f6e09952a5ba9e956ED0C25e3Fa4c7F1) |

0 commit comments

Comments
 (0)