Skip to content
Official JavaScript implementation of the Nimiq protocol
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix Markdown issue in Contributing Guidelines Feb 5, 2019
clients JsonRpcServer: Support getBlock in nano mode (#491) May 8, 2019
dist Types: fix value for Transaction.Flag.NONE Apr 15, 2019
doc Remove bounty network Feb 11, 2019
packaging Update GitHub repository urls May 1, 2019
spec/support add node tests to build matrix May 14, 2017
src Fix package.json for ES6 module Feb 15, 2019
.editorconfig Test lint on Travis CI May 27, 2017
.esdoc.json ESDoc: Switch from esdoc-standard-plugin to seperate plugins Dec 13, 2017
.eslintignore Initial BigNumber usage May 5, 2018
.eslintrc.json for now, we do not require parameter/return value descriptions Jul 16, 2017
.gitignore Add script for web npm package publication Dec 4, 2018
.npmignore Support for publishing an npm library package (#117) Jun 5, 2017
.travis.yml Update travis-slack integration May 3, 2019
Dockerfile_deb Increased NodeJS version in Dockerfile_* to 10 Dec 3, 2018
Dockerfile_git Update GitHub repository urls May 1, 2019
Dockerfile_repo Increased NodeJS version in Dockerfile_* to 10 Dec 3, 2018
LICENSE.md Set copyright owner to "Nimiq Foundation" in LICENSE.md (#327) Feb 9, 2018
README.md Set Travis CI badge to master branch May 12, 2019
binding.gyp Add conditional compilation of native addons Jan 15, 2019
gulpfile.js Remove DnsUtils Feb 8, 2019
karma.conf.js Use Edge 18 for automated tests Feb 5, 2019
package.json Upgrade to istanbul-api May 12, 2019
travis-script.sh Use cpuid-git to select the best variant of nimiq_native Sep 15, 2018
tslint.json Enable linting of the types.d.ts definitions Feb 11, 2019
yarn.lock Enable linting of the types.d.ts definitions Feb 11, 2019

README.md

Nimiq Blockchain Build Status

Nimiq is a frictionless payment protocol for the web.

Resources

Demo

Check out our Testnet.

Packages

Prebuilt binary packages

For users looking to run a standalone Nimiq node (which is also capable of mining), see our Downloads page for installable Linux and Windows binary packages.

NPM Packages

For developers looking to include Nimiq support on their applications, there are two npm packages available:

  • @nimiq/core: Module for use in node.js applications.
  • @nimiq/core-web: Module for use in client-side (browser) applications (includes the same files that are available from our CDN).

Quickstart

  1. Install Node.js v8.0.0 or higher.
  2. On Ubuntu and Debian, install git and build-essential: sudo apt-get install -y git build-essential.
  3. Install yarn globally: sudo npm install -g yarn.
  4. Install gulp globally: yarn global add gulp.
  5. Clone this repository: git clone https://github.com/nimiq/core-js.
  6. Build the project: cd core && yarn && yarn build.
  7. Open clients/browser/index.html in your browser.

Web Developers

Simple Web Application on top of Nimiq

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

Getting Started

Follow the Quickstart guide or make use of our CDN:

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

Browser client

Open clients/browser/index.html in your browser or include <script src="dist/nimiq.js"></script> in your project.

Node.js client

To run a Node.js client you will need a publicly routable IP, Domain, and SSL Certificate (get a free certificate at letsencrypt.org). Start the client by running clients/nodejs/nimiq with the respective configuration.

Test and Build

Run Testsuite

  • yarn test runs browser and Node.js tests.
  • yarn test-browser runs the testsuite in your browser only.
  • yarn test-node runs the testsuite in Node.js only.

Run ESLint

yarn lint runs the ESLint javascript linter.

Build

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

Contribute

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

License

This project is under the Apache License 2.0.

You can’t perform that action at this time.