package
A JavaScript library for composing Ethereum provider objects using middleware modules
npm install web3-provider-engineGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Web3 ProviderEngine is a tool for composing your own web3 providers.
[!CAUTION] This package has been deprecated.
This package was originally created for MetaMask, but has been replaced by
@metamask/json-rpc-engine,@metamask/eth-json-rpc-middleware,@metamask/eth-json-rpc-provider, and various other packages.Here is an example of how to create a provider using those packages:
import { providerFromMiddleware } from '@metamask/eth-json-rpc-provider'; import { createFetchMiddleware } from '@metamask/eth-json-rpc-middleware'; import { valueToBytes, bytesToBase64 } from '@metamask/utils'; import fetch from 'cross-fetch'; const rpcUrl = '[insert RPC URL here]'; const fetchMiddleware = createFetchMiddleware({ btoa: (stringToEncode) => bytesToBase64(valueToBytes(stringToEncode)), fetch, rpcUrl, }); const provider = providerFromMiddleware(fetchMiddleware); provider.sendAsync( { id: 1, jsonrpc: '2.0', method: 'eth_chainId' }, (error, response) => { if (error) { console.error(error); } else { console.log(response.result); } } );This example was written with v12.1.0 of
@metamask/eth-json-rpc-middleware, v3.0.1 of@metamask/eth-json-rpc-provider, and v8.4.0 of@metamask/utils.
Built to be modular - works via a stack of 'sub-providers' which are like normal web3 providers but only handle a subset of rpc methods.
The subproviders can emit new rpc requests in order to handle their own; e.g. eth_call may trigger eth_getAccountBalance, eth_getCode, and others.
The provider engine also handles caching of rpc request results.
const ProviderEngine = require('web3-provider-engine')
const CacheSubprovider = require('web3-provider-engine/subproviders/cache.js')
const FixtureSubprovider = require('web3-provider-engine/subproviders/fixture.js')
const FilterSubprovider = require('web3-provider-engine/subproviders/filters.js')
const VmSubprovider = require('web3-provider-engine/subproviders/vm.js')
const HookedWalletSubprovider = require('web3-provider-engine/subproviders/hooked-wallet.js')
const NonceSubprovider = require('web3-provider-engine/subproviders/nonce-tracker.js')
const RpcSubprovider = require('web3-provider-engine/subproviders/rpc.js'
When importing in webpack:
import * as Web3ProviderEngine from 'web3-provider-engine';
import * as RpcSource from 'web3-provider-engine/subproviders/rpc';
import * as HookedWalletSubprovider from 'web3-provider-engine/subproviders/hooked-wallet';The Ethereum JSON RPC was not designed to have one node service many clients. However a smaller, lighter subset of the JSON RPC can be used to provide the blockchain data that an Ethereum 'zero-client' node would need to function. We handle as many types of requests locally as possible, and just let data lookups fallback to some data source ( hosted rpc, blockchain api, etc ). Categorically, we don’t want / can’t have the following types of RPC calls go to the network:
yarn testfrederikbolding
frederik.bolding@consensys.net
Estimated unpacked size across 62 packages.
18.9 MB+
Includes dependencies.
^6.5.0
10.1.3
^3.6.2
4.8.0
^3.0.1
4.0.1
^8.1.0
10.1.3
^4.3.0
10.1.3
^8.1.0
8.1.0
^1.0.0
1.0.0
^6.2.1
7.0.3
^1.1.1
1.3.0
^7.0.1
10.0.0
^1.1.0
10.1.3
10.3.0
9.0.0
26.0.1