diff --git a/pages/Frequency/Identity.md b/pages/Frequency/Identity.md index 525e6667..6cd55d82 100644 --- a/pages/Frequency/Identity.md +++ b/pages/Frequency/Identity.md @@ -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 @@ -14,7 +14,7 @@ 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. @@ -22,13 +22,13 @@ At least one public key MUST be associated with an MSA Id for it to be considere ## 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 diff --git a/pages/Frequency/Operations.md b/pages/Frequency/Operations.md index 0f4c97b1..52f377da 100644 --- a/pages/Frequency/Operations.md +++ b/pages/Frequency/Operations.md @@ -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 @@ -48,14 +48,14 @@ Write operations are via Transactions (also called Extrinsics): `pallet::extrins | Operation | Principal(s) | Pallet::Extrinsic | State Change Record | | --- | --- | --- | --- | -| Create Identifier | 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) | -| Retire Identifier | 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) | -| Define Delegation | 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) | -| Revoke Delegation | 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) | -| Revoke Delegation | 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) | -| Add Control Key | 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) | -| Remove Control Key | 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) | -| Publish Announcement | 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) | -| Publish Batch | 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) | +| Create Identifier | 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) | +| Retire Identifier | 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) | +| Define Delegation | 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) | +| Revoke Delegation | 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) | +| Revoke Delegation | 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) | +| Add Control Key | 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) | +| Remove Control Key | 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) | +| Publish Announcement | 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) | +| Publish Batch | 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) | | Get User Data | Any | See [User Data: Read Operation Mapping](./UserData.md#read-operation-mapping) | - | | Replace User Data | User OR Delegate | See [User Data: Write Operation Mapping](./UserData.md#write-operation-mapping) | [User Data Replaced Record](Records.md#user-data-replaced) | diff --git a/pages/Frequency/Overview.md b/pages/Frequency/Overview.md index 40ce8202..e2f67337 100644 --- a/pages/Frequency/Overview.md +++ b/pages/Frequency/Overview.md @@ -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) diff --git a/pages/Frequency/Publishing.md b/pages/Frequency/Publishing.md index 16a555ab..968223a9 100644 --- a/pages/Frequency/Publishing.md +++ b/pages/Frequency/Publishing.md @@ -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. - + | Enum | Announcement | Type | Deployed Schema Id | Frequency Model Type | Frequency Payload Location | | :--: | --- | --- | --- | --- | --- | -| 0 | [Tombstone](../DSNP/Types/Tombstone.md) | Batched | Mainnet: 1
Testnet (Paseo): 1
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
Testnet (Paseo): 2
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
Testnet (Paseo): 3
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
Testnet (Paseo): 4
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
Testnet (Paseo): 6
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
Testnet (Paseo): 5
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
Testnet (Paseo): 7
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
Testnet (Paseo): 1
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
Testnet (Paseo): 2
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
Testnet (Paseo): 3
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
Testnet (Paseo): 4
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
Testnet (Paseo): 6
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
Testnet (Paseo): 5
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
Testnet (Paseo): 7
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. @@ -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. diff --git a/pages/Frequency/Records.md b/pages/Frequency/Records.md index f8f9ac97..7c293913 100644 --- a/pages/Frequency/Records.md +++ b/pages/Frequency/Records.md @@ -21,7 +21,7 @@ Events are referenced by `pallet::EventName`. ### Messages Frequency Messages store Announcements or Batch Publication Records. -It uses the [Messages Pallet](https://libertydsnp.github.io/frequency/pallet_messages/). +It uses the [Messages Pallet](https://frequency-chain.github.io/frequency/pallet_messages/). Messages are retrieved via state queries (`pallet.stateQuery`) or RPC calls (`pallet.rpcCall()`). @@ -36,13 +36,13 @@ State data is retrieved via state queries (`pallet.stateQuery`) or RPC calls (`p | Record Type | Record Pointer/Location | | --- | --- | -| Identifier Creation Record | Event: [`msa::MsaCreated`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.MsaCreated)
State: [`msa.publicKeyToMsaId`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/type.PublicKeyToMsaId.html) | -| Identifier Retirement Record | Event: [`msa::MsaRetired`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.MsaRetired) | -| Delegation Definition Record | Event: [`msa::DelegationGranted`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.DelegationGranted), [`msa::DelegationUpdated`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.DelegationUpdated)
RPC: [`msa.checkDelegations()`](https://libertydsnp.github.io/frequency/pallet_msa_rpc/trait.MsaApiClient.html#method.check_delegations), [`msa.getGrantedSchemasByMsaId()`](https://libertydsnp.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_granted_schemas_by_msa_id) | -| Delegation Revocation Record | Event: [`msa::DelegationRevoked`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.DelegationRevoked)
RPC: [`msa.checkDelegations()`](https://libertydsnp.github.io/frequency/pallet_msa_rpc/trait.MsaApiClient.html#method.check_delegations) | -| Control Key Addition Record | Event: [`msa::PublicKeyAdded`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.PublicKeyAdded)
State: [`msa.publicKeyToMsaId`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/type.PublicKeyToMsaId.html) | -| Control Key Removal Record | Event: [`msa::PublicKeyDeleted`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.PublicKeyDeleted)
State: [`msa.publicKeyToMsaId`](https://libertydsnp.github.io/frequency/pallet_msa/pallet/type.PublicKeyToMsaId.html) | -| Announcement Published Record | Event: [`messages::MessagesStored`](https://libertydsnp.github.io/frequency/pallet_messages/pallet/enum.Event.html#variant.MessagesStored)
RPC: [`messages.getBySchemaId()`](https://libertydsnp.github.io/frequency/pallet_messages_rpc/trait.MessagesApiServer.html#tymethod.get_messages_by_schema_id) | -| Batch Published Record | Event: [`messages::MessagesStored`](https://libertydsnp.github.io/frequency/pallet_messages/pallet/enum.Event.html#variant.MessagesStored)
RPC: [`messages.getBySchemaId()`](https://libertydsnp.github.io/frequency/pallet_messages_rpc/trait.MessagesApiServer.html#tymethod.get_messages_by_schema_id) | +| Identifier Creation Record | Event: [`msa::MsaCreated`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.MsaCreated)
State: [`msa.publicKeyToMsaId`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/type.PublicKeyToMsaId.html) | +| Identifier Retirement Record | Event: [`msa::MsaRetired`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.MsaRetired) | +| Delegation Definition Record | Event: [`msa::DelegationGranted`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.DelegationGranted), [`msa::DelegationUpdated`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.DelegationUpdated)
RPC: [`msa.checkDelegations()`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiClient.html#method.check_delegations), [`msa.getGrantedSchemasByMsaId()`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiServer.html#tymethod.get_granted_schemas_by_msa_id) | +| Delegation Revocation Record | Event: [`msa::DelegationRevoked`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.DelegationRevoked)
RPC: [`msa.checkDelegations()`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiClient.html#method.check_delegations) | +| Control Key Addition Record | Event: [`msa::PublicKeyAdded`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.PublicKeyAdded)
State: [`msa.publicKeyToMsaId`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/type.PublicKeyToMsaId.html) | +| Control Key Removal Record | Event: [`msa::PublicKeyDeleted`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/enum.Event.html#variant.PublicKeyDeleted)
State: [`msa.publicKeyToMsaId`](https://frequency-chain.github.io/frequency/pallet_msa/pallet/type.PublicKeyToMsaId.html) | +| Announcement Published Record | Event: [`messages::MessagesStored`](https://frequency-chain.github.io/frequency/pallet_messages/pallet/enum.Event.html#variant.MessagesStored)
RPC: [`messages.getBySchemaId()`](https://frequency-chain.github.io/frequency/pallet_messages_rpc/trait.MessagesApiServer.html#tymethod.get_messages_by_schema_id) | +| Batch Published Record | Event: [`messages::MessagesStored`](https://frequency-chain.github.io/frequency/pallet_messages/pallet/enum.Event.html#variant.MessagesStored)
RPC: [`messages.getBySchemaId()`](https://frequency-chain.github.io/frequency/pallet_messages_rpc/trait.MessagesApiServer.html#tymethod.get_messages_by_schema_id) | | Failure Record | See section on [Failure Handling](./Operations.md#failure-handling) | -| User Data Replaced Record | Event: [`stateful_storage::ItemizedPageUpdated`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.ItemizedPageUpdated), [`stateful_storage::ItemizedPageDeleted`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.ItemizedPageDeleted), [`stateful_storage::PaginatedPageUpdated`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.PaginatedPageUpdated), [`stateful_storage::PaginatedPageDeleted`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.PaginatedPageDeleted)
RPC: [`statefulStorage.getPaginatedStorage()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiServer.html#tymethod.get_paginated_storage), [`statefulStorage.getItemizedStorage()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiServer.html#tymethod.get_itemized_storage)
See Also: [Read User Data](./UserData.md#read-operation-mapping) | +| User Data Replaced Record | Event: [`stateful_storage::ItemizedPageUpdated`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.ItemizedPageUpdated), [`stateful_storage::ItemizedPageDeleted`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.ItemizedPageDeleted), [`stateful_storage::PaginatedPageUpdated`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.PaginatedPageUpdated), [`stateful_storage::PaginatedPageDeleted`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Event.html#variant.PaginatedPageDeleted)
RPC: [`statefulStorage.getPaginatedStorage()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiServer.html#tymethod.get_paginated_storage), [`statefulStorage.getItemizedStorage()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiServer.html#tymethod.get_itemized_storage)
See Also: [Read User Data](./UserData.md#read-operation-mapping) | diff --git a/pages/Frequency/UserData.md b/pages/Frequency/UserData.md index 5fd5ad05..cf790e4d 100644 --- a/pages/Frequency/UserData.md +++ b/pages/Frequency/UserData.md @@ -1,6 +1,6 @@ # Frequency User Data -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. +On Frequency, User Data and select Announcements are mapped to Schemas which use [Stateful Storage](https://frequency-chain.github.io/frequency/pallet_stateful_storage/index.html) for storage and retrieval of the data. ## User Data Sets @@ -8,9 +8,9 @@ On Frequency, User Data and select Announcements are mapped to Schemas which use | User Data Set | Deployed Schema Ids | Frequency Model Type | Frequency Payload Location | Settings | | --- | --- | --- | --- | --- | -| [Public Follows](../DSNP/Graph.md#public-follows) | Mainnet: 8
Testnet (Paseo): 8
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 | -| [Private Follows](../DSNP/Graph.md#private-follows) | Mainnet: 9
Testnet (Paseo): 9
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 | -| [Private Connections](../DSNP/Graph.md#private-connections) | Mainnet: 10
Testnet (Paseo): 10
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 | +| [Public Follows](../DSNP/Graph.md#public-follows) | Mainnet: 8
Testnet (Paseo): 8
Testnet (Rococo): 13 | [`AvroBinary`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Paginated`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Paginated) | None | +| [Private Follows](../DSNP/Graph.md#private-follows) | Mainnet: 9
Testnet (Paseo): 9
Testnet (Rococo): 14 | [`AvroBinary`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Paginated`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Paginated) | None | +| [Private Connections](../DSNP/Graph.md#private-connections) | Mainnet: 10
Testnet (Paseo): 10
Testnet (Rococo): 15 | [`AvroBinary`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.ModelType.html#variant.AvroBinary) | [`Paginated`](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.PayloadLocation.html#variant.Paginated) | None | [Pseudonymous Relationship Identifiers](./../DSNP/Graph.md#pseudonymous-relationship-identifiers) (PRIds) are stored along side Private Connections in the same Stateful Storage page. @@ -20,7 +20,7 @@ Source code for each schema is located in the [LibertyDSNP/schemas](https://gith | Announcement | Deployed Schema Ids | Frequency Model Type | Frequency Payload Location | Settings | | --- | --- | --- | --- | --- | -| [Public Key](../DSNP/Types/PublicKey.md) | Mainnet: 7
Testnet (Paseo): 7
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) | +| [Public Key](../DSNP/Types/PublicKey.md) | Mainnet: 7
Testnet (Paseo): 7
Testnet (Rococo): 7 | [`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) | [Append Only](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.AppendOnly), [Signature Required](https://frequency-chain.github.io/frequency/common_primitives/schema/enum.SchemaSetting.html#variant.SignatureRequired) | ## Read Operation Mapping @@ -28,8 +28,8 @@ Stateful data is retrieved via state queries (`pallet.stateQuery`) or RPC calls | Model Type | DSNP Properties | Query/Call | | --- | --- | --- | -| Itemized | Entity Tag | [`stateful_storage.getItemizedStorage()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiClient.html#method.get_itemized_storage) | -| Paginated | Entity Tag, Chunked | [`stateful_storage.getPaginatedStorage()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiClient.html#method.get_paginated_storage) | +| Itemized | Entity Tag | [`stateful_storage.getItemizedStorage()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiClient.html#method.get_itemized_storage) | +| Paginated | Entity Tag, Chunked | [`stateful_storage.getPaginatedStorage()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage_rpc/trait.StatefulStorageApiClient.html#method.get_paginated_storage) | ## Write Operation Mapping @@ -37,9 +37,9 @@ Write operations are via Transactions (also called Extrinsics): `pallet::extrins | Model Type | Operation | Pallet::Extrinsic | | --- | --- | --- | -| Itemized | Insert, Update, Delete | [`stateful_storage::apply_item_actions()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.apply_item_actions)
[`stateful_storage::apply_item_actions_with_signature()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.apply_item_actions_with_signature) | -| Paginated | Insert, Update | [`stateful_storage::upsert_page()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.upsert_page)
[`stateful_storage::upsert_page_with_signature()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.upsert_page_with_signature) | -| Paginated | Delete | [`stateful_storage::delete_page()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.delete_page)
[`stateful_storage::delete_page_with_signature()`](https://libertydsnp.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.delete_page_with_signature) | +| Itemized | Insert, Update, Delete | [`stateful_storage::apply_item_actions()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.apply_item_actions)
[`stateful_storage::apply_item_actions_with_signature()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.apply_item_actions_with_signature) | +| Paginated | Insert, Update | [`stateful_storage::upsert_page()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.upsert_page)
[`stateful_storage::upsert_page_with_signature()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.upsert_page_with_signature) | +| Paginated | Delete | [`stateful_storage::delete_page()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.delete_page)
[`stateful_storage::delete_page_with_signature()`](https://frequency-chain.github.io/frequency/pallet_stateful_storage/pallet/enum.Call.html#variant.delete_page_with_signature) | ### Entity Tags diff --git a/pages/Frequency/Validation.md b/pages/Frequency/Validation.md index c2502ee5..e939bb0c 100644 --- a/pages/Frequency/Validation.md +++ b/pages/Frequency/Validation.md @@ -1,8 +1,8 @@ # Batch Publication Validation - + -The [Frequency Message](https://libertydsnp.github.io/frequency/common_primitives/messages/struct.MessageResponse.html) for a Batch Publication has several important fields for validation: +The [Frequency Message](https://frequency-chain.github.io/frequency/common_primitives/messages/struct.MessageResponse.html) for a Batch Publication has several important fields for validation: | Field | Description | | ----- | ----------- | @@ -20,7 +20,7 @@ The [Frequency Message](https://libertydsnp.github.io/frequency/common_primitive ## Publication Announcements Validation 1. Collect the unique set of `fromId` values. -1. Use the [Custom RPC `msa.checkDelegations()`](https://libertydsnp.github.io/frequency/pallet_msa_rpc/trait.MsaApiClient.html#method.check_delegations) with the `fromId` values as the `delegator_msa_ids` and the `provider_msa_id` at the `block_number`. +1. Use the [Custom RPC `msa.checkDelegations()`](https://frequency-chain.github.io/frequency/pallet_msa_rpc/trait.MsaApiClient.html#method.check_delegations) with the `fromId` values as the `delegator_msa_ids` and the `provider_msa_id` at the `block_number`. 1. The `fromId` values that `msa.checkDelegations()` verifies as having a delegation at `block_number` are valid Announcements. 1. Set the `schema_id` parameter to the Schema Id used in the Frequency Message