From 4febaf417ae1dcfc06379a5bd6debb69e3ec91b2 Mon Sep 17 00:00:00 2001 From: Eric Martindale Date: Thu, 5 Dec 2024 01:10:39 -0800 Subject: [PATCH] Update documentation, improve logging --- DEVELOPERS.md | 2 +- GOALS.md | 2 +- INSTALL.md | 6 +++--- QUICKSTART.md | 2 +- examples/app.js | 2 +- package-lock.json | 23 ++++++++++------------- reports/TODO.txt | 3 +-- reports/install.log | 2 +- types/service.js | 2 +- 9 files changed, 20 insertions(+), 24 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 28d77dcbc..8b85c7957 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -5,7 +5,7 @@ applications, so grab a coffee ☕ and settle in. ## Quick Start See also [`QUICKSTART.md`][quickstart-guide] for up-to-date instructions. -0. `nvm use 18.19.0` (you can get `nvm` from [nvm.sh][nvm-official]) +0. `nvm use 18.19.1` (you can get `nvm` from [nvm.sh][nvm-official]) 1. `npm install -g @fabric/core` to add `fabric` to your path 2. (optional) `fabric setup` to set up your environment (generates a new master key) 3. `fabric` should now be enough to get you up and running! diff --git a/GOALS.md b/GOALS.md index 909f7a7e4..f264369b0 100644 --- a/GOALS.md +++ b/GOALS.md @@ -17,7 +17,7 @@ and no mission succeeds without a clearly-defined set of goals. ## Current Goals These are our immediate goals: -- [ ] Find all TODO items (run script, check diff) +- [x] Find all TODO items (run script, check diff) - [ ] Audit all documentation - [ ] Check all hyperlinks on `npm run dev` - [ ] 100% test coverage diff --git a/INSTALL.md b/INSTALL.md index 38b6e86e6..d8cd77cc6 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,6 +1,6 @@ # Installing Fabric ## Prerequisites -- Node.js 18.19.0 +- Node.js 18.19.1 ## Quick Start You can install Fabric by running: @@ -24,8 +24,8 @@ By default, the Fabric CLI connects to `playnet` for an initial set of peers. Y ## Notes If you don't have Node.js, or an incorrect version, we recommend [installing NVM][installing-nvm]. Once complete, you can install and set the default node version: ``` -nvm install 18.19.0 -nvm alias default 18.19.0 # optional +nvm install 18.19.1 +nvm alias default 18.19.1 # optional ``` [installing-nvm]: https://nvm.sh diff --git a/QUICKSTART.md b/QUICKSTART.md index c450d2cb9..af43e1aba 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -2,7 +2,7 @@ ## Prerequisites 0. (optional) Install NVM: `https://nvm.sh` -1. Install Node 18.19.0 (use `nvm install 18.19.0` if using `nvm`) +1. Install Node 18.19.1 (use `nvm install 18.19.1` if using `nvm`) ## Instructions 0. Meet the prerequisites (above) diff --git a/examples/app.js b/examples/app.js index ae0eaad57..66938013b 100644 --- a/examples/app.js +++ b/examples/app.js @@ -5,7 +5,7 @@ // This example is intended for downstream consumers — those seeking to implement client-facing applications using Fabric. // // ## Quickstart -// Ensure that you are using NodeJS `18.19.0` — execute in your clone of the Fabric Core repository. +// Ensure that you are using NodeJS `18.19.1` — execute in your clone of the Fabric Core repository. // // ### Cloning Fabric // Run the following commands: diff --git a/package-lock.json b/package-lock.json index 8e60f856d..a79e20480 100644 --- a/package-lock.json +++ b/package-lock.json @@ -189,12 +189,12 @@ } }, "node_modules/@babel/parser": { - "version": "7.26.2", - "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.2.tgz", - "integrity": "sha512-DWMCZH9WA4Maitz2q21SRKHo9QXZxkDsbNZoVD62gusNtNBBqDg9i7uOhASfTfIGNzW+O+r7+jAlM8dwphcJKQ==", + "version": "7.26.3", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.26.3.tgz", + "integrity": "sha512-WJ/CvmY8Mea8iDXo6a7RK2wbmJITT5fN3BEkRuFlxVyNx8jOKIIhmC4fSkTcPcf8JyavbBwIe6OpiCOBXt/IcA==", "dev": true, "dependencies": { - "@babel/types": "^7.26.0" + "@babel/types": "^7.26.3" }, "bin": { "parser": "bin/babel-parser.js" @@ -204,9 +204,9 @@ } }, "node_modules/@babel/types": { - "version": "7.26.0", - "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.0.tgz", - "integrity": "sha512-Z/yiTPj+lDVnF7lWeKCIJzaIkI0vYO87dMpZ4bg4TDrFe4XXLFWL1TbXU27gBP3QccxV9mZICCrnjnYlJjXHOA==", + "version": "7.26.3", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.26.3.tgz", + "integrity": "sha512-vN5p+1kl59GVKMvTHt55NzzmYVxprfJD+ql7U9NFIfKCBkYE55LYtS+WtPlaYOyzydrKI8Nezd+aZextrd+FMA==", "dev": true, "dependencies": { "@babel/helper-string-parser": "^7.25.9", @@ -3600,12 +3600,9 @@ } }, "node_modules/gopd": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.1.0.tgz", - "integrity": "sha512-FQoVQnqcdk4hVM4JN1eromaun4iuS34oStkdlLENLdpULsuQcTyXj8w7ayhuUfPwEYZ1ZOooOTT6fdA9Vmx/RA==", - "dependencies": { - "get-intrinsic": "^1.2.4" - }, + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz", + "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==", "engines": { "node": ">= 0.4" }, diff --git a/reports/TODO.txt b/reports/TODO.txt index 61a02f5af..34506738e 100644 --- a/reports/TODO.txt +++ b/reports/TODO.txt @@ -231,7 +231,6 @@ ./types/stack.js: // TODO: return Transaction ./API.md:TODO: move to @fabric/http/types/spa ./API.md:TODO: move to @fabric/http/types/spa -./API.md:TODO: move to @fabric/http/types/spa ./SUMMARY.md:* [✅ TODO List][todo] ./SUMMARY.md:[todo]: TODO.md ./fabric-whitepaper.md:### TODO: include content hashes of links as they appear at document compilation time. @@ -299,7 +298,7 @@ ./scripts/chat.js: // TODO: replicate this program in C / ASM ./scripts/transfer.js: // TODO: add support for segwit, taproot ./functions/_handleFabricMessage.js: const message = Message.fromVector([...data]); // TODO: redefine... -./GOALS.md:- [ ] Find all TODO items (run script, check diff) +./GOALS.md:- [x] Find all TODO items (run script, check diff) ./services/bitcoin.js:// TODO: replace with `secp256k1` ./services/bitcoin.js: // httpPort: 48449, // TODO: disable HTTP entirely! ./services/bitcoin.js: // TODO: import ZMQ settings diff --git a/reports/install.log b/reports/install.log index 9622f661f..e0d724eb7 100644 --- a/reports/install.log +++ b/reports/install.log @@ -1,6 +1,6 @@ $ npm i -added 791 packages, and audited 792 packages in 28s +added 791 packages, and audited 792 packages in 14s 90 packages are looking for funding run `npm fund` for details diff --git a/types/service.js b/types/service.js index 37b7f6ade..92e2d0008 100644 --- a/types/service.js +++ b/types/service.js @@ -400,7 +400,7 @@ class Service extends Actor { self.emit('debug', `[FABRIC:SERVICE] Source "${name}" emitted channel: ${JSON.stringify(channel, null, ' ')}`); }), _handleCommit: source.on('commit', async function (commit) { - self.emit('log', `[FABRIC:SERVICE] Source "${name}" committed: ${JSON.stringify(commit, null, ' ')}`); + self.emit('debug', `[FABRIC:SERVICE] Source "${name}" committed: ${JSON.stringify(commit, null, ' ')}`); }), _handleError: source.on('error', async function _handleTrustedError (error) { self.emit('debug', `[FABRIC:SERVICE] Source "${name}" emitted error: ${error}`);