This tutorial uses the Matic Testnet ( Mumbai ) which is mapped to the Goerli Network to demonstrate the asset transfer to and fro the two blockchains. An important thing to be noted while following this tutorial is that you should always use a Proxy address whenever it is available. For eg. The RootChainManagerProxy address has to be used for interaction instead of the RootChainManager address. The PoS contract addresses, ABI, Test Token Addresses and other deployment details of the PoS bridge contracts can be found here.
Mapping your assets is necessary to integrate the PoS bridge on your application. You can submit a mapping request here. But for the purpose of this tutorial, we have already deployed the Test tokens and Mapped then on the PoS bridge. You may need it for trying out the tutorial on your own. You can request the desired Asset from the faucet. If the test tokens are unavailable on the faucet, do reach us on discord
In the upcoming tutorial, every step will be explained in detail along with a few code snippets. However, you can always refer to this repository which will have all the example source code that can help you to integrate and understand the working of PoS bridge.
High Level Flow
Deposit ERC1155 -
- Approve ERC1155Predicate contract to spend the tokens that have to be deposited.
- Make depositFor call on RootChainManager.
Withdraw ERC1155 -
- Burn tokens on matic chain.
- Call exit function on RootChainManager to submit proof of burn transaction. This call can be made after checkpoint is submitted for the block containing burn transaction.
Configuring Matic SDK
Install Matic SDK (2.0.2)
While creating MaticPOSClient object network,version,maticProvider, parentProvider, posERC1155Predicate and posRootChainManager need to be provided.
The configuration file should be structured like this. Make sure you add your Address, Privatekey and Goerli RPC into this file.
This is a normal ERC1155 approval so that ERC1155Predicate can call transferFrom function. Matic POS client exposes approveERC1155ForDeposit method to make this call.
Deposit can be done by calling depositFor on RootChainManager contract. Note that token needs to be mapped and approved for transfer beforehand. Once tokens are transferred deposit proceeds using StateSync mechanism. Matic POS client exposes depositSingleERC1155ForUser & depositBatchERC1155ForUser method to make this call.
deposit function of ChildToken is called by the ChildChainManager. Tokens should be minted when this call is made.
NOTE: Deposits from Ethereum to Matic happen using a state sync mechanism and takes about ~5-7 minutes. After waiting for this time interval, it is recommended to check the balance using web3.js/matic.js library or using Metamask. The explorer will show the balance only if at least one asset transfer has happened on the child chain. This link explains how to track the deposit events.
User can call withdraw function of ChildToken contract. This function should burn the tokens. Matic POS client exposes burnSingleERC1155 & burnBatchERC1155 method to make this call.
Store the transaction hash for this call and use it while generating burn proof.
Once the checkpoint has been submitted for the block containing burn transaction, user should call the exit function of RootChainManager contract and submit the proof of burn. Upon submitting valid proof tokens are transferred to the user. Matic POS client exposes exitBatchERC1155 & exitSingleERC1155 method to make this call. This function can be called only after the checkpoint is included in the main chain. The checkpoint inclusion can be tracked by following this guide.