Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
@truffle/hdwallet-provider
Advanced tools
Readme
HD Wallet-enabled Web3 provider. Use it to sign transactions for addresses derived from a 12 or 24 word mnemonic.
$ npm install @truffle/hdwallet-provider
Node >= 7.6
Web3 ^1.2.0
You can use this provider wherever a Web3 provider is needed, not just in Truffle. For Truffle-specific usage, see next section.
By default, the HDWalletProvider
will use the address of the first address that's generated from the mnemonic. If you pass in a specific index, it'll use that address instead.
You can instantiate hdwallet-provider
with options passed in an object with
named keys. You can specify the following options in your object:
Parameters:
Parameter | Type | Default | Required | Description |
---|---|---|---|---|
mnemonic | object|string | null | [ ] | Object containing phrase and password (optional) properties. phrase is a 12 word mnemonic string which addresses are created from. Alternately the value for mnemonic can be a string with your mnemonic phrase. |
privateKeys | string[] | null | [ ] | Array containing 1 or more private keys. |
providerOrUrl | string|object | null | [x] | URI or Ethereum client to send all other non-transaction-related Web3 requests |
addressIndex | number | 0 | [ ] | If specified, will tell the provider to manage the address at the index specified |
numberOfAddresses | number | 1 | [ ] | If specified, will create numberOfAddresses addresses when instantiated |
shareNonce | boolean | true | [ ] | If false , a new WalletProvider will track its own nonce-state |
derivationPath | string | "m/44'/60'/0'/0/" | [ ] | If specified, will tell the wallet engine what derivation path should use to derive addresses. |
pollingInterval | number | 4000 | [ ] | If specified, will tell the wallet engine to use a custom interval when polling to track blocks. Specified in milliseconds. |
chainId | `number/ | string` | undefined | [ ] |
Some examples can be found below:
const HDWalletProvider = require("@truffle/hdwallet-provider");
const Web3 = require("web3");
const mnemonicPhrase = "mountains supernatural bird..."; // 12 word mnemonic
let provider = new HDWalletProvider({
mnemonic: {
phrase: mnemonicPhrase
},
providerOrUrl: "http://localhost:8545"
});
// Or, alternatively pass in a zero-based address index.
provider = new HDWalletProvider({
mnemonic: mnemonicPhrase,
providerOrUrl: "http://localhost:8545",
addressIndex: 5
});
// Or, use your own hierarchical derivation path
provider = new HDWalletProvider({
mnemonic: mnemonicPhrase,
providerOrUrl: "http://localhost:8545",
numberOfAddresses: 1,
shareNonce: true,
derivationPath: "m/44'/137'/0'/0/"
});
// To make HDWallet less "chatty" over JSON-RPC,
// configure a higher value for the polling interval.
provider = new HDWalletProvider({
mnemonic: {
phrase: mnemonicPhrase
},
providerOrUrl: "http://localhost:8545",
pollingInterval: 8000
});
// HDWalletProvider is compatible with Web3. Use it at Web3 constructor, just like any other Web3 Provider
const web3 = new Web3(provider);
// Or, if web3 is alreay initialized, you can call the 'setProvider' on web3, web3.eth, web3.shh and/or web3.bzz
web3.setProvider(provider)
// ...
// Write your code here.
// ...
// At termination, `provider.engine.stop()' should be called to finish the process elegantly.
provider.engine.stop();
Note: If both mnemonic and private keys are provided, the mnemonic is used.
The legacy interface is deprecated and it is recommended to pass options in an object as detailed above. The following method of passing options is here primarily to document the interface thoroughly and avoid confusion.
You can specify the following options in the order below.
Pass undefined
if you want to omit a parameter.
Parameters:
Parameter | Type | Default | Required | Description |
---|---|---|---|---|
mnemonic /privateKeys | string /string[] | null | [x] | 12 word mnemonic which addresses are created from or array of private keys. |
providerOrUrl | string|object | null | [x] | URI or Ethereum client to send all other non-transaction-related Web3 requests |
addressIndex | number | 0 | [ ] | If specified, will tell the provider to manage the address at the index specified |
numberOfAddresses | number | 1 | [ ] | If specified, will create numberOfAddresses addresses when instantiated |
shareNonce | boolean | true | [ ] | If false , a new WalletProvider will track its own nonce-state |
derivationPath | string | "m/44'/60'/0'/0/" | [ ] | If specified, will tell the wallet engine what derivation path should use to derive addresses. |
chainId | `number/ | string` | undefined | [ ] |
Instead of a mnemonic, you can alternatively provide a private key or array of
private keys as the first parameter. When providing an array, addressIndex
and numberOfAddresses
are fully supported.
const HDWalletProvider = require("@truffle/hdwallet-provider");
//load single private key as string
let provider = new HDWalletProvider("3f841bf589fdf83a521e55d51afddc34fa65351161eead24f064855fc29c9580", "http://localhost:8545");
// Or, pass an array of private keys, and optionally use a certain subset of addresses
const privateKeys = [
"3f841bf589fdf83a521e55d51afddc34fa65351161eead24f064855fc29c9580",
"9549f39decea7b7504e15572b2c6a72766df0281cea22bd1a3bc87166b1ca290",
];
provider = new HDWalletProvider(privateKeys, "http://localhost:8545", 0, 2); //start at address_index 0 and load both addresses
NOTE: This is just an example. NEVER hard code production/mainnet private keys in your code or commit them to git. They should always be loaded from environment variables or a secure secret management system.
You can easily use this within a Truffle configuration. For instance:
truffle-config.js
const HDWalletProvider = require("@truffle/hdwallet-provider");
const mnemonicPhrase = "mountains supernatural bird ...";
module.exports = {
networks: {
development: {
host: "localhost",
port: 8545,
network_id: "*" // Match any network id
},
ropsten: {
// must be a thunk, otherwise truffle commands may hang in CI
provider: () =>
new HDWalletProvider({
mnemonic: {
phrase: mnemonicPhrase
},
providerOrUrl: "https://ropsten.infura.io/v3/YOUR-PROJECT-ID",
numberOfAddresses: 1,
shareNonce: true,
derivationPath: "m/44'/1'/0'/0/"
}),
network_id: '3',
}
}
};
FAQs
HD Wallet-enabled Web3 provider
The npm package @truffle/hdwallet-provider receives a total of 9,427 weekly downloads. As such, @truffle/hdwallet-provider popularity was classified as popular.
We found that @truffle/hdwallet-provider demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 9 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.