mirror of
https://github.com/embarklabs/ethereumjs-wallet.git
synced 2025-02-05 23:33:31 +00:00
Describe provider-engine in the README
This commit is contained in:
parent
b27e211760
commit
f0b0c8f0fe
12
README.md
12
README.md
@ -87,6 +87,18 @@ Instance methods:
|
||||
* `deriveChild(index)` - derive a node based on a child index
|
||||
* `getWallet()` - return a `Wallet` instance as seen above
|
||||
|
||||
## Provider Engine
|
||||
|
||||
The Wallet can be easily plugged into [provider-engine](https://github.com/metamask/provider-engine) to provide signing:
|
||||
|
||||
```js
|
||||
const WalletSubprovider = require('ethereumjs-wallet/provider-engine')
|
||||
|
||||
<engine>.addProvider(new WalletSubprovider(<wallet instance>))
|
||||
```
|
||||
|
||||
Note it only supports the basic wallet. With a HD Wallet, call `getWallet()` first.
|
||||
|
||||
### Remarks about `toV3`
|
||||
|
||||
The `options` is an optional object hash, where all the serialization parameters can be fine tuned:
|
||||
|
Loading…
x
Reference in New Issue
Block a user