Skip to content

Commit d623db7

Browse files
authored
ZIL-5471: Bridge - move back to pnpm + reorgnise repo + check finalised blocks (#280)
* migrate back to pnpm * add checks for finalised blocks * Reorganise files + add roadmap on readme * fix readme
1 parent 65049f8 commit d623db7

28 files changed

+4349
-8569
lines changed

pnpm-lock.yaml

-13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

products/bridge/README.md

+45
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,48 @@ The middle layer are cross-chain applications that use the cross-chain conctract
193193
- the twin contract checks the expiration and whether the approved token and amount are as required, transfers the amount to user 1 and returns true as response
194194
- the swap contract on Zilliqa receives the response of its twin and transfers the locked amount to user 2
195195
- if the swap contract does not receive a response from its twin before the expiration, user 1 can claim the approved amount and the swap contract sends it back to user 1
196+
197+
## Roadmap
198+
199+
The bridge will have the following deliverables:
200+
201+
- **Smart Contracts** – these will be written with the combination of:
202+
- Hardhat - E2E testing + deployment
203+
- Foundry - Unit testing + fuzzing + invariant testing + gas reporting
204+
- **Validator Node Lib**
205+
- Written in Rust
206+
- Should encapsulate most functionality required for a validator to run the bridge protocol
207+
- **Off-chain Validator Nodes**
208+
- Written in Rust
209+
- Will use `Validator Node Lib` as a dependency for most shared code
210+
- This will run the validator set
211+
- Signature aggregation through a gossip network
212+
- Validators run by Zilliqa
213+
- **Frontend DApp**
214+
- Written in React
215+
- Simple DApp enabling bridge activities
216+
- **Integrate bridge into ZQ2 consensus**
217+
- Integrate `Validator Node Lib`
218+
- Migrate validators to ZQ2 once released and stable
219+
220+
### MVP
221+
222+
The MVP bridge will run on a gossip network with validators managed by Zilliqa
223+
224+
- [ ] **Smart Contracts** - on hardhat (E2E testing & deployment) + foundry (Unit testing + fuzzing)
225+
- [ ] Integrate foundry to support effective unit testing on contracts
226+
- [ ] Finish remaining TODO tests
227+
- [ ] Write deployment scripts
228+
- [ ] Support CREATE2
229+
- [ ] [Deterministic Deployment Proxy](https://github.com/Arachnid/deterministic-deployment-proxy)
230+
- [ ] Integrate mechanism for gas reversal
231+
- [ ] Multichain support - appending chain-ids to event calls
232+
- [ ] Fuzz + variant testing
233+
- [ ] **Off-Chain Validator Nodes** & **Validator Node Lib**
234+
- Binary and lib would be developed together. Lib will be refactored out later to be used for ZQ2
235+
- [ ] Determine type of connection to use to connect to non-zilliqa chains
236+
- Light node/client? [helios](https://github.com/a16z/helios)
237+
- [ ] P2P network for sharing signatures - [rust-libp2p](https://github.com/libp2p/rust-libp2p)
238+
- [ ] Read & Write to chains
239+
- [ ] **Frontend DApp**
240+
- [ ] Boilerplate setup (Vite React with Rainbow Kit)

0 commit comments

Comments
 (0)