Chainbridge-core is the project that was born from the existing version of Chainbridge. It was built to improve the maintainability and modularity of the current solution. The fundamental distinction is that chainbridge-core is more of a framework rather than a stand-alone application.
Project still in deep beta
- Chat with us on discord.
Refer to installation guide for assistance in installing.
The chainbridge-core-example currently supports two modules:
Since chainbridge-core is the modular framework it will require writing some code to get it running. Here you can find some examples
Metrics, in chainbridge-core are handled via injecting metrics provider compatible with Metrics interface into Relayer instance. It currently needs only one method, TrackDepositMessage(m *message.Message)
which is called inside relayer router when a Deposit event appears and should contain all necessary metrics data for extraction in custom implementations.
chainbridge-core provides already implemented metrics provider via OpenTelemetry that is vendor-agnostic. It sends metrics to a separate collector that then sends metrics via configured exporters to one or many metrics back-ends.
This module provides instruction for communicating with EVM-compatible chains.
Usage:
evm-cli [command]
Available Commands:
accounts Account instructions
admin Admin-related instructions
bridge Bridge-related instructions
deploy Deploy smart contracts
erc20 ERC20-related instructions
erc721 ERC721-related instructions
utils Utils-related instructions
Flags:
-h, --help help for evm-cli
Account instructions, allowing us to generate keypairs or import existing keypairs for use.
Usage:
evm-cli accounts [command]
Available Commands:
generate Generate bridge keystore (Secp256k1)
import Import bridge keystore
transfer Transfer base currency
Flags:
-h, --help help for accountsThe generate subcommand is used to generate the bridge keystore. If no options are specified, a Secp256k1 key will be made.
Usage:
evm-cli accounts generate [flags]
Flags:
-h, --help help for generateThe import subcommand is used to import a keystore for the bridge.
Usage:
evm-cli accounts import [flags]
Flags:
-h, --help help for import
--password string password to encrypt withThe generate subcommand is used to transfer the base currency.
Usage:
evm-cli accounts transfer [flags]
Flags:
--amount string transfer amount
--decimals uint base token decimals (default 18)
-h, --help help for transfer
--recipient string recipient address
Admin-related instructions.
Usage:
evm-cli admin [command]
Available Commands:
add-admin Add a new admin
add-relayer Add a new relayer
is-relayer Check if an address is registered as a relayer
pause Pause deposits and proposals
remove-admin Remove an existing admin
remove-relayer Remove a relayer
set-fee Set a new fee for deposits
set-threshold Set a new relayer vote threshold
unpause Unpause deposits and proposals
withdraw Withdraw tokens from a handler contract
Flags:
-h, --help help for adminAdd a new admin.
Usage:
evm-cli admin add-admin [flags]
Flags:
--admin string address to add
--bridge string bridge contract address
-h, --help help for add-adminAdd a new relayer.
Usage:
evm-cli admin add-relayer [flags]
Flags:
--bridge string bridge contract address
-h, --help help for add-relayer
--relayer string address to addCheck if an address is registered as a relayer.
Usage:
evm-cli admin is-relayer [flags]
Flags:
--bridge string bridge contract address
-h, --help help for is-relayer
--relayer string address to checkPause deposits and proposals,
Usage:
evm-cli admin pause [flags]
Flags:
--bridge string bridge contract address
-h, --help help for pause
Remove an existing admin.
Usage:
evm-cli admin remove-admin [flags]
Flags:
--admin string address to remove
--bridge string bridge contract address
-h, --help help for remove-adminRemove a relayer.
Usage:
evm-cli admin remove-relayer [flags]
Flags:
--bridge string bridge contract address
-h, --help help for remove-relayer
--relayer string address to removeSet a new fee for deposits.
Usage:
evm-cli admin set-fee [flags]
Flags:
--bridge string bridge contract address
--fee string New fee (in ether)
-h, --help help for set-feeSet a new relayer vote threshold.
Usage:
evm-cli admin set-threshold [flags]
Flags:
--bridge string bridge contract address
-h, --help help for set-threshold
--threshold uint new relayer thresholdUnpause deposits and proposals.
Usage:
evm-cli admin unpause [flags]
Flags:
--bridge string bridge contract address
-h, --help help for unpauseWithdraw tokens from a handler contract.
Usage:
evm-cli admin withdraw [flags]
Flags:
--amount string token amount to withdraw. Should be set or ID or amount if both set error will occur
--bridge string bridge contract address
--decimals uint ERC20 token decimals
--handler string handler contract address
-h, --help help for withdraw
--id string token ID to withdraw. Should be set or ID or amount if both set error will occur
--recipient string address to withdraw to
--token string ERC20 or ERC721 token contract address
Bridge-related instructions.
Usage:
evm-cli bridge [command]
Available Commands:
cancel-proposal Cancel an expired proposal
query-proposal Query an inbound proposal
query-resource Query the contract address
register-generic-resource Register a generic resource ID
register-resource Register a resource ID
set-burn Set a token contract as mintable/burnable
Flags:
-h, --help help for bridgeCancel an expired proposal.
Usage:
evm-cli bridge cancel-proposal [flags]
Flags:
--bridge string bridge contract address
--domainId uint domain ID of proposal to cancel
--dataHash string hash of proposal metadata
--depositNonce uint deposit nonce of proposal to cancel
-h, --help help for cancel-proposalQuery an inbound proposal.
Usage:
evm-cli bridge query-proposal [flags]
Flags:
--bridge string bridge contract address
--domainId uint source domain ID of proposal
--dataHash string hash of proposal metadata
--depositNonce uint deposit nonce of proposal
-h, --help help for query-proposalQuery the contract address with the provided resource ID for a specific handler contract.
Usage:
evm-cli bridge query-resource [flags]
Flags:
--handler string handler contract address
-h, --help help for query-resource
--resourceId string resource ID to queryRegister a resource ID with a contract address for a generic handler.
Usage:
evm-cli bridge register-generic-resource [flags]
Flags:
--bridge string bridge contract address
--deposit string deposit function signature (default "0x00000000")
--depositerOffset int depositer address position offset in the metadata, in bytes
--execute string execute proposal function signature (default "0x00000000")
--handler string handler contract address
--hash treat signature inputs as function prototype strings, hash and take the first 4 bytes
-h, --help help for register-generic-resource
--resourceId string resource ID to query
--target string contract address to be registeredRegister a resource ID
Usage:
evm-cli bridge register-resource [flags]
Flags:
--bridge string bridge contract address
--handler string handler contract address
-h, --help help for register-resource
--resourceId string resource ID to be registered
--target string contract address to be registeredSet a token contract as mintable/burnable
Usage:
evm-cli bridge set-burn [flags]
Flags:
--bridge string bridge contract address
--handler string ERC20 handler contract address
-h, --help help for set-burn
--tokenContract string token contract to be registered
Deploy smart contracts.
Used to deploy all or some of the contracts required for bridging. Selection of contracts can be made by either specifying --all or a subset of flags
Usage:
evm-cli deploy [flags]
Flags:
--all deploy all
--bridge deploy bridge
--bridgeAddress string bridge contract address. Should be provided if handlers are deployed separately
--domainId string domain ID for the instance (default "1")
--erc20 deploy ERC20
--erc20Handler deploy ERC20 handler
--erc20Name string ERC20 contract name
--erc20Symbol string ERC20 contract symbol
--erc721 deploy ERC721
--erc721Handler deploy ERC721 handler
--erc721Name string ERC721 contract name
--erc721Symbol string ERC721 contract symbol
--erc721BaseURI ERC721 base URI
--genericHandler deploy generic handler
--fee string fee to be taken when making a deposit (in ETH, decimas are allowed) (default "0")
-h, --help help for deploy
--relayerThreshold uint number of votes required for a proposal to pass (default 1)
--relayers strings list of initial relayers
ERC20-related instructions.
Usage:
evm-cli erc20 [command]
Available Commands:
add-minter Add a minter to an Erc20 mintable contract
allowance Get the allowance of a spender for an address
approve Approve tokens in an ERC20 contract for transfer
balance Query balance of an account in an ERC20 contract
deposit Initiate a transfer of ERC20 tokens
mint Mint tokens on an ERC20 mintable contract
Flags:
-h, --help help for erc20Add a minter to an Erc20 mintable contract.
Usage:
evm-cli erc20 add-minter [flags]
Flags:
--erc20Address string ERC20 contract address
-h, --help help for add-minter
--minter string handler contract address
Get the allowance of a spender for an address.
Usage:
evm-cli erc20 allowance [flags]
Flags:
--erc20Address string ERC20 contract address
-h, --help help for allowance
--owner string address of token owner
--spender string address of spenderApprove tokens in an ERC20 contract for transfer.
Usage:
evm-cli erc20 approve [flags]
Flags:
--amount string amount to grant allowance
--decimals uint ERC20 token decimals (default 18)
--erc20address string ERC20 contract address
-h, --help help for approve
--recipient string address of recipientQuery balance of an account in an ERC20 contract.
Usage:
evm-cli erc20 balance [flags]
Flags:
--accountAddress string address to receive balance of
--erc20Address string ERC20 contract address
-h, --help help for balanceInitiate a transfer of ERC20 tokens.
Usage:
evm-cli erc20 deposit [flags]
Flags:
--amount string amount to deposit
--bridge string address of bridge contract
--decimals uint ERC20 token decimals
--domainId string destination domain ID
-h, --help help for deposit
--recipient string address of recipient
--resourceId string resource ID for transferMint tokens on an ERC20 mintable contract.
Usage:
evm-cli erc20 mint [flags]
Flags:
--amount string amount to mint fee (in ETH)
--decimal uint ERC20 token decimals (default 18)
--dstAddress string Where tokens should be minted. Defaults to TX sender
--erc20Address string ERC20 contract address
-h, --help help for mint
ERC721-related instructions.
Usage:
evm-cli erc721 [command]
Available Commands:
add-minter Add a minter to an Erc721 mintable contract
approve Approve token in an ERC721 contract for transfer
deposit Initiate a transfer of ERC721 token
mint Mint token on an ERC721 mintable contract
owner Get token owner from an ERC721 mintable contractAdd a minter to an ERC721 mintable contract.
Usage:
evm-cli erc721 add-minter [flags]
Flags:
--erc721Address string ERC721 contract address
-h, --help help for add-minter
--minter string address of minterApprove token in an ERC721 contract for transfer.
Usage:
evm-cli erc721 approve [flags]
Flags:
--contract-address string ERC721 contract address
--recipient string address of recipient
--tokenId string ERC721 token ID
-h, --help help for add-minterDeposit ERC721 token.
Usage:
evm-cli erc721 deposit [flags]
Flags:
--contract-address string ERC721 contract address
--recipient string address of recipient
--bridge string address of bridge contract
--destId string destination domain ID
--resourceId string resource ID for transfer
--tokenId string ERC721 token ID
-h, --help help for add-minterMint token on an ERC721 mintable contract.
Usage:
evm-cli erc721 mint [flags]
Flags:
--contract-address string ERC721 contract address
--destination-address string address of token recipient
--tokenId string ERC721 token ID
--metadata string token metadata
-h, --help help for add-minterGet token owner from an ERC721 mintable contract.
Usage:
evm-cli erc721 owner [flags]
Flags:
--contract-address string ERC721 contract address
--tokenId string ERC721 token ID
-h, --help help for add-minterUtils-related instructions. Useful for debugging
Usage:
evm-cli utils [command]
Available Commands:
hashList List tx hashes
simulate Simulate transaction invocation
Flags:
-h, --help help for utilsList tx hashes.
Usage:
evm-cli utils hashList [flags]
Flags:
--blockNumber string block number
-h, --help help for hashListReplay a failed transaction by simulating invocation; not state-altering
Usage:
evm-cli utils simulate [flags]
Flags:
--blockNumber string block number
--fromAddress string address of sender
-h, --help help for simulate
--txHash string transaction hashCentrifuge-related instructions.
This command can be used to deploy Centrifuge asset store contract that represents bridged Centrifuge assets.
Usage:
evm-cli centrifuge deployChecks _assetsStored map on Centrifuge asset store contract to find if asset hash exists.
Usage:
evm-cli centrifuge getHash [flags]
Flags:
--address string Centrifuge asset store contract address
--hash string A hash to lookup
-h, --help help for getHash
This module provides instruction for communicating with Celo-compatible chains.
More information can be found about this module within its repository, listed below.
This module provides instruction for communicating with Substrate-compatible chains.
Currently there is no CLI for this, though more information can be found about this module within its repository, listed below.
This section allows developers with a way to quickly and with minimal effort stand-up a local development environment in order to fully test out functionality of the chainbridge.
Locally deploy bridge and ERC20 handler contracts with preconfigured accounts and ERC20 handler.
Usage:
local-setup [flags]
Flags:
-h, --help help for local-setupThis can be easily run by building the chainbridge-core-example app, or by issuing a Makefile instruction directly from the root of the chainbridge-core itself.
make local-setup^ this command will run a shell script that contains instructions for running two EVM chains via Docker (docker-compose). Note: this will likely take a few minutes to run.
You can also review our Local Setup Guide for a more detailed example of setting up a local development environment manually.
We take all security issues seriously, if you believe you have found a security issue within a ChainSafe project please notify us immediately. If an issue is confirmed, we will take all necessary precautions to ensure a statement and patch release is made in a timely manner.
Please email us a description of the flaw and any related information (e.g. reproduction steps, version) to security at chainsafe dot io.
GNU Lesser General Public License v3.0