Module holochain_types::prelude
source · Expand description
reexport some common things
Re-exports§
pub use crate::access::*;pub use crate::action::*;pub use crate::activity::*;pub use crate::app::error::*;pub use crate::app::*;pub use crate::autonomic::*;pub use crate::chain::*;pub use crate::chc::*;pub use crate::combinators::*;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::entry::*;pub use crate::link::*;pub use crate::metadata::*;pub use crate::record::error::*;pub use crate::record::*;pub use crate::signal::*;pub use crate::validation_receipt::*;pub use crate::wasmer_types::*;pub use crate::fixt::*;pub use crate::test_utils::*;
Modules§
- represent arbitrary bytes (not serialized) e.g. totally random crypto bytes from random_bytes
- A “Cell” represents a DNA/AgentId pair - a space where one dna/agent can track its source chain and service network requests / responses.
- Cells can be cloned to create new cells with the different properties.
- Defines DnaDef struct
- DNA Properties Support types
- Types for arbitrary data driven by entropy
- ffs - the Friendly Filesystem
- Items related to the DNA initialization callback.
- 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
- Implements YamlProperties, and potentially any other data types that can represent “properties” of a DNA
- Types for source chain queries
- Types for requesting metadata
- Schedule functions to run outside a direct zome call.
- App-defined signals
- Common helpers for writing tests against zome types
- A microsecond-precision UTC timestamp for use in Holochain’s actions.
- Tracking versions between the WASM host and guests and other interfaces.
- Types for warrants
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 records returned from a agent_activity_query
- The struct containing all information about the executing agent’s identity.
- Action 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
- The location of an app entry definition.
- Identifier for an entry definition. This may be removed.
- A signal emitted by an app via
emit_signal - Represents a block. Also can represent an unblock. NOT serializable and NOT pub fields by design.
try_newMUST be the only entrypoint to build aBlockas this enforces that the start/end times are valid according to invariants the SQL queries rely on to avoid corrupting the database. - 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
- Filter source chain items. Starting from some chain position given as an
ActionHashthe chain is walked backwards to genesis. The filter can stop early by specifying the number of chain items to take and / or anActionHashto consume until. - The chain has been forked by these two actions
- The action at the head of the complete chain. This is as far as this authority can see a chain with no gaps.
- Specifies arguments to a query of the source chain, including ordering and filtering.
- Identifier of a clone cell, composed of the DNA’s role name and the index of the clone, starting at 0.
- Cloned cell that was created from a provisioned cell at runtime.
- When migrating to a new version of a DNA, this action is committed to the old chain to declare the migration path taken. Currently unused
- A type marker for a coordinator
InlineZome. - Every countersigning agent must sign against their chain state. The chain must be frozen until each agent decides to sign or exit the session.
- All the data required for a countersigning session.
- Every countersigning session must complete a full set of actions between the start and end times to be valid.
- A action which “speaks” Entry content into being. The same content can be referenced by multiple such actions.
- Base data for Create actions.
- The arguments to create a clone of an existing cell.
- Zome input to create an entry.
- 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 Action should be nullified and considered deleted.
- Placeholder for future when we want to have deletes on actions Not currently in use.
- Zome input for all delete operations.
- Declares that a previously made Link should be nullified and considered removed.
- Query arguments for the deterministic version of GetAgentActivity
- Arguments to specify the clone cell to be disabled.
- The Dna Action is always the first action in a source chain
- The definition of a DNA: the hash of this data is what produces the DnaHash.
- Builder for
DnaDef. - Information about the current DNA.
- Information about the current DNA.
- Modifiers of this DNA - the network seed, properties and origin time - as opposed to the actual DNA code. These modifiers are included in the DNA hash computation.
- Builder for
DnaModifiers. DnaModifiersoptions of which all are optional.- An inline zome clonable type object.
- All definitions for all entry types in an integrity zome.
- An Entry with all its metadata.
- Combination of the three main rate limiting data types, for convenience
- 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
- Data passed into the genesis_self_check callback for verifying the initial chain entries. DnaInfo can be read with a call to
dna_infowithin the self check callback, it is elided here to minimise/stabilise the callback function signature. - Zome input for get and get_details calls.
- Options for controlling how get works
- Parameters for granting a zome call capability.
- 256 Bit generic hash.
- 512 Bit generic hash.
- The highest action sequence observed by this authority. This also includes the actions at this sequence. If there is more then one then there is a fork.
- It’s an interval bounded by timestamps that are not infinite.
- A action which declares that all zome init functions have successfully completed, and the chain is ready for commits. Contains no explicit data.
- An “inline” zome definition in pure Rust, as opposed to a zome defined in Wasm.
- A type marker for an integrity
InlineZome. - Data with an optional validation status.
- CreateLinks with and DeleteLinks on them
[CreateLink, [DeleteLink]] - A query for links to be used with host functions that support filtering links
- 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
- Zome input for must_get_action.
- Input to the
must_get_agent_activitycall. - Zome input for must_get_entry.
- Zome input for must_get_valid_record.
- 256 Bit generic nonce.
- When migrating to a new version of a DNA, this action is committed to the new chain to declare the migration path taken. Currently unused
- Every preflight request can have optional arbitrary bytes that can be agreed to.
- The same PreflightRequest is sent to every agent. Each agent signs this data as part of their PreflightResponse. Every preflight must be identical and signed by every agent for a session to be valid.
- Every agent must send back a preflight response. All the preflight response data is signed by each agent and included in the session data.
- A curve to make actions have public entry types
- Specifies arguments to a query of the source chain, including ordering and filtering.
- Combination of two rate limiting data types, for convenience
- a chain record containing the signed action along with the entry if the action type has one.
- A specific Record with any updates and deletes. This is all the metadata available for a record.
- Registers a link between two
Entrys. This is the act of creating aAction::CreateLinkand publishing it to the DHT. The authority is the entry authority for the baseEntry. - Registers a deletion of an instance of an
Entryin the DHT. This is the act of creating aAction::Deleteand publishing it to the DHT. - Deletes a link between two
Entrys. This is the act of creating aAction::DeleteLinkand publishing it to the DHT. The delete always references a specificAction::CreateLink. - Registers an update from an instance of an
Entryin the DHT. This is the act of creating aAction::Updateand publishing it to the DHT. Note that theAction::Updatestores an new instance of anEntryand registers it as an update to the originalEntry. This operation is only concerned with registering the update. - Remote signal many agents without waiting for responses.
- The number of validations required for an entry to be considered published.
- Agents can have a role specific to each countersigning session. The role is app defined and opaque to the subconscious.
- A fully qualified scheduled function.
- A type with the zome that it is defined in.
- zome types that are in scope for the calling zome.
- The set of
EntryDefIndexandLinkTypes in scope for the calling zome. - 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<Vec<u8>>) Each of the items of the outer vector represents something to sign and will have a corresponding Signature in the output. The public key for the ephemeral operation will be returned in the output. Structurally mirrors/complements theSignaturestruct 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.
- A combination of an action and its signature.
- Any content that has been hashed and signed.
- Stores a new
Entryin the DHT. This is the act of creating a either aAction::Createor aAction::Updateand publishing it to the DHT. These actions create a new instance of anEntry. - A microsecond-precision UTC timestamp for use in Holochain’s actions.
- Representation of message to be logged via the
debughost 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 action 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 actions Not currently in use.
- Base data for Update actions.
- Zome input type for all update operations.
- 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.
- Key refs represent shared secrets stored in the keystore. They can either be user-specified, or auto-generated at time of secret creation, or ingestion.
- A type to allow json values to be used as
SerializedBytes - 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.
- Zome calls need to be signed regardless of how they are called. This defines exactly what needs to be signed.
- The index into the
ZomeIndexvec. - 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.
- A key to the
ScopedZomeTypescontainer.
Enums§
- Action contains variants for each type of action.
- Enum to mirror Action for all the shared data required to build session actions. Does NOT hold any agent specific information.
- A unit enum which just maps onto the different Action variants, without containing any extra data
- Get either the full activity or just the status of the chain
- Target of a block. Each target type has an ID and associated reason.
- 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.
- Reason why we might want to block a cell.
- Specify which
Actions to allow through this filter. - Defines several ways that queries can be restricted to a range. Notably hash bounded ranges disambiguate forks whereas sequence indexes do not as the same position can be found in many forks. The reason that this does NOT use native rust range traits is that the hash bounded queries MUST be inclusive otherwise the integrity and fork disambiguation logic is impossible. An exclusive range bound that does not include the final action tells us nothing about which fork to select between N forks of equal length that proceed it. With an inclusive hash bounded range the final action always points unambiguously at the “correct” fork that the range is over. Start hashes are not needed to provide this property so ranges can be hash terminated with a length of preceeding records to return only. Technically the seq bounded ranges do not imply any fork disambiguation and so could be a range but for simplicity we left the API symmetrical in boundedness across all enum variants. @TODO It may be possible to provide/implement RangeBounds in the case that a full sequence of records/actions is provided but it would need to be handled as inclusive first, to enforce the integrity of the query, then the exclusiveness achieved by simply removing the final record after the fact.
- Status of the agent activity chain
- Ways of specifying a clone cell.
- Errors related to the secure primitive macro.
- Return type for get_details calls. ActionHash returns a Record. EntryHash returns an Entry.
- Structure holding the entry portion of a chain record.
- Either an
EntryDefIndexor one of: - The status of an Entry in the Dht
- Errors involving app entry creation
- Allows Actions which reference Entries to know what type of Entry it is referencing. Useful for examining Actions 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.
- A collection of zome/function pairs
- Input to holochain hash function.
- Output from the holochain hashing host function.
- Anything that can go wrong while calling a HostFnApi method
- A human-readable timestamp which is represented/serialized as an RFC3339 when possible, and a microsecond integer count otherwise. Both representations can be deserialized to this type.
- The result of the DNA initialization callback.
- Reason why we might want to block an IP.
- 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
- Filter on a set of
LinkTypes. - Reason why we might want to block a node.
- These are the operations that can be applied to Holochain data. Every
Actionproduces a set of operations. These operations are each sent to an authority for validation. - A preflight request can be accepted, or invalid, or valid but the local agent cannot accept it.
- Represents the different ways the entry_address reference within an action can be interpreted
- The level of validation package required by an entry.
- Defines either a persisted or ephemeral schedule for a schedule function. Persisted schedules survive a conductor reboot, ephemeral will not. Persisted schedules continue beyond irrecoverable errors, ephemeral do not.
- Scheduling errors.
- Errors related to the secure primitive macro.
- A full UnitEnum, or just the unit type of that UnitEnum
- Unresolved dependencies that are either a set of hashes or an agent activity query.
- The validation status for an op or record 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
- Input to the
weighcallback. Includes an “unweighed” action, and Entry if applicable. - 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.
- Delimiter in a clone id that separates the base cell’s role name from the clone index.
- Entries larger than this number of bytes cannot be created
- 8 seems like a reasonable limit of agents to countersign.
- Need at least two to countersign.
- One million
- Expire persisted schedules after this long.
- Any action with a action_seq less than this value is part of a record created during genesis. Anything with this seq or higher was created after genesis.
- Tick the scheduler every this many millis.
- The timestamps on actions for a session use this offset relative to the session start time. This makes it easier for agents to accept a preflight request with actions that are after their current chain top, after network latency.
- Maximum time in the future the session start can be in the opinion of the participating agent. As the action will be
SESSION_ACTION_TIME_OFFSETafter the session start we include that here. - Ed25519 signatures are always the same length, 64 bytes.
Statics§
- 10MB of entropy free for the taking. Useful for initializing arbitrary::Unstructured data
Traits§
- Builder for non-genesis Actions
- A trait to unify the “inner” parts of an Action, i.e. the structs inside the Action enum’s variants. This trait is used for the “unweighed” version of each struct, i.e. the version with weight information erased.
- A trait to unify the “inner” parts of an Action, i.e. the structs inside the Action enum’s variants. This trait is used for the “weighed” version of each struct, i.e. the version without weight information erased.
- Extend holo_hash::AgentPubKey with additional signature functionality from Keystore.
- A data structure that can be deserialized from any data format supported by Serde.
- Helper trait for deserializing
Entrys to the correct type. - Data that requires a validation status.
- 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. - Trait to convert from dna properties into specified type
- An attempted conversion that consumes
self, which may or may not be expensive. - Helper trait for types that are internally represented as
u8but need to be used as indicies into containers. - A utility trait for associating a data enum with a unit enum that has the same variants.
Functions§
- Check the entry variant matches the variant in the actions entry type
- A fixture ActionHash for unit testing.
- 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 example CellId for unit testing.
- A fixture DhtOpHash for unit testing.
- A fixture DnaHash for unit testing.
- A fixture EntryHash for unit testing.
- Get some noise to feed into arbitrary::Unstructured
- A Generator backed by unstructured_noise
- Get a random network seed
- Alias for arbitrary::Unstructured::new
- 10MB of random Unstructured data for use with
arbitrary - A rough check that a sequence of Actions constitutes a valid source chain
Type Aliases§
- simply alias whatever serde bytes is already doing for
Vec<u8> - 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 theCapGrant::ChainAuthorgrant is already implied byEntry::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.
- Ordered list of coordinator zomes in this DNA.
- Alias for a list of agents and their roles.
- Arguments to delete a disabled clone cell of an app.
- A DnaDef paired with its DnaHash
- Convenience alias to the latest
DnaInfoN. - Arguments to specify the clone cell to be enabled.
- An Entry paired with its EntryHash
- Alias to the current version of
GenesisSelfCheckData. - a single zome/function pair
- An inline zome function takes a Host API and an input, and produces an output.
- Ordered list of integrity zomes in this DNA.
- Alias
- App-specific payload for proving membership in the membrane of the app
- Placeholder for a real network seed type. See [
DnaDef]. - The amount that a bucket is “filled”
- A bucket ID, for rate limiting
- The normalized total size of this action, for rate limiting
- The weight of this action, for rate limiting
- Alias for record with ref entry
- Identifier for an App Role, a foundational concept in the App manifest.
- An
EntryDefIndexwithin the scope of the zome where it’s defined. - A
LinkTypewithin the scope of the zome where it’s defined. - The hashed action and the signature that signed it
- A type alias for a
Vec<u8>whose fixturator is expected to only return a Vec of length 32 - A key to the
ScopedZomeTypes<EntryDefIndex>container. - A key to the
ScopedZomeTypes<LinkType>container.