@kosu/wrapper-enhancements
JavaScript module enhancing and adding automation for the kosu contract wrappers.
Last updated 9 months ago by paradigm-labs .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @kosu/wrapper-enhancements 
SYNC missed versions from official npm registry.

Wrapper Enhancements

A TypeScript/JavaScript library for assistance with interactions with the Kosu contract system wrappers. This library simplifies and chains complex multi-step contract interactions.

View the documentation here.

Installation

@kosu/wrapper-enhancements can be installed into your project through yarn or npm, and can be passed through webpack or browserify for usage in the browser.

Install

Yarn:

yarn add @kosu/wrapper-enhancements

NPM:

npm install --save @kosu/wrapper-enhancements

Import

Kosu and its exported classes can be imported directly into TypeScript or JavaScript projects.

TypeScript (and ES6+):

// directly access exported classes/utilities
import {
    // contract wrapper classes
    KosuToken,
    OrderGateway,
    PosterRegistry,
    Treasury,
    ValidatorRegistry,
    Voting,
} from "@kosu/wrapper-enhancements";

JavaScript (CommonJS):

const {
    KosuToken,
    OrderGateway,
    PosterRegistry,
    Treasury,
    ValidatorRegistry,
    Voting,
} = require("@kosu/wrapper-enhancements");

Development

@todo: add contribution guidelines summary and link

Linting

The TypeScript source can be linted with:

yarn lint

Building

Build the TypeScript source to distributable JavaScript (CommonJS) as well as source mappings and typing files with:

yarn build

License

Open-source software, MIT licensed.

Copyright (c) 2019 Paradigm Labs, corp.

Current Tags

  • 0.3.0                                ...           latest (9 months ago)

1 Versions

  • 0.3.0                                ...           9 months ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (10)
Dev Dependencies (13)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |