Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@nimiq/core
Advanced tools
**[Nimiq](https://nimiq.com/)** is a frictionless payment protocol for the web.
Nimiq is a frictionless payment protocol for the web.
For a high-level introduction check out the Nimiq White Paper.
To dive into the details of the protocol architecture check out the Nimiq Developer Reference.
Check out our testnet Browser Miner and Wallet.
git
and build-essential
: sudo apt-get install -y git build-essential
.
git
, python2.7
, make
, gcc
and gcc-c++
.yarn
to manage the dependencies, run: sudo npm install -g yarn
.gulp
globally: sudo npm install -g gulp
or yarn global add gulp
.git clone https://github.com/nimiq-network/core
.cd core
.npm install
or yarn
.npm run build
or yarn build
.clients/browser/index.html
in your browser.A good way to get started is to have a look at the most simple web application on top of the Nimiq Blockchain.
Follow the Quickstart guide or use our CDN:
<script src="https://cdn.nimiq.com/core/nimiq.js"></script>
Open clients/browser/index.html
in your browser.
Just include <script src="dist/nimiq.js"></script>
in your project.
Visit the API Documentation.
To run a Node.js 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 --cert=SSL_CERT_FILE --key=SSL_KEY_FILE [options]
Configuration | |
---|---|
--host=HOSTNAME | Hostname of the Node.js client. |
--port=PORT | Port to listen on for connections. |
--cert=SSL_CERT_FILE | SSL certificate file for your domain. CN should match HOSTNAME. |
--key=SSL_KEY_FILE | SSL private key file for your domain. |
Options | |
--help | Show usage instructions. |
--log[=LEVEL] | Configure global log level. |
--log-tag=TAG[:LEVEL] | Configure log level for a specific tag. |
--miner[=THREADS] | Activate mining on this node with THREADS parallel threads. |
--passive | Do not actively connect to the network. |
--rpc[=PORT] | Start JSON-RPC server on port PORT (default: 8648). |
--statistics[=INTERVAL] | Output miner statistics every INTERVAL seconds. |
--type=TYPE | Configure the consensus type, one of full (default), light or nano. |
--wallet-seed=SEED | Initialize wallet using SEED as a wallet seed. |
--wallet-address=ADDRESS | Initialize wallet using ADDRESS as a wallet address. |
After running npm install
or yarn
(from the Quickstart section):
dpkg
, jq
and fakeroot
installed (if you don't, they can be easily installed with apt
).npm run build-deb
.dist/
directory.Note: creating deb packages only works on Debian-based distributions (only has been extensively tested on Ubuntu).
After running npm install
or yarn
(from the Quickstart section):
rpm-build
installed (if you don't, it can be easily installed with yum
or dnf
).npm run build-rpm
.dist/
directory.Note: creating rpm packages only works on rpm-based distributions (only has been extensively tested on Fedora).
Developers are free to choose between npm
and yarn
for managing the dependencies.
npm install
yarn
npm test
or yarn test
runs browser and Node.js tests.npm run test-browser
or yarn test-browser
runs the testsuite in your browser only.npm run test-node
or yarn test-node
runs the testsuite in Node.js only.npm run lint
or yarn lint
runs the ESLint javascript linter.
Executing npm run build
or yarn build
concatenates all sources into dist/{web,web-babel,web-crypto,node}.js
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 |
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 .
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.
docker logs -f <instance_id_or_name>
If you'd like to contribute to the development of Nimiq please follow our Code of Conduct and Contributing Guidelines.
This project is under the Apache License 2.0.
FAQs
**[Nimiq](https://nimiq.com/)** is a frictionless payment protocol for the web.
The npm package @nimiq/core receives a total of 120 weekly downloads. As such, @nimiq/core popularity was classified as not popular.
We found that @nimiq/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.