open-index/open-npm huggingface dataset:
npm package: @kosu/kosu.js
Description: JavaScript module for connecting with Kosu.
Latest version: 0.3.0

# Kosu.js

A TypeScript/JavaScript library for interacting with the Kosu contract system and order relay network.

**View [the documentation here.](https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/packages/kosu.js/docs/)**

## Installation

Kosu.js 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/kosu.js
```

**NPM:**

```
npm install --save @kosu/kosu.js
```

### Import

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

**TypeScript (and ES6+):**

```typescript
// top-level Kosu class
import { Kosu } from "@kosu/kosu.js";

// directly access exported classes/utilities
import {
    // contract wrapper classes
    KosuToken,
    OrderGateway,
    PosterRegistry,
    Treasury,
    ValidatorRegistry,
    Voting,

    // utils/classes and constants
    OrderSerializer,
    OrderHelper,
    Signature,
    toBytes32
    NULL_ADDRESS,
} from "@kosu/kosu.js";
```

**JavaScript (CommonJS):**

```javascript
const { Kosu } = require("@kosu/kosu.js");

const {
    KosuToken,
    OrderGateway,
    PosterRegistry,
    Treasury,
    ValidatorRegistry,
    Voting,

    OrderSerializer,
    OrderHelper,
    Signature,
    toBytes32
    NULL_ADDRESS,
} = require("@kosu/kosu.js");
```

## 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.](https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/LICENSE)

Copyright (c) 2019 Paradigm Labs, corp.
npm package: @kosu/node-client
Description: JavaScript module for connecting interacting with the Kosu JSONRPC.
Latest version: 0.5.0

# Node Client

A TypeScript/JavaScript library for interacting with the Kosu order relay network.

**View [the documentation here.](https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/packages/node-client/docs/)**

## Installation

The Node Client 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/node-client
```

**NPM:**

```
npm install --save @kosu/node-client
```

### Import

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

**TypeScript (and ES6+):**

```typescript
// top-level Kosu class
import { NodeClient } from "@kosu/node-client";
```

**JavaScript (CommonJS):**

```javascript
const { NodeClient } = require("@kosu/node-client");
```

## 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.](https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/LICENSE)

Copyright (c) 2019 Paradigm Labs, corp.
npm package: @kosu/tsc-config
Description: TypeScript compiler base configuration for TS projects at Paradigm Labs.
Author: Henry Harder
Latest version: 0.1.0

# @kosu/tsc-config

Base `typescript` compiler configuration used by Paradigm Labs for TypeScript `kuso` projects.

## Installation

Install locally in your project (ensure you have `typescript` installed as well).

```bash
$ yarn add --dev @kuso/tsc-config
```

## Usage

Add the following to your `tsconfig.json` file. Ensuring you add `baseUrl` and `ourDir` to `compilerOptions` for your project. Additionally extend as necessary.

```json
{
    "extends": "@kuso/tsc-config"
}
```
npm package: @kosu/tslint-config
Description: TypeScript linter base configuration for TS projects at Paradigm Labs.
Author: Henry Harder
Latest version: 0.0.5

# @kosu/tslint-config

Base `tslint` configuration used by Paradigm Labs for TypeScript `kuso` projects.

## Installation

Install locally in your project (ensure you have `tslint` installed as well).

```bash
$ yarn add --dev @kuso/tslint-config
```

## Usage

Add the following to your `tslint.json` file

```json
{
    "extends": ["@kuso/tslint-config"]
}
```
npm package: @kosu/web-helpers
Description: Simple web interfaces for interacting with the Kosu contract system and network.
Latest version: 0.2.2

# `@kosu/web-helpers`

Quick and simple web tools for checking Kosu network status, and interacting with the current Kosu contract system (on Ropsten).

In the future, may be expanded for other network stats and utilities.

## Develop

Run a local static server with build files:

```bash
yarn develop
```

## Deploy

Deploy client files to static site:

```bash
yarn deploy
```

View live changes at [`https://portal.kosu.io/`](https://portal.kosu.io/)

## Notes

-   Currently only supports the Kosu contract system, as the node is under construction.
npm package: @kosu/wrapper-enhancements
Description: JavaScript module enhancing and adding automation for the kosu contract wrappers.
Latest version: 0.3.0

# 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.](https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/packages/kosu-wrapper-enhancements/docs/)**

## 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+):**

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

**JavaScript (CommonJS):**

```javascript
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.](https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/LICENSE)

Copyright (c) 2019 Paradigm Labs, corp.