@jointlabs/miner-cli

Miner CLI

The Miner CLI is a command line application that allows the user to perform Joint Protocol "mining" operations. It allows the user to pull mining tasks from the indexer service and automate the execution of tasks on the relevant network.

Tasks

An active miner will receive the following tasks from the indexer service:

• Draft: Draft mediators into a pending dispute.
• Undraft: Undraft mediators from an executed dispute.
• Execute: Execute the verdict of a dispute.

Install

npm install @jointlabs/miner-cli -g

Usage

npx miner --key=0xYourPrivateKey --net=ethereum

Options

The following command line options or environment variables can be used to configure the miner:

• --key, KEY: The private key that will be used to sign transactions.
• --net, NETWORK: The network to connect to (ex: sepolia, ethereum, base, localhost)
• --gas, GAS: The gas price to use for the transaction (default: 20).
• --indexer, INDEXER: An alternative indexer address (optional)

Others:

• --port, PORT: The port the HTTP server is listen on (default: 3333).
• -v --version: Print the version number.

License

MIT