Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: updating readme with bridging info #120

Merged
merged 2 commits into from
Mar 1, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ The changelog leading to the implementation of `wveOLAS` can be found here: [Cha

To complement, a list of known vulnerabilities can be found here: [Vulnerabilities list](https://github.com/valory-xyz/autonolas-governance/blob/main/docs/Vulnerabilities_list_governance.pdf?raw=true)

In order to manage cross-bridge transactions via the `Timelock` contract on the Polygon network, the Fx Governor Tunnel contract is implemented:
- [FxGovernorTunnel](https://github.com/valory-xyz/autonolas-governance/blob/main/contracts/bridges/FxGovernorTunnel.sol).

In order to manage cross-bridge transactions via the `Timelock` contract on the Gnosis network, the Home Mediator contract is implemented:
- [HomeMediator](https://github.com/valory-xyz/autonolas-governance/blob/main/contracts/bridges/HomeMediator.sol).
In order to manage cross-bridge transactions via the `Timelock` contract on L2 networks, the following contracts are implemented:
- Polygon PoS: [FxGovernorTunnel](https://github.com/valory-xyz/autonolas-governance/blob/main/contracts/bridges/FxGovernorTunnel.sol);
- Gnosis: [HomeMediator](https://github.com/valory-xyz/autonolas-governance/blob/main/contracts/bridges/HomeMediator.sol);
- Optimism and Base: [OptimismMessenger](https://github.com/valory-xyz/autonolas-governance/blob/main/contracts/bridges/OptimismMessenger.sol);
- L2 networks without own native bridge: [WormholeMessenger](https://github.com/valory-xyz/autonolas-governance/blob/main/contracts/bridges/WormholeMessenger.sol);

The functionality thereby enabled is outlined in detail here: [Cross-chain governance: from Ethereum to Polygon](https://github.com/valory-xyz/autonolas-governance/blob/main/docs/governace_bridge.pdf?raw=true).

Expand Down Expand Up @@ -231,6 +231,10 @@ The governance contracts and the rest was inspired and based on the following so
- [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts).

The bridging contracts were based on and inspired by the following sources:
- [Polygon](https://github.com/maticnetwork).
- [fx-portal](https://github.com/fx-portal).
- [Gnosis Chain Docs](https://docs.gnosischain.com/bridges/tokenbridge/amb-bridge).
- [Polygon](https://github.com/maticnetwork);
- [fx-portal](https://github.com/fx-portal);
- [Gnosis Docs](https://docs.gnosischain.com/bridges/tokenbridge/amb-bridge);
- [Arbitrum Docs](https://docs.arbitrum.io);
- [Optimism Docs](https://docs.optimism.io);
- [Base Docs](https://docs.base.org);
- [Wormhole Docs](https://docs.wormhole.com/).
Loading