Crate safe_nd

SAFE network data types.

Structs

ADataAppendOperation	Entries to append.
ADataEntry	A key-value entry in AppendOnlyData.
ADataIndices	Set of data, owners, permissions indices.
ADataOwner	An owner could represent an individual user, or a group of users, depending on the public_key type.
ADataPubPermissionSet	Set of published permissions for a user.
ADataPubPermissions	Published permissions.
ADataUnpubPermissionSet	Set of unpublished permissions for a user.
ADataUnpubPermissions	Unpublished permissions.
AppFullId	A struct holding a keypair variant and the corresponding public ID for a network App.
AppPermissions	Permissions for an app stored by the Client Handlers.
AppPublicId	A struct representing the public identity of a network App.
ClientFullId	A struct holding a keypair variant and the corresponding public ID for a network Client.
ClientPublicId	A struct representing the public identity of a network Client.
Coins	Structure representing a safecoin amount.
Ed25519Digest	SHA-3-512 hash function.
LoginPacket	Login packet containing arbitrary user's login information.
MDataPermissionSet	Set of user permissions.
MDataSeqEntryActions	Sequenced Entry Actions for given entry keys.
MDataSeqValue	A value in sequenced MutableData.
MDataUnseqEntryActions	Unsequenced Entry Actions for given entry keys.
MessageId	Unique ID for messages.
NodeFullId	A struct holding an Ed25519 keypair, an optional BLS keypair share, and the corresponding public ID for a network Node.
NodePublicId	A struct representing the public identity of a network Node.
Notification	Notification of a transaction.
PubImmutableData	Published ImmutableData: an immutable chunk of data which cannot be deleted.
SeqMutableData	MutableData 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.
Transaction	Coin transaction.
UnpubImmutableData	Unpublished ImmutableData: an immutable chunk of data which can be deleted. Can only be fetched by the listed owner.
UnseqMutableData	MutableData 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.
XorName	A XOR_NAME_BITS-bit number, viewed as a point in XOR space.

Enums

AData	Object storing an AppendOnlyData variant.
ADataAction	An action on AppendOnlyData.
ADataAddress	Address of an AppendOnlyData.
ADataIndex	Index of some data.
ADataKind	Kind of an AppendOnlyData.
ADataPermissions	Wrapper type for permissions, which can be published or unpublished.
ADataUser	User that can access AppendOnlyData.
Challenge	Challenge request/response used to establish new connections and verify the key.
Data	Object storing a data variant.
EntryError	Entry error for Error::InvalidEntryActions.
Error	Main error type for the crate.
IData	Object storing an ImmutableData variant.
IDataAddress	Address of an ImmutableData.
IDataKind	Kind of an ImmutableData.
MData	Object storing a MutableData variant.
MDataAction	Set of Actions that can be performed on the MutableData.
MDataAddress	Address of an MutableData.
MDataEntries	Wrapper type for entries, which can be sequenced or unsequenced.
MDataEntryActions	Wrapper type for entry actions, which can be sequenced or unsequenced.
MDataKind	Kind of a MutableData.
MDataSeqEntryAction	Action for a Sequenced Entry.
MDataUnseqEntryAction	Action for an Unsequenced Entry.
MDataValue	Wrapper type for values, which can be sequenced or unsequenced.
MDataValues	Wrapper type for lists of sequenced or unsequenced values.
Message	Wrapper message that contains a message ID and the requester ID along the request or response. It should also contain a valid signature if it's sent by the owner(s).
PublicId	An enum representing the identity of a network Node or Client.
PublicKey	Wrapper for different public key types.
Request	RPC Request that is sent to vaults.
Response	RPC responses from vaults.
Signature	Wrapper for different signature types.
TryFromError	Error type for an attempted conversion from Response to a type implementing TryFrom<Response>.

Constants

MAX_COINS_VALUE	The maximum amount of safecoin represented by a single Coins.
MAX_IMMUTABLE_DATA_SIZE_IN_BYTES	Maximum allowed size for a serialised ImmutableData to grow to.
MAX_LOGIN_PACKET_BYTES	Login packet size is limited .
XOR_NAME_LEN	Constant byte length of XorName.

Traits

AppendOnlyData	Common methods for all AppendOnlyData flavours.
SeqAppendOnly	Common methods for published and unpublished sequenced AppendOnlyData.
UnseqAppendOnly	Common methods for published and unpublished unsequenced AppendOnlyData.

Functions

verify_signature

Verify that a signature is valid for a given Request + MessageId combination.

Type Definitions

ADataEntries	List of entries.
MDataSeqEntries	Sequenced entries (key-value pairs, with versioned values).
MDataUnseqEntries	Unsequenced entries (key-value pairs, without versioned values).
PubSeqAppendOnlyData	Published sequenced AppendOnlyData.
PubUnseqAppendOnlyData	Published unsequenced AppendOnlyData.
Result	A specialised Result type for safecoin.
TransactionId	Transaction ID.
UnpubSeqAppendOnlyData	Unpublished sequenced AppendOnlyData.
UnpubUnseqAppendOnlyData	Unpublished unsequenced AppendOnlyData.