@0x/subproviders

@0x/subproviders

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

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

$3

Installation

``
yarn add @0x/subproviders
`

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

`json
"compilerOptions": {
"typeRoots": ["node_modules/@0x/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.

$3

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

`bash
yarn config set workspaces-experimental true
`

Then install dependencies

`bash
yarn install
`

$3

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

`bash
PKG=@0x/subproviders yarn build
`

Or continuously rebuild on change:

`bash
PKG=@0x/subproviders yarn watch
`

$3

`bash
yarn clean
`

$3

`bash
yarn lint
`

$3

#### Unit tests

`bash
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

`bash
yarn run test:all
``