open-index/open-npm huggingface dataset:
npm package: @rigoblock/contracts
Description: ## Available Scripts
Latest version: 0.3.10

# RigoBlock Contracts

## Available Scripts

In the project directory, you can run:

### `yarn ganache`

Starts the Ganache-cli server on port 8545 and with network Id 5777.

### `yarn compile`

Compiles all solidity contracts and generates the JSON artifacts. The contract's abi and address are stored under `networks[networkId]`.

### `yarn build`

In order: compiles all contracts, deleted *dist* folder, bootstraps contract on ganache, builds with webpack. **Requires Ganache to be up prior to running the command.**

### `yarn test`

Runs tests for the solidity contracts. **Ganache must not be up** when running this command as it will automatically start it before each test suite.

### `yarn lint`

Lints all JS files.

### `yarn deploy`

Launches the smart contract deployment CLI.

## Contract deployment

- Create a new branch (eg. `git checkout -b feature/kovan-contracts-deployment`)
- From the `rigoblock-monorepo/packages/contracts` directory, launch `yarn deploy`
- In the CLI:
  - select the network where you wish to deploy the contract
  - Insert your public key (wallet address)
  - Insert the name of the contract to be deployed
  - Insert the arguments required from the contract, if any, separated by a comma
  - Insert your account mnemonic
- The `contracts/artifacts` folder will now have uncommitted changes, commit them.
- Push the changes to Github (`git push --set-upstream origin your-branch-name`)
- Open a pull request with your changes and await approval.

>Note: At the current time it is necessary to pass the account MNEMONIC rather than the private key.


Here is a demo of how the script works:

![kapture 2018-10-25 at 16 06 14](https://user-images.githubusercontent.com/11726051/47506264-fc42b600-d86f-11e8-9f16-1df1da3f1dc1.gif)

## Writing Tests

Read the [testing documentation.](docs/testing.md)
npm package: @rigochain/rweb3
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Migration Guide


## Useful links


## Architecture Overview


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-core
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-core

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-errors
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-errors

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-providers-http
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-providers-http

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-providers-ws
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-providers-ws

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-rigo
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-rigo

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-rigo-abi
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-rigo-abi

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-rigo-accounts
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-rigo-accounts

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-rigo-contract
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-rigo-contract

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-rpc-methods
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-rpc-methods

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-types
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Migration Guide


## Useful links


## Architecture Overview


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-utils
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-utils

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |
npm package: @rigochain/rweb3-validator
Description: RWeb3.js
Author: Kyle Kwon
Latest version: 1.0.23


# RWeb3.js - rweb3-validator

RWeb3.js

## Installation


### Using NPM

```bash
npm install rweb3
```

### Using Yarn

```bash
yarn add rweb3
```

## Getting Started


## Prerequisites


## Package.json Scripts

| Script      | Description                                                        |
|-------------| ------------------------------------------------------------------ |
| clean       | Uses `rimraf` to remove `dist/`                                    |
| build       | Uses `tsc` to build all packages                                   |
| lint        | Uses `eslint` to lint all packages                                 |
| lint:fix    | Uses `eslint` to check and fix any warnings                        |
| test        | Uses `jest` to run unit tests in each package                      |
| test:slient | Uses `jest` to run tests under `/test/integration` in each package |