Skip to content

README.md

Latest commit

 

History

History
64 lines (41 loc) · 1.55 KB

README.md

File metadata and controls

64 lines (41 loc) · 1.55 KB

Mining Local Server

Instruction

By now, there is no RPC API implemented in stacks-node for mining module(like Receive Mining Transaction or Change Burn Fee In Every Mining Cycle). So the Mining Local Server is released as a short term production before Stacks 2.0 Mainnet for public to participate in stacks mining easily. It works as Mining Intern Server Bridge and System Command Executor between stacks-node and Mining Bot Client.

Feature

In detail, we use Mining Local Server to execute system command like :

    # Node Start
    stacks-node start --config="a.toml"

    # Node Shut Down
    kill {stacks-node PID}

    # Node Status
    ps -ax | grep stacks-node

Each system command corresponds to a RPC API. Mining Module of Mining Bot Client connects with Mining Local Server using API above.

Getting Started

Download and build Mining-Local-Server

The first step is to ensure that you have nodejs and npm environment.

$ node -v
14.8.0

$ npm -v
6.14.7

The second step is downloading and building from source.

$ git clone https://github.com/Daemon-Technologies/Mining-Local-Server.git
$ cd Mining-Local-Server
$ npm install

Then running Mining-Local-Server

$ npm start

If you see the following logs that means you have succeeded!

> miningbot-server@1.0.0 start D:\Projects\Blockstack\Mining-Local-Server
> node server.js

(node:4312) ExperimentalWarning: The ESM module loader is experimental.
Example app listening at http://localhost:5000