Skip to content

Latest commit

 

History

History
114 lines (79 loc) · 2.98 KB

README.md

File metadata and controls

114 lines (79 loc) · 2.98 KB
Raw

Ethereum Contracts

This directory contains smart contracts utilized by the Polkadot-Ethereum Bridge.

  • Bridge.sol: application registry and routing of messages from Substrate
  • Application.sol: an abstract contract that must be implemented by any Bridge application
    • ETHApp.sol: application for cross-chain ETH transfers between Ethereum and Substrate
    • ERC20App.sol: application for cross-chain ERC20 transfers between Ethereum and Substrate
  • Decoder.sol: a library for decoding SCALE encoded data
  • Verifier.sol: verifies tx origin and signatures
  • Scale.sol: implements decoding of SCALE encoded compact uints; not currently used, included to support future work on generalized data relay

Set up

After starting the blockchain and deploying the contracts, the Bridge's Ethereum component is ready for usage.

Install Ganache

yarn global add ganache-cli

Install dependencies with yarn:

yarn install

Set up .env file. Note that deploying to ropsten network requires modifying the INFURA_PROJECT_ID and MNEMONIC environment variables.

cp .env.example .env

Start a ganache instance:

ganache-cli \
    --port=9545 \
    --blockTime=0 \
    --networkId=344 \
    --deterministic \
    --mnemonic='stone speak what ritual switch pigeon weird dutch burst shaft nature shove'

Open a fresh terminal window and deploy the contracts:

truffle migrate --all

Testing

Make sure the truffle environment is running, then run tests

# Start testing environment if it's not already running
ganache-cli \
    --port=9545 \
    --blockTime=0 \
    --networkId=344 \
    --deterministic \
    --mnemonic='stone speak what ritual switch pigeon weird dutch burst shaft nature shove'

# In a new terminal, test application gas expenditures
truffle test test/test_gas.js

# Run all tests
truffle test

Scripts

The project includes several scripts for Bridge interaction:

getTx.js gets information about a transaction

truffle exec scripts/getTx.js [tx-hash]

getEthBalance.js gets an address' ETH balance

truffle exec scripts/getEthBalance.js [ethereum-address]

getERC20balance.js gets an address' ERC20 token balance

truffle exec scripts/getERC20Balance.js [ethereum-address] [token-contract-address]

sendEth.js deposits ETH into the ETHApp, initiating a cross-chain transfer to Substrate

truffle exec scripts/sendEth.js [amount] [polkadot-recipient]

sendERC20.js deposits ERC20 tokens into the ERC20App, initiating a cross-chain transfer to Substrate

truffle exec scripts/sendERC20.js [amount] [token-contract-address] [polkadot-recipient]

Autogenerated Documentation

Solidity documentation can be autogenerated using the solidity-docgen library. It will generate markdown files from the contracts directory and output them to the docs directory.

# The library is only compatible with npx
npx solidity-docgen