Skip to content

Commit 16343fc

Browse files
committed
chg: update README
1 parent 384493f commit 16343fc

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

README.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,43 @@
11
# fx-portal
22
FxPortal for Matic chain. No mapping. Seamless.
33

4-
## How Matic state transfer works?
4+
**Warning:** Code is not audited.
55

6-
## Why they are many bridges?
6+
### What is FxChild and FxRoot?
77

8-
## Can I built my own bridge?
8+
`FxChild` and `FxRoot` are main contracts on which mapping-less bridge works. It calls and passes data to user-defined methods on another chain without mapping.
99

10-
## What is Fx bridge (fx-portal)?
10+
I have already deployed both contracts:
11+
12+
**Mumbai**
13+
14+
[FxRoot (Goerli)](https://goerli.etherscan.io/address/0x3d1d3E34f7fB6D26245E6640E1c50710eFFf15bA#code): `0x3d1d3E34f7fB6D26245E6640E1c50710eFFf15bA`
15+
16+
[FxChild (Mumbai)](https://explorer-mumbai.maticvigil.com/address/0xCf73231F28B7331BBe3124B907840A94851f9f11/contracts): `0xCf73231F28B7331BBe3124B907840A94851f9f11`
17+
18+
**Mainnet**
19+
20+
[FxRoot (Ethereum Mainnet)](https://etherscan.io/address/0xfe5e5d361b2ad62c541bab87c45a0b9b018389a2#code): `0xfe5e5D361b2ad62c541bAb87C45a0B9B018389a2`
21+
22+
[FxChild (Matic Mainnnet)](https://explorer-mainnet.maticvigil.com/address/0x8397259c983751DAf40400790063935a11afa28a/contracts): `0x8397259c983751DAf40400790063935a11afa28a`
23+
24+
25+
26+
### How Matic state transfer works?
27+
28+
### Why they are many bridges?
29+
30+
### Can I built my own bridge?
31+
32+
### What is Fx bridge (fx-portal)?
1133

1234
Meta bridge :)
1335

1436
Bridge which allows any type of state sync without mapping.
1537

16-
## What can I build with it?
38+
### What can I build with it?
39+
40+
* Arbitrary state bridge (examples/state-transfer)
41+
* Normal ERC20 bridge (examples/erc2-transfer)
42+
* ERC20 token generator bridge (example/mintable-erc20-transfer)
1743

18-
* ERC20 bridge
19-
* Mintable ERC20 bridge
20-
* Token generator (dynamic ERC20 token creator without new mapping)

0 commit comments

Comments
 (0)