/sdk

Core SDK of Harmony protocol.

Primary LanguageTypeScriptMIT LicenseMIT

npm version Build Status

Harmony-SDK-Core

A Harmony's blockchain javascript library

It's a mono-repo library, not yet published to npm.

Install from npm/yarn

Note: we added a @next tag to npm package, please use the following command to install with npm/yarn

# npm
npm install @harmony-js/core@next 

# yarn
yarn add @harmony-js/core@next

# tslib may be required, we'd better install it as well
npm install tslib
yarn add tslib

Examples with tutorials

Packages

  1. @harmony-js/core
  2. @harmony-js/account
  3. @harmony-js/crypto
  4. @harmony-js/network
  5. @harmony-js/utils
  6. @harmony-js/transaction
  7. @harmony-js/contract

Hacking from source files

  1. install lerna and typescript globally (if you have these, you can skip)
yarn global add lerna && yarn global add typescript
  1. bootstrap repostory
yarn install && yarn bootstrap
  1. run watcher before editing any source file
yarn watch
  1. if you are ready to build/test/bundle, please refer to the following section:

Manually Build/bundle

Build

yarn build

Bundle

There are 2 ways bundling files.

  1. building the es5 version bundled javascript for each sub-packages, which can be run in Browser directly.

    yarn dist

    All files are exported in /dist folder

  2. build umd and esm version javascript for each sub-packages, which can be accessed by import or require

    yarn bundle

    All files are exported in packages/dist folder, use **.esm.js or **.umd.js format

E2E tests

Contantly updating now, please get back later

  1. edit .env file if you have custom setting
  2. run harmony node locally(this fork currently : https://github.com/mikedoan/harmony/tree/enable_tx)
  3. wait for 1-2 mins, and run this:
yarn build && yarn test:e2e