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.
nico
18da2be63d
|
7 months ago | |
---|---|---|
e2e | 7 months ago | |
packages | 7 months ago | |
scripts | 7 months ago | |
typings | 2 years ago | |
.babelrc | 6 years ago | |
.eslintignore | 6 years ago | |
.gitignore | 4 years ago | |
.prettierignore | 6 years ago | |
.prettierrc | 5 years ago | |
.travis.yml | 2 years ago | |
.yarnrc | 5 years ago | |
LICENSE | 5 years ago | |
README.md | 7 months ago | |
RELEASE.md | 7 months ago | |
TYPEDOC.md | 7 months ago | |
gulpfile.js | 7 months ago | |
lerna.json | 2 years ago | |
log.txt | 4 years ago | |
package-lock.json | 7 months ago | |
package.json | 7 months ago | |
tsconfig.base.json | 6 years ago | |
tsconfig.e2e.json | 5 years ago | |
tsconfig.json | 7 months ago | |
tsconfig.test.json | 7 months ago | |
tslint.json | 6 years ago |
README.md
Woop JavaScript SDK
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.
- @woop-js/core
- @woop-js/account
- @woop-js/crypto
- @woop-js/network
- @woop-js/utils
- @woop-js/transaction
- @woop-js/contract
- @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
- Remove the
'cross-fetch': 'jest-fetch-mock'
line fromscripts/jest/jest.e2e.config.js
- Run woop node locally, follow the instructions: https://github.com/woop-chain/woop
- Wait for 1-2 mins, and run this:
yarn build && yarn test:e2e