Expand description
SAFE network data types.
Structs§
- Account
- Use this only while we don’t have Authenticator as its own app. Containing arbitrary user’s account information.
- AppPermissions
- Permissions for an app stored by the Client Handlers.
- BlsKeypair
- BLS keypair.
- BlsKeypair
Share - BLS keypair share.
- BlsProof
- Proof that a quorum of the section elders has agreed on something.
- BlsProof
Share - Single share of
Proof
. - Client
Full Id - A struct holding a keypair variant and the corresponding public ID for a network Client.
- Client
Public Id - A struct representing the public identity of a network Client.
- Debit
Agreement Proof - The aggregated Replica signatures of the Actor debit cmd.
- Ed25519
Digest - SHA-3-512 hash function.
- Ed25519
Proof - Known
Group Added - The Replica event raised when we learn of a new group PK set.
- MapPermission
Set - Set of user permissions.
- MapSeq
Entry Actions - Sequenced Entry Actions for given entry keys.
- MapSeq
Value - A value in sequenced Map.
- MapUnseq
Entry Actions - Unsequenced Entry Actions for given entry keys.
- Message
Id - Unique ID for messages.
- Money
- Structure representing a safeMoney amount.
- MsgEnvelope
- Node
Full Id - A struct holding an Ed25519 keypair, an optional BLS keypair share, and the corresponding public ID for a network Node.
- Node
Keypairs - This is used at a network node for holding the obligatory Ed25519 keypair needed as Adult, and then a BLS keypair share when being promoted to Elder. (Also the corresponding public keys). The Ed25519 is kept as Elder, in case it is demoted.
- Node
Public Id - A struct representing the public identity of a network Node.
- Private
Blob - Private Blob: an immutable chunk of data which can be deleted. Can only be fetched by the listed owner.
- Proven
- A value together with the proof that it was agreed on by the quorum of the section elders.
- Public
Blob - Public Blob: an immutable chunk of data which cannot be deleted.
- Reward
Counter - SeqMap
- Map that is unpublished on the network. This data can only be fetched by the owner or
those in the permissions fields with
Permission::Read
access. - Sequence
Private Permissions - Set of private permissions for a user.
- Sequence
Private Policy - Private permissions.
- Sequence
Public Permissions - Set of public permissions for a user.
- Sequence
Public Policy - Public permissions.
- Sequence
Write Op - Write operation to apply to Sequence. This is used for all kind of CRDT operations made on the Sequence, i.e. not only on the data but also on the permissions and owner info.
- Signature
Share - A signature share, with its index in the combined collection.
- Signed
Transfer - An Actor cmd.
- Transfer
- A transfer of money between two keys.
- Transfer
Notification - Notification of a Transfer sent to a recipient.
- Transfer
Propagated - The crediting Replica event raised when PropagateTransfer cmd has been successful.
- Transfer
Registered - The debiting Replica event raised when RegisterTransfer cmd has been successful.
- Transfer
Validated - The debiting Replica event raised when ValidateTransfer cmd has been successful.
- Unseq
Map - Map that is unpublished on the network. This data can only be fetched by the owner or
those in the permissions fields with
Permission::Read
access.
Enums§
- Account
Read - Use this only while we don’t have Authenticator as its own app.
- Account
Write - Use this only while we don’t have Authenticator as its own app.
- Address
- Adult
Duties - Duties of an Adult.
- AuthCmd
- To be removed. Use this only while we don’t have Authenticator as its own app.
- Auth
Query - Former ClientAuth To be removed. Use this only while we don’t have Authenticator as its own app.
- Authorisation
Kind - The kind of authorisation needed for a request.
- Blob
- Object storing an Blob variant.
- Blob
Address - Address of an Blob.
- Blob
Kind - Kind of an Blob.
- Blob
Read - TODO: docs
- Blob
Write - TODO: docs
- Cmd
- TODO: docs
- CmdError
- Data
- Object storing a data variant.
- Data
Auth Kind - Authorisation for data requests.
- DataCmd
- TODO: docs
- Data
Query - TODO: docs
- Duty
- Elder
Duties - Duties of an Elder.
- Entry
Error - Entry error for
Error::InvalidEntryActions
. - Error
- Main error type for the crate.
- Event
- Events from the network that are pushed to the client.
- Handshake
Request - Handshake requests sent from clients to vaults to establish new connections and verify a client’s key (to prevent replay attacks).
- Handshake
Response - Handshake responses sent from vaults to clients.
- Keypair
- Wrapper for different keypair types.
- Map
- Object storing a Map variant.
- MapAction
- Set of Actions that can be performed on the Map.
- MapAddress
- Address of an Map.
- MapEntries
- Wrapper type for entries, which can be sequenced or unsequenced.
- MapEntry
Actions - Wrapper type for entry actions, which can be sequenced or unsequenced.
- MapKind
- Kind of a Map.
- MapRead
- TODO: docs
- MapSeq
Entry Action - Action for a sequenced Entry.
- MapUnseq
Entry Action - Action for an unsequenced Entry.
- MapValue
- Wrapper type for values, which can be sequenced or unsequenced.
- MapValues
- Wrapper type for lists of sequenced or unsequenced values.
- MapWrite
- TODO: docs
- Message
- Misc
Auth Kind - Miscellaneous authorisation kinds. NB: Not very well categorized yet
- Money
Auth Kind - Authorisation for money requests.
- MsgSender
- NodeCmd
- Node
CmdError - Node
Data Cmd - Node
Data Error - Node
Data Query - Node
Data Query Response - Node
Duties - Duties of a Node.
- Node
Event - Node
Query - Node
Query Response - Node
Reward Error - Node
Reward Query - Reward query that is sent between sections.
- Node
Reward Query Response - Node
System Cmd - Cmds related to the running of a node.
- Node
Transfer Cmd - Node
Transfer Error - Node
Transfer Query - Node
Transfer Query Response - Proof
- Public
Id - An enum representing the identity of a network Node or Client.
- Public
Key - Wrapper for different public key types.
- Query
- TODO: docs
- Query
Response - Query responses from the network.
- Replica
Event - Events raised by the Replica.
- Sequence
- Object storing a Sequence variant.
- Sequence
Action - An action on Sequence data type.
- Sequence
Address - Address of a Sequence.
- Sequence
Index - Index of some data.
- Sequence
Kind - Kind of a Sequence.
- Sequence
Permissions - Wrapper type for permissions set, which can be public or private.
- Sequence
Policy - Wrapper type for permissions, which can be public or private.
- Sequence
Read - TODO: docs
- Sequence
User - User that can access Sequence.
- Sequence
Write - TODO: docs
- Signature
- Wrapper for different signature types.
- Transfer
Cmd - Money cmd that is sent to network.
- Transfer
Error - Transfer
Query - Money query that is sent to network.
- TryFrom
Error - Error type for an attempted conversion from
QueryResponse
to a type implementingTryFrom<Response>
.
Constants§
- MAX_
BLOB_ SIZE_ IN_ BYTES - Maximum allowed size for a serialised Blob to grow to.
- MAX_
LOGIN_ PACKET_ BYTES - Login packet size is limited .
Functions§
- verify_
signature - Verify that a signature is valid for a given
Request
+MessageId
combination.
Type Aliases§
- Account
Id - Actor id
- MapSeq
Entries - Sequenced entries (key-value pairs, with versioned values).
- MapUnseq
Entries - Unsequenced entries (key-value pairs, without versioned values).
- Private
SeqData - Private Sequence.
- Public
SeqData - Public Sequence.
- Replica
Public KeySet - Public Key Set for a group of transfer replicas.
- Result
- A specialised
Result
type. - Sequence
Data Write Op - Data mutation operation to apply to Sequence.
- Sequence
Entries - List of entries.
- Sequence
Entry - An entry in a Sequence.
- Transfer
Id - Transfer ID.
- Work
- The representation of the smallest unit of work. This is strictly incrementing (i.e. accumulated) during the network lifetime of the worker.