Have ideas to improve npm?Join in the discussion! »

spartan-gold

1.0.5 • Public • Published

SpartanGold

SpartanGold (SG) is a simplified blockchain-based cryptocurrency for education and experimentation.

Its design is loosely based on Bitcoin. Like Bitcoin, SpartanGold uses a proof-of-work (PoW) blockchain. However, several parts of the design are simplified. For example:

  • SpartanGold uses an account-based model, rather than Bitcoin's unspent transaction output (UTXO) model.
  • No scripting language is used. Transactions are only designed to transfer money (gold in SG parlance).
  • The proof-of-work target is not adjusted during program execution.

All of these features could be added to SpartanGold, but we want to make the design as simple and easy to modify as possible.

Using SpartanGold

There are two different approaches for running SpartanGold:

  1. In single-threaded mode, multiple miners and clients can run within the same JavaScript process.
  2. Using TcpMiner, the SpartanGold code runs within different JavaScript processes.

Single-threaded Mode

This mode is designed for quick and easy experimentation, avoiding a lot of unnecessary complexity.

To see an example, run driver.js from the command line:

$ node driver.js

This script has three miners, Minnie, Mickey, and Donald, along with three additional non-mining clients. Donald starts after a delay and must spend some time catching up with the other two miners.

One point to note is that Donald is given more mining power, represented as the miningRounds parameter. Minnie and Mickey try 2000 hashes when it is their turn to find a proof, whereas Donald tries 3000 hashes. Over time, Donald should earn more rewards than the other two miners, despite his late start.

Note that the use of miningRounds as a way to specify mining power only works in single-threaded mode.

Multi-process Mode

In this mode, each SpartanGold miner runs in its own JavaScript process. You must specify a configuration file in JSON format. If you look in the sampleConfigs/ directory, you will see some JSON files that you can use to get started.

Here is a sample:

$ node tcpMiner.js sampleConfigs/minnie.json

This command will start a miner listening on localhost, port 9000. It then presents a text-based menu, including information about the miner's address, its current funds, and any outstanding transactions that it has. Here is an example:

Starting Minnie

  Funds: 501
  Address: hDDXlpBFlnKViXVhbpJbf+tua7F8yMPIYtjJ+8KbWbk=
  Pending transactions: 
  
  What would you like to do?
  *(c)onnect to miner?
  *(t)ransfer funds?
  *(r)esend pending transactions?
  *show (b)alances?
  *show blocks for (d)ebugging and exit?
  *(s)ave your state?
  *e(x)it without saving?
  
  Your choice: 

In a separate process, you can start an additional miner on another port. The miner will register with miners at any additional ports listed. For example:

$ node tcpMiner.js sampleConfigs/mickey.json

The two miners will now race to find proofs, sending their blocks back and forth.

While this mode is a little more complex, it creates a more realistic feel, and takes away some possible "cheats" that you can get away with in single-threaded mode.

Projects Based on SpartanGold

SpartanGold is designed to allow students to experiment with a Bitcoin-like cryptocurrency. A few different projects have used it as the basis of a cryptocurrency prototype:

Install

npm i spartan-gold

DownloadsWeekly Downloads

1

Version

1.0.5

License

MIT

Unpacked Size

68.3 kB

Total Files

20

Last publish

Collaborators

  • avatar