What's Nimiq? ​

Nimiq is an open source crypto designed for simplicity and ease of use. With our browser-first approach, Nimiq works directly within web browsers without the need for additional software, providing easy integration for developers and seamless interaction for users.

The protocol is based on the Albatross consensus algorithm, a proof-of-stake system renowned for its speed, security and low power consumption. Albatross supports high transaction throughput, and can handle thousands of transactions per second.

The Nimiq Web Client ​

The Nimiq Web Client is a JavaScript library that allows you to be part of the Nimiq PoS blockchain directly in your browser. No intermediaries, no servers.

The Web Client provides a simple interface to build consensus with other nodes, create wallets, send transactions and interact with the blockchain.

Reaching consensus with the network is easy:

js
import init, { Client, ClientConfiguration } from '@nimiq/core/web'

await init()

const config = new ClientConfiguration()
const client = await Client.create(config.build())

await client.waitForConsensusEstablished()

This is a simple example using web integration. For other environments, be sure to modify the import statement accordingly.

Then, you can start interacting with the blockchain:

js
client.addHeadChangedListener((head) => {
  console.log('New head:', head)
})

Using your private node ​

Although the Web Client already offers a lot of functionality, you can also set up your own private node for full control and advanced customisation. Find out more about their differences.

Issues, bugs and feedback ​

This is an early version of the client code compiled to WebAssembly, and as such there might be issues and friction, especially now that more people are trying it in more environments than we could ever test ourselves.

If you encounter problems or find a bug, please open an issue in our Github repository.

If you want to provide feedback or have questions about the client, our Nimiq Coders Dojo Telegram and Community Forum are the places to go.