Home Reference Source Repository

Nimiq Blockchain Build Status

Nimiq is a frictionless payment protocol for the web.

For a high-level introduction checkout the Nimiq White Paper.

Library Demo

Check out our betanet Browser Miner.

Quickstart

  1. Clone this repository git clone https://github.com/nimiq-network/core.
  2. Run npm install or yarn
  3. Run npm run build or yarn build
  4. Open clients/browser/index.html in your browser to access the Browser Client.

Web Developers

Most simple Web Application on top of the Nimiq Blockchain

A good way to get started is to have a look at the most simple web application on top of the Nimiq Blockchain.

Installation for Web Developers

Follow the Quickstart guide or use our CDN:

<script src="https://cdn.nimiq.com/core/nimiq.js"></script>

Run Client

Run Browser Client

Open clients/browser/index.html in your browser.

Run NodeJs client

To run a NodeJs Client you will need a publicly routable IP, Domain and SSL Certificate (get a free one at letsencrypt.org). Start the client by running clients/nodejs/index.js.

cd clients/nodejs/
node index.js --host <hostname> --port <port> --key <privkey> --cert <certificate>
Argument Description
host Hostname of the NodeJs client.
port Port used to communicate with the peers.
key Private key for the client
cert SSL certificate of your Domain.
wallet-seed Your wallet seed (optional)

Build your own Browser client

Just include <script src="dist/nimiq.js"></script> in your project.

API

Visit the API Documentation.

Core Developers

Developers are free to choose between npm and yarn for managing the dependencies.

Installation for Core Developers (using npm)

Installation for Core Developers (using yarn)

Test and Build

Run Testsuite

Run ESLint

npm run lint or yarn lint runs the ESLint javascript linter.

Build

Executing npm run build or yarn build concatenates all sources into dist/{web,web-babel,web-crypto,node}.js

Docker

A Dockerfile is provided which allows for creating your own backbone image using the following arguments.

Argument Description
BRANCH Defaults to master but can be any available git branch
PORT Defaults to TCP port 8080
DOMAIN Domain to be used for hosting the backbone node
KEY Path to an existing certificate key for the DOMAIN
CRT Path to an existing signed certificate for the DOMAIN
WALLET_SEED Pre-existing wallet private key

Building the Docker image using the above arguments

docker build \
  --build-arg DOMAIN=<DOMAIN> \
  --build-arg BRANCH=<BRANCH> \
  --build-arg WALLET_SEED=<WALLET_SEED> \
  --build-arg KEY=<KEY> \
  --build-arg CRT=<CRT> \
  --build-arg PORT=<PORT> \
  -t nimiq .

Running an instance of the image

docker run -d -p 8080:8080 -v /etc/letsencrypt/:/etc/letsencrypt/ --name "nimiq" nimiq

Note that you can override any of the arguments which were baked into the image at runtime with exception to the BRANCH. The -v flag here allows for mapping a local system path into the container for the purpose of using the existing DOMAIN certificates.

Check status

docker logs -f <instance_id_or_name>

Contribute

If you'd like to contribute to development Nimiq please follow our Code of Conduct and Contributing Guidelines.

License

This project is under the Apache License 2.0.