README.md

neon-js

Neon JavaScript SDK.

Overview

This is the JS SDK for the NEO blockchain platform. This project aims to be a lightweight library focused on providing blockchain interactions in the browser.

Neon-JS is used internally by Neon Wallet and many other libraries and applications.

Visit the docs to learn how to use this library!

For Dapp development, NeonDappkit and WalletConnectSDK offer a more user-friendly experience, specifically tailored for this purpose. While Neon-JS provides a comprehensive set of features, these two alternatives are better suited for developing decentralized applications.

Getting started

Installation

Nodejs

npm i @cityofzion/neon-js

Browser through CDN

<script src="https://unpkg.com/@cityofzion/neon-js" />

Usage

Nodejs

import {
    default as Neon
} from "@cityofzion/neon-js";
const acct = Neon.create.account("NKuyBkoGdZZSLyPbJEetheRhMjeznFZszf");

Browser

Once imported using the script tag, the module is available as a global object Neon .

console.log(Neon);
var acct = Neon.create.account("NKuyBkoGdZZSLyPbJEetheRhMjeznFZszf");

Note For most use-cases, we recommend neon-js . Do not use neon-js and neon-core in the same project. The classes are not cross-package compatible. See #850.

Contributing

Please refer to CONTRIBUTING for development practices.

Setup

This repository is a typescript mono-repo using Lerna. Please ensure the following is installed:

• Node (latest LTS aka v18 at time of writing)

lerna is optional and only required for advanced operations.

git clone https://github.com/CityOfZion/neon-js.git
cd neon-js
yarn
npm run bootstrap
npm run build

Testing

npm run lint
npm run build
npm run dist
npm run test:unit
npm run test:integration

Docs

We use Docusaurus for our docs website. The docs are stored in ./docs while the main website and its configuration is in ./website .

cd website
yarn
npm run start

License

• Open-source MIT.
• Main author and maintainer is Yak Jun Xiang.