2018-03-27 17:47:04 +02:00
..
2018-03-12 03:37:27 +01:00
2018-03-27 17:47:04 +02:00
2018-03-27 17:47:04 +02:00
2018-03-27 17:47:04 +02:00

@0xproject/subproviders

A few useful web3 subproviders including a LedgerSubprovider useful for adding Ledger Nano S support.

We have written up a Wiki article detailing some use cases of this subprovider package.

Read the Documentation.

Installation

yarn add @0xproject/subproviders

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 strongly recommend that the community help us make improvements and determine the future direction of the protocol. 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
yarn install

Build

yarn build

or

yarn build:watch

Clean

yarn clean

Lint

yarn lint

Run tests

Unit tests

yarn run test:unit

Integration tests

In order to run the integration tests, make sure you have a Ledger Nano S available.

  • Setup your Ledger with the development mnemonic seed: concert load couple harbor equip island argue ramp clarify fence smart topic
  • Plug it into your computer
  • Unlock the device
  • Open the on-device Ethereum app
  • Make sure "browser support" and "contract data" are disabled
  • Start TestRPC locally at port 8545

Then run:

yarn test:integration

Note: We assume a derivation path of m/44'/60'/0'/0 which is already configured in the tests. With this setup and derivation path, your first account should be 0x5409ed021d9299bf6814279a6a1411a7e866a631, exactly like TestRPC.

All tests

yarn run test:all