Module hdk::prelude

Exports common types and functions according to the Rust prelude pattern.

Re-exports

• pub use crate::capability::create_cap_claim;
• pub use crate::capability::create_cap_grant;
• pub use crate::capability::delete_cap_grant;
• pub use crate::capability::generate_cap_secret;
• pub use crate::capability::update_cap_grant;
• pub use crate::chain::get_agent_activity;
• pub use crate::chain::query;
• pub use crate::countersigning::accept_countersigning_preflight_request;
• pub use crate::countersigning::session_times_from_millis;
• pub use crate::ed25519::sign;
• pub use crate::ed25519::sign_ephemeral;
• pub use crate::ed25519::sign_ephemeral_raw;
• pub use crate::ed25519::sign_raw;
• pub use crate::entry::create;
• pub use crate::entry::create_entry;
• pub use crate::entry::delete;
• pub use crate::entry::delete_entry;
• pub use crate::entry::get;
• pub use crate::entry::get_details;
• pub use crate::entry::update;
• pub use crate::entry::update_entry;
• pub use crate::hash_path::anchor::anchor;
• pub use crate::hash_path::anchor::list_anchor_addresses;
• pub use crate::hash_path::anchor::list_anchor_tags;
• pub use crate::hash_path::anchor::list_anchor_type_addresses;
• pub use crate::hash_path::anchor::Anchor;
• pub use crate::hash_path::path::Path;
• pub use crate::hash_path::path::TypedPath;
• pub use crate::info::agent_info;
• pub use crate::info::call_info;
• pub use crate::link::count_links;
• pub use crate::link::create_link;
• pub use crate::link::delete_link;
• pub use crate::link::get_link_details;
• pub use crate::link::get_links;
• pub use crate::map_extern;
• pub use crate::map_extern;
• pub use crate::p2p::call;
• pub use crate::p2p::call_remote;
• pub use crate::p2p::emit_signal;
• pub use crate::p2p::remote_signal;
• pub use crate::time::schedule;
• pub use crate::time::sleep;
• pub use crate::time::sys_time;
• pub use crate::x_salsa20_poly1305::create_x25519_keypair;
• pub use crate::x_salsa20_poly1305::x_25519_x_salsa20_poly1305_encrypt;
• pub use crate::x_salsa20_poly1305::x_salsa20_poly1305_encrypt;
• pub use crate::x_salsa20_poly1305::x_salsa20_poly1305_shared_secret_create_random;
• pub use crate::x_salsa20_poly1305::x_salsa20_poly1305_shared_secret_export;
• pub use crate::x_salsa20_poly1305::x_salsa20_poly1305_shared_secret_ingest;
• pub use hdi;
• pub use hdk_derive;
• pub use holo_hash;
• pub use holochain_zome_types;
• pub use tracing;
• pub use crate::hash::*;
• pub use crate::hdk::*;
• pub use crate::random::*;
• pub use crate::clone::*;

Modules

• agent_activity
• allocation
• block
• builder
• bytes
  represent arbitrary bytes (not serialized) e.g. totally random crypto bytes from random_bytes
• call
• cell
  A “Cell” represents a DNA/AgentId pair - a space where one dna/agent can track its source chain and service network requests / responses.
• clone
  Cells can be cloned to create new cells with the different properties.
• conversions
• crdt
• data
• dna_def
  Defines DnaDef struct
• dna_properties
  DNA Properties Support types
• encrypted_data
• error
• holochain_serialized_bytes
• init
  Items related to the DNA initialization callback.
• instrument
  Attach a span to a std::future::Future.
• judged
  Wrapper type to indicate some data which has a ValidationStatus associated with it.
• key_ref
• metadata
  Metadata types for use in wasm
• migrate_agent
• nonce
• query
  Types for source chain queries
• request
  Types for requesting metadata
• result
• schedule
  Schedule functions to run outside a direct zome call.
• serde_bytes
  Wrapper types to enable optimized handling of &[u8] and Vec<u8>.
• signal
  App-defined signals
• timestamp
  A microsecond-precision UTC timestamp for use in Holochain’s actions.
• version
  Tracking versions between the WASM host and guests and other interfaces.
• warrant
  Types for warrants
• x25519

Macros

• app_entry
  Implements conversion traits to allow a struct to be handled as an app entry. If you have some need to implement custom serialization logic or metadata injection you can do so by implementing these traits manually instead.
• debug
  Constructs an event at the debug level.
• entry_def
  Implements a whole lot of sane defaults for a struct or enum that should behave as an entry. All the entry def fields are available as dedicated methods on the type and matching From impls are provided for each. This allows for both Foo::entry_def() and EntryDef::from(Foo::new()) style logic which are both useful in different scenarios.
• error
  Constructs an event at the error level.
• 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.
• holochain_serial
  unidiomatic way to derive default trait implementations of TryFrom in/out of SerializedBytes
• host_externs
• impl_to_sql_via_as_ref
  Helper macro for implementing ToSql, when using rusqlite as a dependency
• impl_to_sql_via_display
  Helper macro for implementing ToSql, when using rusqlite as a dependency
• info
  Constructs an event at the info level.
• map_extern
  Hides away the gross bit where we hook up integer pointers to length-prefixed guest memory to serialization and deserialization, and returning things to the host, and memory allocation and deallocation.
• paste
• secure_primitive
  Cryptographic secrets are fiddly at the best of times.
• trace
  Constructs an event at the trace level.
• try_ptr
  A simple macro to wrap return_err_ptr in an analogy to the native rust ?.
• warn
  Constructs an event at the warn level.
• wasm_error
  Helper macro for returning an error from a WASM.

Structs

• ActionBuilderCommon
• AgentActivity
  An agents chain records returned from a agent_activity_query
• AgentInfo
  The struct containing all information about the executing agent’s identity.
• 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
• AppEntryDefLocation
  The location of an app entry definition.
• AppEntryName
  Identifier for an entry definition. This may be removed.
• AppSignal
  A signal emitted by an app via emit_signal
• BTreeSet
  An ordered set based on a B-Tree.
• Block
  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.
• BlockAgentInput
• Call
• CallInfo
• 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.
• CellId
  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
• 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.
• ChainFork
  The chain has been forked by these two actions
• ChainHead
  The action at the head of the complete chain. This is as far as this authority can see a chain with no gaps.
• ChainQueryFilter
  Specifies arguments to a query of the source chain, including ordering and filtering.
• CloneId
  Identifier of a clone cell, composed of the DNA’s role name and the index of the clone, starting at 0.
• ClonedCell
  Cloned cell that was created from a provisioned cell at runtime.
• 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
• CoordinatorZomeDef
• 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.
• CrdtType
• 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.
• CreateCloneCellInput
  The arguments to create a clone of an existing cell.
• CreateInput
  Zome input to create an entry.
• CreateLink
  Declares that a metadata Link should be made between two EntryHashes
• CreateLinkInput
  Zome IO inner type for link creation.
• CurryPayloads
  @todo Ability to forcibly curry payloads into functions that are called with a claim.
• 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.
• DeleteInput
  Zome input for all delete operations.
• DeleteLink
  Declares that a previously made Link should be nullified and considered removed.
• DeleteLinkInput
• DeterministicGetAgentActivityFilter
  Query arguments for the deterministic version of GetAgentActivity
• DeterministicGetAgentActivityResponse
• DisableCloneCellInput
  Arguments to specify the clone cell to be disabled.
• Dna
  The Dna Action is always the first action in a source chain
• DnaDef
  The definition of a DNA: the hash of this data is what produces the DnaHash.
• DnaInfoV1
  Information about the current DNA.
• DnaInfoV2
  Information about the current DNA.
• DnaModifiers
  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.
• DnaModifiersOpt
  DnaModifiers options of which all are optional.
• EntryDef
• EntryDefIndex
• EntryDefs
  All definitions for all entry types in an integrity zome.
• EntryDetails
  An Entry with all its metadata.
• EntryHashes
  A newtype for a collection of EntryHashes, needed for some wasm return types.
• 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.
• GenesisSelfCheckDataV1
  Data passed into the genesis_self_check callback for verifying the initial chain entries
• GenesisSelfCheckDataV2
  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.
• GetAgentActivityInput
• GetInput
  Zome input for get and get_details calls.
• GetLinksInput
• GetOptions
  Options for controlling how get works
• GrantZomeCallCapabilityPayload
  Parameters for granting a zome call capability.
• Hash256Bits
  256 Bit generic hash.
• Hash512Bits
  512 Bit generic hash.
• HashSet
  A hash set implemented as a HashMap where the value is ().
• HighestObserved
  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.
• HoloHash
  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.
• HoloHashed
  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.
• 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.
• IntegrityZomeDef
• Judged
  Data with an optional validation status.
• Link
• LinkDetails
  CreateLinks with and DeleteLinks on them [CreateLink, [DeleteLink]]
• LinkQuery
  A query for links to be used with host functions that support filtering links
• LinkTag
  Opaque tag for the link applied at the app layer, used to differentiate between different semantics and validation rules for different links
• LinkType
• MetadataRequest
  Metadata that can be requested on a basis
• 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.
• Nonce256Bits
  256 Bit generic nonce.
• 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.
• QueryFilter
  Specifies arguments to a query of the source chain, including ordering and filtering.
• 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.
• RecordDetails
  A specific Record with any updates and deletes. This is all the metadata available for a record.
• 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.
• RemoteSignal
  Remote signal many agents without waiting for responses.
• 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.
• ScheduledFn
  A fully qualified scheduled function.
• 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.
• SerializedBytes
  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.
• Sign
  Input structure for creating a signature.
• SignEphemeral
  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.
• Signature
  The raw bytes of a signature.
• SignedAction
  A combination of an action and its 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
• UnsafeBytes
  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.
• 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.
• UpdateInput
  Zome input type for all update operations.
• VerifySignature
  Mirror struct for Sign that includes a signature to verify against a key and data.
• Warrant
  Placeholder for warrant type
• WasmError
  Wraps a WasmErrorInner with a file and line number. The easiest way to generate this is with the wasm_error! macro that will insert the correct file/line and can create strings by forwarding args to the format! macro.
• WasmZome
  A zome defined by Wasm bytecode
• WrongActionError
• X25519PubKey
• X25519XSalsa20Poly1305Decrypt
• X25519XSalsa20Poly1305Encrypt
• XSalsa20Poly1305Data
  Data that can be encrypted with secretbox.
• XSalsa20Poly1305Decrypt
• XSalsa20Poly1305Encrypt
• 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.
• XSalsa20Poly1305SharedSecretExport
• XSalsa20Poly1305SharedSecretIngest
• Zome
  A Holochain Zome. Includes the ZomeDef as well as the name of the Zome.
• 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.
• ZomeCallUnsigned
  Zome calls need to be signed regardless of how they are called. This defines exactly what needs to be signed.
• 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

• Action
  Action contains variants for each type of action.
• ActionBase
  Enum to mirror Action for all the shared data required to build session actions. Does NOT hold any agent specific information.
• ActionError
• ActionType
  A unit enum which just maps onto the different Action variants, without containing any extra data
• ActivityRequest
  Get either the full activity or just the status of the chain
• BlockTarget
  Target of a block. Each target type has an ID and associated reason.
• BlockTargetId
• BlockTargetReason
• CallTarget
• CallTargetCell
• CapAccess
  Represents access requirements for capability grants.
• CapGrant
  Represents a potentially valid access grant to a zome call. Zome call response will be Unauthorized without a valid grant.
• CellBlockReason
  Reason why we might want to block a cell.
• ChainFilters
  Specify which Actions to allow through this filter.
• ChainQueryFilterRange
  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.
• ChainStatus
  Status of the agent activity chain
• ChainTopOrdering
• CloneCellId
  Ways of specifying a clone cell.
• CloneIdError
  Errors during conversion from RoleName to CloneId.
• CounterSigningError
  Errors related to the secure primitive macro.
• Details
  Return type for get_details calls. ActionHash returns a Record. EntryHash returns an Entry.
• Entry
  Structure holding the entry portion of a chain record.
• EntryCreationAction
  Either a Action::Create or a Action::Update. These actions both create a new instance of an Entry.
• EntryDefId
• EntryDefLocation
  Either an EntryDefIndex or one of:
• EntryDefsCallbackResult
• EntryDhtStatus
  The status of an Entry in the Dht
• EntryError
  Errors involving app entry creation
• EntryType
  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.
• EntryVisibility
• GetStrategy
  Describes the get call and what information the caller is concerned about. This helps the subconscious avoid unnecessary network calls.
• GrantedFunctions
  A collection of zome/function pairs
• HashInput
  Input to holochain hash function.
• HashOutput
  Output from the holochain hashing host function.
• HostFnApiError
  Anything that can go wrong while calling a HostFnApi method
• HumanTimestamp
  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.
• InitCallbackResult
  The result of the DNA initialization callback.
• IpBlockReason
  Reason why we might want to block an IP.
• Level
  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
• LinkTypeFilter
  Filter on a set of LinkTypes.
• MigrateAgent
• MigrateAgentCallbackResult
• NodeBlockReason
  Reason why we might want to block a node.
• Op
  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.
• PreflightRequestAcceptance
  A preflight request can be accepted, or invalid, or valid but the local agent cannot accept it.
• RecordEntry
  Represents the different ways the entry_address reference within an action can be interpreted
• RequiredValidationType
  The level of validation package required by an entry.
• Schedule
  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.
• ScheduleError
  Scheduling errors.
• SecurePrimitiveError
  Errors related to the secure primitive macro.
• SerializedBytesError
• TimestampError
• UnitEnumEither
  A full UnitEnum, or just the unit type of that UnitEnum
• UnresolvedDependencies
  Unresolved dependencies that are either a set of hashes or an agent activity query.
• ValidateCallbackResult
• ValidationStatus
  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
• WasmErrorInner
  Enum of all possible ERROR states that wasm can encounter.
• WeighInput
  Input to the weigh callback. Includes an “unweighed” action, and Entry if applicable.
• ZomeCallAuthorization
• ZomeCallResponse
  Response to a zome call.
• ZomeDef
  Just the definition of a Zome, without the name included. This exists mainly for use in HashMaps where ZomeDefs are keyed by ZomeName.
• ZomeError
  Anything that can go wrong while calling a HostFnApi method

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.
• CLONE_ID_DELIMITER
  Delimiter in a clone id that separates the base cell’s role name from the clone index.
• 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
• PERSISTED_TIMEOUT
  Expire persisted schedules after this long.
• 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.
• SCHEDULER_INTERVAL
  Tick the scheduler every this many millis.
• 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

• ActionBuilder
  Builder for non-genesis Actions
• ActionExt
• 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.
• CallbackResult
• Deserialize
  A data structure that can be deserialized from any data format supported by Serde.
• 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.
• HasHash
  Anything which has an owned HoloHashOf.
• HasValidationStatus
  Data that requires a validation status.
• HostFnApiT
• LinkTypeFilterExt
  An extension to obtain a link type filter.
• LinkTypesHelper
  A helper trait for finding the app defined link type from a ZomeIndex and LinkType.
• OpHelper
  This trait provides a conversion to a convenience type FlatOp for use in the validation call back.
• Serialize
  A data structure that can be serialized into any data format supported by Serde.
• TryFrom
  Simple and safe type conversions that may fail in a controlled way under some circumstances. It is the reciprocal of TryInto.
• TryFromDnaProperties
  Trait to convert from dna properties into specified type
• TryInto
  An attempted conversion that consumes self, which may or may not be expensive.
• 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

• __hc__accept_countersigning_preflight_request_1^⚠
• __hc__agent_info_1^⚠
• __hc__block_agent_1^⚠
• __hc__call_1^⚠
• __hc__call_info_1^⚠
• __hc__call_remote_1^⚠
• __hc__capability_claims_1^⚠
• __hc__capability_grants_1^⚠
• __hc__capability_info_1^⚠
• __hc__count_links_1^⚠
• __hc__create_1^⚠
• __hc__create_clone_cell_1^⚠
• __hc__create_link_1^⚠
• __hc__create_x25519_keypair_1^⚠
• __hc__delete_1^⚠
• __hc__delete_clone_cell_1^⚠
• __hc__delete_link_1^⚠
• __hc__disable_clone_cell_1^⚠
• __hc__dna_info_1^⚠
• __hc__emit_signal_1^⚠
• __hc__enable_clone_cell_1^⚠
• __hc__get_1^⚠
• __hc__get_agent_activity_1^⚠
• __hc__get_details_1^⚠
• __hc__get_link_details_1^⚠
• __hc__get_links_1^⚠
• __hc__hash_1^⚠
• __hc__must_get_action_1^⚠
• __hc__must_get_entry_1^⚠
• __hc__must_get_valid_record_1^⚠
• __hc__query_1^⚠
• __hc__random_bytes_1^⚠
• __hc__remote_signal_1^⚠
• __hc__schedule_1^⚠
• __hc__sign_1^⚠
• __hc__sign_ephemeral_1^⚠
• __hc__sleep_1^⚠
• __hc__sys_time_1^⚠
• __hc__trace_1^⚠
• __hc__unblock_agent_1^⚠
• __hc__unreachable_1^⚠
• __hc__update_1^⚠
• __hc__verify_signature_1^⚠
• __hc__x_25519_x_salsa20_poly1305_decrypt_1^⚠
• __hc__x_25519_x_salsa20_poly1305_encrypt_1^⚠
• __hc__x_salsa20_poly1305_decrypt_1^⚠
• __hc__x_salsa20_poly1305_encrypt_1^⚠
• __hc__x_salsa20_poly1305_shared_secret_create_random_1^⚠
• __hc__x_salsa20_poly1305_shared_secret_export_1^⚠
• __hc__x_salsa20_poly1305_shared_secret_ingest_1^⚠
• __hc__zome_info_1^⚠
• decode
• dna_info
  Get the DNA information. There are no inputs to dna_info .
• encode
• entry_type_matches
  Check the entry variant matches the variant in the actions entry type
• host_args
  Receive arguments from the host. The guest sets the type O that the host needs to match. If deserialization fails then a GuestPtr to a WasmError::Deserialize is returned. The guest should immediately return an Err back to the host. The WasmError::Deserialize enum contains the bytes that failed to deserialize so the host can unambiguously provide debug information.
• host_call
  Given an extern that we expect the host to provide:
• merge_u32
• merge_u64
• merge_usize
  Given 2x u32, return a DoubleUSize merged. Works via a simple bitwise shift to move the pointer to high bits then OR the length into the low bits.
• must_get_action
  MUST get a SignedActionHashed at a given ActionHash.
• must_get_agent_activity
  The chain this filter produces on the given agents chain must be fetched before the validation can be completed. This allows for deterministic validation of chain activity by making a hash bounded range of an agents chain into a dependency for something that is being validated.
• must_get_entry
  MUST get an EntryHashed at a given EntryHash.
• must_get_valid_record
  MUST get a VALID Record at a given ActionHash.
• return_err_ptr
  Convert a WasmError to a GuestPtrLen as best we can. This is not necessarily straightforward as the serialization process can error recursively. In the worst case we can’t even serialize an enum variant, in which case we panic. The casts from usize to u32 are safe as long as the guest code is compiled for wasm32-unknown-unknown target.
• return_ptr
  Convert any serializable value into a GuestPtr that can be returned to the host. The host is expected to know how to consume and deserialize it.
• split_u64
• split_u128
• split_usize
  Given 2x merged usize, split out two usize. Performs the inverse of merge_usize.
• verify_signature
  Verify the passed signature and public key against the passed serializable input.
• verify_signature_raw
  Verify the passed signature and public key against the literal bytes input.
• x_25519_x_salsa20_poly1305_decrypt
  Libsodium keypair based authenticated encryption: box_open
• x_salsa20_poly1305_decrypt
  Libsodium secret-key authenticated encryption: secretbox_open
• zome_info
  Get the zome information. There are no inputs to zome_info .

Type Aliases

• ActionHash
  The hash of an action
• ActionHashed
• AgentPubKey
  An Agent public signing key. Not really a hash, more of an “identity hash”.
• AnyDhtHash
  The hash of anything referrable in the DHT. This is a composite of either an EntryHash or a ActionHash
• AnyLinkableHash
  The hash of anything linkable.
• BoxData
• Bytes
  simply alias whatever serde bytes is already doing for Vec<u8>
• CapClaimEntry
  The data type written to the source chain to denote a capability claim
• CapGrantEntry
  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
• CapSecretBytes
  A fixed size array of bytes that a secret must be.
• CoordinatorZome
• CoordinatorZomes
  Ordered list of coordinator zomes in this DNA.
• CounterSigningAgents
  Alias for a list of agents and their roles.
• DeleteCloneCellInput
  Arguments to delete a disabled clone cell of an app.
• DnaInfo
  Convenience alias to the latest DnaInfoN.
• DoubleUSize
• EnableCloneCellInput
  Arguments to specify the clone cell to be enabled.
• EntryHash
  The hash of an Entry.
• EntryHashed
  An Entry paired with its EntryHash
• ExternResult
  Every extern must return a WasmError in the case of failure.
• ExternalHash
  The hash of some external data that can’t or doesn’t exist on the DHT.
• GenesisSelfCheckData
  Alias to the current version of GenesisSelfCheckData.
• GrantedFunction
  a single zome/function pair
• GuestPtr
  A WasmSize that points to a position in wasm linear memory that the host and guest are sharing to communicate across function calls.
• GuestPtrLen
  Enough bits to fit a pointer and length into so we can return it. The externs defined as “C” don’t support multiple return values (unlike wasm). The native Rust support for wasm externs is not stable at the time of writing.
• IntegrityZome
• IntegrityZomes
  Ordered list of integrity zomes in this DNA.
• Len
  A WasmSize integer that represents the size of bytes to read/write to memory.
• MembraneProof
  App-specific payload for proving membership in the membrane of the app
• NetworkSeed
  Placeholder for a real network seed type. See [DnaDef].
• RateBucketCapacity
  The amount that a bucket is “filled”
• RateBucketId
  A bucket ID, for rate limiting
• RateBytes
  The normalized total size of this action, for rate limiting
• RateUnits
  The weight of this action, for rate limiting
• RecordEntryRef
  Alias for record with ref entry
• RoleName
  Identifier for an App Role, a foundational concept in the App manifest.
• ScopedEntryDefIndex
  An EntryDefIndex within the scope of the zome where it’s defined.
• ScopedLinkType
  A LinkType within the scope of the zome where it’s defined.
• SecretBoxData
• SignedActionHashed
  The hashed action and the signature that signed it
• TimestampResult
• WasmSize
  Something like usize for wasm. Wasm has a memory limit of 4GB so offsets and lengths fit in u32.
• ZomeEntryTypesKey
  A key to the ScopedZomeTypes<EntryDefIndex> container.
• ZomeLinkTypesKey
  A key to the ScopedZomeTypes<LinkType> container.
• ZomeResult

Attribute Macros

• dna_properties
• hdk_dependent_entry_types
• hdk_dependent_link_types
• hdk_entry_defs
  Declares the integrity zome’s entry types.
• hdk_entry_defs_conversions
• hdk_entry_helper
  Helper for entry data types.
• hdk_extern
• hdk_link_types
  Implements all the required types needed for a LinkTypes enum.
• hdk_to_coordinates
• instrument
  Instruments a function to create and enter a tracing span every time the function is called.

Derive Macros

• Deserialize
• EntryDefRegistration
• Serialize
• SerializedBytes
• UnitEnum