@darwinia/dj
Advanced tools
dj is the CLI tool for Darwinia Bridge, which is a cross-chain bridge currently supports bidirectional cross chain relay between Ethereum and Darwinia.
Darwinia supports the cross-chain bridge of Ethereum by implementing an Ethereum light client(Darwinia ChainRelay) on its chain. Therefore, someone needs to submit the Ethereum block headers to this light client. dj is such a tool, anyone can use it to submit block headers to the Ethereum light client on Darwinia and get rewards.
Darwinia ChainRelay is a sub-linear light client, which means it does not store every block header of the blockchain it monitors. When initialized, it contains only one block, which is the genesis block. When a relayer submits a new block header, it might be the block header of height 10,000 or even higher. There are huge blanks in-between. If another relayer does not agree and submits a different block header claiming that's the block header data at the height of 10,000. How does ChainRelay resolve this conflict, and who is going to be the judge?
Once a block header is submitted, it provides block header hash and its mmr_root of all previous block header hashes till genesis block. Therefore, if a block header submission is in question, ChainRelay will challenge the relayer for a prior block header data or more specified by a sampling function. That block header hashes must be a leaf or leaves of previously submitted mmr_root. In this way, if an adversary tries to fool ChainRelay, he must prepare the whole chain, while each block must comply with consensus rule. The attack difficulty equals attacking the original blockchain network.
Ethereum Relay on Darwinia can verify specific transactions of Ethereum based on mmr_root, such as redeem of RING, KTON and deposit.
The redeem of KTON and RING is in the Issuing contract, and the redeem of the deposit is in the burnAndRedeem method of the GringottsBankV2 contract. BurnAndRedeem token need to pay the bridge fee, the basic token of the fees is RING. Therefore, it is necessary to approve a amount of RING to the Issuing contract before operation to ensure execution of the contract. Ethereum Relay on Darwinia confirms the amount of redeem, receiver, sender, etc. through the tx events in the verification.
It is recommended to use nvm for installing nodejs. version 8.x and above will be better.
yarn
A seed used to sign and send extrinsics. The easiest way is to generate an account in the web wallet and write down the mnemonic seed during the generation process. For more information, please refer to this tutorial.
(Optional) docker
(Optional) A local darwinia crab network node if you want to test with a local node.
yarn global add @darwinia/dj
Now you can type dj in your command-line:
> dj
dj <hello@darwinia.network>
Commands:
dj balance [address] Get balance of account address
dj config [edit] Show config
dj proposal <block> Submit a relay proposal to darwinia
dj transfer <address> <amount> Transfer RING to darwinia account
Options:
--help, -h Show help [boolean]
--version, -V Show version number
By default, dj is configured to point to the Infura Ethereum node and the official Darwinia crab network node. So you can immediately start using dj to submit Ethereum block headers to the Darwinia crab network and get rewards.
dj
When the dj command is executed for the first time, you will be asked to input a seed. At this time, you need to enter the seed you have prepared and press Enter to continue.
You can see the submission result in a few minutes. If ok appears, it means the submission is successful. If reject appears, xxx.
dj proposal
Submit a proposal to darwinia network. The proposal includes the target block header with its proof.
dj balance
Get the RING balance of your seed account.
dj transfer
Transfor RING to address from your seed account
dj config
Show your dj's current config.
If you want to change your seed, you need to find the configuration file <your home directory>/.darwinia/config.json . Open this file with an editor, replace the original seed and save it.
For more information about configuration, see the configuration section.
As mentioned earlier, dj configuration file is <your home directory>/.darwinia/config.json, there are three configuration items:
node
darwinia node websocket url.
seed
seed used to sign and send extrinsics by dj
shadow
shadow proposal endpoint ur
shadow is a service for dj to fetch ethereum headers with proof.
For more information about shadow, see the Shadow service section.
Run node
It is recommended to use docker to run Darwinia node.
Find the latest version from the releases, and then pull its docker image.
docker pull darwinianetwork/darwinia:v0.6.7
After the image is successfully pulled, run:
docker run -it -p 9944:9944 darwinianetwork/darwinia:v0.6.7 --chain crab --rpc-methods=unsafe --rpc-external=true --ws-external=true --rpc-cors=all
Now, you got a local node running locally, and wait for the sync to complete.
Edit dj's .darwinia/config.jsonto point it to your local node
Open the file with an editor and replace the node with ws://127.0.0.1:9944 and save it.
{
"node": "ws://127.0.0.1:9944",
"seed": "...",
"shadow": "..."
}
Under development, currently not supported
Shadow is a service used by dj to retrieve header data and generate proof. Shadow will index the data it needs from blockchain nodes, such as Ethereum and Darwinia.
dj uses the official shadow service by default, if you don’t want to use the official service, you can run the service yourself, and then configure dj to use it.
Install
# install rust and cargo
$ curl https://sh.rustup.rs -sSf | sh
# install shadow
$ cargo install darwinia-shadow
Run
shadow run --verbose --fetch
Edit dj's .darwinia/config.jsonto point it to your local shadow service
{
"node": "...",
"seed": "...",
"shadow": "http://0.0.0.0:3000/api/v1"
}
Run your darwinia node in dev
docker run -it -p 9944:9944 darwinianetwork/darwinia:v0.6.7 --chain crab-dev --rpc-methods=unsafe --rpc-external=true --ws-external=true --rpc-cors=all
Run your shadow service
shadow run --verbose --fetch
Configure your dj
Edit your .darwinia/config.json
{
"node": "ws://0.0.0.0:9944",
"seed": "//Alice",
"shadow": "http://0.0.0.0:3000/api/v1"
}
Run dj to submit header to your local dev node
dj
https://github.com/evolutionlandorg/common-contracts/blob/master/contracts/Issuing.sol
https://github.com/evolutionlandorg/bank/blob/master/contracts/GringottsBankV2.sol
event BurnAndRedeem(address indexed token, address indexed from, uint256 amount, bytes receiver);
The event generates at Issuing(token_redeem_address)
event BurnAndRedeem(uint256 indexed _depositID, address _depositor, uint48 _months, uint48 _startAt, uint64 _unitInterest, uint128 _value, bytes _data);
The event generates at GringottsBankV2(deposit_redeem_address)
ring_token_address): 0xb52FBE2B925ab79a821b261C82c5Ba0814AAA5e0kton_token_address): 0x1994100c58753793D52c6f457f189aa3ce9cEe94token_redeem_address): 0x49262B932E439271d05634c32978294C7Ea15d0Cdeposit_redeem_address): 0x6EF538314829EfA8386Fc43386cB13B4e0A67D1e[TBD]
dj is a typescript project. You need to install nodejs, yarn and ts-node and ready to go.
git clone https://github.com/darwinia-network/dj.git
cd dj
yarn install
ts-node index.ts help
# run dj
ts-node index.ts
# run dj subcommand
ts-node index.ts config
We are using GitHub Issues for bug tracking.
Before you report a bug, please make sure you've searched existing issues.
FAQs
Darwinia bridge relayer tool
We found that @darwinia/dj demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.