Crate holochain_types::prelude::dependencies::holochain_integrity_types

Expand description

Holochain Integrity Types: only the types needed by Holochain application developers to use in their integrity Zome code, and nothing more.

This crate is intentionally kept as minimal as possible, since it is typically included as a dependency in Holochain Zomes, which are distributed as chunks of Wasm.

This crate is also designed to be deterministic and more stable than the higher level crates.

Modules

  • action
  • capability
    Capability Grants and Claims
  • chain
    Source Chain Filtering
  • countersigning
    Countersigned entries involve preflights between many agents to build a session that is part of the entry.
  • entry
    An Entry is a unit of data in a Holochain Source Chain.
  • entry_def
  • genesis
    Types related to the genesis process whereby a user commits their initial records 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.
  • hash
  • info
    Information about the current zome and dna.
  • link
  • op
    Dht Operations
  • prelude
    Common types

Macros

  • fixed_array_serialization
    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.
  • secure_primitive
    Cryptographic secrets are fiddly at the best of times.

Structs

  • AgentValidationPkg
    Action for an agent validation package, used to determine whether an agent is allowed to participate in this DNA
  • AppEntryBytes
    Newtype for the bytes comprising an App entry
  • AppEntryDef
    Information about a class of Entries provided by the DNA
  • AppEntryName
    Identifier for an entry definition. This may be removed.
  • CapClaim
    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.
  • CapSecret
    A CapSecret is used by a caller to prove to a callee access to a committed CapGrant.
  • ChainFilter
    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.
  • CloseChain
    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
  • CounterSigningAgentState
    Every countersigning agent must sign against their chain state. The chain must be frozen until each agent decides to sign or exit the session.
  • CounterSigningSessionData
    All the data required for a countersigning session.
  • CounterSigningSessionTimes
    Every countersigning session must complete a full set of actions between the start and end times to be valid.
  • Create
    A action which “speaks” Entry content into being. The same content can be referenced by multiple such actions.
  • CreateBase
    Base data for Create actions.
  • CreateLink
    Declares that a metadata Link should be made between two EntryHashes
  • Delete
    Declare that a previously published Action should be nullified and considered deleted.
  • DeleteAction
    Placeholder for future when we want to have deletes on actions Not currently in use.
  • DeleteLink
    Declares that a previously made Link should be nullified and considered removed.
  • Dna
    The Dna Action is always the first action in a source chain
  • DnaInfo
    Information about the current DNA.
  • EntryDef
  • EntryDefIndex
  • EntryDefs
    All definitions for all entry types in an integrity zome.
  • EntryRateWeight
    Combination of the three main rate limiting data types, for convenience
  • EphemeralSignatures
    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.
  • ExternIO
  • FunctionName
    A single function name.
  • GenesisSelfCheckData
    Data passed into the genesis_self_check callback for verifying the initial chain entries
  • Hash256Bits
    256 Bit generic hash.
  • Hash512Bits
    512 Bit generic hash.
  • InclusiveTimestampInterval
    It’s an interval bounded by timestamps that are not infinite.
  • InitZomesComplete
    A action which declares that all zome init functions have successfully completed, and the chain is ready for commits. Contains no explicit data.
  • LinkTag
    Opaque tag for the link applied at the app layer, used to differentiate between different semantics and validation rules for different links
  • LinkType
  • MustGetActionInput
    Zome input for must_get_action.
  • MustGetAgentActivityInput
    Input to the must_get_agent_activity call.
  • MustGetEntryInput
    Zome input for must_get_entry.
  • MustGetValidRecordInput
    Zome input for must_get_valid_record.
  • OpenChain
    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
  • PreflightBytes
    Every preflight request can have optional arbitrary bytes that can be agreed to.
  • PreflightRequest
    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.
  • PreflightResponse
    Every agent must send back a preflight response. All the preflight response data is signed by each agent and included in the session data.
  • RateWeight
    Combination of two rate limiting data types, for convenience
  • Record
    a chain record containing the signed action along with the entry if the action type has one.
  • RegisterAgentActivity
    Registers a new Action on an agent source chain. This is the act of creating any Action and publishing it to the DHT.
  • RegisterCreateLink
    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.
  • RegisterDelete
    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.
  • RegisterDeleteLink
    Deletes a link between two Entrys. This is the act of creating a Action::DeleteLink and publishing it to the DHT. The delete always references a specific Action::CreateLink.
  • RegisterUpdate
    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.
  • RequiredValidations
    The number of validations required for an entry to be considered published.
  • Role
    Agents can have a role specific to each countersigning session. The role is app defined and opaque to the subconscious.
  • ScopedZomeType
    A type with the zome that it is defined in.
  • ScopedZomeTypes
    zome types that are in scope for the calling zome.
  • ScopedZomeTypesSet
    The set of EntryDefIndex and LinkTypes in scope for the calling zome.
  • Signature
    The raw bytes of a signature.
  • SignedHashed
    Any content that has been hashed and signed.
  • StoreEntry
    Stores a new Entry in the DHT. This is the act of creating a either a Action::Create or a Action::Update and publishing it to the DHT. These actions create a new instance of an Entry.
  • StoreRecord
    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
    A microsecond-precision UTC timestamp for use in Holochain’s actions.
  • TraceMsg
    Representation of message to be logged via the debug host function
  • Update
    A action which specifies that some new Entry content is intended to be an update to some old Entry.
  • UpdateAction
    Placeholder for future when we want to have updates on actions Not currently in use.
  • UpdateBase
    Base data for Update actions.
  • VerifySignature
    Mirror struct for Sign that includes a signature to verify against a key and data.
  • WrongActionError
  • X25519PubKey
  • X25519XSalsa20Poly1305Decrypt
  • XSalsa20Poly1305Data
    Data that can be encrypted with secretbox.
  • XSalsa20Poly1305Decrypt
  • XSalsa20Poly1305EncryptedData
  • XSalsa20Poly1305KeyRef
    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.
  • ZomeCallCapGrant
    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.
  • ZomeDependencyIndex
    The index into the ZomeIndex vec.
  • ZomeIndex
    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
  • ZomeInfo
    The properties of the current dna/zome being called.
  • ZomeName
    ZomeName as a String.
  • ZomeTypesKey
    A key to the ScopedZomeTypes container.

Enums

Constants

  • CAP_SECRET_BITS
    The number of bits we want for a comfy secret.
  • CAP_SECRET_BYTES
    The number of bytes we want for a comfy secret.
  • ENTRY_SIZE_LIMIT
    Entries larger than this number of bytes cannot be created
  • MAX_COUNTERSIGNING_AGENTS
    8 seems like a reasonable limit of agents to countersign.
  • MIN_COUNTERSIGNING_AGENTS
    Need at least two to countersign.
  • MM
    One million
  • POST_GENESIS_SEQ_THRESHOLD
    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.
  • SESSION_ACTION_TIME_OFFSET
    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.
  • SESSION_TIME_FUTURE_MAX
    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_OFFSET after the session start we include that here.
  • SIGNATURE_BYTES
    Ed25519 signatures are always the same length, 64 bytes.
  • X25519_PUB_KEY_BYTES

Traits

  • ActionUnweighed
    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.
  • ActionWeighed
    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.
  • EntryDefRegistration
    Trait for binding static EntryDef property access for a type. This trait maps a type to its corresponding EntryDef property at compile time.
  • EntryTypesHelper
    Helper trait for deserializing Entrys to the correct type.
  • LinkTypesHelper
    A helper trait for finding the app defined link type from a ZomeIndex and LinkType.
  • U8Index
    Helper trait for types that are internally represented as u8 but need to be used as indicies into containers.
  • UnitEnum
    A utility trait for associating a data enum with a unit enum that has the same variants.

Functions

  • many_bytes_string
    Helpful pattern for debug formatting many bytes. If the size is > 32 bytes, only the first 8 and last 8 bytes will be displayed.

Type Definitions