Skip to content
This repository was archived by the owner on Oct 30, 2024. It is now read-only.

Commit f0b0c8f

Browse files
committed
Describe provider-engine in the README
1 parent b27e211 commit f0b0c8f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,18 @@ Instance methods:
8787
* `deriveChild(index)` - derive a node based on a child index
8888
* `getWallet()` - return a `Wallet` instance as seen above
8989

90+
## Provider Engine
91+
92+
The Wallet can be easily plugged into [provider-engine](https://github.com/metamask/provider-engine) to provide signing:
93+
94+
```js
95+
const WalletSubprovider = require('ethereumjs-wallet/provider-engine')
96+
97+
<engine>.addProvider(new WalletSubprovider(<wallet instance>))
98+
```
99+
100+
Note it only supports the basic wallet. With a HD Wallet, call `getWallet()` first.
101+
90102
### Remarks about `toV3`
91103

92104
The `options` is an optional object hash, where all the serialization parameters can be fine tuned:

0 commit comments

Comments
 (0)