Skip to content

Commit

Permalink
Change Frequency Rust docs URL (#278)
Browse files Browse the repository at this point in the history
Change libertydsnp.github.io to frequency-chain.github.io to fix broken
links

Co-authored-by: Wes Biggs <[email protected]>
  • Loading branch information
wesbiggs and Wes Biggs authored Jun 3, 2024
1 parent e1447f1 commit f782332
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 49 deletions.
8 changes: 4 additions & 4 deletions pages/Frequency/Identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Identity
- **Name**: Message Source Account or MSA
- **Docs**: [`MSA Pallet`](https://libertydsnp.github.io/frequency/pallet_msa/index.html)
- **Docs**: [`MSA Pallet`](https://frequency-chain.github.io/frequency/pallet_msa/index.html)
- **Representation**:
The following data that constitute a Message Source Account are stored in the MSA pallet:
* The DSNP User Id associated with this MSA
Expand All @@ -14,21 +14,21 @@ The following data that constitute a Message Source Account are stored in the MS
## DSNP User Identifier
- **Name**: Message Source Account Identifier, or MSA Id.
- **Data Type**: `uint64`
- **Docs**: [`MessageSourceId`](https://libertydsnp.github.io/frequency/common_primitives/msa/type.MessageSourceId.html)
- **Docs**: [`MessageSourceId`](https://frequency-chain.github.io/frequency/common_primitives/msa/type.MessageSourceId.html)
- **Mapping**: The MSA Id is able to be used directly as the DSNP User Id
- **Description**:
At least one public key MUST be associated with an MSA Id for it to be considered active.

## Control Keys
- **Name**: Referred to as: `public_key`, `provider_key`, or `delegator_key`
- **Data Type**: `AccountId`, Schnorrkel/Ristretto X25519 ("sr25519") derived cryptographic public key
- **Docs**: [`AccountId`](https://libertydsnp.github.io/frequency/common_primitives/node/type.AccountId.html)
- **Docs**: [`AccountId`](https://frequency-chain.github.io/frequency/common_primitives/node/type.AccountId.html)
- **Description**: See [Cryptography on Polkadot](https://wiki.polkadot.network/docs/learn-cryptography) and [Polkadot Protocol Specification](https://spec.polkadot.network/#defn-account-key).
A public key CANNOT be associated with more than one MSA at a time.

## Delegation
- **Name**: `delegation`
- **Docs**: [`Delegation`](https://libertydsnp.github.io/frequency/pallet_msa/types/struct.Delegation.html)
- **Docs**: [`Delegation`](https://frequency-chain.github.io/frequency/pallet_msa/types/struct.Delegation.html)
- **Representation**:
The following data storage relates necessary information for retrieving and validating delegations:
* Provider registry
Expand Down
20 changes: 10 additions & 10 deletions pages/Frequency/Operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Responsible for DSNP User Data (see [User Data](./UserData.md)) and select Annou

### Documentation Links
- [Frequency Documentation](https://docs.frequency.xyz)
- [Frequency Rust Documentation](https://libertydsnp.github.io/frequency)
- [Frequency Rust Documentation](https://frequency-chain.github.io/frequency)

## Principals

Expand Down Expand Up @@ -48,14 +48,14 @@ Write operations are via Transactions (also called Extrinsics): `pallet::extrins

| Operation | Principal(s) | Pallet::Extrinsic | State Change Record |
| --- | --- | --- | --- |
| <a id="create-identifier">Create Identifier</a> | None | [`msa::create()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.create), [`msa::create_sponsored_account_with_delegation()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.create_sponsored_account_with_delegation) | [Identifier Creation Record](Records.md#identifier-creation) |
| <a id="retire-identifier">Retire Identifier</a> | User | [`msa::retire_msa()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.retire_msa) | [Identifier Retirement Record](Records.md#identifier-retirement) |
| <a id="define-delegation">Define Delegation</a> | User AND Delegate | [`msa::grant_delegation()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.grant_delegation), [`msa::create_sponsored_account_with_delegation()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.create_sponsored_account_with_delegation) | [Delegation Definition Record](Records.md#delegation-definition) |
| <a id="revoke-delegation">Revoke Delegation</a> | User | [`msa::revoke_delegation_by_delegator()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.revoke_delegation_by_delegator) | [Delegation Revocation Record](Records.md#delegation-revocation) |
| <a id="revoke-delegation">Revoke Delegation</a> | Delegate | [`msa::revoke_delegation_by_provider()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.revoke_delegation_by_provider) | [Delegation Revocation Record](Records.md#delegation-revocation) |
| <a id="add-control-key">Add Control Key</a> | User | [`msa::add_public_key_to_msa()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.add_public_key_to_msa) | [Control Key Addition Record](Records.md#control-key-addition) |
| <a id="remove-control-key">Remove Control Key</a> | User | [`msa::delete_msa_public_key()`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.delete_msa_public_key) | [Control Key Removal Record](Records.md#control-key-removal) |
| <a id="publish-announcement">Publish Announcement</a> | User OR Delegate | [`messages::add_onchain_message()`](https://libertydsnp.github.io/frequency/pallet_messages/pallet/enum.Call.html#variant.add_onchain_message) | [Announcement Published Record](Records.md#announcement-published) |
| <a id="publish-batch">Publish Batch</a> | User OR Delegate | [`messages::add_ipfs_message()`](https://libertydsnp.github.io/frequency/pallet_messages/pallet/enum.Call.html#variant.add_ipfs_message) | [Batch Published Record](Records.md#batch-published) |
| <a id="create-identifier">Create Identifier</a> | None | [`msa::create()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.create), [`msa::create_sponsored_account_with_delegation()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.create_sponsored_account_with_delegation) | [Identifier Creation Record](Records.md#identifier-creation) |
| <a id="retire-identifier">Retire Identifier</a> | User | [`msa::retire_msa()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.retire_msa) | [Identifier Retirement Record](Records.md#identifier-retirement) |
| <a id="define-delegation">Define Delegation</a> | User AND Delegate | [`msa::grant_delegation()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.grant_delegation), [`msa::create_sponsored_account_with_delegation()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.create_sponsored_account_with_delegation) | [Delegation Definition Record](Records.md#delegation-definition) |
| <a id="revoke-delegation">Revoke Delegation</a> | User | [`msa::revoke_delegation_by_delegator()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.revoke_delegation_by_delegator) | [Delegation Revocation Record](Records.md#delegation-revocation) |
| <a id="revoke-delegation">Revoke Delegation</a> | Delegate | [`msa::revoke_delegation_by_provider()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.revoke_delegation_by_provider) | [Delegation Revocation Record](Records.md#delegation-revocation) |
| <a id="add-control-key">Add Control Key</a> | User | [`msa::add_public_key_to_msa()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.add_public_key_to_msa) | [Control Key Addition Record](Records.md#control-key-addition) |
| <a id="remove-control-key">Remove Control Key</a> | User | [`msa::delete_msa_public_key()`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Call.html#variant.delete_msa_public_key) | [Control Key Removal Record](Records.md#control-key-removal) |
| <a id="publish-announcement">Publish Announcement</a> | User OR Delegate | [`messages::add_onchain_message()`](https://frequency-chain.github.io/frequency/pallet_messages/pallet/enum.Call.html#variant.add_onchain_message) | [Announcement Published Record](Records.md#announcement-published) |
| <a id="publish-batch">Publish Batch</a> | User OR Delegate | [`messages::add_ipfs_message()`](https://frequency-chain.github.io/frequency/pallet_messages/pallet/enum.Call.html#variant.add_ipfs_message) | [Batch Published Record](Records.md#batch-published) |
| <a id="get-user-data">Get User Data</a> | Any | See [User Data: Read Operation Mapping](./UserData.md#read-operation-mapping) | - |
| <a id="replace-user-data">Replace User Data</a> | User OR Delegate | See [User Data: Write Operation Mapping](./UserData.md#write-operation-mapping) | [User Data Replaced Record](Records.md#user-data-replaced) |
2 changes: 1 addition & 1 deletion pages/Frequency/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Frequency is a Polkadot Parachain written in Rust, using the Substrate framework
- [Frequency Website](https://www.frequency.xyz)
- [Frequency GitHub](https://github.com/LibertyDSNP/frequency)
- [Frequency Documentation](https://docs.frequency.xyz)
- [Frequency Rust Documentation](https://libertydsnp.github.io/frequency/)
- [Frequency Rust Documentation](https://frequency-chain.github.io/frequency/)
- Helpful Links
- [Getting Started - Polkadot Wiki](https://wiki.polkadot.network/docs/getting-started)
- [Parachains - Polkadot Wiki](https://wiki.polkadot.network/docs/learn-parachains)
Expand Down
22 changes: 11 additions & 11 deletions pages/Frequency/Publishing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ On Frequency, [Announcements](../DSNP/Announcements.md) are mapped to Schemas wh
Frequency Messages are either individual Announcements from a particular user, or a Batch Publication with a multitude of possible users.
Frequency Stateful Storage is either direct Announcements from a particular user or [User Data](./UserData.md) changes.

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

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

| Enum | Announcement | Type | Deployed Schema Id | Frequency Model Type | Frequency Payload Location |
| :--: | --- | --- | --- | --- | --- |
| 0 | [Tombstone](../DSNP/Types/Tombstone.md) | Batched | Mainnet: 1<br />Testnet (Paseo): 1<br />Testnet (Rococo): 1 | [`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) |
| 2 | [Broadcast](../DSNP/Types/Broadcast.md) | Batched | Mainnet: 2<br />Testnet (Paseo): 2<br />Testnet (Rococo): 2 | [`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) |
| 3 | [Reply](../DSNP/Types/Reply.md) | Batched | Mainnet: 3<br />Testnet (Paseo): 3<br />Testnet (Rococo): 3 | [`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) |
| 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) |
| 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) |
| 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) |
| 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) |
| 0 | [Tombstone](../DSNP/Types/Tombstone.md) | Batched | Mainnet: 1<br />Testnet (Paseo): 1<br />Testnet (Rococo): 1 | [`Parquet`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
| 2 | [Broadcast](../DSNP/Types/Broadcast.md) | Batched | Mainnet: 2<br />Testnet (Paseo): 2<br />Testnet (Rococo): 2 | [`Parquet`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
| 3 | [Reply](../DSNP/Types/Reply.md) | Batched | Mainnet: 3<br />Testnet (Paseo): 3<br />Testnet (Rococo): 3 | [`Parquet`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
| 4 | [Reaction](../DSNP/Types/Reaction.md) | Batched | Mainnet: 4<br />Testnet (Paseo): 4<br />Testnet (Rococo): 4 | [`Parquet`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
| 5 | [Profile](../DSNP/Types/Profile.md) | Batched | Mainnet: 6<br />Testnet (Paseo): 6<br />Testnet (Rococo): 5 | [`Parquet`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
| 6 | [Update](../DSNP/Types/Update.md) | Batched | Mainnet: 5<br />Testnet (Paseo): 5<br />Testnet (Rococo): 6 | [`Parquet`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.Parquet) | [`IPFS`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.IPFS) |
| 7 | [Public Key](../DSNP/Types/PublicKey.md) | [Stateful](./UserData.md#announcements) | Mainnet: 7<br />Testnet (Paseo): 7<br />Testnet (Rococo): 18 | [`AvroBinary`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Itemized`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Itemized) |

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

Expand Down Expand Up @@ -49,9 +49,9 @@ It is left to user interfaces to handle these situations.

## Retrieval

Frequency nodes provide an RPC interface [`messages.getBySchemaId()`](https://libertydsnp.github.io/frequency/pallet_messages_rpc/trait.MessagesApiClient.html#method.get_messages_by_schema) with paginated responses that differ based on the Schema.
Frequency nodes provide an RPC interface [`messages.getBySchemaId()`](https://frequency-chain.github.io/frequency/pallet_messages_rpc/trait.MessagesApiClient.html#method.get_messages_by_schema) with paginated responses that differ based on the Schema.

Frequency nodes can provide a websocket interface that will emit an event for each block that has one or more messages of a given schema in that block.
The [`messages::MessagesStored`](https://libertydsnp.github.io/frequency/pallet_messages/pallet/enum.Event.html#variant.MessagesStored) event can be used to know when to call the RPC interface to retrieve the messages.
The [`messages::MessagesStored`](https://frequency-chain.github.io/frequency/pallet_messages/pallet/enum.Event.html#variant.MessagesStored) event can be used to know when to call the RPC interface to retrieve the messages.

See the [Frequency Documentation](https://libertydsnp.github.io/frequency/pallet_messages_rpc/trait.MessagesApiClient.html#method.get_messages_by_schema) for more details on Message retrieval.
See the [Frequency Documentation](https://frequency-chain.github.io/frequency/pallet_messages_rpc/trait.MessagesApiClient.html#method.get_messages_by_schema) for more details on Message retrieval.
Loading

0 comments on commit f782332

Please sign in to comment.