From 65c6ff38bd2e87c5cd6b510880e38a83da2b21ab Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Tue, 11 Jan 2022 11:16:45 -0800 Subject: [PATCH] Customizing README and package.json --- README.md | 19 +----- package-lock.json | 146 +++++++++++++++++++++++++--------------------- package.json | 16 ++--- 3 files changed, 89 insertions(+), 92 deletions(-) diff --git a/README.md b/README.md index 3f41947..99607b3 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,7 @@ -# npm-lib-boilerplate - -This repository is a code 'boilerplate' for starting a new npm library. It -contains the following features: - -- [Semantic Release](https://github.com/semantic-release/semantic-release) configured to work with [Travis CI](https://travis-ci.org/). -- Automatic linting using [Standard](https://www.npmjs.com/package/standard) JavaScript. -- Unit and integration tests using Mocha and Chai, following the best practices and design patterns in [this YouTube video](https://www.youtube.com/watch?v=lE3RYnchHps): - - Uses ECMAScript 2015 `Class` for business logic and utility libraries. - - Follows [TDD](https://builttoadapt.io/why-tdd-489fdcdda05e) best practices. - - Uses `_this` to maintain context to the instance of the class. - - Uses [Sinon stubs](https://sinonjs.org/releases/latest/stubs/) to mock external dependencies for unit tests. - - Each function is wrapped in try/catch statements, allowing thrown errors to 'bubble up' to the top-level function, and give every function along the way an opportunity to handle exceptions. - - Testing assertions focus on properties and structure, not values. +# bch-consumer +An npm JS library for interacting with [ipfs-bch-wallet-consumer](https://github.com/Permissionless-Software-Foundation/ipfs-bch-wallet-consumer). # Licence -[MIT](LICENSE.md) - +[MIT](LICENSE.md) diff --git a/package-lock.json b/package-lock.json index 4d58ede..86fb691 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "1.0.0", "license": "MIT", "dependencies": { - "@psf/bch-js": "4.20.21", + "@psf/bch-js": "4.21.0", "apidoc": "0.25.0" }, "devDependencies": { @@ -21,13 +21,13 @@ "eslint-plugin-node": "11.1.0", "eslint-plugin-prettier": "3.3.1", "eslint-plugin-standard": "4.0.0", - "husky": "^4.3.8", + "husky": "4.3.8", "lodash.clonedeep": "4.5.0", - "mocha": "^8.4.0", + "mocha": "8.4.0", "nyc": "15.1.0", "semantic-release": "17.4.2", "sinon": "9.2.2", - "standard": "^16.0.4" + "standard": "16.0.4" } }, "node_modules/@babel/code-frame": { @@ -501,6 +501,19 @@ "node": ">=6.9.0" } }, + "node_modules/@chris.troutner/bip32-utils": { + "version": "1.0.5", + "resolved": "http://94.130.170.209:4873/@chris.troutner%2fbip32-utils/-/bip32-utils-1.0.5.tgz", + "integrity": "sha512-pa9dh5VpPmfol1bdLy+FyqONmxlf/QH6Q01a57OP6C9gTVOZM1Rt0kCLXxXKC6e2AnNIrXpYN1UtlyBm+r6P0g==", + "license": "MIT", + "dependencies": { + "keccak": "^3.0.1", + "tape": "*" + }, + "engines": { + "node": ">=10.15.1" + } + }, "node_modules/@dabh/diagnostics": { "version": "2.0.2", "resolved": "http://94.130.170.209:4873/@dabh%2fdiagnostics/-/diagnostics-2.0.2.tgz", @@ -830,13 +843,13 @@ } }, "node_modules/@psf/bch-js": { - "version": "4.20.21", - "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-4.20.21.tgz", - "integrity": "sha512-0dvKpGZuJOwwW+Mk/Gz+0/jzrUUCmScv7ocxBsr2/e0ALHIMnKe9ykIuuxloaa+ZOiSxz5H2Ine/Yn1Ei23WPw==", + "version": "4.21.0", + "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-4.21.0.tgz", + "integrity": "sha512-UIiwTsWzJHfQjo/stGuZ1j34V2qKN6r5B7CLT+HbDVMRlmgCoMJq6gsokzDizig9zdDUWZeKDpsiBS/r54qaDA==", "license": "MIT", "dependencies": { + "@chris.troutner/bip32-utils": "1.0.5", "@psf/bip21": "2.0.1", - "@psf/bip32-utils": "1.0.1", "@psf/bitcoincash-ops": "2.0.0", "@psf/bitcoincashjs-lib": "4.0.2", "@psf/coininfo": "4.0.0", @@ -896,19 +909,6 @@ "qs": "^6.3.0" } }, - "node_modules/@psf/bip32-utils": { - "version": "1.0.1", - "resolved": "http://94.130.170.209:4873/@psf%2fbip32-utils/-/bip32-utils-1.0.1.tgz", - "integrity": "sha512-Q4fayYLTZYDQTr/UMas1Zf+LdTBCFuJwPWFWMf36TlhlFSBB+i0cDI2fvbaqaVwUChNQ0ppFrPmypYSgtp4oow==", - "license": "MIT", - "dependencies": { - "keccak": "^3.0.1", - "tape": "*" - }, - "engines": { - "node": ">=10.15.1" - } - }, "node_modules/@psf/bitcoincash-ops": { "version": "2.0.0", "resolved": "http://94.130.170.209:4873/@psf%2fbitcoincash-ops/-/bitcoincash-ops-2.0.0.tgz", @@ -4817,12 +4817,13 @@ } }, "node_modules/has-dynamic-import": { - "version": "2.0.0", - "resolved": "http://94.130.170.209:4873/has-dynamic-import/-/has-dynamic-import-2.0.0.tgz", - "integrity": "sha512-GYPi/aZmACJVrVfEhP1rNUFmtCuK+SQ96mn8Bs7mXiGZRAJiI4VjaMmjj4uuvW8qaF085uWJvyJk9UNYUIYn0A==", + "version": "2.0.1", + "resolved": "http://94.130.170.209:4873/has-dynamic-import/-/has-dynamic-import-2.0.1.tgz", + "integrity": "sha512-X3fbtsZmwb6W7fJGR9o7x65fZoodygCrZ3TVycvghP62yYQfS0t4RS0Qcz+j5tQYUKeSWS09tHkWW6WhFV3XhQ==", "license": "MIT", "dependencies": { - "call-bind": "^1.0.2" + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" }, "funding": { "url": "https://github.com/sponsors/ljharb" @@ -5695,10 +5696,14 @@ } }, "node_modules/is-weakset": { - "version": "2.0.1", - "resolved": "http://94.130.170.209:4873/is-weakset/-/is-weakset-2.0.1.tgz", - "integrity": "sha512-pi4vhbhVHGLxohUw7PhGsueT4vRGFoXhP7+RGN0jKIv9+8PWYCQTqtADngrxOm2g46hoH0+g8uZZBzMrvVGDmw==", + "version": "2.0.2", + "resolved": "http://94.130.170.209:4873/is-weakset/-/is-weakset-2.0.2.tgz", + "integrity": "sha512-t2yVvttHkQktwnNNmBQ98AhENLdPUTDTE21uPqAQ0ARwQfGeQKRVS0NNurH7bTf7RrvcVn1OOge45CnBeHCSmg==", "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + }, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -10341,9 +10346,9 @@ } }, "node_modules/object-inspect": { - "version": "1.11.0", - "resolved": "http://94.130.170.209:4873/object-inspect/-/object-inspect-1.11.0.tgz", - "integrity": "sha512-jp7ikS6Sd3GxQfZJPyH3cjcbJF6GZPClgdV+EFygjFLQ5FmW/dRUnTd9PQ9k0JhoNDabWFbpF1yCdSWCC6gexg==", + "version": "1.12.0", + "resolved": "http://94.130.170.209:4873/object-inspect/-/object-inspect-1.12.0.tgz", + "integrity": "sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g==", "license": "MIT", "funding": { "url": "https://github.com/sponsors/ljharb" @@ -13001,9 +13006,9 @@ "license": "MIT" }, "node_modules/tape": { - "version": "5.3.1", - "resolved": "http://94.130.170.209:4873/tape/-/tape-5.3.1.tgz", - "integrity": "sha512-Mj3h+/dgfI2xct4kTpzqZaRxhhglXcMg//xGTbB0AQisfiOYa6ZBNQIgv46xi1MqbgthuNLSS1SAySDZsb7MMA==", + "version": "5.4.0", + "resolved": "http://94.130.170.209:4873/tape/-/tape-5.4.0.tgz", + "integrity": "sha512-8Cq4mql6oZVO7zkMcen+2AZoJyICsHjJqTiWk1kVub6C/EsS4o9zBVWWbvBBLzx10okW3SKCoNN9XfwfTAIR2w==", "license": "MIT", "dependencies": { "call-bind": "^1.0.2", @@ -13012,18 +13017,18 @@ "dotignore": "^0.1.2", "for-each": "^0.3.3", "get-package-type": "^0.1.0", - "glob": "^7.1.7", + "glob": "^7.2.0", "has": "^1.0.3", - "has-dynamic-import": "^2.0.0", + "has-dynamic-import": "^2.0.1", "inherits": "^2.0.4", "is-regex": "^1.1.4", "minimist": "^1.2.5", - "object-inspect": "^1.11.0", + "object-inspect": "^1.12.0", "object-is": "^1.1.5", "object.assign": "^4.1.2", "resolve": "^2.0.0-next.3", "resumer": "^0.0.0", - "string.prototype.trim": "^1.2.4", + "string.prototype.trim": "^1.2.5", "through": "^2.3.8" }, "bin": { @@ -14346,6 +14351,15 @@ "to-fast-properties": "^2.0.0" } }, + "@chris.troutner/bip32-utils": { + "version": "1.0.5", + "resolved": "http://94.130.170.209:4873/@chris.troutner%2fbip32-utils/-/bip32-utils-1.0.5.tgz", + "integrity": "sha512-pa9dh5VpPmfol1bdLy+FyqONmxlf/QH6Q01a57OP6C9gTVOZM1Rt0kCLXxXKC6e2AnNIrXpYN1UtlyBm+r6P0g==", + "requires": { + "keccak": "^3.0.1", + "tape": "*" + } + }, "@dabh/diagnostics": { "version": "2.0.2", "resolved": "http://94.130.170.209:4873/@dabh%2fdiagnostics/-/diagnostics-2.0.2.tgz", @@ -14601,12 +14615,12 @@ } }, "@psf/bch-js": { - "version": "4.20.21", - "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-4.20.21.tgz", - "integrity": "sha512-0dvKpGZuJOwwW+Mk/Gz+0/jzrUUCmScv7ocxBsr2/e0ALHIMnKe9ykIuuxloaa+ZOiSxz5H2Ine/Yn1Ei23WPw==", + "version": "4.21.0", + "resolved": "http://94.130.170.209:4873/@psf%2fbch-js/-/bch-js-4.21.0.tgz", + "integrity": "sha512-UIiwTsWzJHfQjo/stGuZ1j34V2qKN6r5B7CLT+HbDVMRlmgCoMJq6gsokzDizig9zdDUWZeKDpsiBS/r54qaDA==", "requires": { + "@chris.troutner/bip32-utils": "1.0.5", "@psf/bip21": "2.0.1", - "@psf/bip32-utils": "1.0.1", "@psf/bitcoincash-ops": "2.0.0", "@psf/bitcoincashjs-lib": "4.0.2", "@psf/coininfo": "4.0.0", @@ -14661,15 +14675,6 @@ "qs": "^6.3.0" } }, - "@psf/bip32-utils": { - "version": "1.0.1", - "resolved": "http://94.130.170.209:4873/@psf%2fbip32-utils/-/bip32-utils-1.0.1.tgz", - "integrity": "sha512-Q4fayYLTZYDQTr/UMas1Zf+LdTBCFuJwPWFWMf36TlhlFSBB+i0cDI2fvbaqaVwUChNQ0ppFrPmypYSgtp4oow==", - "requires": { - "keccak": "^3.0.1", - "tape": "*" - } - }, "@psf/bitcoincash-ops": { "version": "2.0.0", "resolved": "http://94.130.170.209:4873/@psf%2fbitcoincash-ops/-/bitcoincash-ops-2.0.0.tgz", @@ -17520,11 +17525,12 @@ "integrity": "sha512-LSBS2LjbNBTf6287JEbEzvJgftkF5qFkmCo9hDRpAzKhUOlJ+hx8dd4USs00SgsUNwc4617J9ki5YtEClM2ffA==" }, "has-dynamic-import": { - "version": "2.0.0", - "resolved": "http://94.130.170.209:4873/has-dynamic-import/-/has-dynamic-import-2.0.0.tgz", - "integrity": "sha512-GYPi/aZmACJVrVfEhP1rNUFmtCuK+SQ96mn8Bs7mXiGZRAJiI4VjaMmjj4uuvW8qaF085uWJvyJk9UNYUIYn0A==", + "version": "2.0.1", + "resolved": "http://94.130.170.209:4873/has-dynamic-import/-/has-dynamic-import-2.0.1.tgz", + "integrity": "sha512-X3fbtsZmwb6W7fJGR9o7x65fZoodygCrZ3TVycvghP62yYQfS0t4RS0Qcz+j5tQYUKeSWS09tHkWW6WhFV3XhQ==", "requires": { - "call-bind": "^1.0.2" + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" } }, "has-flag": { @@ -18064,9 +18070,13 @@ } }, "is-weakset": { - "version": "2.0.1", - "resolved": "http://94.130.170.209:4873/is-weakset/-/is-weakset-2.0.1.tgz", - "integrity": "sha512-pi4vhbhVHGLxohUw7PhGsueT4vRGFoXhP7+RGN0jKIv9+8PWYCQTqtADngrxOm2g46hoH0+g8uZZBzMrvVGDmw==" + "version": "2.0.2", + "resolved": "http://94.130.170.209:4873/is-weakset/-/is-weakset-2.0.2.tgz", + "integrity": "sha512-t2yVvttHkQktwnNNmBQ98AhENLdPUTDTE21uPqAQ0ARwQfGeQKRVS0NNurH7bTf7RrvcVn1OOge45CnBeHCSmg==", + "requires": { + "call-bind": "^1.0.2", + "get-intrinsic": "^1.1.1" + } }, "is-windows": { "version": "1.0.2", @@ -21395,9 +21405,9 @@ "dev": true }, "object-inspect": { - "version": "1.11.0", - "resolved": "http://94.130.170.209:4873/object-inspect/-/object-inspect-1.11.0.tgz", - "integrity": "sha512-jp7ikS6Sd3GxQfZJPyH3cjcbJF6GZPClgdV+EFygjFLQ5FmW/dRUnTd9PQ9k0JhoNDabWFbpF1yCdSWCC6gexg==" + "version": "1.12.0", + "resolved": "http://94.130.170.209:4873/object-inspect/-/object-inspect-1.12.0.tgz", + "integrity": "sha512-Ho2z80bVIvJloH+YzRmpZVQe87+qASmBUKZDWgx9cu+KDrX2ZDH/3tMy+gXbZETVGs2M8YdxObOh7XAtim9Y0g==" }, "object-is": { "version": "1.1.5", @@ -23240,9 +23250,9 @@ } }, "tape": { - "version": "5.3.1", - "resolved": "http://94.130.170.209:4873/tape/-/tape-5.3.1.tgz", - "integrity": "sha512-Mj3h+/dgfI2xct4kTpzqZaRxhhglXcMg//xGTbB0AQisfiOYa6ZBNQIgv46xi1MqbgthuNLSS1SAySDZsb7MMA==", + "version": "5.4.0", + "resolved": "http://94.130.170.209:4873/tape/-/tape-5.4.0.tgz", + "integrity": "sha512-8Cq4mql6oZVO7zkMcen+2AZoJyICsHjJqTiWk1kVub6C/EsS4o9zBVWWbvBBLzx10okW3SKCoNN9XfwfTAIR2w==", "requires": { "call-bind": "^1.0.2", "deep-equal": "^2.0.5", @@ -23250,18 +23260,18 @@ "dotignore": "^0.1.2", "for-each": "^0.3.3", "get-package-type": "^0.1.0", - "glob": "^7.1.7", + "glob": "^7.2.0", "has": "^1.0.3", - "has-dynamic-import": "^2.0.0", + "has-dynamic-import": "^2.0.1", "inherits": "^2.0.4", "is-regex": "^1.1.4", "minimist": "^1.2.5", - "object-inspect": "^1.11.0", + "object-inspect": "^1.12.0", "object-is": "^1.1.5", "object.assign": "^4.1.2", "resolve": "^2.0.0-next.3", "resumer": "^0.0.0", - "string.prototype.trim": "^1.2.4", + "string.prototype.trim": "^1.2.5", "through": "^2.3.8" }, "dependencies": { diff --git a/package.json b/package.json index b3996d2..4912bba 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { - "name": "@chris.troutner/npm-lib-boilerplate", + "name": "bch-consumer", "version": "1.0.0", - "description": "A boilerplate for creating an npm library with Semantic Release, linting, and tests.", + "description": "A npm JS library for interacting with ipfs-bch-wallet-consumer REST API", "main": "index.js", "scripts": { "start": "node index.js", @@ -28,12 +28,12 @@ "author": "Chris Troutner ", "license": "MIT", "apidoc": { - "title": "npm-lib-boilerplate", + "title": "bch-consumer", "url": "localhost:5000" }, - "repository": "christroutner/npm-lib-boilerplate", + "repository": "Permissionless-Software-Foundation/bch-consumer", "dependencies": { - "@psf/bch-js": "4.20.21", + "@psf/bch-js": "4.21.0", "apidoc": "0.25.0" }, "devDependencies": { @@ -45,13 +45,13 @@ "eslint-plugin-node": "11.1.0", "eslint-plugin-prettier": "3.3.1", "eslint-plugin-standard": "4.0.0", - "husky": "^4.3.8", + "husky": "4.3.8", "lodash.clonedeep": "4.5.0", - "mocha": "^8.4.0", + "mocha": "8.4.0", "nyc": "15.1.0", "semantic-release": "17.4.2", "sinon": "9.2.2", - "standard": "^16.0.4" + "standard": "16.0.4" }, "release": { "publish": [