Compass is the Golang implementation of cross-chain communication maintainer for MAP Protocol. It currently supports bridging between EVM based chains.
The newly designed compass version contains all the functions required to run the relay node. With this tool, you can run nodes on almost all hardware platforms.
Contents
Quick Start
the recommanded way to get the executable is to download it from the release page.
if you want to build it from the source code,check the section below.
2. Prepare the accounts for each chain
fund some accounts in order to send txs on each chain, you want to provice crosse-chain service. the esaiest way is to using the same one address for every chain.
after that we need to import the account into the keystore of compass.
using the private key is the simplest way,run the following command in terminal:
compass accounts import --privateKey '********** your private key **********'
during the process of importing, you will be asked to input a password.
the password is used to encrypt your keystore.you have to input it when unlocking your account.
to list the imported keys in the keystore, using the command below:
{
"mapchain": {
"id": "0", // Chain ID of the MAP chain
"endpoint": "ws://<host>:<port>", // Node endpoint
"from": "0xff93...", // MAP chain address of maintainer
"opts": {} // MAP Chain configuration options (see below)
},
"chains": [] // List of Chain configurations
}
A chain configurations take this form:
{
"name": "eth", // Human-readable name
"type": "ethereum", // Chain type (Please see the following cousin for details)
"id": "0", // Chain ID
"endpoint": "ws://<host>:<port>", // Node endpoint
"from": "0xff93...", // On-chain address of maintainer
"keystorePath" : "/you/path/", //
"opts": {}, // Chain-specific configuration options (see below)
}
chain
type
ethereum
ethereum
bsc
bsc
goerli
eth2
polygon
matic
near
near
klaytn
klaytn
See config.json.example for an example configuration.
Options
Since MAP is also a EVM based chain, so the opts of the mapchain is following the options below as well
Ethereum chains support the following additional options:
{
"mcs": "0x12345...", // Address of the bridge contract (required)
"maxGasPrice": "0x1234", // Gas price for transactions (default: 20000000000)
"gasLimit": "0x1234", // Gas limit for transactions (default: 6721975)
"gasMultiplier": "1.25", // Multiplies the gas price by the supplied value (default: 1)
"http": "true", // Whether the chain connection is ws or http (default: false)
"startBlock": "1234", // The block to start processing events from (default: 0)
"blockConfirmations": "10" // Number of blocks to wait before processing a block
"egsApiKey": "xxx..." // API key for Eth Gas Station (https://www.ethgasstation.info/)
"egsSpeed": "fast" // Desired speed for gas price selection, the options are: "average", "fast", "fastest"
"lightnode": "0x12345...", // the lightnode to sync header
"syncToMap": "true", // Whether sync blockchain headers to Map
"syncIdList": "[214]" // Those chain ids are synchronized to the map，and This configuration can only be used in mapchain
"event": "mapTransferOut(...)|depositOutToken(...)", // MCS events monitored by the program, multiple with | interval，
// Here we give the events that need to be monitored，Map:mapTransferOut(bytes,bytes,bytes32,uint256,uint256,bytes,uint256,bytes) Near: 2ef1cdf83614a69568ed2c96a275dd7fb2e63a464aa3a0ffe79f55d538c8b3b5|150bd848adaf4e3e699dcac82d75f111c078ce893375373593cc1b9208998377
"waterLine": "5000000000000000000", // If the user balance is lower than, an alarm will be triggered, unit ：wei
"alarmSecond": "3000", // How long does the user balance remain unchanged, triggering the alarm, unit ：seconds
}
Blockstore
The blockstore is used to record the last block the maintainer processed, so it can pick up where it left off.
To disable loading from the chunk library, specify the "--fresh" flag. Add the fresh flag, and the program will execute from height 0，
In addition, the configuration file provides the "startBlock" option, and the program will execute from the startBlock
Keystore
Compass requires keys to sign and submit transactions, and to identify each bridge node on chain.
To use secure keys, see compass accounts --help. The keystore password can be supplied with the KEYSTORE_PASSWORD environment variable.
To import external ethereum keys, such as those generated with geth, use compass accounts import --ethereum /path/to/key.
To import private keys as keystores, use compass accounts import --privateKey key.
Chain Implementations
Building compass requires a compiler(version 1.16 or later)
Ethereum (Solidity): The Solidity contracts required for compass. Includes scripts for deployment.
