Enum AppRequest 

pub enum AppRequest {
    AppInfo,
    AgentInfo {
        dna_hashes: Option<Vec<HoloHash<Dna>>>,
    },
    PeerMetaInfo {
        url: Url,
        dna_hashes: Option<Vec<HoloHash<Dna>>>,
    },
    CallZome(Box<ZomeCallParamsSigned>),
    CreateCloneCell(Box<CreateCloneCellPayload>),
    DisableCloneCell(Box<DisableCloneCellPayload>),
    EnableCloneCell(Box<DisableCloneCellPayload>),
    DumpOpTimings {
        dna_hash: HoloHash<Dna>,
        cursor: Option<OpTimingsCursor>,
        limit: Option<u32>,
    },
    DumpNetworkMetrics {
        dna_hash: Option<HoloHash<Dna>>,
        include_dht_summary: bool,
    },
    DumpNetworkStats,
    ListWasmHostFunctions,
    ProvideMemproofs(HashMap<String, Arc<SerializedBytes>>),
    EnableApp,
    SendDirectSignal {
        dna_hash: HoloHash<Dna>,
        agents: Vec<HoloHash<Agent>>,
        signal: Vec<u8>,
    },
}

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.

Errors

Returns an AppResponse::Error with a reason why the request failed.

Variants

AppInfo

Get info about the app that you are connected to, including info about each cell installed by this app.

Returns

AppResponse::AppInfo

AgentInfo

Request information about the agents in this Conductor’s peer store.

This is limited to cells of the app you are connected to.

Returns

AppResponse::AgentInfo

Fields

dna_hashes: Option<Vec<HoloHash<Dna>>>

Optionally limit the results to specific DNA hashes

PeerMetaInfo

Request the contents of the peer meta store(s) related to the given dna hashes for the agent at the given Url.

If dna_hashes is set to None it returns the contents for all dnas of the app.

Returns

AppResponse::PeerMetaInfo

Fields

url: Url

dna_hashes: Option<Vec<HoloHash<Dna>>>

CallZome(Box<ZomeCallParamsSigned>)

Call a zome function.

The payload to this call is composed of the serialized ZomeCallParams as bytes and the provenance’s signature.

Serialization must be performed with MessagePack. The resulting bytes are hashed using the SHA2 512-bit algorithm, and the hash is signed with the provenance’s private ed25519 key. The hash is not included in the call’s payload.

Returns

AppResponse::ZomeCalled Indicates the zome call was deserialized successfully. If the call was authorized, the response yields the return value of the zome function as MessagePack encoded bytes. The bytes can be deserialized to the expected return type.

This response is also returned when authorization of the zome call failed because of an invalid signature, capability grant or nonce.

Errors

SerializedBytesError is returned when the serialized bytes could not be deserialized to the expected ZomeCallParams.

CreateCloneCell(Box<CreateCloneCellPayload>)

Clone a DNA (in the biological sense), thus creating a new Cell.

Using the provided, already-registered DNA, create a new DNA with a unique ID and the specified properties, create a new cell from this cloned DNA, and add the cell to the specified app.

Returns

AppResponse::CloneCellCreated

DisableCloneCell(Box<DisableCloneCellPayload>)

Disable a clone cell.

Providing a CloneId or CellId, disable an existing clone cell. When the clone cell exists, it is disabled and can not be called any longer. If it doesn’t exist, the call is a no-op.

Returns

AppResponse::CloneCellDisabled if the clone cell existed and has been disabled.

EnableCloneCell(Box<DisableCloneCellPayload>)

Enable a clone cell that was previously disabled.

Returns

AppResponse::CloneCellEnabled

DumpOpTimings

Dump the lifecycle timings of the DHT ops held by this conductor for the DNA of one of this app’s cells.

Identical to AdminRequest::DumpOpTimings except that dna_hash must be the DNA of a cell of the app this connection is authenticated for. As there, the DHT database is shared by every cell running the same DNA, so the dump covers the whole DHT arc this conductor is currently holding for that DNA, not the ops of any one agent running the DNA.

Returns

AppResponse::OpTimingsDumped

Fields

dna_hash: HoloHash<Dna>

The DNA whose DHT arc to dump op timings for. This app must run a cell of this DNA.

cursor: Option<OpTimingsCursor>

Pagination cursor from a previous DumpOpTimings; only ops ordered strictly after it are returned. None starts from the beginning.

limit: Option<u32>

Maximum number of ops to return. Must be greater than zero.

DumpNetworkMetrics

Retrieve network metrics for the current app.

Identical to what AdminRequest::DumpNetworkMetrics does, but scoped to the current app.

If dna_hash is not set, metrics for all DNAs in the current app are returned.

Returns

AppResponse::NetworkMetricsDumped

Fields

dna_hash: Option<HoloHash<Dna>>

If set, limits the metrics dumped to a single DNA hash space.

include_dht_summary: bool

Whether to include a DHT summary.

You need a dump from multiple nodes in order to make a comparison, so this is not requested by default.

DumpNetworkStats

Dump network statistics from the Kitsune2 networking transport module.

Identical to what AdminRequest::DumpNetworkStats does, but scoped to the current app. Connections that are not relevant to a DNA in the current app are filtered out.

Returns

AppResponse::NetworkStatsDumped

ListWasmHostFunctions

List all host functions available to wasm on this conductor.

Returns

AppResponse::ListWasmHostFunctions

ProvideMemproofs(HashMap<String, Arc<SerializedBytes>>)

Provide the membrane proofs for this app, if this app was installed using allow_deferred_memproofs and memproofs were not provided at installation time.

Returns

AppResponse::Ok

EnableApp

Enable the app, only in special circumstances. Can only be called while the app is in the Disabled(NotStartedAfterProvidingMemproofs) state. Cannot be used to enable the app if it’s in any other state, or Disabled for any other reason.

Returns

AppResponse::Ok

SendDirectSignal

Send a remote signal directly to one or more peers.

Using this app request is equivalent to calling a zome function that forwards to the HDK function send_remote_signal. On the receiving end, the conductor does not call the corresponding zome’s recv_remote_signal function, which would then have to invoke the HDK function emit_signal. The result is that signals can be exchanged between peers without having to run a WASM function on each side.

Note that this bypasses the usual security mechanism where zomes must create a capability grant to permit recv_remote_signal to be invoked without restriction.

Fields

dna_hash: HoloHash<Dna>

The app network to send messages on.

agents: Vec<HoloHash<Agent>>

The agents to send the signal payload to.

An empty payload is treated as an error.

signal: Vec<u8>

The signal payload.

Treated as opaque by Holochain, it is up to the application to decide how to serialize, deserialize and process payloads.

Trait Implementations

impl Clone for AppRequest

fn clone(&self) -> AppRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AppRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AppRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<AppRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AppRequest

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&AppRequest> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &AppRequest) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<AppRequest> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: AppRequest) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for AppRequest

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<AppRequest, SerializedBytesError>

Performs the conversion.