Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/begmaroman/nerif-bridge
Nerif Bridge is the decentralized cross-chain bridge powered by Nerif Network
https://github.com/begmaroman/nerif-bridge
blockchain bridge cross-chain dapp decentralized
Last synced: 3 minutes ago
JSON representation
Nerif Bridge is the decentralized cross-chain bridge powered by Nerif Network
- Host: GitHub
- URL: https://github.com/begmaroman/nerif-bridge
- Owner: begmaroman
- License: mit
- Created: 2023-05-01T13:11:15.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-05-04T16:59:51.000Z (almost 2 years ago)
- Last Synced: 2024-12-08T20:23:19.454Z (about 2 months ago)
- Topics: blockchain, bridge, cross-chain, dapp, decentralized
- Language: TypeScript
- Homepage:
- Size: 544 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nerif Bridge
Nerif Bridge is the decentralized cross-chain bridge powered by Nerif Network.
**DO NOT USE FOR PRODUCTION PURPOSES.**
This bridge setup does not have a proper security mechanisms, billing, and many other things that are needed for production use.
The current state of Nerif Bridge shows high level overview of the bridging architecture using [Nerif Network](https://nerif.network) and can be used for demo only.
## Set up
Bootstrapping the Nerif Bridge requires deploying several smart contracts and creating a special workflow within Nerif Network in order to power the bridge.
Bridge contracts deployment requires having [Gateway](https://github.com/nerifnetwork/contracts/blob/main/contracts/operational/Gateway.sol) contract already deployed and registered per [Registry](https://github.com/nerifnetwork/contracts/blob/main/contracts/operational/Registry.sol#L244) on both Goerli and Mumbai.
### Initialize environment
First aff all, run the following command in order to create all required environment files:
```bash
$ make init
```
As a results, the following files will be created: .env, contracts-5.json, contracts-80001.json.
Replace gateway address for the real one in those .json files. Specify real values in .env file.
Now the bridge contracts can be deployed:
```bash
$ VERIFY=true make deploy-bridge
```
As a result, [the bridge contract](./contracts/bridge/NerifBridge.sol) will be deployed on Goerli (5) and Mumbai (80001) chains.
Addresses are stored in those .json filed in the root of the repo.
### Create Nerif Network workflow
All needed contracts are deployed so those can be automated by Nerif Network.
It requires creating a bridging workflow that has the following logic:
1. Trigger workflow execution when `event Send(uint256 chainId, address target, bytes payload, uint256 gasAmount, address sender)` event is emitted on the Goerli chain within the bridge contract.
2. Add conditional step to check the given chain ID and exit the workflow if the value is not 80001.
3. Otherwise, send a transaction to the bridge contract deployed on Mumbai chain in order to execute `rec` function within the contract. Pass all required arguments coming from the event.
*Note: other steps could be added at the bridge owner's discretion.*
### Test
There is [the test receiver contract](./contracts/test/TestReceiver.sol) that can be deployed on those chains.
The following command deploys this contract on the Mumbai (80001) chain:
```bash
$ VERIFY=true make deploy-receiver
```
Test receiver contract address is stored in the contracts-80001.json file.
Now, the first test message can be sent be executing `send` function within the bridge contract deployed on goerli.
It can be done in many ways, but there is a command for sending a test message:
```bash
$ make send-message
```