/eos-evm-miner

Primary LanguageTypeScriptOtherNOASSERTION

EOS EVM Miner

This tool allows you to accept Ethereum transactions and relay them to the EOS EVM.

For every transaction that you relay you will receive a reward in the form of EOS tokens.

Environment Variables

Name Description Default
PRIVATE_KEY The private key of the miner account.
MINER_ACCOUNT The name of the miner account on the EOS Network.
RPC_ENDPOINTS A list of EOS RPC endpoints to connect to, comma-delimited. The list is a failover. list.
PORT The port to listen on for incoming Ethereum transactions. 50305
EVM_ACCOUNT eosio.evm
EVM_SCOPE
MINER_FEE_MODE Set how the miner collect fees after EOS-EVM upgrading to version 1. Can be CPU or FIXED. FIXED
GAS_PER_CPU priority_fee = cpu_per_us / GAS_PER_CPU * (1 + MINER_MARKUP_PERCENTAGE/100) * GAS_TOKEN_EXCHANGE_RATE if MINER_FEE_MODE=CPU 74
MINER_MARKUP_PERCENTAGE priority_fee = cpu_per_us / GAS_PER_CPU * (1 + MINER_MARKUP_PERCENTAGE/100) * GAS_TOKEN_EXCHANGE_RATE if MINER_FEE_MODE=CPU 0
GAS_TOKEN_EXCHANGE_RATE priority_fee = cpu_per_us / GAS_PER_CPU * (1 + MINER_MARKUP_PERCENTAGE/100) * GAS_TOKEN_EXCHANGE_RATE if MINER_FEE_MODE=CPU 1
FIXED_MINER_FEE Fixed priority_fee in wei if MINER_FEE_MODE=FIXED. 0
EXPIRE_SEC Expiration time when broadcasting EOS transaction. 60
RETRY_TX Whether local Leap node should retry when broadcasting failed. true
PRICING_ENDPOINTS Endpoints used for querying CPU price. Mainly for tests. Only ONE url instead of a list should be put here. null

Usage

⚠ You must have registered your miner

You must have registered your miner account on the EOS Network. Head over to our docs to learn all about mining, claiming your rewards, and more.

Get the code

git clone https://github.com/eosnetworkfoundation/eos-evm-miner.git
cd eos-evm-miner

Install dependencies

yarn

OR

npm install

Environment Variables

Copy the .env.example file to .env and fill in the environment variables.

Start mining

This command will build and run the node.

yarn mine

OR

npm run mine

If you want to just run the node without building, you can run:

yarn start

OR

npm run start

Logging

This project uses Winston for logging.

When you run the miner a directory called logs will be created in the root of the project. Inside you will find two log files, combined.log and error.log.