@holochain/client/lib/api/admin/types.d.ts

A JavaScript client for the Holochain Conductor API

import { Action, DhtOp, Entry, ZomeCallCapGrant } from "../../hdk/index.js";
import { ActionHash, AgentPubKey, CellId, DnaHash, DnaHashB64, DnaProperties, HoloHash, HoloHashB64, InstalledAppId, KitsuneAgent, KitsuneSpace, RoleName, Signature, Timestamp, WasmHash } from "../../types.js";
import { CloneCellId } from "../app/types.js";
import { Requester } from "../common.js";
/**
 * @public
 */
export type AttachAppInterfaceRequest = {
    port?: number;
    /**
     * Comma separated list of origins, or `*` to allow any origin.
     * For example: `http://localhost:3000,http://localhost:3001`
     */
    allowed_origins: string;
    /**
     * Optionally, bind this app interface to a specific installed app.
     */
    installed_app_id?: InstalledAppId;
};
/**
 * @public
 */
export type AttachAppInterfaceResponse = {
    port: number;
};
/**
 * @public
 */
export type EnableAppRequest = {
    installed_app_id: InstalledAppId;
};
/**
 * @public
 */
export type EnableAppResponse = AppInfo;
/**
 * @public
 */
export type PausedAppReason = {
    type: "error";
    value: string;
};
/**
 * @public
 */
export type DisabledAppReason = {
    type: "never_started";
} | {
    type: "user";
} | {
    type: "not_started_after_providing_memproofs";
} | {
    type: "error";
    value: string;
};
/**
 * @public
 */
export type AppStatus = {
    type: "disabled";
    value: DisabledAppReason;
} | {
    type: "enabled";
} | {
    type: "awaiting_memproofs";
};
/**
 * @public
 */
export interface StemCell {
    dna: DnaHash;
    name?: string;
    dna_modifiers: DnaModifiers;
}
/**
 * @public
 */
export interface ProvisionedCell {
    cell_id: CellId;
    dna_modifiers: DnaModifiers;
    name: string;
}
/**
 * @public
 */
export interface ClonedCell {
    cell_id: CellId;
    clone_id: RoleName;
    original_dna_hash: DnaHash;
    dna_modifiers: DnaModifiers;
    name: string;
    enabled: boolean;
}
/**
 * @public
 */
export declare enum CellType {
    Provisioned = "provisioned",
    Cloned = "cloned",
    Stem = "stem"
}
/**
 * @public
 */
export type CellInfo = {
    type: CellType.Provisioned;
    value: ProvisionedCell;
} | {
    type: CellType.Cloned;
    value: ClonedCell;
} | {
    type: CellType.Stem;
    value: StemCell;
};
/**
 * @public
 */
export type AppInfo = {
    agent_pub_key: AgentPubKey;
    installed_app_id: InstalledAppId;
    cell_info: Record<RoleName, Array<CellInfo>>;
    status: AppStatus;
    installed_at: Timestamp;
};
/**
 * @public
 */
export type MembraneProof = Uint8Array;
/**
 * @public
 */
export type MemproofMap = {
    [key: RoleName]: MembraneProof;
};
/**
 * @public
 */
export type RoleSettingsMap = {
    [key: RoleName]: RoleSettings;
};
/**
 * @public
 */
export type RoleSettings = {
    type: "use_existing";
    value: {
        cell_id: CellId;
    };
} | {
    type: "provisioned";
    value: {
        membrane_proof?: MembraneProof;
        modifiers?: DnaModifiersOpt;
    };
};
/**
 *  @public
 * Any value that is serializable to a Yaml value
 */
export type YamlProperties = unknown;
/**
 * @public
 */
export type DnaModifiersOpt = {
    network_seed?: NetworkSeed;
    properties?: YamlProperties;
};
/**
 * @public
 */
export type DisableAppRequest = {
    installed_app_id: InstalledAppId;
};
/**
 * @public
 */
export type DisableAppResponse = null;
/**
 * @public
 */
export type StartAppRequest = {
    installed_app_id: InstalledAppId;
};
/**
 * @public
 */
export type StartAppResponse = boolean;
/**
 * @public
 */
export type DumpStateRequest = {
    cell_id: CellId;
};
/**
 * @public
 */
export type DumpStateResponse = any;
/**
 * @public
 */
export type DumpFullStateRequest = {
    cell_id: CellId;
    dht_ops_cursor?: number;
};
/**
 * @public
 */
export type DumpFullStateResponse = FullStateDump;
/**
 * @public
 */
export type GenerateAgentPubKeyRequest = void;
/**
 * @public
 */
export type GenerateAgentPubKeyResponse = AgentPubKey;
/**
 * @public
 */
export type RevokeAgentKeyRequest = {
    agent_key: AgentPubKey;
    app_id: InstalledAppId;
};
/**
 * Contains a list of errors of the cells where deletion was unsuccessful.
 *
 * If the key could not be deleted from all cells, the call
 * {@link RevokeAgentKeyRequest} can be re-attempted to delete the key from the remaining cells.
 *
 * @public
 */
export type RevokeAgentKeyResponse = [CellId, string][];
/**
 * @public
 */
export type DnaModifiers = {
    network_seed: NetworkSeed;
    properties: Uint8Array;
};
/**
 * @public
 */
export type FunctionName = string;
/**
 * @public
 */
export type ZomeName = string;
/**
 * @public
 */
export type ZomeDefinition = [
    ZomeName,
    {
        wasm_hash: WasmHash;
        dependencies: ZomeName[];
    }
];
/**
 * @public
 */
export type IntegrityZome = ZomeDefinition;
/**
 * @public
 */
export type CoordinatorZome = ZomeDefinition;
/**
 * @public
 */
export type DnaDef = {
    name: string;
    modifiers: DnaModifiers;
    lineage: DnaHashB64[];
    integrity_zomes: IntegrityZome[];
    coordinator_zomes: CoordinatorZome[];
};
/**
 * @public
 *
 * @deprecated Renamed to DnaDef. This alias will be removed in 0.22.0
 */
export type DnaDefinition = DnaDef;
/**
 * @public
 */
export type GetDnaDefinitionRequest = CellId;
/**
 * @public
 */
export type GetDnaDefinitionResponse = DnaDef;
/**
 * @public
 */
export type UninstallAppRequest = {
    installed_app_id: InstalledAppId;
};
/**
 * @public
 */
export type UninstallAppResponse = null;
/**
 * @public
 */
export type UpdateCoordinatorsRequest = {
    source: CoordinatorSource;
    cell_id: CellId;
};
/**
 * @public
 */
export type UpdateCoordinatorsResponse = void;
/**
 * @public
 */
export type ResourceBytes = Uint8Array;
/**
 * @public
 */
export type ResourceMap = {
    [key: string]: ResourceBytes;
};
/**
 * @public
 */
export declare enum CellProvisioningStrategy {
    /**
     * Always create a new Cell when installing this App
     */
    Create = "create",
    /**
     * Always create a new Cell when installing the App,
     * and use a unique network seed to ensure a distinct DHT network.
     *
     * Not implemented
     */
    /**
     * Require that a Cell is already installed which matches the DNA version
     * spec, and which has an Agent that's associated with this App's agent
     * via DPKI. If no such Cell exists, *app installation fails*.
     */
    UseExisting = "use_existing",
    /**
     * Try `UseExisting`, and if that fails, fallback to `Create`
     */
    CreateIfNoExists = "create_if_no_exists"
}
/**
 * @public
 */
export interface CellProvisioning {
    strategy: CellProvisioningStrategy;
    deferred?: boolean;
}
/**
 * @public
 */
export type DnaVersionSpec = Array<HoloHashB64>;
/**
 * @public
 */
export type DnaVersionFlexible = {
    singleton: HoloHashB64;
} | {
    multiple: DnaVersionSpec;
};
/**
 * @public
 */
export type AppRoleDnaManifest = {
    path?: string;
    modifiers?: Partial<DnaModifiers>;
    installed_hash?: DnaHash;
    clone_limit?: number;
};
/**
 * @public
 */
export type AppRoleManifest = {
    name: RoleName;
    provisioning?: CellProvisioning;
    dna: AppRoleDnaManifest;
};
/**
 * @public
 */
export type AppManifest = {
    manifest_version: "0";
    name: string;
    description?: string;
    roles: Array<AppRoleManifest>;
    membrane_proofs_deferred: boolean;
};
/**
 * @public
 */
export type AppBundle = {
    manifest: AppManifest;
    resources: ResourceMap;
};
/**
 * @public
 */
export type AppBundleSource = {
    type: "path";
    value: string;
} | {
    type: "bytes";
    value: Uint8Array;
};
/**
 * @public
 */
export type NetworkSeed = string;
/**
 * @public
 */
export type InstallAppRequest = {
    /**
     * Where to obtain the AppBundle, which contains the app manifest and DNA bundles
     * to be installed. This is the main payload of app installation.
     */
    source: AppBundleSource;
    /**
     * The agent to use when creating Cells for this App.
     * If not specified, a new agent will be generated by Holochain.
     * If DPKI is enabled (default), and the agent key is not specified here,
     * a new agent key will be derived from the DPKI device seed and registered with DPKI.
     */
    agent_key?: AgentPubKey;
    /**
     * The unique identifier for an installed app in this conductor.
     * If not specified, it will be derived from the app name in the bundle manifest.
     */
    installed_app_id?: InstalledAppId;
    /**
     * Optional global network seed override.  If set will override the network seed value for all
     * DNAs in the bundle.
     */
    network_seed?: NetworkSeed;
    /**
     * Specify role specific settings or modifiers that will override any settings in the dna manifest.
     */
    roles_settings?: RoleSettingsMap;
    /**
     * Optional: If app installation fails due to genesis failure, normally the app will be immediately uninstalled.
     * When this flag is set, the app is left installed with empty cells intact. This can be useful for
     * using graft_records_onto_source_chain, or for diagnostics.
     */
    ignore_genesis_failure?: boolean;
};
/**
 * @public
 */
export type InstallAppResponse = AppInfo;
/**
 * @public
 */
export type ListDnasRequest = void;
/**
 * @public
 */
export type ListDnasResponse = Array<string>;
/**
 * @public
 */
export type ListCellIdsRequest = void;
/**
 * @public
 */
export type ListCellIdsResponse = Array<CellId>;
/**
 * @public
 */
export type ListActiveAppsRequest = void;
/**
 * @public
 */
export type ListActiveAppsResponse = Array<InstalledAppId>;
/**
 * @public
 */
export declare enum AppStatusFilter {
    Enabled = "enabled",
    Disabled = "disabled"
}
/**
 * @public
 */
export type ListAppsRequest = {
    status_filter?: AppStatusFilter;
};
/**
 * @public
 */
export type ListAppsResponse = Array<AppInfo>;
/**
 * @public
 */
export type ListAppInterfacesRequest = void;
/**
 * @public
 */
export type ListAppInterfacesResponse = Array<AppInterfaceInfo>;
/**
 * @public
 */
export interface AppInterfaceInfo {
    port: number;
    allowed_origins: string;
    installed_app_id?: InstalledAppId;
}
/**
 * This type is meant to be opaque
 *
 * @public
 */
export type AgentInfoSigned = unknown;
/**
 * @public
 */
export type AgentInfoRequest = {
    dna_hashes: DnaHash[] | null;
};
/**
 * @public
 */
export type AgentInfoResponse = Array<string>;
/**
 * @public
 */
export type AddAgentInfoRequest = {
    agent_infos: Array<string>;
};
/**
 * @public
 */
export type AddAgentInfoResponse = unknown;
/**
 * @public
 */
export interface PeerMetaInfoRequest {
    url: string;
    dna_hashes?: DnaHash[];
}
/**
 * @public
 */
export type PeerMetaInfoResponse = Record<DnaHashB64, Record<string, PeerMetaInfo>>;
/**
 * @public
 */
export interface PeerMetaInfo {
    meta_value: string;
    expires_at: Timestamp | null;
}
/**
 * @public
 */
export interface DeleteCloneCellRequest {
    /**
     * The app id that the clone cell belongs to
     */
    app_id: InstalledAppId;
    /**
     * The clone id or cell id of the clone cell
     */
    clone_cell_id: CloneCellId;
}
/**
 * @public
 */
export type DeleteCloneCellResponse = void;
/**
 * @public
 */
export interface GrantZomeCallCapabilityRequest {
    /**
     * Cell for which to authorize the capability.
     */
    cell_id: CellId;
    /**
     * Specifies the capability, consisting of zomes and functions to allow
     * signing for as well as access level, secret and assignees.
     */
    cap_grant: ZomeCallCapGrant;
}
/**
 * @public
 */
export type GrantZomeCallCapabilityResponse = ActionHash;
/**
 * @public
 */
export interface RevokeZomeCallCapabilityRequest {
    /**
     * The action hash of the capability to revoke.
     */
    action_hash: ActionHash;
    /**
     * Cell ID of the cell for which to revoke the capability.
     */
    cell_id: CellId;
}
/**
 * @public
 */
export type RevokeZomeCallCapabilityResponse = void;
/**
 * @public
 */
export interface ListCapabilityGrantsRequest {
    /**
     * The app id for which to list the capability grants.
     */
    installed_app_id: InstalledAppId;
    /**
     * Whether to include also revoked grants in the response.
     */
    include_revoked: boolean;
}
/**
 * @public
 */
export type ListCapabilityGrantsResponse = Array<[CellId, CapGrantInfo[]]>;
/**
 * @public
 */
export interface CapGrantInfo {
    /**
     * The cap grant data.
     */
    cap_grant: ZomeCallCapGrant;
    /**
     * The action hash of the cap grant.
     */
    action_hash: ActionHash;
    /**
     * The timestamp when the cap grant was created.
     */
    created_at: Timestamp;
    /**
     * The timestamp when the cap grant was revoked, if it was revoked.
     */
    revoked_at?: Timestamp;
}
/**
 * @public
 */
export type InstallAppDnaPayload = {
    hash: HoloHash;
    role_name: RoleName;
    membrane_proof?: MembraneProof;
};
/**
 * @public
 */
export interface ZomeDependency {
    name: ZomeName;
}
/**
 * @public
 */
export type ZomeManifest = {
    name: string;
    path: string;
    hash?: string;
    dependencies?: ZomeDependency[];
};
/**
 * @public
 */
export interface CoordinatorManifest {
    zomes: Array<ZomeManifest>;
}
/**
 * @public
 */
export interface CoordinatorBundle {
    manifest: CoordinatorManifest;
    resources: ResourceMap;
}
/**
 * @public
 */
export type CoordinatorSource = {
    type: "path";
    value: string;
} | {
    type: "bundle";
    value: CoordinatorBundle;
};
/**
 * @public
 */
export type DnaManifest = {
    /**
     * No finalized version yet, hence only "0" is supported.
     */
    manifest_version: "0";
    /**
     * The friendly "name" of a Holochain DNA.
     */
    name: string;
    /**
     * A network seed for uniquifying this DNA.
     */
    network_seed?: NetworkSeed;
    /**
     * Any arbitrary application properties can be included in this object.
     */
    properties?: DnaProperties;
    /**
     * An array of zomes associated with your DNA.
     * The order is significant: it determines initialization order.
     */
    zomes: Array<ZomeManifest>;
    /**
     *  A list of past "ancestors" of this DNA.
     *
     * Whenever a DNA is created which is intended to be used as a migration from
     * a previous DNA, the lineage should be updated to include the hash of the
     * DNA being migrated from. DNA hashes may also be removed from this list if
     * it is desired to remove them from the lineage.
     *
     * The meaning of the "ancestor" relationship is as follows:
     * - For any DNA, there is a migration path from any of its ancestors to itself.
     * - When an app depends on a DnaHash via UseExisting, it means that any installed
     *     DNA in the lineage which contains that DnaHash can be used.
     * - The app's Coordinator interface is expected to be compatible across the lineage.
     *     (Though this cannot be enforced, since Coordinators can be swapped out at
     *      will by the user, the intention is still there.)
     *
     * Holochain does nothing to ensure the correctness of the lineage, it is up to
     * the app developer to make the necessary guarantees.
     */
    lineage: DnaHashB64[];
};
/**
 * @public
 */
export type DnaBundle = {
    manifest: DnaManifest;
    resources: ResourceMap;
};
/**
 * @public
 */
export type DnaSource = {
    type: "path";
    value: string;
} | {
    type: "bundle";
    value: DnaBundle;
} | {
    type: "hash";
    value: HoloHash;
};
/**
 * @public
 */
export type Zomes = Array<[string, {
    wasm_hash: Array<HoloHash>;
}]>;
/**
 * @public
 */
export type WasmCode = [HoloHash, {
    code: Array<number>;
}];
/**
 * @public
 */
export interface AgentInfoDump {
    kitsune_agent: KitsuneAgent;
    kitsune_space: KitsuneSpace;
    dump: string;
}
/**
 * @public
 */
export interface P2pAgentsDump {
    /**
     * The info of this agent's cell.
     */
    this_agent_info: AgentInfoDump | undefined;
    /**
     * The dna as a [`DnaHash`] and [`kitsune_p2p::KitsuneSpace`].
     */
    this_dna: [DnaHash, KitsuneSpace] | undefined;
    /**
     * The agent as [`AgentPubKey`] and [`kitsune_p2p::KitsuneAgent`].
     */
    this_agent: [AgentPubKey, KitsuneAgent] | undefined;
    /**
     * All other agent info.
     */
    peers: Array<AgentInfoDump>;
}
/**
 * @public
 */
export interface FullIntegrationStateDump {
    validation_limbo: Array<DhtOp>;
    integration_limbo: Array<DhtOp>;
    integrated: Array<DhtOp>;
    dht_ops_cursor: number;
}
/**
 * @public
 */
export interface SourceChainJsonRecord {
    signature: Signature;
    action_address: ActionHash;
    action: Action;
    entry: Entry | undefined;
}
/**
 * @public
 */
export interface SourceChainJsonDump {
    records: Array<SourceChainJsonRecord>;
    published_ops_count: number;
}
/**
 * @public
 */
export interface FullStateDump {
    peer_dump: P2pAgentsDump;
    source_chain_dump: SourceChainJsonDump;
    integration_dump: FullIntegrationStateDump;
}
/**
 * @public
 */
export interface DnaStorageInfo {
    authored_data_size: number;
    authored_data_size_on_disk: number;
    dht_data_size: number;
    dht_data_size_on_disk: number;
    cache_data_size: number;
    cache_data_size_on_disk: number;
    used_by: Array<InstalledAppId>;
}
/**
 * @public
 */
export type DnaStorageBlob = {
    type: "dna";
    value: DnaStorageInfo;
};
/**
 * @public
 */
export interface StorageInfo {
    blobs: Array<DnaStorageBlob>;
}
/**
 * @public
 */
export type StorageInfoRequest = void;
/**
 * @public
 */
export type StorageInfoResponse = StorageInfo;
/**
 * @public
 */
export interface IssueAppAuthenticationTokenRequest {
    installed_app_id: InstalledAppId;
    expiry_seconds?: number;
    single_use?: boolean;
}
/**
 * @public
 */
export type AppAuthenticationToken = number[];
/**
 * @public
 */
export interface IssueAppAuthenticationTokenResponse {
    token: AppAuthenticationToken;
    expires_at?: Timestamp;
}
/**
 * @public
 */
export type DumpNetworkStatsRequest = void;
/**
 * @public
 */
export interface ApiTransportStats {
    /**
     * Stats from the configured transport implementation.
     */
    transport_stats: TransportStats;
    /**
     * Blocked message counts.
     */
    blocked_message_counts: Record<PeerUrl, Record<SpaceId, MessageBlockCount>>;
}
/**
 * Peer Url
 *
 * @public
 */
export type PeerUrl = string;
/**
 * kitsune2 space id
 *
 * @public
 */
export type SpaceId = string;
/**
 * @public
 */
export interface MessageBlockCount {
    /**
     * Count of incoming messages that have been blocked and dropped.
     */
    incoming: number;
    /**
     * Count of outgoing messages that have been blocked and dropped.
     */
    outgoing: number;
}
/**
 * Stats for a transport connection.
 *
 * This is intended to be a state dump that gives some insight into what the transport is doing.
 *
 * @public
 */
export interface TransportStats {
    /**
     * The networking backend that is in use.
     */
    backend: string;
    /**
     * The list of peer urls that this Kitsune2 instance can currently be reached at.
     */
    peer_urls: string[];
    /**
     * The list of current connections.
     *
     * @public
     */
    connections: TransportConnectionStats[];
}
/**
 * Stats for a single transport connection.
 *
 * @public
 */
export interface TransportConnectionStats {
    /**
     * The public key of the remote peer.
     */
    pub_key: string;
    /**
     * The message count sent on this connection.
     */
    send_message_count: number;
    /**
     * The bytes sent on this connection.
     */
    send_bytes: number;
    /**
     * The message count received on this connection.
     */
    recv_message_count: number;
    /**
     * The bytes received on this connection
     */
    recv_bytes: number;
    /**
     * UNIX epoch timestamp in seconds when this connection was opened.
     */
    opened_at_s: number;
    /**
     * * True if this connection has successfully upgraded to a direct connection.
     */
    is_direct: boolean;
}
/**
 * @public
 */
export type DumpNetworkStatsResponse = ApiTransportStats;
/**
 * @public
 */
export type AppDumpNetworkStatsResponse = TransportStats;
/**
 * Arguments for dumping network metrics.
 *
 * @public
 */
export interface DumpNetworkMetricsRequest {
    /**
     * The DNA hash of the app network to dump.
     */
    dna_hash?: DnaHash;
    /**
     * Include DHT summary in the response.
     */
    include_dht_summary: boolean;
}
/**
 * The definition of a storage arc compatible with the concept of
 * storage and querying of items in a store that fall within that arc.
 *
 * @public
 */
export type DhtArc = /**
 * No DHT locations are contained within this arc.
 */ null
/**
 * A specific range of DHT locations are contained within this arc.
 *
 * The lower and upper bounds are inclusive.
 */
 | [number, number];
/**
 * Summary of a local agent's network state.
 *
 * @public
 */
export interface LocalAgentSummary {
    /**
     * The agent's public key.
     */
    agent: AgentPubKey;
    /**
     * The current storage arc that the agent is declaring.
     *
     * This is the arc that the agent is claiming that it is an authority for.
     */
    storage_arc: DhtArc;
    /**
     * The target arc that the agent is trying to achieve as a storage arc.
     *
     * This is not declared to other peers on the network. It is used during gossip to try to sync
     * ops in the target arc. Once the DHT state appears to be in sync with the target arc, the
     * storage arc can be updated towards the target arc.
     */
    target_arc: DhtArc;
}
/**
 * Summary of the fetch state.
 *
 * @public
 */
export interface FetchStateSummary {
    /**
     * The op ids that are currently being fetched.
     *
     * Each op id is associated with one or more peer URL from which the op data could be
     * requested.
     */
    pending_requests: Record<HoloHashB64, string[]>;
    /**
     * The peer URL for nodes that are currently on backoff because of failed fetch requests, and the timestamp when that backoff will expire.
     *
     * If peers are in here then they are not being used as potential sources in
     * [`FetchStateSummary::pending_requests`].
     */
    peers_on_backoff: Map<string, number>;
}
/**
 * DHT segment state.
 *
 * @public
 */
export interface DhtSegmentState {
    /**
     * The top hash of the DHT ring segment.
     */
    disc_top_hash: Uint8Array;
    /**
     * The boundary timestamp of the DHT ring segment.
     */
    disc_boundary: Timestamp;
    /**
     * The top hashes of each DHT ring segment.
     */
    ring_top_hashes: Uint8Array[];
}
/**
 * Peer metadata dump.
 *
 * @public
 */
export interface PeerMeta {
    /**
     * The timestamp of the last gossip round.
     */
    last_gossip_timestamp?: Timestamp;
    /**
     * The bookmark of the last op bookmark received.
     */
    new_ops_bookmark?: Timestamp;
    /**
     * The number of behavior errors observed.
     */
    peer_behavior_errors?: number;
    /**
     * The number of local errors.
     */
    local_errors?: number;
    /**
     * The number of busy peer errors.
     */
    peer_busy?: number;
    /**
     * The number of terminated rounds.
     *
     * Note that termination is not necessarily an error.
     */
    peer_terminated?: number;
    /**
     * The number of completed rounds.
     */
    completed_rounds?: number;
    /**
     * The number of peer timeouts.
     */
    peer_timeouts?: number;
}
/**
 * Gossip round state summary.
 *
 * @public
 */
export interface GossipRoundStateSummary {
    /**
     * The URL of the peer with which the round is initiated.
     */
    session_with_peer: string;
}
/**
 * Gossip state summary.
 *
 * @public
 */
export interface GossipStateSummary {
    /**
     * The current initiated round summary.
     */
    initiated_round?: GossipRoundStateSummary;
    /**
     * The list of accepted round summaries.
     */
    accepted_rounds: GossipRoundStateSummary[];
    /**
     * DHT summary.
     */
    dht_summary: Record<string, DhtSegmentState>;
    /**
     * Peer metadata dump for each agent in this space.
     */
    peer_meta: Record<string, PeerMeta>;
}
/**
 * Network metrics from Kitsune2.
 *
 * @public
 */
export interface NetworkMetrics {
    /**
     * A summary of the fetch queue.
     *
     * The fetch queue is used to retrieve op data based on op ids that have been discovered
     * through publish or gossip.
     */
    fetch_state_summary: FetchStateSummary;
    /**
     * A summary of the gossip state.
     *
     * This includes both live gossip rounds and metrics about peers that we've gossiped with.
     * Optionally, it can include a summary of the DHT state as Kitsune2 sees it.
     */
    gossip_state_summary: GossipStateSummary;
    /**
     * A summary of the state of each local agent.
     */
    local_agents: LocalAgentSummary[];
}
/**
 * @public
 */
export type DumpNetworkMetricsResponse = Record<DnaHashB64, NetworkMetrics>;
/**
 * @public
 */
export interface AdminApi {
    attachAppInterface: Requester<AttachAppInterfaceRequest, AttachAppInterfaceResponse>;
    enableApp: Requester<EnableAppRequest, EnableAppResponse>;
    disableApp: Requester<DisableAppRequest, DisableAppResponse>;
    dumpState: Requester<DumpStateRequest, DumpStateResponse>;
    dumpFullState: Requester<DumpFullStateRequest, DumpFullStateResponse>;
    generateAgentPubKey: Requester<GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse>;
    getDnaDefinition: Requester<GetDnaDefinitionRequest, GetDnaDefinitionResponse>;
    uninstallApp: Requester<UninstallAppRequest, UninstallAppResponse>;
    installApp: Requester<InstallAppRequest, InstallAppResponse>;
    listDnas: Requester<ListDnasRequest, ListDnasResponse>;
    listCellIds: Requester<ListCellIdsRequest, ListCellIdsResponse>;
    listApps: Requester<ListAppsRequest, ListAppsResponse>;
    listAppInterfaces: Requester<ListAppInterfacesRequest, ListAppInterfacesResponse>;
    agentInfo: Requester<AgentInfoRequest, AgentInfoResponse>;
    addAgentInfo: Requester<AddAgentInfoRequest, AddAgentInfoResponse>;
    peerMetaInfo: Requester<PeerMetaInfoRequest, PeerMetaInfoResponse>;
    deleteCloneCell: Requester<DeleteCloneCellRequest, DeleteCloneCellResponse>;
    grantZomeCallCapability: Requester<GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse>;
    revokeZomeCallCapability: Requester<RevokeZomeCallCapabilityRequest, RevokeZomeCallCapabilityResponse>;
    listCapabilityGrants: Requester<ListCapabilityGrantsRequest, ListCapabilityGrantsResponse>;
    storageInfo: Requester<StorageInfoRequest, StorageInfoResponse>;
    issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
    dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;
}