PoS_EVM
/
sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Javascript SDK of WoopChain protocol
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
546 Commits
43 Branches
113 Tags
6.4 MiB
 
 
Tag: Branch: Tree: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
nico 18da2be63d
woop 		8 months ago
e2e woop 8 months ago
packages woop 8 months ago
scripts woop 8 months ago
typings Replace scrypt-shim with scrypt.js; add test (#128) 2 years ago
.babelrc [WIP] add dependencies 6 years ago
.eslintignore [feat] update a lot 6 years ago
.gitignore package-lock.json should not be ignored by gitignore 4 years ago
.prettierignore [WIP] add dependencies 6 years ago
.prettierrc feat(Provider): added a Provider to get Http and WS Provider easier 5 years ago
.travis.yml Replace scrypt-shim with scrypt.js; add test (#128) 2 years ago
.yarnrc fix(publisher):update .yarnrc to prevent npm registry problem 5 years ago
LICENSE [feat] update LICENSE 6 years ago
README.md woop 8 months ago
RELEASE.md woop 8 months ago
TYPEDOC.md woop 8 months ago
gulpfile.js woop 8 months ago
lerna.json v0.1.58 2 years ago
log.txt v0.1.56 4 years ago
package-lock.json woop 8 months ago
package.json woop 8 months ago
tsconfig.base.json added harmony-network and new bundler 6 years ago
tsconfig.e2e.json wip(e2e): add e2e tests 5 years ago
tsconfig.json woop 8 months ago
tsconfig.test.json woop 8 months ago
tslint.json [WIP] add dependencies 6 years ago

README.md

Woop JavaScript SDK

npm version Build Status

This is the Woop Javascript SDK which provides an easier way to interact with Woop blockchain.

Please read the documentation for full API doc.

The SDK includes following packages with package-level documentation and examples inside each package.

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

Installation

This library works on both nodejs and browser. Please use it according to your use case.

Enviorment requirement

  • Nodejs: 10.0+
  • Browser: Latest Chrome and Firefox

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 @woop-js/core@next 

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

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

Building from source files

Install lerna and typescript globally

yarn global add lerna && yarn global add typescript

Bootstrap and build

yarn bootstrap

Bundle

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

yarn dist

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

Running Tests

Unit tests

yarn test:src

e2e tests

  1. Remove the 'cross-fetch': 'jest-fetch-mock' line from scripts/jest/jest.e2e.config.js
  2. Run woop node locally, follow the instructions: https://github.com/woop-chain/woop
  3. Wait for 1-2 mins, and run this:
yarn build && yarn test:e2e