The state of an agent’s activity.
The state of an authors activity according to this authority.
A Record to be added to the CHC.
An agents chain records returned from a agent_activity_query
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 bundle of an AppManifest and collection of DNAs
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.
Version 1 of the App manifest schema
Version 1 of the App manifest schema
Normalized, validated representation of the App Manifest.
App “roles” correspond to cell entries in the AppManifest.
The DNA portion of an app role
Description of an app “role” defined by this app.
Roles get filled according to the provisioning rules, as well as by
potential runtime clones.
The answer to the question:
“how do we concretely assign DNAs to the open roles of this App?”
Includes the DNAs selected to fill the roles and the details of the role assignments.
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_new MUST be the only
entrypoint to build a Block as 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
ActionHash
the chain is walked backwards to genesis.
The filter can stop early by specifying the number of
chain items to take and / or an
ActionHash to consume until.
Iterate over a source chain and apply the
ChainFilter to each element.
This iterator will:
A
ChainFilter with the action sequences for the
starting position and any
until hashes.
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
Error converting a composite hash into a subset composite hash, due to type mismatch
A bundle of coordinator zomes.
Coordinator zomes.
Response type for a WireLinkQuery.
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.
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.
Specifies the environment used for authoring data by all cells on the same
DnaHash.
Specifies the environment used by each Cache (one per dna).
Specifies the environment used by a Conductor
Specifies the environment used for dht data by all cells on the same
DnaHash.
State of the p2p network (one per space).
Metrics for peers on p2p network (one per space).
Specifies the environment used to save wasm
A read-only version of
DbWrite.
This environment can only generate read-only transactions, never read-write.
The canonical representation of a (singleton) database.
The wrapper contains methods for managing transactions
and database connections,
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
This cache allows us to track selected database queries that
are too slow to run frequently.
The queries are lazily evaluated and cached.
Then the cache is updated in memory without needing to
go to the database.
Arguments to specify the clone cell to be disabled.
Arguments to specify the clone cell to be disabled.
The Dna Action is always the first action in a source chain
A bundle of Wasm zomes, respresented as a file.
The definition of a DNA: the hash of this data is what produces the DnaHash.
Represents a full DNA, including DnaDef and WebAssembly bytecode.
Information about the current DNA.
Information about the current DNA.
The structure of data that goes in the DNA bundle manifest “dna.yaml”.
The structure of data that goes in the DNA bundle manifest “dna.yaml”.
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.
Represents web assembly code.
An inline zome clonable type object.
Encrypted bytes of an Entry
All entry data common to an get entry request.
All definitions for all entry types in an integrity zome.
An Entry with all its metadata.
A newtype for a collection of EntryHashes, needed for some wasm return types.
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_info within the
self check callback, it is elided here to minimise/stabilise the callback
function signature.
Zome input for get and get_details calls.
Link response to get links
Options for controlling how get is executed.
The request to retrieve records from the CHC.
The full request for get_record_data
Parameters for granting a zome call capability.
256 Bit generic hash.
512 Bit generic hash.
Error converting a composite hash into a primitive one, due to type mismatch
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.
A HoloHash contains a vector of 36 bytes representing a 32-byte blake2b hash
plus 4 bytes representing a DHT location. It also contains a zero-sized
type which specifies what it is a hash of.
A wrapper around HoloHash that Serializes into a base64 string
rather than a raw byte array.
Represents some piece of content along with its hash representation, so that
hashes need not be calculated multiple times.
Provides an easy constructor which consumes the content.
A HostApi paired with a ghost_actor sender (legacy)
When all legacy functions have been moved to the API,
this type can be replaced by HostApi.
Access a call has to host functions
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.
Information needed to specify a DNA as part of an App
An app which has been installed.
An installed app is merely its collection of “roles”, associated with an ID.
The common data between apps of any status
Data about an installed Cell.
Manifest for all items that will change the
DnaHash.
Data with an optional validation status.
Distinguish multiple agents within the same network module.
The basis hash/coordinate when identifying a neighborhood.
Data and handlers for diagnostic info, to be used by the host.
The op data with its location
Top-level “KitsuneDataHash” items are buckets of related meta-data.
These metadata “Operations” each also have unique OpHashes.
A cryptographic signature.
Distinguish multiple categories of communication within the same network module.
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
Metadata returned from a GetMeta request.
The Ord derive on TimedActionHash means each set is ordered by time.
Zome input for must_get_action.
Input to the must_get_agent_activity call.
Zome input for must_get_entry.
Zome input for must_get_valid_record.
The instructions on how to request NetworkInfo
A 32 byte cert identifying a peer
256 Bit generic nonce.
This is used as an index for ordering ops in our database.
It gives the most likely ordering where dependencies will come
first.
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
Newtype to hand out connections that can only be used for running transactions
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.
Host-defined data used to implement custom connection preflight checks.
Specifies arguments to a query of the source chain, including ordering and filtering.
Combination of two rate limiting data types, for convenience
This type gives full metadata that can be combined
monotonically with other metadata and the actual data
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.
A group of records with a common entry
Record with it’s status
Registers a new
Action on an agent source chain.
This is the act of creating any
Action and
publishing it to the DHT.
Registers a link between two
Entrys.
This is the act of creating a
Action::CreateLink and
publishing it to the DHT.
The authority is the entry authority for the base
Entry.
Registers a deletion of an instance of an
Entry in the DHT.
This is the act of creating a
Action::Delete and
publishing it to the DHT.
The instructions on how to get the DNA to be registered
Registers an update from an instance of an
Entry in the DHT.
This is the act of creating a
Action::Update and
publishing it to the DHT.
Note that the
Action::Update stores an new instance
of an
Entry and registers it as an update to the original
Entry.
This operation is only concerned with registering the update.
Remote signal many agents without waiting for responses.
The data rendered from a wire op to place in the database.
The full data for insertion into the database.
The reason we don’t use
DhtOp is because we don’t
want to clone the entry for every action.
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.
An active app
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.
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 the Signature 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.
A combination of an action and its signature.
Any content that has been hashed and signed.
A full, signed validation receipt.
An app which is either Paused or Disabled, i.e. not Running
Stores a new
Record in the DHT.
This is the act of creating a new
Action
and publishing it to the DHT.
Note that not all
Actions contain an
Entry.
Timestamp of when the action was created with the actions hash.
A microsecond-precision UTC timestamp for use in Holochain’s actions.
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 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.
The instructions on how to update coordinators for a dna file.
Zome input type for all update operations.
A dna manifest that has been successfully validated.
Validation receipt content - to be signed.
A bundle of validation receipts to be sent together.
Mirror struct for Sign that includes a signature to verify against a key and data.
Placeholder for warrant type
Wasms need to be an ordered map from WasmHash to a wasm::DnaWasm
A zome defined by Wasm bytecode
A action of one of the two types that create a new entry.
The minimum unique data for Create actions
that share a common entry
Condensed data needed for a get entry request.
Link key for sending across the wire for get links requests.
Condensed link ops for sending across the wire in response to get links.
Query for links to be sent over the network.
Record without the hashes for sending across the network
TODO: Remove this as it’s no longer needed.
A condensed version of get record request.
This saves bandwidth by removing duplicated and implied data.
The minimum unique data for Update actions
that share a common entry
This type is used when sending updates from the
original entry authority to someone asking for
metadata on that original entry.
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 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.
Manifest for integrity zomes that another zome
depends on.
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.
Manifest for an individual Zome
ZomeName as a String.
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
The primitive hash types represented by this composite hash
The primitive hash types represented by this composite hash
Errors occurring while installing an AppBundle
The possible locations of an AppBundle
Container struct which uses the manifest_version field to determine
which manifest version to deserialize to.
Rules to determine if and how a Cell will be created for this Dna
The status of an installed app.
A declaration of the side effects of a particular AppStatusTransition.
The AppStatus without the reasons.
Represents a state transition operation from one state to another
The various processes which run “autonomically”, aka subconsciously.
These are currently not used.
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.
Rules to determine if and how a Cell will be created for this Dna
Uninhabitable placeholder
Specifies what step should be taken to provision a cell while installing an App
Specify which
Actions to allow through
this filter.
The type of agent activity returned in this request
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.
The source of coordinators to be installed, either as binary data, or from a path
Errors related to the secure primitive macro.
The various types of database, used to specify the list of databases to initialize
The sqlite synchronous level.
Corresponds to the
PRAGMA synchronous pragma.
See
sqlite documentation.
The strategy for database file system synchronization.
Some databases like the cache can be safely rebuilt if
corruption occurs due to using the faster
DbSyncLevel::Off.
Return type for get_details calls.
ActionHash returns a Record.
EntryHash returns an Entry.
A unit of DHT gossip. Used to notify an authority of new (meta)data to hold
as well as changes to the status of already held data.
A type for storing in databases that don’t need the actual
data. Everything is a hash of the type except the signatures.
This enum is used to
The reason for an app being in a Disabled state.
Holochain DnaError type.
The enum which encompasses all versions of the DNA manifest, past and present.
The source of the DNA to be installed, either as binary data, or from a path
Structure holding the entry portion of a chain record.
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.
Responses from a dht get.
These vary is size depending on the level of metadata required
Set if data should be fetched from the network or only from the local
databases.
The type of gossip module running this gossip.
A collection of zome/function pairs
Input to holochain hash function.
Output from the holochain hashing host function.
HashableContent can be expressed as “content”, or “prehashed”, which affects
how a HoloHashed type will be constructed from it.
HoloHash Error Type.
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.
KitsuneP2p Error Type.
How do we match this link in queries?
Response to a must_get_agent_activity call.
A action of one of the two types that create a new entry.
Same as NewEntryAction but takes actions as reference
Reason why we might want to block a node.
These are the operations that can be applied to Holochain data.
Every
Action produces a set of operations.
These operations are each sent to an authority for validation.
Type for deriving ordering of DhtOps
Don’t change the order of this enum unless
you mean to change the order we process ops
The reason for an app being in a Paused state.
NB: there is no way to manually pause an app.
Permission granted to a call
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.
Outcome of trying to find the action sequences in a filter.
A Signal is some information emitted from within Holochain out through
an Interface
The various reasons for why an App is not in the Running state.
A Signal which originates from within the Holochain system, as opposed to
from within a Cell
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 weigh callback. Includes an “unweighed” action, and Entry
if applicable.
A action of one of the two types that create a new entry.
Condensed version of ops for sending across the wire.
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
The hash of an action
Base64-ready version of ActionHash
The request type for add_records
An Agent public signing key. Not really a hash, more of an “identity hash”.
Base64-ready version of AgentPubKey
The hash of anything referrable in the DHT.
This is a composite of either an EntryHash or a ActionHash
Base64-ready version of AnyDhtHash
The hash of anything linkable.
Base64-ready version of AnyLinkableHash
A result that returns a generic type T in case of success and an
AppManifestError` otherwise.
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 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.
Alias for getting the associated hash type of a ChainItem
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.
Arguments to delete a disabled clone cell of an app.
The hash of a DhtOp’s “unique form” representation
Base64-ready version of DhtOpHash
A DhtOp paired with its DhtOpHash
Old alias for DhtOpLite
A DnaDef paired with its DnaHash
The hash of a DnaDef
Base64-ready version of DnaHash
Convenience alias to the latest DnaInfoN.
Specifies remote, local, or bundled location of DNA
Result type for DnaError
A DnaWasm paired with its WasmHash
Arguments to specify the clone cell to be enabled.
Arguments to specify the clone cell to be enabled.
The hash of an Entry.
Base64-ready version of EntryHash
An Entry paired with its EntryHash
The hash of some external data that can’t or doesn’t exist on the DHT.
Base64-ready version of ExternalHash
Alias to the current version of GenesisSelfCheckData.
a single zome/function pair
A convenience type, for specifying a hash by HashableContent rather than
by its HashType
HoloHash Result type
Trait object for the host interface
An inline zome function takes a Host API and an input, and produces an output.
The unique identifier for an installed app in this conductor
A map from InstalledAppId -> InstalledApp
Ordered list of integrity zomes in this DNA.
Convenience type
A boxed future result with dynamic error type
Result Type
App-specific payload for proving membership in the membrane of the app
The hash of a network ID
Base64-ready version of NetIdHash
Placeholder for a real network seed type. See [DnaDef].
Alias for AnyLinkableHash. This hash forms the notion of the “basis hash” of an op.
Alias for DhtOpLite
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
EntryDefIndex within the scope of the zome where it’s defined.
A
LinkType within the scope of the zome where it’s defined.
The hashed action and the signature that signed it
A sys validation dependency
The hash of some wasm bytecode
Base64-ready version of WasmHash
A public key of a pair of signing keys for signing zome calls.
Alias for a suitable representation of zome location