diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..3d276647 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,24 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [16.0.0] - 2020-09-22 + +### Changed + +- **Breaking:** Use Infura V3 API ([#352](https://github.com/MetaMask/web3-provider-engine/pull/352)) + - The previously used Infura API is deprecated and will be (or is already) removed. + - Using the Infura Provider now requires an API key. + See [`eth-json-rpc-infura`](https://npmjs.com/package/eth-json-rpc-infura) and [infura.io](https://infura.io) for details. +- Update various dependencies + - eth-json-rpc-middleware@6.0.0 ([#350](https://github.com/MetaMask/web3-provider-engine/pull/350)) + - eth-json-rpc-filters@4.2.1 ([#351](https://github.com/MetaMask/web3-provider-engine/pull/351)) + - eth-json-rpc-infura@5.1.0 ([#352](https://github.com/MetaMask/web3-provider-engine/pull/352)) + - eth-rpc-errors@3.0.0 ([#353](https://github.com/MetaMask/web3-provider-engine/pull/353)) +- Specify publish files + +[Unreleased]:https://github.com/MetaMask/web3-provider-engine/compare/v16.0.0...HEAD diff --git a/example.js b/example.js deleted file mode 100644 index 4d469c19..00000000 --- a/example.js +++ /dev/null @@ -1,23 +0,0 @@ -const Ethjs = require('ethjs') -const ProviderEngine = require('./index.js') -const ZeroClientProvider = require('./zero.js') - -// create engine -const providerEngine = ZeroClientProvider({ - // supports http and websockets - // but defaults to infura's mainnet rest api - // rpcUrl: 'https://mainnet.infura.io', - // rpcUrl: 'http://localhost:8545', - // rpcUrl: 'wss://mainnet.infura.io/ws', - // rpcUrl: 'ws://localhost:8545/ws', -}) - -// use the provider to instantiate Ethjs, Web3, etc -const eth = new Ethjs(providerEngine) - -// log new blocks -providerEngine.on('block', function(block) { - const blockNumber = Number.parseInt(block.number.toString('hex'), 16) - const blockHash = `0x${block.hash.toString('hex')}` - console.log(`block: #${blockNumber} ${blockHash}`) -}) diff --git a/package.json b/package.json index 4118c3a0..db1cc7d4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "web3-provider-engine", - "version": "15.0.12", + "version": "16.0.0", "description": "A JavaScript library for composing Ethereum provider objects using middleware modules", "repository": "https://github.com/MetaMask/web3-provider-engine", "main": "index.js", @@ -13,7 +13,12 @@ "bundle-engine": "browserify -s ProviderEngine -e index.js -t [ babelify --presets [ @babel/preset-env ] ] > dist/ProviderEngine.js", "lint": "eslint --quiet --ignore-path .gitignore ." }, - "author": "", + "files": [ + "*.js", + "dist", + "subprovider", + "util" + ], "license": "MIT", "resolutions": { "ganache-core/**/elliptic": "^6.5.2"