CityCoins Scripts

This directory provides a set of Node.js scripts and utilities to interact with the CityCoins protocol.

All functions are documented using JSDoc, and the documentation lives on GitHub Pages.

To learn more about a specific script, click on the link below.

Name	Description
autominer.js	Utility for continously mining CityCoins
autominingclaimer.js	Utility for claiming CityCoin mining rewards
getnetworkstatus.js	Utility for getting the current network status
getstackinginfo.js	Get the current Stacking info for a given address
gettxstatus.js	Get the current status of a given transaction

All of the scripts use prompts to gather the required information, and nothing is stored on disk.

For scripts that use a private key, remember to keep it safe and never share with anyone. This page has more information on how to obtain your hex encoded private key for scripts that require it.

Requirements

• Node.js / NPM (or nvm for Mac/Linux)

Installation

Clone this repository using either ssh or https:

git clone [email protected]:citycoins/scripts.git
OR
git clone https://github.com/citycoins/scripts.git

Enter the directory for the scripts and install the prequisites:

cd scripts
npm install

Any scripts listed in the table above can be run using the following command:

node scriptname.js