Crate holochain_conductor_api

Interfaces to manage Holochain applications (hApps) and call their functions.

The Conductor is the central component of Holochain. It exposes WebSockets for clients to connect to, processes incoming requests and orchestrates data flow and persistence.

Refer to Holochain’s architecture for more info. Read about hApp development in the Happ Development Kit (HDK) documentation.

There is a Holochain client for JavaScript and a Rust client to connect to the Conductor.

The Conductor API is split into Admin and App requests and responses. Each has an associated enum AdminRequest and AppRequest that define and document available calls.

The admin interface generally manages the conductor itself, such as installing apps, listing dnas, cells and apps, accessing state and metric information dumps and managing agents.

The app interface is smaller and focussed on interfacing with an app directly. Notably the app interface allows calling functions exposed by the hApps’ modules, called DNAs. To discover a particular hApp’s structure, its app info can be requested.

Re-exports

• pub use config::*;
• pub use state_dump::*;
• pub use storage_info::*;

Modules

• config
• signal_subscription
• state_dump
• storage_info

Structs

• AppAuthenticationRequest
  The request payload that should be sent in a WireMessage::Authenticate message.
• AppAuthenticationTokenIssued
  Response payload for AdminResponse::AppAuthenticationTokenIssued.
• AppInfo
  Info about an installed app, returned as part of AppResponse::AppInfo
• AppInterfaceInfo
  Informational response for listing app interfaces.
• IssueAppAuthenticationTokenPayload
  Request payload for AdminRequest::IssueAppAuthenticationToken.
• NetworkInfo
• ProvisionedCell
  Provisioned cell, a cell instantiated from a DNA on app installation.
• StemCell
  Cell whose instantiation has been deferred. Not yet implemented.
• ZomeCall
  The data provided over an app interface in order to make a zome call

Enums

• AdminRequest
  Represents the available conductor functions to call over an admin interface.
• AdminResponse
  Represents the possible responses to an AdminRequest and follows a general convention of noun_verb as opposed to the verb_noun of AdminRequest.
• AppInfoStatus
  A flat, slightly more API-friendly representation of AppInfo
• AppRequest
  Represents the available conductor functions to call over an app interface and will result in a corresponding AppResponse message being sent back over the interface connection.
• AppResponse
  Represents the possible responses to an AppRequest.
• AppStatusFilter
  Filter for AdminRequest::ListApps.
• CellInfo
• ExternalApiWireError
  Error type that goes over the websocket wire. This intends to be application developer facing so it should be readable and relevant
• ScottyPanel

Type Aliases

• AppAuthenticationToken
  A token issued by the conductor that can be used to authenticate a connection to an app interface.