Gear Bridge is an implementation of a trustless ZK-based cross-chain bridge facilitating the transfer of assets between Ethereum and Gear-based blockchains, such as the Vara network.
Caution
This code has not yet been fully audited and therefore shouldn't be used in production.
Ethernal team have performed partial audit of the code, which covered the following scope for the commit d42251c:
- prover
plonky2
circuits for crypto primitivesethereum
smart-contracts
Warning
One of the conclusions of this audit was that malicious node which relayer is connected to can cause the proof generation process to be halt. So all deployed relayers MUST use their own dedicated gear node which is known to be non-malicious.
The Gear <-> Eth transfer protocol allows relaying messages from Gear-based blockchains to Ethereum and back. These messages contain generic data defined by protocols built on top of the bridge. The protocol doesn't guarantee the order in which messages are relayed.
This repository contains the implementation of a token bridging protocol built on top of a more generic messaging protocol.
- Pallet-Gear-Eth-Bridge Built-in Actor: a Built-in Actor - the entry point into the generic bridging protocol. Receives messages from any actor on the Gear network and relays them to
pallet-gear-eth-bridge
. - Pallet-Gear-Eth-Bridge: Receives messages from the
pallet-gear-eth-bridge
built-in actor and stores them in the binary Merkle trie. This Merkle trie gets slashed at the end of eachERA
. Also stores and updates hashedGRANDPA
authority set. - Relayer(proxy)1: Accepts proofs of Merkle trie root inclusion and, if they're valid, stores Merkle trie roots in memory. Deployed behind ERC-1967 Proxy.
- Verifier: A contract capable of verifying
plonk
proofs created by gnark. The submitted proofs are plonky2 proofs wrapped bygnark
. - MessageQueue(proxy)1: Used to recover messages from Merkle tries. A user can request a message to be relayed further onto Ethereum by providing proof of inclusion of a message actually included in the Merkle trie, given that this Merkle root was already relayed by
gear->eth protocol relayer
(or another party). This is also the exit point of the generic Gear -> Eth bridging protocol. - Checkpoint-Light-Client: Lazy ethereum light client that maintains
sync committee
validator list and is capable of verifying block headers using it. - Ethereum-Event-Client: Program on Gear that's capable of verifying that some event was included into some block. To check validity of the block it requests data from
checkpoint-light-client
. - Historical-Proxy: Program on Gear that maintains historical
ethereum-event-client
program addresses and redirects requests to aethereum-event-client
responsible of processing requested transaction. Serves as an exit point from core Ethereum -> Gear protocol. - Gear -> Eth Protocol Relayer: Reads Gear state, generates ZK-proofs, and submits them to Ethereum. Capable of creating two types of ZK-proofs: proof of authority set changes and proof of inclusion of Merkle trie root into the storage of
pallet-gear-eth-bridge
. Proofs of authority set changes are intermediate and stored in on-chainproof storage
while proofs of Merkle trie root inclusion are submitted to Ethereum. - Eth -> Gear Protocol Relayer: Relayer that monitors
sync committee
changes and blocks signed by it on Ethereum and updates state ofcheckpoint-light-client
using it.
- VFT: A program capable of transferring, burning, and minting
vft
tokens. It repeats the implementation of theERC20
standard on the Gear network, the standard implementationvft
can be found here. - VFT-Manager: Receives
vft
tokens from users, burns/locks them, and emits a message to thepallet-gear-eth-bridge
built-in actor. This message contains information about which token is being bridged, how much of it, and the recipient of funds on the Ethereum network. Also managesEth -> Gear
token transfers by verifying ethereum events usinghistorical-proxy
program and minting/unlocking corresponding tokens. It can work with both Ethereum and Gear supplied tokens. When token supply is based on Ethereum it will perform burns and mints of correspondingVFT
tokens. When token supply is based on Gear it will perform locks and unlocks of correspondingVFT
tokens. - ERC20Manager(proxy)1: Mirroring behaviour of
vft-manager
but on Ethereum side and without sending request to apallet-gear-eth-bridge
. - Bridging Payment: Program on Gear and smart-contract on Ethereum that have the same functions. When bridging request is sent to them, they collect fees and relay this request to the corresponding smart-contract/program responsible of executing this request. Then some
token relayer
can observe events signaling that request have been processed and fee is paid and process this request on the other chain, using its own funds as tx fees.bridging payment
services are fully in control of relayer that've deployed them, so to perform bridging using them one should trust the owner. - Gear -> Eth Token Relayer and Eth -> Gear Token Relayer: These relayers hook to the events produced by
bridging payment
services and perform cross-chain actions to guarantee message delivery. For example,gear -> eth token relayer
collects bridging fees from user on Gear. When merkle root that contain this message will be relayed to Ethereum, this relayer will send transaction to theMessageQueue
that will trigger transfer fromERC20Manager
to the user.
Workflow of Gear -> Ethereum
Token2 Transfer
- The user submits his bridging request to
frontend
frontend
submitsapprove
call to thevft
program. Approve should allowvft-manager
to spend amount of tokens that user have requested to bridge.frontend
submits user request to thebridging-payment
.bridging-payment
takes fee and submits a message to thevft-manager
to initiate bridging.- The
vft-manager
burns/locksvft
tokens and emits a message to thepallet-gear-eth-bridge
built-in actor. - The
pallet-gear-eth-bridge
built-in actor relays the message topallet-gear-eth-bridge
. - The
pallet-gear-eth-bridge
stores the message in a Merkle trie. - Eventually, the
gear->eth protocol relayer
(or another party) relays the message to theRelayer
contract, and it gets stored there. gear->eth token relayer
sees that user message was relayed and submits a Merkle proof of inclusion to theMessageQueue
contract.- The
MessageQueue
contract reads the Merkle root from theRelayer
contract, checks the Merkle proof, and relays the message to theERC20Manager
. - The
ERC20Manager
releases funds to the user's account on Ethereum.
Workflow of Ethereum -> Gear
Token2 Transfer
- The user submits his bridging request to
frontend
frontend
submitsapprove
call to the correspondingERC20
contract. Approve should allowBridgingPayment
to spend amount of tokens that user have requested to bridge.frontend
submits user request to theBridgingPayment
.- The
ERC20Manager
locks/burnsERC20
tokens and emits an event. - Eventually, the
eth->gear protocol relayer
(or another party) sumbits tocheckpoint-light-client
ethereum block which has block number bigger than one where event have been emitted. - Eventually, the
eth->gear token relayer
(or another party) submits this event tohistorical-proxy
historical-proxy
verifies this event by sending a message toethereum-event-client
.ethereum-event-client
verifies that block where event is present is a valid finalized block on ethereum by callingcheckpoint-light-client
.historical-proxy
routes user bridging request tovft-manager
vft-manager
sends message to avft
program that corresponds to aERC20
token that've been locked/burned in step 4. This message is eithertransfer
(in the case when token supply is on Gear) ormint
(in the case when token supply is on Ethereum).vft
program mints/transfers tokens to a user address.
Install rust:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Install golang: golang installation
Install forge:
curl -L https://foundry.paradigm.xyz | bash
foundryup
Note
To build ring
crate follow BUILDING.md.
Build workspace:
cargo build --release -p relayer
And then run
./target/release/relayer --help
to see required parameters to start different kinds of relayers.