{"id":13701473,"url":"https://github.com/nimiq/core-js","last_synced_at":"2025-04-11T11:48:45.291Z","repository":{"id":21638676,"uuid":"90784559","full_name":"nimiq/core-js","owner":"nimiq","description":"Official JavaScript implementation of the Nimiq protocol","archived":false,"fork":false,"pushed_at":"2024-04-10T23:58:47.000Z","size":14861,"stargazers_count":994,"open_issues_count":14,"forks_count":208,"subscribers_count":98,"default_branch":"master","last_synced_at":"2024-05-01T21:37:32.184Z","etag":null,"topics":["cryptocurrency","javascript","nimiq"],"latest_commit_sha":null,"homepage":"https://nimiq.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nimiq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-09T19:33:54.000Z","updated_at":"2024-05-30T23:45:27.773Z","dependencies_parsed_at":"2024-05-30T23:44:53.627Z","dependency_job_id":"a8699ca9-bfa6-4f65-9baa-c3c5ffc2e2d3","html_url":"https://github.com/nimiq/core-js","commit_stats":{"total_commits":2063,"total_committers":54,"mean_commits":38.2037037037037,"dds":0.6611730489578285,"last_synced_commit":"b7fba257758ca2d28bc1a6a9e776dd035cfeec57"},"previous_names":["nimiq-network/core"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nimiq%2Fcore-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nimiq","download_url":"https://codeload.github.com/nimiq/core-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248388831,"owners_count":21095469,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cryptocurrency","javascript","nimiq"],"created_at":"2024-08-02T20:01:40.798Z","updated_at":"2025-04-11T11:48:45.268Z","avatar_url":"https://github.com/nimiq.png","language":"JavaScript","readme":"# Nimiq Blockchain [![Build Status](https://github.com/nimiq/core-js/actions/workflows/build%2Btest.yml/badge.svg?branch=master)](https://github.com/nimiq/core-js/actions?query=branch%3Amaster)\n\n**[Nimiq](https://nimiq.com/)** is a frictionless payment protocol for the web.\n\n[Nimiq PoS has been launched](https://www.nimiq.com/blog/nimiq-proof-of-stake-is-now-live/). This repository is archived. You can use the [Nimiq PoS Rust implementation](https://github.com/nimiq/core-rs-albatross/) instead.\n\n## Resources\n\n- [Nimiq White Paper](https://nimiq.com/whitepaper/): High-level introduction of the Nimiq payment protocol.\n- [Nimiq Developer Reference](https://nimiq-network.github.io/developer-reference/): Details of the protocol architecture.\n- [Core API Documentation](https://doc.esdoc.org/github.com/nimiq/core-js/): Documentation of the Nimiq Core library API.\n- [Node.js Client Documentation](doc/nodejs-client.md): Usage and configuration documentation for the Nimiq Node.js Client.\n- [JSON-RPC Client Documentation](doc/json-rpc-client.md): Usage instructions for the Nimiq JSON-RPC Client.\n- [Docker Documentation](doc/docker.md): Instructions on setting up a Nimiq Node using Docker.\n- [Packaging Documentation](doc/linux-packaging.md): Instructions on how to build binary packages for Linux (.deb and/or RPM) from this source code.\n\n## Demo\nCheck out our [Testnet](https://nimiq-testnet.com).\n\n## Packages\n### Prebuilt binary packages\nFor users looking to run a standalone Nimiq node (which is also capable of mining), see our [Downloads page](https://nimiq.com/#downloads) for installable Linux and Windows binary packages.\n\n### NPM Packages\nFor developers looking to include Nimiq support on their applications, there are two npm packages available:\n\n- [`@nimiq/core`](https://www.npmjs.com/package/@nimiq/core): Module for use in node.js applications.\n- [`@nimiq/core-web`](https://www.npmjs.com/package/@nimiq/core-web): Module for use in client-side (browser) applications (includes the same files that are available from [our CDN](#getting-started)).\n\n## Quickstart\n\n1. Install [Node.js](https://nodejs.org) \u003e= v16.20.2.\n2. On Ubuntu and Debian, install `git` and `build-essential`: `sudo apt-get install -y git build-essential`.\n    - On other Linux systems, install `git`, `python3`, `make`, `gcc` and `gcc-c++`.\n    - For MacOS or Windows, [check here for git](https://git-scm.com/downloads) and [here for compilation tools](https://github.com/nodejs/node-gyp#on-mac-os-x).\n3. Install `yarn` globally: `sudo npm install -g yarn`.\n4. Install `gulp` globally:  `yarn global add gulp`.\n5. Clone this repository: `git clone https://github.com/nimiq/core-js`.\n6. Build the project: `cd core-js \u0026\u0026 yarn \u0026\u0026 yarn build`.\n7. Open `clients/browser/index.html` in your browser.\n\n## Web Developers\n### Simple Web Application on top of Nimiq\nA good way to get started is to have a look at [the most simple web application on top of the Nimiq Blockchain](https://demo.nimiq.com/).\n\n### Getting Started\nFollow the [Quickstart](#quickstart) guide or make use of our CDN:\n\n```\n\u003cscript src=\"https://cdn.nimiq.com/latest/nimiq.js\"\u003e\u003c/script\u003e\n```\n\n## Browser client\n\nOpen `clients/browser/index.html` in your browser or include `\u003cscript src=\"dist/nimiq.js\"\u003e\u003c/script\u003e` in your project.\n\n## Node.js client\n\nTo run a Node.js client you will need a **publicly routable IP**, **Domain**, and **SSL Certificate** (get a free certificate at [letsencrypt.org](https://letsencrypt.org/)). Start the client by running `clients/nodejs/nimiq` with the respective [configuration](doc/nodejs-client.md).\n\n## Test and Build\n\n### Run Testsuite\n- `yarn test` runs browser and Node.js tests.\n- `yarn test-browser` runs the testsuite in your browser only.\n- `yarn test-node` runs the testsuite in Node.js only.\n\n### Run ESLint\n`yarn lint` runs the ESLint javascript linter.\n\n### Build\nExecuting `yarn build` concatenates all sources into `dist/{web,web-babel,web-crypto,node}.js`\n\n## Contribute\n\nIf you'd like to contribute to the development of Nimiq please follow our [Code of Conduct](/.github/CODE_OF_CONDUCT.md) and [Contributing Guidelines](/.github/CONTRIBUTING.md).\n\n## License\n\nThis project is under the [Apache License 2.0](./LICENSE.md).\n","funding_links":[],"categories":["JavaScript","Others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimiq%2Fcore-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnimiq%2Fcore-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnimiq%2Fcore-js/lists"}