Module holochain_types::prelude [−][src]
Expand description
reexport some common things
Re-exports
pub use crate::access::*;pub use crate::activity::*;pub use crate::app::error::*;pub use crate::app::*;pub use crate::autonomic::*;pub use crate::chain::*;pub use crate::db::*;pub use crate::dht_op::error::*;pub use crate::dht_op::*;pub use crate::dna::error::*;pub use crate::dna::wasm::*;pub use crate::dna::*;pub use crate::element::error::*;pub use crate::element::*;pub use crate::entry::*;pub use crate::env::*;pub use crate::header::error::*;pub use crate::header::*;pub use crate::link::*;pub use crate::metadata::*;pub use crate::properties::*;pub use crate::signal::*;pub use crate::timestamp;pub use crate::timestamp::*;pub use crate::validate::*;pub use crate::fixt::*;pub use crate::test_utils::*;Modules
represent arbitrary bytes (not serialized) e.g. totally random crypto bytes from random_bytes
Capability Grants and Claims
A “Cell” represents a DNA/AgentId pair - a space where one dna/agent can track its source chain and service network requests / responses.
Re-exported dependencies
Defines DnaDef struct
Defines a Element, the basic unit of Holochain data.
An Entry is a unit of data in a Holochain Source Chain.
ffs - the Friendly Filesystem
Fixturators for zome types
Types related to the genesis process whereby a user commits their initial elements and validates them to the best of their ability. Full validation may not be possible if network access is required, so they perform a “self-check” (as in “check yourself before you wreck yourself”) before joining to ensure that they can catch any problems they can before being subject to the scrutiny of their peers and facing possible rejection.
A variant of Zome which is defined entirely by native, inline Rust code
Wrapper type to indicate some data which has a ValidationStatus associated with it.
Metadata types for use in wasm
Types for source chain queries
Types for requesting metadata
App-defined signals
Signature for authenticity of data
Common helpers for writing tests against zome types
Timestamp
Types related to the debug host function
Tracking versions between the WASM host and guests and other interfaces.
Types for warrants
A Zome is a module of app-defined code which can be run by Holochain.
A group of Zomes are composed to form a DnaDef.
Macros
Serialization for fixed arrays is generally not available in a way that can be derived. Being able to wrap fixed size arrays is important e.g. for crypto safety etc. so this is a simple way to implement serialization so that we can send these types between the host/guest.
unidiomatic way to derive default trait implementations of TryFrom in/out of SerializedBytes
Helper macro for implementing ToSql, when using rusqlite as a dependency
Helper macro for implementing ToSql, when using rusqlite as a dependency
Cryptographic secrets are fiddly at the best of times.
Structs
An agents chain elements returned from a agent_activity_query
The struct containing all information about the executing agent’s identity.
Header for an agent validation package, used to determine whether an agent is allowed to participate in this DNA
a curve to spit out Entry::App values
Newtype for the bytes comprising an App entry
Information about a class of Entries provided by the DNA
A signal emitted by an app via emit_signal
System entry to hold a capability token claim for use as a caller. Stored by a claimant so they can remember what’s necessary to exercise this capability by sending the secret to the grantor.
A CapSecret is used by a caller to prove to a callee access to a committed CapGrant.
The unique identifier for a Cell. Cells are uniquely determined by this pair - this pair is necessary and sufficient to refer to a cell in a conductor
The chain has been forked by these two headers
The header at the head of the complete chain. This is as far as this authority can see a chain with no gaps.
Query arguments
When migrating to a new version of a DNA, this header is committed to the old chain to declare the migration path taken. Currently unused
A header which “speaks” Entry content into being. The same content can be referenced by multiple such headers.
Declares that a metadata Link should be made between two EntryHashes
Zome IO inner type for link creation.
@todo Ability to forcibly curry payloads into functions that are called with a claim.
Declare that a previously published Header should be nullified and considered deleted.
Placeholder for future when we want to have deletes on headers Not currently in use.
Declares that a previously made Link should be nullified and considered removed.
Query arguments for the deterministic version of GetAgentActivity
The Dna Header is always the first header in a source chain
The definition of a DNA: the hash of this data is what produces the DnaHash.
Builder for DnaDef.
a chain element containing the signed header along with the entry if the header type has one.
A specific Element with any deletes This is all the metadata available for an element.
An Entry with all it’s metadata.
Data to create an entry.
The output of ephemeral signing. The private key for this public key has been discarded by this point. The signatures match the public key provided but cannot be reproduced or forged because the private key no longer exists. The signatures match the input items positionally in the vector, it is up to the caller to reconstruct/align/zip them back together.
A single function name.
Data passed into the genesis_self_check callback for verifying the initial chain entries
Zome IO inner for get and get_details calls.
Options for controlling how get works
The highest header sequence observed by this authority. This also includes the headers at this sequence. If there is more then one then there is a fork.
A header which declares that all zome init functions have successfully completed, and the chain is ready for commits. Contains no explicit data.
An InlineZome, which consists
Data with an optional validation status.
CreateLinks with and DeleteLinks on them
[CreateLink, [DeleteLink]]
Opaque tag for the link applied at the app layer, used to differentiate between different semantics and validation rules for different links
Metadata that can be requested on a basis
When migrating to a new version of a DNA, this header is committed to the new chain to declare the migration path taken. Currently unused
A curve to make headers have public entry types
Query arguments
Remote signal many agents without waiting for responses.
A Canonical Serialized Bytes representation for data If you have a data structure that needs a canonical byte representation use this Always round-trip through SerializedBytes via. a single TryFrom implementation. This ensures that the internal bytes of SerializedBytes are indeed canonical. The corrolary is that if bytes are NOT wrapped in SerializedBytes we can assume they are NOT canonical. Typically we need a canonical serialization when data is to be handled at the byte level by independently implemented and maintained systems.
Input structure for creating a signature.
Ephemerally sign a vector of bytes (i.e. a Vec<VecSignature struct as a new type.
There we know the key on the input side, here we receive the key on the output.
The raw bytes of a signature. The equality is not different, it’s just constant time, so we can derive a hash. For an actually secure thing we wouldn’t want to just assume a safe default hashing But that is not what clippy is complaining about here.
A combination of a Header and its signature.
The header and the signature that signed it
A UTC timestamp for use in Holochain’s headers. It is assumed to be untrustworthy: it may
contain times offset from the UNIX epoch with the full +/- i64 range. Most of these times are
not representable by a chrono::DateTime
Representation of message to be logged via the debug host function
UnsafeBytes the only way to implement a custom round trip through bytes for SerializedBytes It is intended to be an internal implementation in TryFrom implementations The assumption is that any code using UnsafeBytes is NOT valid messagepack data This allows us to enforce that all data round-tripping through SerializedBytes is via TryFrom and also allow for custom non-messagepack canonical representations of data types.
A header which specifies that some new Entry content is intended to be an update to some old Entry.
Placeholder for future when we want to have updates on headers Not currently in use.
Zome IO inner for update.
Mirror struct for Sign that includes a signature to verify against a key and data.
Placeholder for warrant type
A zome defined by Wasm bytecode
Data that can be encrypted with secretbox.
A Holochain Zome. Includes the ZomeDef as well as the name of the Zome.
The entry for the ZomeCall capability grant. This data is committed to the callee’s source chain as a private entry. The remote calling agent must provide a secret and we source their pubkey from the active network connection. This must match the strictness of the CapAccess.
this id is an internal reference, which also serves as a canonical ordering for zome initialization. The value should be auto-generated from the Zome Bundle def
The properties of the current dna/zome being called.
ZomeName as a String.
Enums
Get either the full activity or just the status of the chain
Represents access requirements for capability grants.
Represents a potentially valid access grant to a zome call. Zome call response will be Unauthorized without a valid grant.
Status of the agent activity chain
Return type for get_details calls. HeaderHash returns an Element. EntryHash returns an Entry.
Represents the different ways the entry_address reference within a Header can be intepreted
Structure holding the entry portion of a chain element.
The status of an Entry in the Dht
Errors involving app entry creation
Allows Headers which reference Entries to know what type of Entry it is referencing. Useful for examining Headers without needing to fetch the corresponding Entries.
Describes the get call and what information the caller is concerned about. This helps the subconscious avoid unnecessary network calls.
Header contains variants for each type of header.
A unit enum which just maps onto the different Header variants, without containing any extra data
Anything that can go wrong while calling a HostFnApi method
Maps directly to the tracing Levels but here to define the interface. See https://docs.rs/tracing-core/0.1.17/tracing_core/struct.Level.html
The level of validation package required by an entry.
Errors related to the secure primitive macro.
The validation status for an op or element much of this happens in the subconscious an entry missing validation dependencies may cycle through Pending many times before finally reaching a final validation state or being abandoned
Response to a zome call.
Just the definition of a Zome, without the name included. This exists mainly for use in HashMaps where ZomeDefs are keyed by ZomeName.
Anything that can go wrong while calling a HostFnApi method
Constants
The number of bits we want for a comfy secret.
The number of bytes we want for a comfy secret.
Entries larger than this number of bytes cannot be created
Key refs are the same length as the keys themselves. The key ref is just a sha256 of the key. There are no benefits, only downsides, to having either a larger or smaller set of outputs (ref size) vs. the set of inputs (key size).
Any header with a header_seq less than this value is part of an element created during genesis. Anything with this seq or higher was created after genesis.
Ed25519 signatures are always the same length, 64 bytes.
Traits
Extend holo_hash::AgentPubKey with additional signature functionality from Keystore.
A data structure that can be deserialized from any data format supported by Serde.
Data that requires a validation status.
Builder for non-genesis Headers
A trait to specify the common parts of a Header
A data structure that can be serialized into any data format supported by Serde.
Simple and safe type conversions that may fail in a controlled
way under some circumstances. It is the reciprocal of TryInto.
An attempted conversion that consumes self, which may or may not be
expensive.
Functions
A fixture AgentPubKey for unit testing.
A fixture AgentPubKey for unit testing. NB: This must match up with AgentPubKeyFixturator’s Predictable curve
Another fixture AgentPubKey for unit testing. NB: This must match up with AgentPubKeyFixturator’s Predictable curve
A fixture CapSecret for unit testing.
A fixture example CellId for unit testing.
A fixture DhtOpHash for unit testing.
A fixture DnaHash for unit testing.
A fixture EntryHash for unit testing.
A fixture HeaderHash for unit testing.
Get a random UID
Type Definitions
simply alias whatever serde bytes is already doing for Vec
The data type written to the source chain to denote a capability claim
The data type written to the source chain when explicitly granting a capability.
NB: this is not simply CapGrant, because the CapGrant::ChainAuthor
grant is already implied by Entry::Agent, so that should not be committed
to a chain. This is a type alias because if we add other capability types
in the future, we may want to include them
A fixed size array of bytes that a secret must be.
A DnaDef paired with its DnaHash
a single zome/function pair
A collection of zome/function pairs
An inline zome function takes a Host API and an input, and produces an output.
GhostSender type for the KeystoreApi
Alias
App-specific payload for proving membership in the membrane of the app
A type alias for a Vec
Placeholder for a real UID type
Zomes need to be an ordered map from ZomeName to a Zome