Skip to content

Commit

Permalink
Editorial corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
misaakidis committed Jan 12, 2021
1 parent 4b88fe4 commit 5ce3952
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 16 deletions.
File renamed without changes
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
home: true
metaTitle: biton — re-build the Internet, together!
metaTitle: biton | Re-build the Internet, together!
heroImage: /logo.png
heroText: Re-build the Internet, together!
tagline: null
Expand Down Expand Up @@ -37,7 +37,7 @@ community networks around local data and services.

If you need to hide your identity, biton is not ready for that just yet.
In the meantime, take a look at [Tor](https://www.torproject.org/) and
[I2P](https://geti2p.net) for anonymous browsing, or at
[I2P](https://geti2p.net) for browsing anonymous services, or at
[Freenet](https://freenetproject.org) for anonymous publishing.
:::

Expand Down
12 changes: 6 additions & 6 deletions docs/guide/intro/developers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# A building block for a local-first Internet
# A building block for peer-to-peer applications

## Full and light biton nodes

Expand All @@ -12,9 +12,9 @@
| OSI Model |
+------------------------+
+------------------------+ +--------------+ +---------------+ +------------+
| Application | | npm module | | hybrid client | | web client |
+------------------------+ +--------------+ +---------------+ +------------+
+------------------------+ +--------------+ +------------+ +---------+
| Application | | npm module | | hybrid app | | web app |
+------------------------+ +--------------+ +------------+ +---------+
| Presentation |
+------------------------+ +------------------+
| Session | | redux middleware |
Expand All @@ -28,7 +28,7 @@
| Interface | Repository | Implementation | Proxying | Storage | Full node |
|----------:|:----------:|:--------------:|:--------:|:-------:|:---------:|
| biton npm module | [biton](https://github.com/bitonproject/biton) | Extending [WebTorrent](https://github.com/WebTorrent) (Node.js) | Yes | Yes | Yes |
| hybrid client | [biton/bin](https://github.com/bitonproject/biton/tree/master/bin) | Demo CLI client that supports WebRTC and TCP connections (Node.js, using the npm module) | Yes | Yes | Yes |
| web client | [biton-web](https://github.com/bitonproject/biton-web) | Web interface (React, integrating the redux middleware) | Yes | Yes | Yes |
| biton hybrid app | [biton/bin](https://github.com/bitonproject/biton/tree/master/bin) | Demo CLI that supports WebRTC and TCP connections (Node.js, using the npm module) | Yes | Yes | Yes |
| web app | [biton-web](https://github.com/bitonproject/biton-web) | Web interface (React, integrating the redux middleware) | Yes | Yes | Yes |
| redux middleware | | Redux middleware (using the biton npm module) | Yes | No | No |
| libp2p transport | [js-libp2p-biton](https://github.com/bitonproject/js-libp2p-biton) | [Libp2p transport](https://github.com/libp2p/js-libp2p-interfaces/tree/master/src/transport) (Node.js using the biton npm module) | Yes | No | No |
4 changes: 2 additions & 2 deletions docs/guide/run/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Join the biton network

A demo of the [biton hybrid](https://github.com/bitonproject/biton) Web interface
is live at <https://demo.bitonproject.org>.
Visit <https://demo.bitonproject.org> for a live demo of the
[biton hybrid](https://github.com/bitonproject/biton) Web interface.
10 changes: 4 additions & 6 deletions docs/guide/tech/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This document outlines the specification for `biton0_BitTorrent`.

* `x || y` is the concatenation of x and y without a separator.
* `x |& y` concatenates x and y with an ampersand character ('&') as separator. You must use this concatenation when a field is optional. In that case, we write no bytes for the empty fields, but still add the separators.
* `\[ ]` denotes byte (uint8_t) arrays.
* `[ ]` denotes byte (uint8_t) arrays.
* `s[:n]` is the first n bytes of s.
* All numeric fields in the wire protocol are transmitted as Big Endian (Network byte order) values.
* For fields of variable length, we write the field length followed by the field value.
Expand All @@ -28,17 +28,15 @@ This document outlines the specification for `biton0_BitTorrent`.
* `bitonCrypto.hash = Blake2b_256`


## biton client address
## biton node address

```
keypair = bitonCrypto.generateKeyPair().x25519
identity = bitonCrypto.base58.encode(keypair.public)
peerId = WebTorrent.VERSION_PREFIX[:8] || identity[:12]
```

> Example: for`identity = BkZgDsGD94DtZ83BwsHgce4Q4j2qr5PQGpjPQnPj8BGs`:
` peerId = -WW0008-BkZgDsGD94Dt` in utf8,
or `peerId = 2d5757303030382d426b5a674473474439344474` in hex.
> Example: for`identity = BkZgDsGD94DtZ83BwsHgce4Q4j2qr5PQGpjPQnPj8BGs`, `peerId = -WW0008-BkZgDsGD94Dt` in utf8, or `peerId = 2d5757303030382d426b5a674473474439344474` in hex.

## biton swarm address
Expand All @@ -59,7 +57,7 @@ or `peerId = 2d5757303030382d426b5a674473474439344474` in hex.
* `chunkId = bitonCrypto.hash(biton.VERSION |& networkMagic |& swarmSecret |& chunkHash)`
* Mesospore wire header: `sporeId = spore.VERSION || networkMagic || chunkId || capabilities || chunk`

Chunks are 1KB or 32KB parts of a `bitonCrypto.secretstream`
Chunks are 1KiB, 32KiB, or 256KiB parts of `bitonCrypto.secretstream`

> Example: `sporeId = "spore0" || [0, 0, 0, 0] || chunkId || capabilities || chunk`
Expand Down

0 comments on commit 5ce3952

Please sign in to comment.