0.2.0 (#2)

* npm dedupe; npm audit fix * chore: remove lint:staged script * chore: remove unused devDependencies * chore: add .nvmrc set to v12 * npm v5+ compat: rename prepublish script to prepare * rename package from ethjs-filter to @metamask/ethjs-filter * format CHANGELOG.md * chore: add missing releases to CHANGELOG.md * 0.2.0 --------- Co-authored-by: legobt <[email protected]> Co-authored-by: github-actions <[email protected]>
legobeat · Nov 14, 2023 · e87924c · e87924c
1 parent 67d3a16
commit e87924c
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 404 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+v12
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,15 +1,64 @@
-# 0.1.6 -- unhandled promise rejection
+# Changelog
+All notable changes to this project will be documented in this file.
 
-1. Fixed unhandled promise rejection
-2. Removed promise watch, only for callbacks
+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).
 
-# 0.1.5 -- config fixes
+## [Unreleased]
 
-1. webpack config updates
-2. build config updates
+## [0.2.0]
+### Uncategorized
+- chore: add missing releases to CHANGELOG.md
+- format CHANGELOG.md
+- rename package from ethjs-filter to @metamask/ethjs-filter
+- npm v5+ compat: rename prepublish script to prepare
+- chore: add .nvmrc set to v12
+- chore: remove unused devDependencies
+- chore: remove lint:staged script
+- npm dedupe; npm audit fix
+- ci: move from TravisCI to GitHub Actions ([#4](https://github.com/legobeat/ethjs-filter/pull/4))
+- deprecate nodejs <8.17, npm<6 ([#5](https://github.com/legobeat/ethjs-filter/pull/5))
+- Check in lockfile ([#3](https://github.com/legobeat/ethjs-filter/pull/3))
+- v0.1.8
+- v0.1.7
+- v0.1.6
+- fix for BlockFilter
+- version 0.1.5 -- config fixes
+- version 0.1.4 -- minor fix to object assign
+- version 0.1.3 -- decoder, defaultTxObject
 
-# 0.0.1 -- ethjs-filter
+## [0.1.8]
+### Fixed
+- Remove redundant dependency `ganache-core`
 
-1. Basic testing
-2. Basic docs
-3. License
+## [0.1.7]
+### Changed
+- Add dependency `ganache-core`
+
+## [0.1.6]
+### Removed
+- Removed promise watch, only for callbacks
+
+### Fixed
+- Fixed unhandled promise rejection
+
+## [0.1.5]
+### Changed
+- config fixes
+  - webpack config updates
+  - build config updates
+
+## [0.0.1]
+### Added
+- ethjs-filter
+  - Basic testing
+  - Basic docs
+  - License
+
+[Unreleased]: https://github.com/legobeat/ethjs-filter/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/legobeat/ethjs-filter/compare/v0.1.8...v0.2.0
+[0.1.8]: https://github.com/legobeat/ethjs-filter/compare/v0.1.7...v0.1.8
+[0.1.7]: https://github.com/legobeat/ethjs-filter/compare/v0.1.6...v0.1.7
+[0.1.6]: https://github.com/legobeat/ethjs-filter/compare/v0.1.5...v0.1.6
+[0.1.5]: https://github.com/legobeat/ethjs-filter/compare/v0.0.1...v0.1.5
+[0.0.1]: https://github.com/legobeat/ethjs-filter/releases/tag/v0.0.1
diff --git a/README.md b/README.md
@@ -1,32 +1,11 @@
 ## ethjs-filter
 
 <div>
-  <!-- Dependency Status -->
-  <a href="https://david-dm.org/ethjs/ethjs-filter">
-    <img src="https://david-dm.org/ethjs/ethjs-filter.svg"
-    alt="Dependency Status" />
-  </a>
-
-  <!-- devDependency Status -->
-  <a href="https://david-dm.org/ethjs/ethjs-filter#info=devDependencies">
-    <img src="https://david-dm.org/ethjs/ethjs-filter/dev-status.svg" alt="devDependency Status" />
-  </a>
-
   <!-- NPM Version -->
-  <a href="https://www.npmjs.org/package/ethjs-filter">
-    <img src="http://img.shields.io/npm/v/ethjs-filter.svg"
+  <a href="https://www.npmjs.org/package/@metamask/ethjs-filter">
+    <img src="http://img.shields.io/npm/v/@metamask/ethjs-filter.svg"
     alt="NPM version" />
   </a>
-
-  <!-- Test Coverage -->
-  <a href="https://coveralls.io/r/ethjs/ethjs-filter">
-    <img src="https://coveralls.io/repos/github/ethjs/ethjs-filter/badge.svg" alt="Test Coverage" />
-  </a>
-
-  <!-- Javascript Style -->
-  <a href="http://airbnb.io/javascript/">
-    <img src="https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg" alt="js-airbnb-style" />
-  </a>
 </div>
 
 <br />
@@ -36,15 +15,15 @@ A simple module for handling Ethereum RPC filters that require watching.
 ## Install
 
 ```
-npm install --save ethjs-filter
+npm install --save @metamask/ethjs-filter
 ```
 
 ## Usage
 
 ```js
 const HttpProvider = require('ethjs-provider-http');
 const Eth = require('ethjs-query');
-const EthFilter = require('ethjs-filter');
+const EthFilter = require('@metamask/ethjs-filter');
 const eth = new Eth(new HttpProvider('http://localhost:8545'));
 const filters = new EthFilter(eth);
 
@@ -133,13 +112,13 @@ There is always a lot of work to do, and will have many rules to maintain. So pl
 
 Please consult our [Code of Conduct](CODE_OF_CONDUCT.md) docs before helping out.
 
-We communicate via [issues](https://github.com/ethjs/ethjs-filter/issues) and [pull requests](https://github.com/ethjs/ethjs-filter/pulls).
+We communicate via [issues](https://github.com/MetaMask/ethjs-filter/issues) and [pull requests](https://github.com/MetaMask/ethjs-filter/pulls).
 
 ## Important documents
 
 - [Changelog](CHANGELOG.md)
 - [Code of Conduct](CODE_OF_CONDUCT.md)
-- [License](https://raw.githubusercontent.com/ethjs/ethjs-filter/master/LICENSE)
+- [License](https://raw.githubusercontent.com/MetaMask/ethjs-filter/main/LICENSE)
 
 ## Licence
 

diff --git a/docs/README.md b/docs/README.md
@@ -10,14 +10,14 @@
 
 ### Structure
 
-The [`src/`](../../../tree/master/src) directory contains your entire application code, including JavaScript, and tests.
+The [`src/`](../../../tree/main/src) directory contains your entire application code, including JavaScript, and tests.
 
 The rest of the folders and files only exist to make your life easier, and
 should not need to be touched.
 
 For more in-depth structure, see the developer-guide.md.
 
-*(If they do have to be changed, please [submit an issue](https://github.com/ethjs/ethjs-filter/issues)!)*
+*(If they do have to be changed, please [submit an issue](https://github.com/MetaMask/ethjs-filter/issues)!)*
 
 ### Testing
 

diff --git a/docs/developer-guide.md b/docs/developer-guide.md
@@ -5,13 +5,13 @@ All information regarding contributing to and progressing `ethjs-filter` module
 ## Install
 
 ```
-npm install --save ethjs-filter
+npm install --save @metamask/ethjs-filter
 ```
 
 ## Install from Source
 
 ```
-git clone http://github.com/ethjs/ethjs-filter
+git clone http://github.com/MetaMask/ethjs-filter
 npm install
 ```
 
@@ -78,8 +78,6 @@ Note, the `./lib` dir is generated from the babel build staging. `./coverage` is
 
 ## NPM Practice
 
-Across all `ethjs-` repos, we enforce version hardening (i.e. "0.0.3" not "^0.0.3"). We want to reduce potential hazardous install changes from dependancies as much as possible to ensure package preformace, testing, security and design. Please make sure all your commits and PR's are version hardend if you are installing or removing new packages.
-
 After build staging it is the `lib` folder which actually gets published to NPM. This allows for easy inclusion into other modules which may not use babel transpiling or which may not support es2015+.
 
 ## NPM/Node Version Requirements

diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -5,7 +5,7 @@ All information for developers using `ethjs-filter` should consult this document
 ## Install
 
 ```
-npm install --save ethjs-filter
+npm install --save @metamask/ethjs-filter
 ```
 
 ## Usage