mirror of https://codeberg.org/pzp/pzp-wiki.git
August update all over the place
This commit is contained in:
Andre Staltz
parent
566a989262
commit
86cc6f6fbb
|
|
@ -1,116 +0,0 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Account
|
||||
|
||||
An account is a special type of tangle, where the messages describe which keypairs are part of the same "account".
|
||||
|
||||
```mermaid
|
||||
graph RL;
|
||||
D--"A"-->C--"A"-->B--"A"-->A;
|
||||
F-->E-->C;
|
||||
G-->D & F;
|
||||
|
||||
style A color:red;
|
||||
```
|
||||
|
||||
Msgs in an account tangle are special because they have empty `account` and `accountTips` fields.
|
||||
|
||||
```typescript
|
||||
interface Msg {
|
||||
data: AccountData
|
||||
metadata: {
|
||||
dataHash: ContentHash
|
||||
dataSize: number
|
||||
account: 'self' // MUST be the string 'self'
|
||||
accountTips: null // MUST be null
|
||||
tangles: {
|
||||
[accountTangleId: string]: {
|
||||
depth: number // maximum distance (positive integer) from this msg to the root
|
||||
prev: Array<MsgHash> // list of msg hashes of existing msgs, unique set and ordered alphabetically
|
||||
}
|
||||
}
|
||||
domain: string // alphanumeric string, at least 3 chars, max 100 chars
|
||||
v: 3
|
||||
}
|
||||
pubkey: Pubkey
|
||||
sig: Signature
|
||||
}
|
||||
|
||||
type AccountData =
|
||||
| { action: 'add', add: AccountAdd }
|
||||
| { action: 'del', del: AccountDel }
|
||||
|
||||
// "add" means this keypair can validly add more keypairs to the account tangle
|
||||
// "del" means this keypair can validly revoke other keypairs from the account
|
||||
// "box" means the peer with this keypair should get access to the box keypair
|
||||
type AccountPower = 'add' | 'del' | 'box'
|
||||
|
||||
type AccountAdd = {
|
||||
key: Key
|
||||
nonce?: string // nonce required only on the account tangle's root
|
||||
consent?: string // base58 encoded signature of the string `:account-add:<ID>` where `<ID>` is the account's ID, required only on non-root msgs
|
||||
accountPowers?: Array<AccountPower> // list of powers granted to this key, defaults to []
|
||||
}
|
||||
|
||||
type AccountDel = {
|
||||
key: Key
|
||||
}
|
||||
|
||||
type Key =
|
||||
| {
|
||||
purpose: 'sig' // digital signatures
|
||||
algorithm: 'ed25519' // libsodium crypto_sign_detached
|
||||
bytes: string // base58 encoded string for the public key being added
|
||||
}
|
||||
| {
|
||||
// WIP!!
|
||||
purpose: 'box' // asymmetric encryption
|
||||
algorithm: 'x25519-xsalsa20-poly1305' // libsodium crypto_box_easy
|
||||
bytes: string // base58 encoded string of the public key
|
||||
}
|
||||
```
|
||||
|
||||
Examples of `accountData`:
|
||||
|
||||
- Registering the first signing pubkey:
|
||||
```json
|
||||
{
|
||||
"action": "add",
|
||||
"add": {
|
||||
"key": {
|
||||
"purpose": "sig",
|
||||
"algorithm": "ed25519",
|
||||
"bytes": "3JrJiHEQzRFMzEqWawfBgq2DSZDyihP1NHXshqcL8pB9"
|
||||
},
|
||||
"nonce": "6GHR1ZFFSB3C5qAGwmSwVH8f7byNo8Cqwn5PcyG3qDvS"
|
||||
}
|
||||
}
|
||||
```
|
||||
- Registering a subaccount:
|
||||
```json
|
||||
{
|
||||
"action": "add",
|
||||
"add": {
|
||||
"key": {
|
||||
"purpose": "subaccount",
|
||||
"algorithm": "tangle",
|
||||
"bytes": "6yqq7iwyJEKdofJ3xpRLEq"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
- Revoking a signing pubkey:
|
||||
```json
|
||||
{
|
||||
"action": "del",
|
||||
"del": {
|
||||
"key": {
|
||||
"purpose": "sig",
|
||||
"algorithm": "ed25519",
|
||||
"bytes": "3JrJiHEQzRFMzEqWawfBgq2DSZDyihP1NHXshqcL8pB9"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
@ -1,9 +1,144 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
sidebar_position: 30
|
||||
---
|
||||
|
||||
# Feed
|
||||
|
||||
:::note Definition
|
||||
**A feed is an evolving set of interlinked messages intended for continuous replication in a gossip network.**
|
||||
:::
|
||||
|
||||
In computer science terms, it's an Directed Acyclic Graph (DAG) with only one source node, where all the "nodes" are messages, and "edges" are references that each message contains of other messages.
|
||||
|
||||
```mermaid
|
||||
graph RL;
|
||||
D--"A"-->C--"A"-->B--"A"-->A;
|
||||
F-->E-->C;
|
||||
G-->D & F;
|
||||
|
||||
style A color:red;
|
||||
```
|
||||
|
||||
The root is...
|
||||
|
||||
The tangle is identified by the hash of its root message.
|
||||
|
||||
|
||||
# Account
|
||||
|
||||
An account is a special type of tangle, where the messages describe which keypairs are part of the same "account".
|
||||
|
||||
```mermaid
|
||||
graph RL;
|
||||
D--"A"-->C--"A"-->B--"A"-->A;
|
||||
F-->E-->C;
|
||||
G-->D & F;
|
||||
|
||||
style A color:red;
|
||||
```
|
||||
|
||||
Msgs in an account tangle are special because they have empty `account` and `accountTips` fields.
|
||||
|
||||
```typescript
|
||||
interface Msg {
|
||||
data: AccountData
|
||||
metadata: {
|
||||
dataHash: ContentHash
|
||||
dataSize: number
|
||||
account: 'self' // MUST be the string 'self'
|
||||
accountTips: null // MUST be null
|
||||
tangles: {
|
||||
[accountTangleId: string]: {
|
||||
depth: number // maximum distance (positive integer) from this msg to the root
|
||||
prev: Array<MsgHash> // list of msg hashes of existing msgs, unique set and ordered alphabetically
|
||||
}
|
||||
}
|
||||
domain: string // alphanumeric string, at least 3 chars, max 100 chars
|
||||
v: 3
|
||||
}
|
||||
pubkey: Pubkey
|
||||
sig: Signature
|
||||
}
|
||||
|
||||
type AccountData =
|
||||
| { action: 'add', add: AccountAdd }
|
||||
| { action: 'del', del: AccountDel }
|
||||
|
||||
// "add" means this keypair can validly add more keypairs to the account tangle
|
||||
// "del" means this keypair can validly revoke other keypairs from the account
|
||||
// "box" means the peer with this keypair should get access to the box keypair
|
||||
type AccountPower = 'add' | 'del' | 'box'
|
||||
|
||||
type AccountAdd = {
|
||||
key: Key
|
||||
nonce?: string // nonce required only on the account tangle's root
|
||||
consent?: string // base58 encoded signature of the string `:account-add:<ID>` where `<ID>` is the account's ID, required only on non-root msgs
|
||||
accountPowers?: Array<AccountPower> // list of powers granted to this key, defaults to []
|
||||
}
|
||||
|
||||
type AccountDel = {
|
||||
key: Key
|
||||
}
|
||||
|
||||
type Key =
|
||||
| {
|
||||
purpose: 'sig' // digital signatures
|
||||
algorithm: 'ed25519' // libsodium crypto_sign_detached
|
||||
bytes: string // base58 encoded string for the public key being added
|
||||
}
|
||||
| {
|
||||
// WIP!!
|
||||
purpose: 'box' // asymmetric encryption
|
||||
algorithm: 'x25519-xsalsa20-poly1305' // libsodium crypto_box_easy
|
||||
bytes: string // base58 encoded string of the public key
|
||||
}
|
||||
```
|
||||
|
||||
Examples of `accountData`:
|
||||
|
||||
- Registering the first signing pubkey:
|
||||
```json
|
||||
{
|
||||
"action": "add",
|
||||
"add": {
|
||||
"key": {
|
||||
"purpose": "sig",
|
||||
"algorithm": "ed25519",
|
||||
"bytes": "3JrJiHEQzRFMzEqWawfBgq2DSZDyihP1NHXshqcL8pB9"
|
||||
},
|
||||
"nonce": "6GHR1ZFFSB3C5qAGwmSwVH8f7byNo8Cqwn5PcyG3qDvS"
|
||||
}
|
||||
}
|
||||
```
|
||||
- Registering a subaccount:
|
||||
```json
|
||||
{
|
||||
"action": "add",
|
||||
"add": {
|
||||
"key": {
|
||||
"purpose": "subaccount",
|
||||
"algorithm": "tangle",
|
||||
"bytes": "6yqq7iwyJEKdofJ3xpRLEq"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
- Revoking a signing pubkey:
|
||||
```json
|
||||
{
|
||||
"action": "del",
|
||||
"del": {
|
||||
"key": {
|
||||
"purpose": "sig",
|
||||
"algorithm": "ed25519",
|
||||
"bytes": "3JrJiHEQzRFMzEqWawfBgq2DSZDyihP1NHXshqcL8pB9"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
# Moot feeds
|
||||
|
||||
A feed is a special type of tangle, where the root is a predictable (by any peer) message with no content.
|
||||
|
||||
```mermaid
|
||||
|
|
@ -32,4 +167,4 @@ interface Msg {
|
|||
pubkey: Pubkey
|
||||
sig: Signature
|
||||
}
|
||||
```
|
||||
```
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
sidebar_position: 8
|
||||
sidebar_position: 80
|
||||
---
|
||||
|
||||
# Glossary
|
||||
|
|
@ -8,6 +8,7 @@ sidebar_position: 8
|
|||
- **Msg hash** = hash(msg.metadata)
|
||||
- **Tangle** = any single-root DAG of msgs that can be replicated by peers
|
||||
- **Tangle Root** = the origin msg of a tangle
|
||||
- **Tangle Affix** = any msg in a tangle that is not the root
|
||||
- **Tangle Tips** = tangle msgs that are not yet referenced by any other msg in the tangle
|
||||
- **Tangle ID** = Msg hash of the tangle's root msg
|
||||
- **Account tangle** = tangle with msgs that add (or remove?) asymmetric-crypto public keys
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
sidebar_position: 50
|
||||
---
|
||||
|
||||
# Hub
|
||||
# Hub
|
||||
|
||||
:::note Definition
|
||||
**A hub is a server that allow clients to communicate with each other via end-to-end encrypted tunnels. Hubs and clients form a fluid multi-star topology.**
|
||||
:::
|
||||
|
|
@ -1,5 +1,8 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
sidebar_position: 60
|
||||
---
|
||||
|
||||
# Invite
|
||||
# Invite
|
||||
|
||||
|
||||
## Promise
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Keypair
|
||||
|
||||
Asymmetric cryptographic keypair that identifies the current peer.
|
||||
|
|
@ -1,5 +1,17 @@
|
|||
---
|
||||
sidebar_position: 9
|
||||
sidebar_position: 20
|
||||
---
|
||||
|
||||
# Message
|
||||
# Message
|
||||
|
||||
:::note Definition
|
||||
**A message is a JSON encoded data structure that is signed by a peer and intended for replication in a gossip network.**
|
||||
:::
|
||||
|
||||
## Data
|
||||
|
||||
## Metadata
|
||||
|
||||
## Public key
|
||||
|
||||
## Signature
|
||||
|
|
|
|||
|
|
@ -4,3 +4,4 @@ sidebar_position: 0
|
|||
|
||||
# Overview
|
||||
|
||||
**In PZP, [peers](./peer) publish [messages](./message) on [feeds](./feed) that are [replicated](./replication) by other peers in a gossip network of [hubs](./hub). To join the network, a peer must be [invited](./invite).**
|
||||
|
|
|
|||
|
|
@ -0,0 +1,15 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
# Peer
|
||||
|
||||
:::note Definition
|
||||
**A peer is a participant in a gossip network, identified by a self-certifying cryptographic keypair.**
|
||||
:::
|
||||
|
||||
|
||||
|
||||
## Keypair for SHSe
|
||||
|
||||
Asymmetric cryptographic keypair that identifies the current peer.
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
# Promise
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
sidebar_position: 45
|
||||
---
|
||||
|
||||
# Replication
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Tangle
|
||||
|
||||
A tangle is a set of interlinked messages published by a peer. In computer science terms, it's an Directed Acyclic Graph (DAG) with only one source node, where all the "nodes" are messages, and "edges" are links between messages.
|
||||
|
||||
```mermaid
|
||||
graph RL;
|
||||
D--"A"-->C--"A"-->B--"A"-->A;
|
||||
F-->E-->C;
|
||||
G-->D & F;
|
||||
|
||||
style A color:red;
|
||||
```
|
||||
|
||||
The root is...
|
||||
|
||||
The tangle is identified by the hash of its root message.
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Sufficiency
|
||||
|
||||
Aim at "good enough" on all relevant criteria, instead of "best" on any one.
|
||||
|
|
@ -2,10 +2,9 @@
|
|||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Communities
|
||||
# Villages
|
||||
|
||||
|
||||
> We are not trying to fix social media, we are trying to make it irrelevant. We want to bring back villages and networks of friendships as a essential component in society.
|
||||
> We are not trying to fix social media, we are trying to make it less central in our lives. As a replacement, we want to increase the role of villages, networks of friends, and small communities in society.
|
||||
|
||||
| Small (dozens) | Medium (hundreds) | Large (thousands+) |
|
||||
|---|---|---|
|
||||
Loading…
Reference in New Issue