protocol

History

Fabio Berger 29dc22e208 Merge branch 'development' into removeMigrateStep

* development:
  Fix lint error
  Fix documentation links in some READMEs
  Fix relative link
  Add step to publishing that upload staging doc jsons, deploys staging website, opens every docs page and asks the dev to confirm that each one renders properly before publishing
  Fix web3Wrapper build command
  Add top-level `yarn lerna:stage_docs` to upload docJsons to the staging S3 bucket for all packages with a docs page
  Added a detailed description of `renameOverloadedMethods` (special thanks to @fabioberger). Updated Javascript styles in the Abi-Gen and Utils packages, around support for function overloading.
  Updated deployer to accept a list of contract directories as input. Contract directories are namespaced to a void clashes. Also in this commit is a fix for overloading contract functions.
  Refactor publish script to have it's main execution body be lean and discrete steps

# Conflicts:
#	packages/contracts/package.json
#	packages/deployer/package.json

2018-04-11 19:00:30 +09:00

coverage

Enable coverage for all other packages with tests

2018-03-14 17:15:38 +01:00

schemas

Apply prettier config

2018-01-03 11:37:38 +01:00

src

Add metacoin example project

2018-04-02 12:34:29 +03:00

test

Use configured version of bignumber in all packages

2018-01-04 12:38:19 +01:00

.npmignore

Add monorepo_scripts to npmignore

2018-03-27 16:49:19 +01:00

CHANGELOG.json

Remove isPublished from all CHANGELOG.json filesx

2018-04-03 09:45:59 +09:00

CHANGELOG.md

Updated CHANGELOGS

2018-04-02 16:01:45 +03:00

package.json

Add --exit to all mocha calls so they exit when called from top-level yarn command (https://github.com/mochajs/mocha/issues/3044 )

2018-04-04 16:34:23 +09:00

README.md

Fix relative link

2018-04-10 21:29:16 -04:00

tsconfig.json

Add clean-state tests

2018-03-27 17:47:04 +02:00

tslint.json

Apply prettify on json and md files

2018-01-04 16:32:03 +01:00

@0xproject/json-schemas

Contains 0x-related json schemas

Installation

yarn add @0xproject/json-schemas

Import

import { SchemaValidator, ValidatorResult, schemas } from '@0xproject/json-schemas';

var schemas = require('@0xproject/json-schemas').schemas;

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

If this is your first time building this package, you must first build all packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from within the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:

yarn lerna:rebuild

Or continuously rebuild on change:

yarn dev

You can also build this specific package by running the following from within its directory:

yarn build

or continuously rebuild on change:

yarn build:watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test