diff --git a/CHANGELOG.md b/CHANGELOG.md index 92ac51ac..aa088126 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,16 +4,19 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm ## \[Unreleased\] +### Added +### Removed +### Changed +### Fixed + +## 2023-05-08: v0.13.0 ### Added - Utility function to wait until all players' integrated DhtOps are identical for a DNA. - **BREAKING CHANGE**: Local signal server for both local (required) and TryCP conductors (optional). -### Removed ### Changed - `runScenario` catches and outputs error occurring during the test run. - **BREAKING CHANGE**: Upgrade to Holochain v0.2.0 and compatible JS client. -### Fixed - ## 2023-02-14: v0.11.2 ### Changed - Output Holochain traces at `info` log level by default. Before log level needed to be set to `debug` for traces to appear. diff --git a/docs/tryorama.adminapiresponse.md b/docs/tryorama.adminapiresponse.md index 91279735..dcd18daa 100644 --- a/docs/tryorama.adminapiresponse.md +++ b/docs/tryorama.adminapiresponse.md @@ -9,7 +9,7 @@ All possible responses from the Admin API. Signature: ```typescript -export type AdminApiResponse = AdminApiResponseAgentInfo | AdminApiResponseAgentInfoAdded | AdminApiResponseAgentPubKeyGenerated | AdminApiResponseAppDisabled | AdminApiResponseAppEnabled | AdminApiResponseAppInstalled | AdminApiResponseAppInterfaceAttached | AdminApiResponseAppInterfacesListed | AdminApiResponseAppStarted | AdminApiResponseAppUninstalled | AdminApiResponseAppsListed | AdminApiResponseCloneCellDeleted | AdminApiResponseCellIdsListed | AdminApiResponseDnasDefinitionReturned | AdminApiResponseDnasListed | AdminApiResponseDnaRegistered | AdminApiResponseFullStateDumped | AdminApiResponseStateDumped | AdminApiResponseZomeCallCapabilityGranted; +export type AdminApiResponse = AdminApiResponseAgentInfo | AdminApiResponseAgentInfoAdded | AdminApiResponseAgentPubKeyGenerated | AdminApiResponseAppDisabled | AdminApiResponseAppEnabled | AdminApiResponseAppInstalled | AdminApiResponseAppInterfaceAttached | AdminApiResponseAppInterfacesListed | AdminApiResponseAppStarted | AdminApiResponseAppUninstalled | AdminApiResponseAppsListed | AdminApiResponseCellIdsListed | AdminApiResponseCloneCellDeleted | AdminApiResponseCoordinatorsUpdated | AdminApiResponseDnasDefinitionReturned | AdminApiResponseDnasListed | AdminApiResponseDnaRegistered | AdminApiResponseFullStateDumped | AdminApiResponseNetworkStatsDumped | AdminApiResponseStateDumped | AdminApiResponseStorageInfo | AdminApiResponseZomeCallCapabilityGranted; ``` -References: [AdminApiResponseAgentInfo](./tryorama.adminapiresponseagentinfo.md), [AdminApiResponseAgentInfoAdded](./tryorama.adminapiresponseagentinfoadded.md), [AdminApiResponseAgentPubKeyGenerated](./tryorama.adminapiresponseagentpubkeygenerated.md), [AdminApiResponseAppDisabled](./tryorama.adminapiresponseappdisabled.md), [AdminApiResponseAppEnabled](./tryorama.adminapiresponseappenabled.md), [AdminApiResponseAppInstalled](./tryorama.adminapiresponseappinstalled.md), [AdminApiResponseAppInterfaceAttached](./tryorama.adminapiresponseappinterfaceattached.md), [AdminApiResponseAppInterfacesListed](./tryorama.adminapiresponseappinterfaceslisted.md), [AdminApiResponseAppStarted](./tryorama.adminapiresponseappstarted.md), [AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md), [AdminApiResponseAppsListed](./tryorama.adminapiresponseappslisted.md), [AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md), [AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md), [AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md), [AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md), [AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md), [AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md), [AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md), [AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) +References: [AdminApiResponseAgentInfo](./tryorama.adminapiresponseagentinfo.md), [AdminApiResponseAgentInfoAdded](./tryorama.adminapiresponseagentinfoadded.md), [AdminApiResponseAgentPubKeyGenerated](./tryorama.adminapiresponseagentpubkeygenerated.md), [AdminApiResponseAppDisabled](./tryorama.adminapiresponseappdisabled.md), [AdminApiResponseAppEnabled](./tryorama.adminapiresponseappenabled.md), [AdminApiResponseAppInstalled](./tryorama.adminapiresponseappinstalled.md), [AdminApiResponseAppInterfaceAttached](./tryorama.adminapiresponseappinterfaceattached.md), [AdminApiResponseAppInterfacesListed](./tryorama.adminapiresponseappinterfaceslisted.md), [AdminApiResponseAppStarted](./tryorama.adminapiresponseappstarted.md), [AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md), [AdminApiResponseAppsListed](./tryorama.adminapiresponseappslisted.md), [AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md), [AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md), [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md), [AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md), [AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md), [AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md), [AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md), [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md), [AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md), [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md), [AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md new file mode 100644 index 00000000..337c46d0 --- /dev/null +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md) > [data](./tryorama.adminapiresponsecoordinatorsupdated.data.md) + +## AdminApiResponseCoordinatorsUpdated.data property + +Signature: + +```typescript +data: UpdateCoordinatorsResponse; +``` diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.md new file mode 100644 index 00000000..9ed6027c --- /dev/null +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md) + +## AdminApiResponseCoordinatorsUpdated interface + + +Signature: + +```typescript +export interface AdminApiResponseCoordinatorsUpdated +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./tryorama.adminapiresponsecoordinatorsupdated.data.md) | | UpdateCoordinatorsResponse | | +| [type](./tryorama.adminapiresponsecoordinatorsupdated.type.md) | | "coordinators\_updated" | | + diff --git a/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md b/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md new file mode 100644 index 00000000..5dd974b8 --- /dev/null +++ b/docs/tryorama.adminapiresponsecoordinatorsupdated.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md) > [type](./tryorama.adminapiresponsecoordinatorsupdated.type.md) + +## AdminApiResponseCoordinatorsUpdated.type property + +Signature: + +```typescript +type: "coordinators_updated"; +``` diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md new file mode 100644 index 00000000..adec763c --- /dev/null +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md) > [data](./tryorama.adminapiresponsenetworkstatsdumped.data.md) + +## AdminApiResponseNetworkStatsDumped.data property + +Signature: + +```typescript +data: DumpNetworkStatsResponse; +``` diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.md new file mode 100644 index 00000000..8bb3514b --- /dev/null +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md) + +## AdminApiResponseNetworkStatsDumped interface + + +Signature: + +```typescript +export interface AdminApiResponseNetworkStatsDumped +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./tryorama.adminapiresponsenetworkstatsdumped.data.md) | | DumpNetworkStatsResponse | | +| [type](./tryorama.adminapiresponsenetworkstatsdumped.type.md) | | "network\_stats\_dumped" | | + diff --git a/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md b/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md new file mode 100644 index 00000000..697a8d62 --- /dev/null +++ b/docs/tryorama.adminapiresponsenetworkstatsdumped.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md) > [type](./tryorama.adminapiresponsenetworkstatsdumped.type.md) + +## AdminApiResponseNetworkStatsDumped.type property + +Signature: + +```typescript +type: "network_stats_dumped"; +``` diff --git a/docs/tryorama.adminapiresponsestorageinfo.data.md b/docs/tryorama.adminapiresponsestorageinfo.data.md new file mode 100644 index 00000000..edde9f96 --- /dev/null +++ b/docs/tryorama.adminapiresponsestorageinfo.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md) > [data](./tryorama.adminapiresponsestorageinfo.data.md) + +## AdminApiResponseStorageInfo.data property + +Signature: + +```typescript +data: StorageInfoResponse; +``` diff --git a/docs/tryorama.adminapiresponsestorageinfo.md b/docs/tryorama.adminapiresponsestorageinfo.md new file mode 100644 index 00000000..fd400584 --- /dev/null +++ b/docs/tryorama.adminapiresponsestorageinfo.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md) + +## AdminApiResponseStorageInfo interface + + +Signature: + +```typescript +export interface AdminApiResponseStorageInfo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./tryorama.adminapiresponsestorageinfo.data.md) | | StorageInfoResponse | | +| [type](./tryorama.adminapiresponsestorageinfo.type.md) | | "storage\_info" | | + diff --git a/docs/tryorama.adminapiresponsestorageinfo.type.md b/docs/tryorama.adminapiresponsestorageinfo.type.md new file mode 100644 index 00000000..b7f1c661 --- /dev/null +++ b/docs/tryorama.adminapiresponsestorageinfo.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md) > [type](./tryorama.adminapiresponsestorageinfo.type.md) + +## AdminApiResponseStorageInfo.type property + +Signature: + +```typescript +type: "storage_info"; +``` diff --git a/docs/tryorama.appapiresponse.md b/docs/tryorama.appapiresponse.md index d6019ca0..fbc1a4fe 100644 --- a/docs/tryorama.appapiresponse.md +++ b/docs/tryorama.appapiresponse.md @@ -9,7 +9,7 @@ App API Responses. Signature: ```typescript -export type AppApiResponse = AppApiResponseAppInfo | AppApiResponseZomeCall | AppApiResponseCloneCellCreated | AppApiResponseCloneCellEnabled | AppApiResponseCloneCellDisabled; +export type AppApiResponse = AppApiResponseAppInfo | AppApiResponseZomeCall | AppApiResponseCloneCellCreated | AppApiResponseCloneCellEnabled | AppApiResponseCloneCellDisabled | AppApiResponseNetworkInfo; ``` -References: [AppApiResponseAppInfo](./tryorama.appapiresponseappinfo.md), [AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md), [AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md), [AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md), [AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md) +References: [AppApiResponseAppInfo](./tryorama.appapiresponseappinfo.md), [AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md), [AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md), [AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md), [AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md), [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) diff --git a/docs/tryorama.appapiresponsenetworkinfo.data.md b/docs/tryorama.appapiresponsenetworkinfo.data.md new file mode 100644 index 00000000..ad7da821 --- /dev/null +++ b/docs/tryorama.appapiresponsenetworkinfo.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) > [data](./tryorama.appapiresponsenetworkinfo.data.md) + +## AppApiResponseNetworkInfo.data property + +Signature: + +```typescript +data: NetworkInfoResponse; +``` diff --git a/docs/tryorama.appapiresponsenetworkinfo.md b/docs/tryorama.appapiresponsenetworkinfo.md new file mode 100644 index 00000000..4bff668e --- /dev/null +++ b/docs/tryorama.appapiresponsenetworkinfo.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) + +## AppApiResponseNetworkInfo interface + + +Signature: + +```typescript +export interface AppApiResponseNetworkInfo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./tryorama.appapiresponsenetworkinfo.data.md) | | NetworkInfoResponse | | +| [type](./tryorama.appapiresponsenetworkinfo.type.md) | | "network\_info" | | + diff --git a/docs/tryorama.appapiresponsenetworkinfo.type.md b/docs/tryorama.appapiresponsenetworkinfo.type.md new file mode 100644 index 00000000..9e260c06 --- /dev/null +++ b/docs/tryorama.appapiresponsenetworkinfo.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) > [type](./tryorama.appapiresponsenetworkinfo.type.md) + +## AppApiResponseNetworkInfo.type property + +Signature: + +```typescript +type: "network_info"; +``` diff --git a/docs/tryorama.conductor.create.md b/docs/tryorama.conductor.create.md index 7b7540e5..2c3d9679 100644 --- a/docs/tryorama.conductor.create.md +++ b/docs/tryorama.conductor.create.md @@ -9,13 +9,14 @@ Factory to create a conductor. Signature: ```typescript -static create(options?: CreateConductorOptions): Promise; +static create(signalingServerUrl: string, options?: CreateConductorOptions): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | +| signalingServerUrl | string | | | options | [CreateConductorOptions](./tryorama.createconductoroptions.md) | (Optional) | Returns: diff --git a/docs/tryorama.conductor.md b/docs/tryorama.conductor.md index 32da1eb5..c7372d4d 100644 --- a/docs/tryorama.conductor.md +++ b/docs/tryorama.conductor.md @@ -23,7 +23,7 @@ export declare class Conductor implements IConductor | [attachAppInterface(request)](./tryorama.conductor.attachappinterface.md) | | Attach a web socket to the App API. | | [connectAppAgentInterface(appId)](./tryorama.conductor.connectappagentinterface.md) | | Connect a web socket for a specific app to the App API. | | [connectAppInterface()](./tryorama.conductor.connectappinterface.md) | | Connect a web socket to the App API. | -| [create(options)](./tryorama.conductor.create.md) | static | Factory to create a conductor. | +| [create(signalingServerUrl, options)](./tryorama.conductor.create.md) | static | Factory to create a conductor. | | [getTmpDirectory()](./tryorama.conductor.gettmpdirectory.md) | | Get the path of the directory that contains all files and folders of the conductor. | | [installAgentsApps(options)](./tryorama.conductor.installagentsapps.md) | | Install an app for multiple agents into the conductor. | | [installApp(appBundleSource, options)](./tryorama.conductor.installapp.md) | | Install an application into the conductor. | diff --git a/docs/tryorama.conductoroptions.bindto.md b/docs/tryorama.conductoroptions.bindto.md deleted file mode 100644 index ea0ab245..00000000 --- a/docs/tryorama.conductoroptions.bindto.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [ConductorOptions](./tryorama.conductoroptions.md) > [bindTo](./tryorama.conductoroptions.bindto.md) - -## ConductorOptions.bindTo property - -Network interface and port to bind to - -Signature: - -```typescript -bindTo?: URL; -``` diff --git a/docs/tryorama.conductoroptions.hostoverride.md b/docs/tryorama.conductoroptions.hostoverride.md deleted file mode 100644 index 871513e1..00000000 --- a/docs/tryorama.conductoroptions.hostoverride.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [ConductorOptions](./tryorama.conductoroptions.md) > [hostOverride](./tryorama.conductoroptions.hostoverride.md) - -## ConductorOptions.hostOverride property - -If you have port-forwarding set up or wish to apply a vanity domain name, you may need to override the local IP. - -Signature: - -```typescript -hostOverride?: URL; -``` diff --git a/docs/tryorama.conductoroptions.md b/docs/tryorama.conductoroptions.md index d7d1e4c4..04ae60b9 100644 --- a/docs/tryorama.conductoroptions.md +++ b/docs/tryorama.conductoroptions.md @@ -16,12 +16,8 @@ export interface ConductorOptions | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [attachAppInterface?](./tryorama.conductoroptions.attachappinterface.md) | | boolean | (Optional) Attach an app interface to the conductor and connect an app websocket to it. | -| [bindTo?](./tryorama.conductoroptions.bindto.md) | | URL | (Optional) Network interface and port to bind to | | [bootstrapUrl?](./tryorama.conductoroptions.bootstrapurl.md) | | URL | (Optional) A bootstrap service URL for peers to discover each other | -| [hostOverride?](./tryorama.conductoroptions.hostoverride.md) | | URL | (Optional) If you have port-forwarding set up or wish to apply a vanity domain name, you may need to override the local IP. | | [networkType?](./tryorama.conductoroptions.networktype.md) | | [NetworkType](./tryorama.networktype.md) | (Optional) The network type the conductor should use | -| [portOverride?](./tryorama.conductoroptions.portoverride.md) | | number | (Optional) If you have port-forwarding set up, you may need to override the local port. | -| [proxy?](./tryorama.conductoroptions.proxy.md) | | URL | (Optional) Run through an external proxy | | [startup?](./tryorama.conductoroptions.startup.md) | | boolean | (Optional) Start up conductor after creation. | | [timeout?](./tryorama.conductoroptions.timeout.md) | | number | (Optional) Timeout for requests to Admin and App API | diff --git a/docs/tryorama.conductoroptions.portoverride.md b/docs/tryorama.conductoroptions.portoverride.md deleted file mode 100644 index 1e70be00..00000000 --- a/docs/tryorama.conductoroptions.portoverride.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [ConductorOptions](./tryorama.conductoroptions.md) > [portOverride](./tryorama.conductoroptions.portoverride.md) - -## ConductorOptions.portOverride property - -If you have port-forwarding set up, you may need to override the local port. - -Signature: - -```typescript -portOverride?: number; -``` diff --git a/docs/tryorama.conductoroptions.proxy.md b/docs/tryorama.conductoroptions.proxy.md deleted file mode 100644 index bedfd4a9..00000000 --- a/docs/tryorama.conductoroptions.proxy.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [ConductorOptions](./tryorama.conductoroptions.md) > [proxy](./tryorama.conductoroptions.proxy.md) - -## ConductorOptions.proxy property - -Run through an external proxy - -Signature: - -```typescript -proxy?: URL; -``` diff --git a/docs/tryorama.createconductor.md b/docs/tryorama.createconductor.md index 8d124672..3a5a0b36 100644 --- a/docs/tryorama.createconductor.md +++ b/docs/tryorama.createconductor.md @@ -9,5 +9,5 @@ The function to create a conductor. It starts a sandbox conductor via the Holoch Signature: ```typescript -createConductor: (options?: ConductorOptions) => Promise +createConductor: (signalingServerUrl: string, options?: ConductorOptions) => Promise ``` diff --git a/docs/tryorama.createconductoroptions.md b/docs/tryorama.createconductoroptions.md index a3211bd2..d77a04e2 100644 --- a/docs/tryorama.createconductoroptions.md +++ b/docs/tryorama.createconductoroptions.md @@ -9,7 +9,7 @@ Options for using the conductor factory. Signature: ```typescript -export type CreateConductorOptions = Pick; +export type CreateConductorOptions = Pick; ``` References: [ConductorOptions](./tryorama.conductoroptions.md) diff --git a/docs/tryorama.default_partial_player_config.md b/docs/tryorama.default_partial_player_config.md index 831ab963..0c4706fd 100644 --- a/docs/tryorama.default_partial_player_config.md +++ b/docs/tryorama.default_partial_player_config.md @@ -9,5 +9,5 @@ The default partial config for a TryCP conductor. Signature: ```typescript -DEFAULT_PARTIAL_PLAYER_CONFIG = "signing_service_uri: ~\nencryption_service_uri: ~\ndecryption_service_uri: ~\ndpki: ~\nnetwork: ~" +DEFAULT_PARTIAL_PLAYER_CONFIG = "signing_service_uri: ~\nencryption_service_uri: ~\ndecryption_service_uri: ~\ndpki: ~\nnetwork:\n network_type: \"quic_mdns\" \n transport_pool:\n - type: webrtc\n signal_url: " ``` diff --git a/docs/tryorama.iconductor.appws.md b/docs/tryorama.iconductor.appws.md index e8549ad7..237c2158 100644 --- a/docs/tryorama.iconductor.appws.md +++ b/docs/tryorama.iconductor.appws.md @@ -7,5 +7,5 @@ Signature: ```typescript -appWs: () => Pick; +appWs: () => Pick; ``` diff --git a/docs/tryorama.iconductor.md b/docs/tryorama.iconductor.md index 4be875d1..8adca022 100644 --- a/docs/tryorama.iconductor.md +++ b/docs/tryorama.iconductor.md @@ -17,7 +17,7 @@ export interface IConductor | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [adminWs](./tryorama.iconductor.adminws.md) | | () => Omit<AdminWebsocket, "client" \| "defaultTimeout" \| "\_requester"> | | -| [appWs](./tryorama.iconductor.appws.md) | | () => Pick<AppWebsocket, "callZome" \| "appInfo" \| "createCloneCell" \| "enableCloneCell" \| "disableCloneCell"> | | +| [appWs](./tryorama.iconductor.appws.md) | | () => Pick<AppWebsocket, "callZome" \| "appInfo" \| "createCloneCell" \| "enableCloneCell" \| "disableCloneCell" \| "networkInfo"> | | | [installAgentsApps](./tryorama.iconductor.installagentsapps.md) | | (options: [AgentsAppsOptions](./tryorama.agentsappsoptions.md)) => Promise<[AgentApp](./tryorama.agentapp.md)\[\]> | | | [installApp](./tryorama.iconductor.installapp.md) | | (appBundleSource: AppBundleSource, options?: [AppOptions](./tryorama.appoptions.md)) => Promise<[AgentApp](./tryorama.agentapp.md)> | | | [shutDown](./tryorama.iconductor.shutdown.md) | | () => Promise<number \| null> | | diff --git a/docs/tryorama.md b/docs/tryorama.md index 7ddec44a..fb0210e3 100644 --- a/docs/tryorama.md +++ b/docs/tryorama.md @@ -46,11 +46,14 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r | [AdminApiResponseAppUninstalled](./tryorama.adminapiresponseappuninstalled.md) | | | [AdminApiResponseCellIdsListed](./tryorama.adminapiresponsecellidslisted.md) | | | [AdminApiResponseCloneCellDeleted](./tryorama.adminapiresponseclonecelldeleted.md) | | +| [AdminApiResponseCoordinatorsUpdated](./tryorama.adminapiresponsecoordinatorsupdated.md) | | | [AdminApiResponseDnaRegistered](./tryorama.adminapiresponsednaregistered.md) | | | [AdminApiResponseDnasDefinitionReturned](./tryorama.adminapiresponsednasdefinitionreturned.md) | | | [AdminApiResponseDnasListed](./tryorama.adminapiresponsednaslisted.md) | | | [AdminApiResponseFullStateDumped](./tryorama.adminapiresponsefullstatedumped.md) | | +| [AdminApiResponseNetworkStatsDumped](./tryorama.adminapiresponsenetworkstatsdumped.md) | | | [AdminApiResponseStateDumped](./tryorama.adminapiresponsestatedumped.md) | | +| [AdminApiResponseStorageInfo](./tryorama.adminapiresponsestorageinfo.md) | | | [AdminApiResponseZomeCallCapabilityGranted](./tryorama.adminapiresponsezomecallcapabilitygranted.md) | | | [AgentApp](./tryorama.agentapp.md) | Provides direct access to cells of an app and the agent key. | | [ApiErrorResponse](./tryorama.apierrorresponse.md) | Error response from the Admin or App API. | @@ -58,6 +61,7 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r | [AppApiResponseCloneCellCreated](./tryorama.appapiresponseclonecellcreated.md) | | | [AppApiResponseCloneCellDisabled](./tryorama.appapiresponseclonecelldisabled.md) | | | [AppApiResponseCloneCellEnabled](./tryorama.appapiresponseclonecellenabled.md) | | +| [AppApiResponseNetworkInfo](./tryorama.appapiresponsenetworkinfo.md) | | | [AppApiResponseZomeCall](./tryorama.appapiresponsezomecall.md) | | | [AppOptions](./tryorama.appoptions.md) | Optional arguments when installing a hApp. | | [ClientsPlayersOptions](./tryorama.clientsplayersoptions.md) | | @@ -80,6 +84,7 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r | [RequestDisconnectAppInterface](./tryorama.requestdisconnectappinterface.md) | Request to disconnect a connected app interface from a conductor. | | [RequestDownloadDna](./tryorama.requestdownloaddna.md) | Request to download a DNA from a URL. | | [RequestEnableCloneCell](./tryorama.requestenableclonecell.md) | Enable a disabled clone cell. | +| [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) | Request network info. | | [RequestReset](./tryorama.requestreset.md) | Request deletion of \*\*all\*\* conductors. | | [RequestSaveDna](./tryorama.requestsavedna.md) | Request to save a DNA to the server's file system. | | [RequestShutdown](./tryorama.requestshutdown.md) | Request shutdown of a conductor. | @@ -102,7 +107,6 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r | [getZomeCaller](./tryorama.getzomecaller.md) | Get a shorthand function to call a cell's zome. | | [pause](./tryorama.pause.md) | A utility function to wait the given amount of time. | | [runScenario](./tryorama.runscenario.md) | A wrapper function to create and run a scenario. A scenario is created and all involved conductors are shut down and cleaned up after running. | -| [stopAllTryCpServers](./tryorama.stopalltrycpservers.md) | Shortcut function to stop all TryCP servers. | | [TRYCP\_SUCCESS\_RESPONSE](./tryorama.trycp_success_response.md) | Empty success response. | ## Type Aliases diff --git a/docs/tryorama.networktype.md b/docs/tryorama.networktype.md index 1bfb0918..445ba2c7 100644 --- a/docs/tryorama.networktype.md +++ b/docs/tryorama.networktype.md @@ -16,6 +16,6 @@ export declare enum NetworkType | Member | Value | Description | | --- | --- | --- | -| Mdns | "mdns" | | -| Quic | "quic" | | +| Mem | "mem" | | +| WebRtc | "webrtc" | | diff --git a/docs/tryorama.requestadmininterfacemessage.data.md b/docs/tryorama.requestadmininterfacemessage.data.md index 03788a16..0fb4e710 100644 --- a/docs/tryorama.requestadmininterfacemessage.data.md +++ b/docs/tryorama.requestadmininterfacemessage.data.md @@ -7,5 +7,5 @@ Signature: ```typescript -data?: AddAgentInfoRequest | AgentInfoRequest | AttachAppInterfaceRequest | DeleteCloneCellRequest | DisableAppRequest | DumpFullStateRequest | DumpStateRequest | EnableAppRequest | GetDnaDefinitionRequest | GrantZomeCallCapabilityRequest | InstallAppRequest | ListAppsRequest | RegisterDnaRequest | StartAppRequest | UninstallAppRequest; +data?: AddAgentInfoRequest | AgentInfoRequest | AttachAppInterfaceRequest | DeleteCloneCellRequest | DisableAppRequest | DumpFullStateRequest | DumpNetworkStatsRequest | DumpStateRequest | EnableAppRequest | GetDnaDefinitionRequest | GrantZomeCallCapabilityRequest | InstallAppRequest | ListAppsRequest | RegisterDnaRequest | StartAppRequest | StorageInfoRequest | UninstallAppRequest | UpdateCoordinatorsRequest; ``` diff --git a/docs/tryorama.requestadmininterfacemessage.md b/docs/tryorama.requestadmininterfacemessage.md index abf99c61..5a6781cc 100644 --- a/docs/tryorama.requestadmininterfacemessage.md +++ b/docs/tryorama.requestadmininterfacemessage.md @@ -16,6 +16,6 @@ export interface RequestAdminInterfaceMessage | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [data?](./tryorama.requestadmininterfacemessage.data.md) | | AddAgentInfoRequest \| AgentInfoRequest \| AttachAppInterfaceRequest \| DeleteCloneCellRequest \| DisableAppRequest \| DumpFullStateRequest \| DumpStateRequest \| EnableAppRequest \| GetDnaDefinitionRequest \| GrantZomeCallCapabilityRequest \| InstallAppRequest \| ListAppsRequest \| RegisterDnaRequest \| StartAppRequest \| UninstallAppRequest | (Optional) | -| [type](./tryorama.requestadmininterfacemessage.type.md) | | "add\_agent\_info" \| "agent\_info" \| "attach\_app\_interface" \| "connect\_app\_interface" \| "delete\_clone\_cell" \| "disable\_app" \| "dump\_full\_state" \| "dump\_state" \| "enable\_app" \| "generate\_agent\_pub\_key" \| "get\_dna\_definition" \| "grant\_zome\_call\_capability" \| "install\_app" \| "install\_app" \| "list\_apps" \| "list\_app\_interfaces" \| "list\_cell\_ids" \| "list\_dnas" \| "register\_dna" \| "start\_app" \| "uninstall\_app" | | +| [data?](./tryorama.requestadmininterfacemessage.data.md) | | AddAgentInfoRequest \| AgentInfoRequest \| AttachAppInterfaceRequest \| DeleteCloneCellRequest \| DisableAppRequest \| DumpFullStateRequest \| DumpNetworkStatsRequest \| DumpStateRequest \| EnableAppRequest \| GetDnaDefinitionRequest \| GrantZomeCallCapabilityRequest \| InstallAppRequest \| ListAppsRequest \| RegisterDnaRequest \| StartAppRequest \| StorageInfoRequest \| UninstallAppRequest \| UpdateCoordinatorsRequest | (Optional) | +| [type](./tryorama.requestadmininterfacemessage.type.md) | | "add\_agent\_info" \| "agent\_info" \| "attach\_app\_interface" \| "connect\_app\_interface" \| "delete\_clone\_cell" \| "disable\_app" \| "dump\_full\_state" \| "dump\_network\_stats" \| "dump\_state" \| "enable\_app" \| "generate\_agent\_pub\_key" \| "get\_dna\_definition" \| "grant\_zome\_call\_capability" \| "install\_app" \| "install\_app" \| "list\_apps" \| "list\_app\_interfaces" \| "list\_cell\_ids" \| "list\_dnas" \| "register\_dna" \| "start\_app" \| "storage\_info" \| "uninstall\_app" \| "update\_coordinators" | | diff --git a/docs/tryorama.requestadmininterfacemessage.type.md b/docs/tryorama.requestadmininterfacemessage.type.md index 6571e89d..4b48487c 100644 --- a/docs/tryorama.requestadmininterfacemessage.type.md +++ b/docs/tryorama.requestadmininterfacemessage.type.md @@ -7,5 +7,5 @@ Signature: ```typescript -type: "add_agent_info" | "agent_info" | "attach_app_interface" | "connect_app_interface" | "delete_clone_cell" | "disable_app" | "dump_full_state" | "dump_state" | "enable_app" | "generate_agent_pub_key" | "get_dna_definition" | "grant_zome_call_capability" | "install_app" | "install_app" | "list_apps" | "list_app_interfaces" | "list_cell_ids" | "list_dnas" | "register_dna" | "start_app" | "uninstall_app"; +type: "add_agent_info" | "agent_info" | "attach_app_interface" | "connect_app_interface" | "delete_clone_cell" | "disable_app" | "dump_full_state" | "dump_network_stats" | "dump_state" | "enable_app" | "generate_agent_pub_key" | "get_dna_definition" | "grant_zome_call_capability" | "install_app" | "install_app" | "list_apps" | "list_app_interfaces" | "list_cell_ids" | "list_dnas" | "register_dna" | "start_app" | "storage_info" | "uninstall_app" | "update_coordinators"; ``` diff --git a/docs/tryorama.requestcallappinterfacemessage.md b/docs/tryorama.requestcallappinterfacemessage.md index fe409c1d..8c6117a4 100644 --- a/docs/tryorama.requestcallappinterfacemessage.md +++ b/docs/tryorama.requestcallappinterfacemessage.md @@ -9,7 +9,7 @@ All possible calls to the App API. Signature: ```typescript -export type RequestCallAppInterfaceMessage = RequestCallZome | RequestAppInfo | RequestCreateCloneCell | RequestEnableCloneCell | RequestDisableCloneCell; +export type RequestCallAppInterfaceMessage = RequestCallZome | RequestAppInfo | RequestCreateCloneCell | RequestEnableCloneCell | RequestDisableCloneCell | RequestNetworkInfo; ``` -References: [RequestCallZome](./tryorama.requestcallzome.md), [RequestAppInfo](./tryorama.requestappinfo.md), [RequestCreateCloneCell](./tryorama.requestcreateclonecell.md), [RequestEnableCloneCell](./tryorama.requestenableclonecell.md), [RequestDisableCloneCell](./tryorama.requestdisableclonecell.md) +References: [RequestCallZome](./tryorama.requestcallzome.md), [RequestAppInfo](./tryorama.requestappinfo.md), [RequestCreateCloneCell](./tryorama.requestcreateclonecell.md), [RequestEnableCloneCell](./tryorama.requestenableclonecell.md), [RequestDisableCloneCell](./tryorama.requestdisableclonecell.md), [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) diff --git a/docs/tryorama.requestnetworkinfo.data.md b/docs/tryorama.requestnetworkinfo.data.md new file mode 100644 index 00000000..954c29f1 --- /dev/null +++ b/docs/tryorama.requestnetworkinfo.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) > [data](./tryorama.requestnetworkinfo.data.md) + +## RequestNetworkInfo.data property + +Signature: + +```typescript +data: NetworkInfoRequest; +``` diff --git a/docs/tryorama.requestnetworkinfo.md b/docs/tryorama.requestnetworkinfo.md new file mode 100644 index 00000000..b3d8c532 --- /dev/null +++ b/docs/tryorama.requestnetworkinfo.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) + +## RequestNetworkInfo interface + +Request network info. + +Signature: + +```typescript +export interface RequestNetworkInfo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./tryorama.requestnetworkinfo.data.md) | | NetworkInfoRequest | | +| [type](./tryorama.requestnetworkinfo.type.md) | | "network\_info" | | + diff --git a/docs/tryorama.requestnetworkinfo.type.md b/docs/tryorama.requestnetworkinfo.type.md new file mode 100644 index 00000000..1fa1f15d --- /dev/null +++ b/docs/tryorama.requestnetworkinfo.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [RequestNetworkInfo](./tryorama.requestnetworkinfo.md) > [type](./tryorama.requestnetworkinfo.type.md) + +## RequestNetworkInfo.type property + +Signature: + +```typescript +type: "network_info"; +``` diff --git a/docs/tryorama.scenario.awaitdhtsync.md b/docs/tryorama.scenario.awaitdhtsync.md index 7bf3ba97..c1f4eabe 100644 --- a/docs/tryorama.scenario.awaitdhtsync.md +++ b/docs/tryorama.scenario.awaitdhtsync.md @@ -9,7 +9,7 @@ Await DhtOp integration of all players for a given cell. Signature: ```typescript -awaitDhtSync(cellId: CellId): Promise; +awaitDhtSync(cellId: CellId, interval?: number, timeout?: number): Promise; ``` ## Parameters @@ -17,6 +17,8 @@ awaitDhtSync(cellId: CellId): Promise; | Parameter | Type | Description | | --- | --- | --- | | cellId | CellId | Cell id to await DHT sync for. | +| interval | number | (Optional) Interval to pause between comparisons (defaults to 50 ms). | +| timeout | number | (Optional) A timeout for the delay (optional). | Returns: diff --git a/docs/tryorama.scenario.md b/docs/tryorama.scenario.md index 66848530..af638f3e 100644 --- a/docs/tryorama.scenario.md +++ b/docs/tryorama.scenario.md @@ -24,6 +24,8 @@ export declare class Scenario | --- | --- | --- | --- | | [conductors](./tryorama.scenario.conductors.md) | | [Conductor](./tryorama.conductor.md)\[\] | | | [networkSeed](./tryorama.scenario.networkseed.md) | | string | | +| [signalingServerProcess](./tryorama.scenario.signalingserverprocess.md) | | ChildProcessWithoutNullStreams \| undefined | | +| [signalingServerUrl](./tryorama.scenario.signalingserverurl.md) | | string \| undefined | | ## Methods @@ -32,7 +34,7 @@ export declare class Scenario | [addConductor()](./tryorama.scenario.addconductor.md) | | Create and add a conductor to the scenario. | | [addPlayersWithApps(playersApps)](./tryorama.scenario.addplayerswithapps.md) | | Create and add multiple players to the scenario, with an app installed for each player. | | [addPlayerWithApp(appBundleSource, options)](./tryorama.scenario.addplayerwithapp.md) | | Create and add a single player with an app installed to the scenario. | -| [awaitDhtSync(cellId)](./tryorama.scenario.awaitdhtsync.md) | | Await DhtOp integration of all players for a given cell. | +| [awaitDhtSync(cellId, interval, timeout)](./tryorama.scenario.awaitdhtsync.md) | | Await DhtOp integration of all players for a given cell. | | [cleanUp()](./tryorama.scenario.cleanup.md) | | Shut down and delete all conductors in the scenario. | | [shareAllAgents()](./tryorama.scenario.shareallagents.md) | | Register all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. | | [shutDown()](./tryorama.scenario.shutdown.md) | | Shut down all conductors in the scenario. | diff --git a/docs/tryorama.scenario.signalingserverprocess.md b/docs/tryorama.scenario.signalingserverprocess.md new file mode 100644 index 00000000..88ee9446 --- /dev/null +++ b/docs/tryorama.scenario.signalingserverprocess.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [Scenario](./tryorama.scenario.md) > [signalingServerProcess](./tryorama.scenario.signalingserverprocess.md) + +## Scenario.signalingServerProcess property + +Signature: + +```typescript +signalingServerProcess: ChildProcessWithoutNullStreams | undefined; +``` diff --git a/docs/tryorama.scenario.signalingserverurl.md b/docs/tryorama.scenario.signalingserverurl.md new file mode 100644 index 00000000..ec71eb9f --- /dev/null +++ b/docs/tryorama.scenario.signalingserverurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [Scenario](./tryorama.scenario.md) > [signalingServerUrl](./tryorama.scenario.signalingserverurl.md) + +## Scenario.signalingServerUrl property + +Signature: + +```typescript +signalingServerUrl: string | undefined; +``` diff --git a/docs/tryorama.stopalltrycpservers.md b/docs/tryorama.stopalltrycpservers.md deleted file mode 100644 index 94e0c281..00000000 --- a/docs/tryorama.stopalltrycpservers.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [stopAllTryCpServers](./tryorama.stopalltrycpservers.md) - -## stopAllTryCpServers variable - -Shortcut function to stop all TryCP servers. - -Signature: - -```typescript -stopAllTryCpServers: (tryCpServers: TryCpServer[]) => Promise -``` diff --git a/docs/tryorama.trycpclient.addconductor.md b/docs/tryorama.trycpclient.addconductor.md index deb5d839..577ebde4 100644 --- a/docs/tryorama.trycpclient.addconductor.md +++ b/docs/tryorama.trycpclient.addconductor.md @@ -9,7 +9,7 @@ Create and add a conductor to the client. Signature: ```typescript -addConductor(signalHandler?: AppSignalCb, config?: string): Promise; +addConductor(signalHandler?: AppSignalCb, partialConfig?: string): Promise; ``` ## Parameters @@ -17,7 +17,7 @@ addConductor(signalHandler?: AppSignalCb, config?: string): Promise(Optional) | -| config | string | (Optional) Conductor configuration (optional). | +| partialConfig | string | (Optional) Conductor configuration (optional). | Returns: diff --git a/docs/tryorama.trycpclient.md b/docs/tryorama.trycpclient.md index 950ce4fd..a2dc80c0 100644 --- a/docs/tryorama.trycpclient.md +++ b/docs/tryorama.trycpclient.md @@ -19,12 +19,13 @@ export declare class TryCpClient | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [conductors](./tryorama.trycpclient.conductors.md) | | [TryCpConductor](./tryorama.trycpconductor.md)\[\] | | +| [signalingServerUrl](./tryorama.trycpclient.signalingserverurl.md) | | string \| undefined | | ## Methods | Method | Modifiers | Description | | --- | --- | --- | -| [addConductor(signalHandler, config)](./tryorama.trycpclient.addconductor.md) | | Create and add a conductor to the client. | +| [addConductor(signalHandler, partialConfig)](./tryorama.trycpclient.addconductor.md) | | Create and add a conductor to the client. | | [call(request)](./tryorama.trycpclient.call.md) | | Send a call to the TryCP server. | | [cleanAllConductors()](./tryorama.trycpclient.cleanallconductors.md) | | Run the reset command on the TryCP server to delete all conductor data. | | [cleanUp()](./tryorama.trycpclient.cleanup.md) | | Shut down all registered conductors and delete them, and close the client connection. | diff --git a/docs/tryorama.trycpclient.signalingserverurl.md b/docs/tryorama.trycpclient.signalingserverurl.md new file mode 100644 index 00000000..7e06031a --- /dev/null +++ b/docs/tryorama.trycpclient.signalingserverurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [TryCpClient](./tryorama.trycpclient.md) > [signalingServerUrl](./tryorama.trycpclient.signalingserverurl.md) + +## TryCpClient.signalingServerUrl property + +Signature: + +```typescript +signalingServerUrl: string | undefined; +``` diff --git a/docs/tryorama.trycpconductor.adminws.md b/docs/tryorama.trycpconductor.adminws.md index 1f2fc5a7..c491031a 100644 --- a/docs/tryorama.trycpconductor.adminws.md +++ b/docs/tryorama.trycpconductor.adminws.md @@ -19,6 +19,7 @@ adminWs(): { deleteCloneCell: (request: DeleteCloneCellRequest) => Promise; disableApp: (request: DisableAppRequest) => Promise; dumpFullState: (request: DumpFullStateRequest) => Promise; + dumpNetworkStats: (request: DumpNetworkStatsRequest) => Promise; dumpState: (request: DumpStateRequest) => Promise<[FullStateDump, string]>; enableApp: (request: EnableAppRequest) => Promise; generateAgentPubKey: () => Promise; @@ -32,12 +33,14 @@ adminWs(): { listDnas: () => Promise; registerDna: (request: RegisterDnaRequest & DnaSource) => Promise; startApp: (request: StartAppRequest) => Promise; + storageInfo: (request: StorageInfoRequest) => Promise; uninstallApp: (request: UninstallAppRequest) => Promise; + updateCoordinators: (request: UpdateCoordinatorsRequest) => Promise; }; ``` Returns: -{ addAgentInfo: (request: AddAgentInfoRequest) => Promise<void>; agentInfo: (req: AgentInfoRequest) => Promise<import("@holochain/client").AgentInfoResponse>; attachAppInterface: (request?: AttachAppInterfaceRequest) => Promise<{ port: number; }>; authorizeSigningCredentials: (cellId: CellId, functions?: GrantedFunctions) => Promise<void>; deleteCloneCell: (request: DeleteCloneCellRequest) => Promise<void>; disableApp: (request: DisableAppRequest) => Promise<null>; dumpFullState: (request: DumpFullStateRequest) => Promise<FullStateDump>; dumpState: (request: DumpStateRequest) => Promise<\[FullStateDump, string\]>; enableApp: (request: EnableAppRequest) => Promise<import("@holochain/client").EnableAppResponse>; generateAgentPubKey: () => Promise<AgentPubKey>; getDnaDefinition: (dnaHash: GetDnaDefinitionRequest) => Promise<DnaDefinition>; grantSigningKey: (cellId: CellId, functions: GrantedFunctions, signingKey: AgentPubKey) => Promise<CapSecret>; grantZomeCallCapability: (request: GrantZomeCallCapabilityRequest) => Promise<void>; installApp: (data: InstallAppRequest) => Promise<import("@holochain/client").AppInfo>; listAppInterfaces: () => Promise<import("@holochain/client").ListAppInterfacesResponse>; listApps: (request: ListAppsRequest) => Promise<import("@holochain/client").ListAppsResponse>; listCellIds: () => Promise<import("@holochain/client").ListCellIdsResponse>; listDnas: () => Promise<import("@holochain/client").ListDnasResponse>; registerDna: (request: RegisterDnaRequest & DnaSource) => Promise<DnaHash>; startApp: (request: StartAppRequest) => Promise<boolean>; uninstallApp: (request: UninstallAppRequest) => Promise<null>; } +{ addAgentInfo: (request: AddAgentInfoRequest) => Promise<void>; agentInfo: (req: AgentInfoRequest) => Promise<import("@holochain/client").AgentInfoResponse>; attachAppInterface: (request?: AttachAppInterfaceRequest) => Promise<{ port: number; }>; authorizeSigningCredentials: (cellId: CellId, functions?: GrantedFunctions) => Promise<void>; deleteCloneCell: (request: DeleteCloneCellRequest) => Promise<void>; disableApp: (request: DisableAppRequest) => Promise<null>; dumpFullState: (request: DumpFullStateRequest) => Promise<FullStateDump>; dumpNetworkStats: (request: DumpNetworkStatsRequest) => Promise<string>; dumpState: (request: DumpStateRequest) => Promise<\[FullStateDump, string\]>; enableApp: (request: EnableAppRequest) => Promise<import("@holochain/client").EnableAppResponse>; generateAgentPubKey: () => Promise<AgentPubKey>; getDnaDefinition: (dnaHash: GetDnaDefinitionRequest) => Promise<DnaDefinition>; grantSigningKey: (cellId: CellId, functions: GrantedFunctions, signingKey: AgentPubKey) => Promise<CapSecret>; grantZomeCallCapability: (request: GrantZomeCallCapabilityRequest) => Promise<void>; installApp: (data: InstallAppRequest) => Promise<import("@holochain/client").AppInfo>; listAppInterfaces: () => Promise<import("@holochain/client").ListAppInterfacesResponse>; listApps: (request: ListAppsRequest) => Promise<import("@holochain/client").ListAppsResponse>; listCellIds: () => Promise<import("@holochain/client").ListCellIdsResponse>; listDnas: () => Promise<import("@holochain/client").ListDnasResponse>; registerDna: (request: RegisterDnaRequest & DnaSource) => Promise<DnaHash>; startApp: (request: StartAppRequest) => Promise<boolean>; storageInfo: (request: StorageInfoRequest) => Promise<import("@holochain/client").StorageInfo>; uninstallApp: (request: UninstallAppRequest) => Promise<null>; updateCoordinators: (request: UpdateCoordinatorsRequest) => Promise<void>; } The Admin API web socket. diff --git a/docs/tryorama.trycpconductor.appws.md b/docs/tryorama.trycpconductor.appws.md index 12469441..abda3464 100644 --- a/docs/tryorama.trycpconductor.appws.md +++ b/docs/tryorama.trycpconductor.appws.md @@ -15,11 +15,12 @@ appWs(): { createCloneCell: (request: CreateCloneCellRequest) => Promise; enableCloneCell: (request: EnableCloneCellRequest) => Promise; disableCloneCell: (request: DisableCloneCellRequest) => Promise; + networkInfo: (request: NetworkInfoRequest) => Promise; }; ``` Returns: -{ appInfo: (request: AppInfoRequest) => Promise<import("@holochain/client").AppInfo>; callZome: <T>(request: CallZomeRequest \| CallZomeRequestSigned) => Promise<T>; createCloneCell: (request: CreateCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; enableCloneCell: (request: EnableCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; disableCloneCell: (request: DisableCloneCellRequest) => Promise<void>; } +{ appInfo: (request: AppInfoRequest) => Promise<import("@holochain/client").AppInfo>; callZome: <T>(request: CallZomeRequest \| CallZomeRequestSigned) => Promise<T>; createCloneCell: (request: CreateCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; enableCloneCell: (request: EnableCloneCellRequest) => Promise<import("@holochain/client").ClonedCell>; disableCloneCell: (request: DisableCloneCellRequest) => Promise<void>; networkInfo: (request: NetworkInfoRequest) => Promise<import("@holochain/client").NetworkInfoResponse>; } The App API web socket. diff --git a/docs/tryorama.trycpscenario.awaitdhtsync.md b/docs/tryorama.trycpscenario.awaitdhtsync.md index 5788a20e..91ab1998 100644 --- a/docs/tryorama.trycpscenario.awaitdhtsync.md +++ b/docs/tryorama.trycpscenario.awaitdhtsync.md @@ -9,7 +9,7 @@ Await DhtOp integration of all players for a given cell. Signature: ```typescript -awaitDhtSync(cellId: CellId): Promise; +awaitDhtSync(cellId: CellId, interval?: number, timeout?: number): Promise; ``` ## Parameters @@ -17,6 +17,8 @@ awaitDhtSync(cellId: CellId): Promise; | Parameter | Type | Description | | --- | --- | --- | | cellId | CellId | Cell id to await DHT sync for. | +| interval | number | (Optional) Interval to pause between comparisons (defaults to 50 ms). | +| timeout | number | (Optional) A timeout for the delay (optional). | Returns: diff --git a/docs/tryorama.trycpscenario.md b/docs/tryorama.trycpscenario.md index aacbd93e..c46e5aec 100644 --- a/docs/tryorama.trycpscenario.md +++ b/docs/tryorama.trycpscenario.md @@ -26,6 +26,8 @@ export declare class TryCpScenario | --- | --- | --- | --- | | [clients](./tryorama.trycpscenario.clients.md) | | [TryCpClient](./tryorama.trycpclient.md)\[\] | | | [network\_seed](./tryorama.trycpscenario.network_seed.md) | | string | | +| [signalingServerProcess](./tryorama.trycpscenario.signalingserverprocess.md) | | ChildProcessWithoutNullStreams \| undefined | | +| [signalingServerUrl](./tryorama.trycpscenario.signalingserverurl.md) | | string \| undefined | | ## Methods @@ -35,7 +37,7 @@ export declare class TryCpScenario | [addClientsPlayers(serverUrls, options)](./tryorama.trycpscenario.addclientsplayers.md) | | Creates client connections for all passed in URLs and, depending on the options, creates multiple players with apps. Adds all clients to the scenario. | | [addPlayersWithApps(tryCpClient, playersApps)](./tryorama.trycpscenario.addplayerswithapps.md) | | Creates and adds multiple players with an installed app to the scenario. | | [addPlayerWithApp(tryCpClient, appBundleSource, options)](./tryorama.trycpscenario.addplayerwithapp.md) | | Creates and adds a single player with an installed app to the scenario, | -| [awaitDhtSync(cellId)](./tryorama.trycpscenario.awaitdhtsync.md) | | Await DhtOp integration of all players for a given cell. | +| [awaitDhtSync(cellId, interval, timeout)](./tryorama.trycpscenario.awaitdhtsync.md) | | Await DhtOp integration of all players for a given cell. | | [cleanUp()](./tryorama.trycpscenario.cleanup.md) | | Shut down and delete all conductors and close all client connections in the scenario. | | [shareAllAgents()](./tryorama.trycpscenario.shareallagents.md) | | Registers all agents of all passed in conductors to each other. This skips peer discovery through gossip and thus accelerates test runs. | | [shutDown()](./tryorama.trycpscenario.shutdown.md) | | Shut down all conductors of all clients in the scenario. | diff --git a/docs/tryorama.trycpscenario.signalingserverprocess.md b/docs/tryorama.trycpscenario.signalingserverprocess.md new file mode 100644 index 00000000..038ded88 --- /dev/null +++ b/docs/tryorama.trycpscenario.signalingserverprocess.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [TryCpScenario](./tryorama.trycpscenario.md) > [signalingServerProcess](./tryorama.trycpscenario.signalingserverprocess.md) + +## TryCpScenario.signalingServerProcess property + +Signature: + +```typescript +signalingServerProcess: ChildProcessWithoutNullStreams | undefined; +``` diff --git a/docs/tryorama.trycpscenario.signalingserverurl.md b/docs/tryorama.trycpscenario.signalingserverurl.md new file mode 100644 index 00000000..54253bff --- /dev/null +++ b/docs/tryorama.trycpscenario.signalingserverurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/tryorama](./tryorama.md) > [TryCpScenario](./tryorama.trycpscenario.md) > [signalingServerUrl](./tryorama.trycpscenario.signalingserverurl.md) + +## TryCpScenario.signalingServerUrl property + +Signature: + +```typescript +signalingServerUrl: string | undefined; +``` diff --git a/package-lock.json b/package-lock.json index 28139cd5..f129abb1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@holochain/tryorama", - "version": "0.12.0", + "version": "0.13.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@holochain/tryorama", - "version": "0.12.0", + "version": "0.13.0", "license": "CAL-1.0", "workspaces": [ "crates/trycp_server/test" diff --git a/package.json b/package.json index aa43b7bb..c2e7ce7c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@holochain/tryorama", "description": "Toolset to manage Holochain conductors and facilitate running test scenarios", - "version": "0.12.0", + "version": "0.13.0", "author": "Holochain Foundation", "keywords": [ "holochain",