Skip to content

Commit

Permalink
Update documentation, improve logging
Browse files Browse the repository at this point in the history
  • Loading branch information
martindale committed Dec 5, 2024
1 parent 753f69a commit 4febaf4
Show file tree
Hide file tree
Showing 9 changed files with 20 additions and 24 deletions.
2 changes: 1 addition & 1 deletion DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion GOALS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
2 changes: 1 addition & 1 deletion QUICKSTART.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion examples/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
23 changes: 10 additions & 13 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions reports/TODO.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion reports/install.log
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion types/service.js
Original file line number Diff line number Diff line change
Expand Up @@ -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}`);
Expand Down

0 comments on commit 4febaf4

Please sign in to comment.