Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RC1 #149

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

RC1 #149

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v18.19.0
v18.19.1
3,412 changes: 992 additions & 2,420 deletions API.md

Large diffs are not rendered by default.

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
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,21 +145,25 @@ Either Fabric libraries or projects running Fabric, this list encompasses the mo
| [`labs.fabric.pub`](https://labs.fabric.pub) |
| [`grove.chat`][chat] |
| `sensemaker.io` | | | `FALSE`
| `verse.pub`
| `trynovo.com` | | | `FALSE`
| `verse.pub` | | |

## Learning More
The best place to get started is in [the #learning channel][learning], a
collection of empassioned educators eager to help you.

Fabric on Twitter: [@FabricProtocol][twitter]

[fabric]: fabric:

[bitcoin]: https://bitcoin.org
[build-guide]: BUILD.md
[chat]: https://grove.chat
[chat-help]: https://grove.chat/#/room/#help:fabric.pub
[chat-support]: https://grove.chat/#/room/#help:fabric.pub
[coverage]: https://codecov.io/gh/FabricLabs/fabric
[development]: https://grove.chat/#/room/#development:fabric.pub
[fabric-fm]: https://fabric.fm
[fabric-pub]: https://fabric.pub
[fabric-github]: https://github.com/FabricLabs/fabric
[fabric-http]: https://github.com/FabricLabs/fabric-http
[protocol]: PROTOCOL.md
Expand Down
5 changes: 5 additions & 0 deletions constants.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ const P2P_MUSIG_SEND_PROPOSAL = 0x4223;
const P2P_MUSIG_REPLY_TO_PROPOSAL = 0x4224;
const P2P_MUSIG_ACCEPT_PROPOSAL = 0x4225;

// Message Types
const PEER_CANDIDATE = 0x09;
// TODO: should be 0x02 for Bitcoin P2P
const BLOCK_CANDIDATE = 0x03;
Expand All @@ -117,6 +118,9 @@ const ZERO_LENGTH_PLAINTEXT = '';
// HTTP
const HTTP_HEADER_CONTENT_TYPE = 'application/json';

// UI
const INPUT_HINT = 'Press the "i" key to begin typing.';

// CommonJS Support
module.exports = {
PEER_PORT,
Expand All @@ -137,6 +141,7 @@ module.exports = {
LARGE_COLLECTION_SIZE,
BLOCK_CANDIDATE,
CHAT_MESSAGE,
INPUT_HINT,
ZERO_LENGTH_PLAINTEXT,
FABRIC_PLAYNET_ADDRESS,
FABRIC_PLAYNET_ORIGIN,
Expand Down
Loading
Loading