Test on Debian/Ubuntu systems:

1. Install requirements:

   sudo apt install -y build-essential cmake libgmp-dev libsodium-dev nasm curl m4 git wget unzip nlohmann-json3-dev pkg-config libssl-dev libclang-dev
   

2. Install Rust toolchain:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   

3. Clone the repo:

   git clone https://github.com/worm-privacy/miner && cd miner
   

4. Download parameters files:

   make download_params
   

5. Install worm-miner:

   cargo install --path .
   

6. Run Anvil

   anvil --mnemonic "myth like bonus scare over problem client lizard pioneer submit female collect"
   

7. Deploy BETH on Anvil:

   git clone https://github.com/worm-privacy/worm && cd worm && forge create --rpc-url http://127.0.0.1:8545 src/BETH.sol:BETH --private-key 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d --broadcast
   

8. Make sure the contract is deployed at: 0xe78A0F7E598Cc8b0Bb87894B0F60dD2a88d6a8Ab

9. Burn ETH and Immediately Mint BETH & submit a proof

   Burn 1 ETH, and use 0.999 of it in the same transaction (i.e., full spend = 0.999, fee = 0.001). This means no remaining amount is left for later spending: :

   worm-miner burn --network anvil --private-key 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d  --amount 1 --spend 0.999 --fee 0.001
   

   This will mint 0.999 BETH to your address

10. Congrats! 0.999 BETH has been minted for 0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1! To verify the minted balance: :

    worm-miner info --network anvil --private-key 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d
    

11. Burn ETH and Spend Only Partially

    For example, burn 1 ETH, but only spend 0.5 now:

    worm-miner burn \
    --network anvil \
    --private-key 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d \
    --amount 1 \
    --spend 0.5 \
    --fee 0.001 
    

    That leaves 1 - 0.5 - 0.001 = 0.499 ETH for future use. Later, spend some of the remaining amount via:

    worm-miner spend --id 1 --amount 0.3 --fee 0.1 --private-key 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d --receiver 0x1dF62f291b2E969fB0849d99D9Ce41e2F137006e --network anvil
    

12. Now run the miner:

    worm-miner mine --network anvil --private-key 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d --amount-per-epoch 0.0001 --num-epochs 3 --claim-interval 3
    

    Where: - --min-beth-per-epoch is the min amount of BETH you are willing to consume in order to participate in any block. - --max-beth-per-epoch is the max amount of BETH you are willing to consume in order to participate in any block. - --assumed-worm-price is your assumed WORM/ETH pair price. - --future-epochs is the number of epochs you would like to participate in in advance. - --custom-rpc is an optional parameter that takes in an rpc-url.

The worm-miner can be built and run using Docker, which automatically handles all dependencies and compilation of multiple components including rapidsnark (zero-knowledge proof system), witness circuits, and the Rust miner application. This eliminates the need to manually install build dependencies, Rust toolchain, or compile the various components.

The Docker build process compiles rapidsnark from source, builds witness generation circuits, and compiles the Rust application with configurable optimization flags:

Build with default (conservative) settings:

docker build -t worm-miner .

Build with CPU acceleration flags:

docker build --build-arg RUSTFLAGS="-C target-cpu=native" -t worm-miner .

Show help (default behavior):

docker run --rm worm-miner

Pre-download parameters locally and mount as volume:

make download_params
docker run --rm -v ~/.worm-miner:/root/.worm-miner worm-miner burn --network sepolia --private-key [privkey] --amount 0.1

Mining example:

docker run --rm -v ~/.worm-miner:/root/.worm-miner worm-miner mine --network sepolia --private-key [privkey] --amount-per-epoch 0.001 --num-epochs 5 --claim-interval 10