diff --git a/.env.mpw.sample b/.env.mpw.sample index 540c109..e4cf8ca 100644 --- a/.env.mpw.sample +++ b/.env.mpw.sample @@ -1,4 +1,4 @@ -RPC_CREDENTIALS=masternode_test:p +RPC_CREDENTIALS=name:password ALLOWED_RPCS=listmasternodes,relaymasternodebroadcast,getbudgetprojection,mnbudgetrawvote,getbudgetinfo PORT=3000 RPC_PORT=51473 diff --git a/.env.sample b/.env.sample index 7ace636..2b3ff4e 100644 --- a/.env.sample +++ b/.env.sample @@ -1,5 +1,5 @@ -RPC_CREDENTIALS=masternode_test:p -ALLOWED_RPCS=help,listmasternodes +RPC_CREDENTIALS=name:password +ALLOWED_RPCS=help,getbalance PORT=3000 RPC_PORT=51473 TESTNET_RPC_PORT=51463 # Remove if you don't want testnet diff --git a/README.md b/README.md index ffe7fc7..d5f03a1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,19 @@ # PivxNodeController -http server used to control a node remotely +Simple http server used to perform RPC calls to a Bitcoin based node + +# HOW TO RUN + +First, download the dependencies with +```bash +npm i +``` +Then, copy the example environment file with +```bash +cp .env.sample .env +``` +If you are setting up a node for MPW, copy `.env.mpw.sample` instead. +Edit the file by chaning the credentials using the ones you set on your crypto node. +Finally, run the server with +```bash +npm run start +```