Skip to content

Commit 4391c5d

Browse files
author
Wes Biggs
committed
Update Frequency docs
1 parent 6279e56 commit 4391c5d

File tree

3 files changed

+19
-24
lines changed

3 files changed

+19
-24
lines changed

pages/Frequency/Overview.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,19 @@ Official schemas may be found in [GitHub](https://github.com/LibertyDSNP/schemas
1919

2020
<!-- These ids are duplicated here for quick reference. -->
2121

22-
| Name | Schema Id Mainnet | Schema Id Testnet (Paseo) | Schema Id Testnet (Rococo) |
23-
| --- | --- | --- | --- |
24-
| [Tombstone](./Publishing.md) | 1 | 1 | 1 |
25-
| [Broadcast](./Publishing.md) | 2 | 2 | 2 |
26-
| [Reply](./Publishing.md) | 3 | 3 | 3 |
27-
| [Reaction](./Publishing.md)| 4 | 4 | 4 |
28-
| [Profile](./Publishing.md) | 6 | 6 | 5 |
29-
| [Update](./Publishing.md)| 5 | 5 | 6 |
30-
| [Public Key](./Publishing.md)| 7 | 7 | 18 |
31-
| [Public Follows](./UserData.md)| 8 | 8 | 13 |
32-
| [Private Follows](./UserData.md) | 9 | 9 | 14 |
33-
| [Private Connections](./UserData.md) | 10 | 10 | 15 |
22+
| Name | Schema Name | Schema Id Mainnet | Schema Id Testnet (Paseo) | Schema Id Testnet (Rococo) |
23+
| --- | --- | --- | --- | --- |
24+
| [Tombstone](./Publishing.md) | `dsnp.tombstone` | 1 | 1 | 1 |
25+
| [Broadcast](./Publishing.md) | `dsnp.broadcast` | 2 | 2 | 2 |
26+
| [Reply](./Publishing.md) | `dsnp.reply` | 3 | 3 | 3 |
27+
| [Reaction](./Publishing.md)| `dsnp.reaction` | 4 | 4 | 4 |
28+
| [Profile](./Publishing.md) | `dsnp.profile` | 6 | 6 | 5 |
29+
| [Update](./Publishing.md)| `dsnp.update` | 5 | 5 | 6 |
30+
| [Public Key (Key Agreement)](./UserData.md)| `dsnp.public-key-key-agreement` | 7 | 7 | 18 |
31+
| [Public Follows](./UserData.md)| `dsnp.public-follows` | 8 | 8 | 13 |
32+
| [Private Follows](./UserData.md) | `dsnp.private-follows` | 9 | 9 | 14 |
33+
| [Private Connections](./UserData.md) | `dsnp.private-connections` | 10 | 10 | 15 |
34+
| [Public Key (Assertion Method)](./UserData.md)| `dsnp.public-key-assertion-method` | TBD | 11 | 100 |
3435

3536
<!--
3637
### Obsolete
@@ -50,4 +51,4 @@ Official schemas may be found in [GitHub](https://github.com/LibertyDSNP/schemas
5051

5152
| Last Update Date | Frequency Release | DSNP Version |
5253
| --- | --- | --- |
53-
| 2023-07-17 | 1.5.2+ | 1.2.0 |
54+
| 2024-04-12 | 1.10.0+ | pre-1.3.0 |

pages/Frequency/Publishing.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Announcement Publishing
22

3-
On Frequency, [Announcements](../DSNP/Announcements.md) are mapped to Schemas which in turn publish Frequency Messages or Stateful Storage changes.
3+
On Frequency, [Announcements](../DSNP/Announcements.md) are mapped to Schemas which in turn publish Frequency Messages.
44
Frequency Messages are either individual Announcements from a particular user, or a Batch Publication with a multitude of possible users.
5-
Frequency Stateful Storage is either direct Announcements from a particular user or [User Data](./UserData.md) changes.
65

76
<!-- Links to https://libertydsnp.github.io/frequency should be updated with links to docs.frequency.xyz when able to be -->
87

@@ -16,7 +15,6 @@ Frequency Stateful Storage is either direct Announcements from a particular user
1615
| 4 | [Reaction](../DSNP/Types/Reaction.md) | Batched | Mainnet: 4<br />Testnet (Paseo): 4<br />Testnet (Rococo): 4 | [`Parquet`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
1716
| 5 | [Profile](../DSNP/Types/Profile.md) | Batched | Mainnet: 6<br />Testnet (Paseo): 6<br />Testnet (Rococo): 5 | [`Parquet`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
1817
| 6 | [Update](../DSNP/Types/Update.md) | Batched | Mainnet: 5<br />Testnet (Paseo): 5<br />Testnet (Rococo): 6 | [`Parquet`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
19-
| 7 | [Public Key](../DSNP/Types/PublicKey.md) | [Stateful](./UserData.md#announcements) | Mainnet: 7<br />Testnet (Paseo): 7<br />Testnet (Rococo): 18 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Itemized`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Itemized) |
2018

2119
Source code for each schema is located in the [LibertyDSNP/schemas](https://github.com/LibertyDSNP/schemas) repository.
2220

pages/Frequency/UserData.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,23 @@
11
# Frequency User Data
22

3-
On Frequency, User Data and select Announcements are mapped to Schemas which use [Stateful Storage](https://libertydsnp.github.io/frequency/pallet_stateful_storage/index.html) for storage and retrieval of the data.
3+
On Frequency, User Data is mapped to Schemas which use [Stateful Storage](https://libertydsnp.github.io/frequency/pallet_stateful_storage/index.html) for storage and retrieval of the data.
44

55
## User Data Sets
66

77
<!-- Update ./Overview.md if a Schema Id is updated -->
88

99
| User Data Set | Deployed Schema Ids | Frequency Model Type | Frequency Payload Location | Settings |
1010
| --- | --- | --- | --- | --- |
11+
| [Public Key (Key Agreement)](../DSNP/Types/PublicKeyUserData.md) | Mainnet: 7<br />Testnet (Paseo): 7<br />Testnet (Rococo): 7 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Itemized`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Itemized) | [Append Only](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.AppendOnly), [Signature Required](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.SignatureRequired) |
1112
| [Public Follows](../DSNP/Graph.md#public-follows) | Mainnet: 8<br />Testnet (Paseo): 8<br />Testnet (Rococo): 13 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Paginated`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Paginated) | None |
1213
| [Private Follows](../DSNP/Graph.md#private-follows) | Mainnet: 9<br />Testnet (Paseo): 9<br />Testnet (Rococo): 14 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Paginated`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Paginated) | None |
1314
| [Private Connections](../DSNP/Graph.md#private-connections) | Mainnet: 10<br />Testnet (Paseo): 10<br />Testnet (Rococo): 15 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Paginated`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Paginated) | None |
15+
| [Public Key (Assertion Method)](../DSNP/Types/PublicKeyUserData.md) | Mainnet: TBD <br />Testnet (Paseo): 11<br />Testnet (Rococo): 100 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Itemized`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Itemized) | [Append Only](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.AppendOnly), [Signature Required](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.SignatureRequired) |
1416

15-
[Pseudonymous Relationship Identifiers](./../DSNP/Graph.md#pseudonymous-relationship-identifiers) (PRIds) are stored along side Private Connections in the same Stateful Storage page.
17+
[Pseudonymous Relationship Identifiers](./../DSNP/Graph.md#pseudonymous-relationship-identifiers) (PRIds) are stored alongside Private Connections in the same Stateful Storage page.
1618

1719
Source code for each schema is located in the [LibertyDSNP/schemas](https://github.com/LibertyDSNP/schemas) repository.
1820

19-
## Announcements
20-
21-
| Announcement | Deployed Schema Ids | Frequency Model Type | Frequency Payload Location | Settings |
22-
| --- | --- | --- | --- | --- |
23-
| [Public Key](../DSNP/Types/PublicKey.md) | Mainnet: 7<br />Testnet (Paseo): 7<br />Testnet (Rococo): 7 | [`AvroBinary`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Itemized`](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Itemized) | [Append Only](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.AppendOnly), [Signature Required](https://libertydsnp.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.SignatureRequired) |
24-
2521
## Read Operation Mapping
2622

2723
Stateful data is retrieved via state queries (`pallet.stateQuery`) or RPC calls (`pallet.rpcCall()`).

0 commit comments

Comments
 (0)