@shibawallet/web3provider v0.5.81

@shibawallet/web3provider

A commonplace web3 provider. Use it to sign and send transactions, to retrieve data, and generate accounts.

Install

$ npm install @shibawallet/web3provider --save

Instantiation

You can instantiate Web3Provider with options passed in an object with named keys. You can specify the following options in your object:

Parameters:

Some examples can be found below:

const Web3Provider = require("@shibawallet/web3provider");
const Web3 = require("web3");
const mnemonicPhrase = "mountains supernatural bird..."; // 12 word mnemonic
let provider = new Web3Provider({
  mnemonic: {
    phrase: mnemonicPhrase
  },
  providerOrUrl: "http://localhost:8545"
});

// Or, alternatively pass in a zero-based address index.
provider = new Web3Provider({
  mnemonic: mnemonicPhrase,
  providerOrUrl: "http://localhost:8545",
  addressIndex: 5
});

// Or, use your own hierarchical derivation path
provider = new Web3Provider({
  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 Web3Provider({
  mnemonic: {
    phrase: mnemonicPhrase
  },
  providerOrUrl: "http://localhost:8545",
  pollingInterval: 8000
});

// Web3Provider 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.

Using the legacy interface (deprecated)

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:

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 Web3Provider = require("@shibawallet/web3provider");
//load single private key as string
let provider = new Web3Provider("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 Web3Provider(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.