@0x/subproviders 中文文档教程
@0x/subproviders
一些有用的 web3 子提供者，包括一个 LedgerSubprovider，可用于添加 Ledger Nano S 支持。
我们撰写了一篇指南文章，详细介绍了此子提供程序包的一些用例。
Read the Documentation.
Installation
yarn add @0x/subproviders
如果您的项目在 TypeScript 中，请将以下内容添加到您的 tsconfig.json：
"compilerOptions": {
"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
Contributing
我们欢迎来自更广泛的社区！ 要报告此包中的错误，请在此存储库中创建一个问题。
请在开始之前阅读我们的贡献指南。
Install dependencies
如果您没有启用 yarn workspaces (Yarn < v1.0) - 启用它们：
yarn config set workspaces-experimental true
然后安装依赖
yarn install
Build
项 要构建此包和它依赖的所有其他 monorepo 包，请从 monorepo 根目录运行以下命令：
PKG=@0x/subproviders yarn build
或持续重建更改：
PKG=@0x/subproviders yarn watch
Clean
yarn clean
Lint
yarn lint
Run tests
Unit tests
yarn run test:unit
Integration tests
为了运行集成测试，请确保您有可用的 Ledger Nano S。
- 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
然后运行：
yarn test:integration
注意： 我们假定派生路径为 m/44'/60'/0'/0，该路径已在测试中配置。 使用此设置和派生路径，您的第一个帐户应该是 0x5409ed021d9299bf6814279a6a1411a7e866a631，与 TestRPC 完全一样。
All tests
yarn run test:all
@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.
Read the Documentation.
Installation
yarn add @0x/subproviders
If your project is in TypeScript, add the following to your tsconfig.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.
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
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
PKG=@0x/subproviders yarn build
Or continuously rebuild on change:
PKG=@0x/subproviders yarn 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
