feat: Update golem-js API Reference for branch beta

golemfactory · May 30, 2024 · 744eb21 · 744eb21
1 parent 305e193
commit 744eb21
Show file tree

Hide file tree

Showing 372 changed files with 20,914 additions and 12,072 deletions.
diff --git a/src/navigation/jsreference.js b/src/navigation/jsreference.js
diff --git a/src/pages/docs/golem-js/reference/README.md b/src/pages/docs/golem-js/reference/README.md
@@ -50,7 +50,7 @@ distributed, computational loads through Golem Network.
 
 ## System requirements
 
-To use `golem-js`, it is necessary to have yagna installed, with a **minimum version requirement of v0.13.2**. Yagna is a
+To use `golem-js`, it is necessary to have yagna installed, with a **recommended minimum version of v0.14.0**. Yagna is a
 service that communicates and performs operations on the Golem Network, upon your requests via the SDK. You
 can [follow these instructions](https://docs.golem.network/docs/creators/javascript/quickstarts/quickstart#install-yagna-2)
 to set it up.
@@ -72,13 +72,13 @@ yagna service run
 
 # IN SEPARATE TERMINAL (if not daemonized)
 # Initialize your requestor
-yagna payment init --sender --network goerli
+yagna payment init --sender --network holesky
 
 # Request funds on the test network
-yagna payment fund --network goerli
+yagna payment fund --network holesky
 
 # Check the status of the funds
-yagna payment status --network goerli
+yagna payment status --network holesky
 ```
 
 #### Obtain your `app-key` to use with SDK

diff --git a/src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md b/src/pages/docs/golem-js/reference/classes/activity_activity.Activity.md
@@ -13,191 +13,154 @@ As part of a given activity, it is possible to execute exe script commands and c
 
 ## Table of contents
 
+### Constructors
+
+- [constructor](activity_activity.Activity#constructor)
+
 ### Properties
 
+- [events](activity_activity.Activity#events)
 - [id](activity_activity.Activity#id)
 - [agreement](activity_activity.Activity#agreement)
-- [yagnaApi](activity_activity.Activity#yagnaapi)
-- [options](activity_activity.Activity#options)
+- [currentState](activity_activity.Activity#currentstate)
+- [usage](activity_activity.Activity#usage)
 
 ### Methods
 
-- [create](activity_activity.Activity#create)
 - [getProviderInfo](activity_activity.Activity#getproviderinfo)
-- [execute](activity_activity.Activity#execute)
-- [stop](activity_activity.Activity#stop)
+- [createExeScriptExecutor](activity_activity.Activity#createexescriptexecutor)
 - [getState](activity_activity.Activity#getstate)
-- [send](activity_activity.Activity#send)
-
-## Properties
 
-### id
-
-• `Readonly` **id**: `string`
+## Constructors
 
-activity ID
+### constructor
 
-#### Defined in
+• **new Activity**(`id`, `agreement`, `currentState?`, `usage`): [`Activity`](activity_activity.Activity)
 
-[src/activity/activity.ts:62](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L62)
-
-___
+#### Parameters
 
-### agreement
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `id` | `string` | `undefined` | The ID of the activity in Yagna |
+| `agreement` | [`Agreement`](market_agreement_agreement.Agreement) | `undefined` | The agreement that's related to this activity |
+| `currentState` | [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum) | `ActivityStateEnum.New` | The current state as it was obtained from yagna |
+| `usage` | `ActivityUsageInfo` | `undefined` | Current resource usage vector information |
 
-• `Readonly` **agreement**: `Agreement`
+#### Returns
 
-Agreement
+[`Activity`](activity_activity.Activity)
 
 #### Defined in
 
-[src/activity/activity.ts:63](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L63)
+[src/activity/activity.ts:50](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L50)
 
-___
-
-### yagnaApi
+## Properties
 
-• `Protected` `Readonly` **yagnaApi**: [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi)
+### events
 
-[YagnaApi](../modules/utils_yagna_yagna#yagnaapi)
+• `Readonly` **events**: `EventEmitter`\<[`ActivityEvents`](../interfaces/activity_activity.ActivityEvents), `any`\>
 
 #### Defined in
 
-[src/activity/activity.ts:64](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L64)
+[src/activity/activity.ts:42](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L42)
 
 ___
 
-### options
+### id
 
-• `Protected` `Readonly` **options**: `ActivityConfig`
+• `Readonly` **id**: `string`
 
-[ActivityOptions](../interfaces/activity_activity.ActivityOptions)
+The ID of the activity in Yagna
 
 #### Defined in
 
-[src/activity/activity.ts:65](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L65)
-
-## Methods
-
-### create
+[src/activity/activity.ts:51](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L51)
 
-▸ **create**(`agreement`, `yagnaApi`, `options?`, `secure?`): `Promise`\<[`Activity`](activity_activity.Activity)\>
-
-Create activity for given agreement ID
-
-#### Parameters
-
-| Name | Type | Default value | Description |
-| :------ | :------ | :------ | :------ |
-| `agreement` | `Agreement` | `undefined` |  |
-| `yagnaApi` | [`YagnaApi`](../modules/utils_yagna_yagna#yagnaapi) | `undefined` |  |
-| `options?` | [`ActivityOptions`](../interfaces/activity_activity.ActivityOptions) | `undefined` | [ActivityOptions](../interfaces/activity_activity.ActivityOptions) |
-| `secure` | `boolean` | `false` | defines if activity will be secure type |
+___
 
-#### Returns
+### agreement
 
-`Promise`\<[`Activity`](activity_activity.Activity)\>
+• `Readonly` **agreement**: [`Agreement`](market_agreement_agreement.Agreement)
 
-Activity
+The agreement that's related to this activity
 
 #### Defined in
 
-[src/activity/activity.ts:79](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L79)
+[src/activity/activity.ts:52](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L52)
 
 ___
 
-### getProviderInfo
-
-▸ **getProviderInfo**(): [`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo)
+### currentState
 
-#### Returns
+• `Protected` `Readonly` **currentState**: [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum) = `ActivityStateEnum.New`
 
-[`ProviderInfo`](../interfaces/agreement_agreement.ProviderInfo)
+The current state as it was obtained from yagna
 
 #### Defined in
 
-[src/activity/activity.ts:89](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L89)
+[src/activity/activity.ts:53](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L53)
 
 ___
 
-### execute
-
-▸ **execute**(`script`, `stream?`, `timeout?`): `Promise`\<`Readable`\>
+### usage
 
-Execute script
-
-#### Parameters
+• `Protected` `Readonly` **usage**: `ActivityUsageInfo`
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `script` | [`ExeScriptRequest`](../interfaces/activity_activity.ExeScriptRequest) | exe script request |
-| `stream?` | `boolean` | define type of getting results from execution (polling or streaming) |
-| `timeout?` | `number` | execution timeout |
-
-#### Returns
-
-`Promise`\<`Readable`\>
+Current resource usage vector information
 
 #### Defined in
 
-[src/activity/activity.ts:100](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L100)
+[src/activity/activity.ts:54](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L54)
 
-___
-
-### stop
+## Methods
 
-▸ **stop**(): `Promise`\<`boolean`\>
+### getProviderInfo
 
-Stop and destroy activity
+▸ **getProviderInfo**(): [`ProviderInfo`](../interfaces/market_agreement_agreement.ProviderInfo)
 
 #### Returns
 
-`Promise`\<`boolean`\>
-
-boolean
+[`ProviderInfo`](../interfaces/market_agreement_agreement.ProviderInfo)
 
 #### Defined in
 
-[src/activity/activity.ts:138](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L138)
+[src/activity/activity.ts:57](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L57)
 
 ___
 
-### getState
-
-▸ **getState**(): `Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\>
+### createExeScriptExecutor
 
-Getting current state of activity
+▸ **createExeScriptExecutor**(`activityControl`, `execObserver`, `logger`, `options?`): [`ExeScriptExecutor`](activity_exe_script_executor.ExeScriptExecutor)
 
-#### Returns
+Temporary helper method that will build a script executor bound to this activity
 
-`Promise`\<[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)\>
+#### Parameters
 
-state
+| Name | Type |
+| :------ | :------ |
+| `activityControl` | `RequestorControlService` |
+| `execObserver` | [`YagnaExeScriptObserver`](../interfaces/shared_yagna_yagnaApi.YagnaExeScriptObserver) |
+| `logger` | [`Logger`](../interfaces/shared_utils_logger_logger.Logger) |
+| `options?` | [`ExecutionOptions`](../interfaces/activity_exe_script_executor.ExecutionOptions) |
 
-**`Throws`**
+#### Returns
 
-Error when cannot query the state
+[`ExeScriptExecutor`](activity_exe_script_executor.ExeScriptExecutor)
 
 #### Defined in
 
-[src/activity/activity.ts:150](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L150)
+[src/activity/activity.ts:64](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L64)
 
 ___
 
-### send
-
-▸ **send**(`script`): `Promise`\<`string`\>
-
-#### Parameters
+### getState
 
-| Name | Type |
-| :------ | :------ |
-| `script` | [`ExeScriptRequest`](../interfaces/activity_activity.ExeScriptRequest) |
+▸ **getState**(): [`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)
 
 #### Returns
 
-`Promise`\<`string`\>
+[`ActivityStateEnum`](../enums/activity_activity.ActivityStateEnum)
 
 #### Defined in
 
-[src/activity/activity.ts:176](https://github.com/golemfactory/golem-js/blob/7cee55b/src/activity/activity.ts#L176)
+[src/activity/activity.ts:73](https://github.com/golemfactory/golem-js/blob/9425cda1/src/activity/activity.ts#L73)