Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@bitski/provider-engine
Advanced tools
Bitski's ProviderEngine is a refactored version of Metamask's original provider engine library. This is the base of the Bitski Javascript SDKs (both browser and node).
Bitski's ProviderEngine is a refactored version of Metamask's original provider engine library. This is the base of the Bitski Javascript SDKs (both browser and node).
npm install @bitski/provider-engine
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.
import {
default as ProviderEngine,
BlockCacheSubprovider,
FixtureSubprovider,
FilterSubprovider,
FetchSubprovider
} from '@bitski/provider-engine';
const engine = new ProviderEngine();
const web3 = new Web3(engine);
// static results
engine.addProvider(new FixtureSubprovider({
web3_clientVersion: 'ProviderEngine/v0.0.0/javascript',
net_listening: true,
eth_hashrate: '0x00',
eth_mining: false,
eth_syncing: true,
}));
// cache layer
engine.addProvider(new BlockCacheSubprovider());
// filters
engine.addProvider(new FilterSubprovider());
// data source
engine.addProvider(new FetchSubprovider({
rpcUrl: 'https://testrpc.metamask.io/',
}));
// log new blocks
engine.on('block', (block) => {
console.log('================================')
console.log('BLOCK CHANGED:', '#'+block.number.toString('hex'), '0x'+block.hash.toString('hex'))
console.log('================================')
});
// network connectivity error
engine.on('error', (err) => {
// report connectivity errors
console.error(err.stack);
});
// start polling for blocks
engine.start();
It's easy to extend the functionality of this module by writing your own Subprovider instance.
See src/subprovider.ts for the full interface.
import { Subprovider } from '@bitski/provider-engine';
export default class MySubprovider extends Subprovider {
// Only requirement is to implement handleRequest
public handleRequest(payload, next, end) {
// The payload includes the original JSON RPC request
if (payload.method === 'eth_helloWorld') {
// Call end() to handle the request in this subprovider
end('hello world!');
} else {
// Call next() to fall-through to the next request in the stack
next();
}
}
}
A special thanks to the folks at Metamask who conceived and wrote the original library.
FAQs
Bitski's ProviderEngine is a refactored version of Metamask's original provider engine library. This is the base of the Bitski Javascript SDKs (both browser and node).
The npm package @bitski/provider-engine receives a total of 226 weekly downloads. As such, @bitski/provider-engine popularity was classified as not popular.
We found that @bitski/provider-engine demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 5 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.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.