update docs

Author: portuu3

docs/sdk/python/human_protocol_sdk.escrow.escrow_client.md

@@ -87,7 +87,7 @@ Creates a prepared transaction for bulk payout without signing or sending it.
 * **Parameters:**
   * **escrow_address** (`str`) – Address of the escrow
   * **recipients** (`List`[`str`]) – Array of recipient addresses
-  * **amounts** (`List`[`Decimal`]) – Array of amounts the recipients will receive
+  * **amounts** (`List`[`int`]) – Array of amounts the recipients will receive
   * **final_results_url** (`str`) – Final results file URL
   * **final_results_hash** (`str`) – Final results file hash
   * **payoutId** (`str`) – Unique identifier for the payout
@@ -157,14 +157,16 @@ Creates a prepared transaction for bulk payout without signing or sending it.
 
 #### create_escrow(\*args, \*\*kwargs)
 
+#### create_fund_and_setup_escrow(\*args, \*\*kwargs)
+
 #### ensure_correct_bulk_payout_input(escrow_address, recipients, amounts, final_results_url, final_results_hash)
 
 Validates input parameters for bulk payout operations.
 
 * **Parameters:**
   * **escrow_address** (`str`) – Address of the escrow
   * **recipients** (`List`[`str`]) – Array of recipient addresses
-  * **amounts** (`List`[`Decimal`]) – Array of amounts the recipients will receive
+  * **amounts** (`List`[`int`]) – Array of amounts the recipients will receive
   * **final_results_url** (`str`) – Final results file URL
   * **final_results_hash** (`str`) – Final results file hash
 * **Return type:**
@@ -183,7 +185,7 @@ Gets the balance for a specified escrow address.
 * **Parameters:**
   **escrow_address** (`str`) – Address of the escrow
 * **Return type:**
-  `Decimal`
+  `int`
 * **Returns:**
   Value of the balance
 * **Raises:**
@@ -463,7 +465,7 @@ Gets the reserved funds for a specified escrow address.
 * **Parameters:**
   **escrow_address** (`str`) – Address of the escrow
 * **Return type:**
-  `Decimal`
+  `int`
 * **Returns:**
   Value of the reserved funds
 * **Raises:**
@@ -595,8 +597,8 @@ Initializes a Escrow instance.
 * **Parameters:**
   * **recording_oracle_address** (`str`) – Address of the Recording Oracle
   * **reputation_oracle_address** (`str`) – Address of the Reputation Oracle
-  * **recording_oracle_fee** (`Decimal`) – Fee percentage of the Recording Oracle
-  * **reputation_oracle_fee** (`Decimal`) – Fee percentage of the Reputation Oracle
+  * **recording_oracle_fee** (`int`) – Fee percentage of the Recording Oracle
+  * **reputation_oracle_fee** (`int`) – Fee percentage of the Reputation Oracle
   * **manifest** (`str`) – Manifest data (can be a URL or JSON string)
   * **hash** (`str`) – Manifest file hash
 

docs/sdk/python/human_protocol_sdk.escrow.escrow_utils.md

@@ -32,34 +32,35 @@ Represents a cancellation refund event.
   * **id** (`str`) – The unique identifier for the cancellation refund event.
   * **escrow_address** (`str`) – The address of the escrow associated with the refund.
   * **receiver** (`str`) – The address of the recipient receiving the refund.
-  * **amount** (`int`) – The amount being refunded.
-  * **block** (`int`) – The block number in which the refund was processed.
-  * **timestamp** (`int`) – The timestamp of the refund event.
+  * **amount** (`str`) – The amount being refunded.
+  * **block** (`str`) – The block number in which the refund was processed.
+  * **timestamp** (`str`) – The timestamp of the refund event in milliseconds.
   * **tx_hash** (`str`) – The transaction hash of the refund event.
 
 #### \_\_init_\_(id, escrow_address, receiver, amount, block, timestamp, tx_hash)
 
-### *class* human_protocol_sdk.escrow.escrow_utils.EscrowData(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, status, token, total_funded_amount, created_at, final_results_url=None, final_results_hash=None, intermediate_results_url=None, intermediate_results_hash=None, manifest_hash=None, manifest=None, recording_oracle=None, reputation_oracle=None, exchange_oracle=None, recording_oracle_fee=None, reputation_oracle_fee=None, exchange_oracle_fee=None)
+### *class* human_protocol_sdk.escrow.escrow_utils.EscrowData(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, job_requester_id, status, token, total_funded_amount, created_at, final_results_url=None, final_results_hash=None, intermediate_results_url=None, intermediate_results_hash=None, manifest_hash=None, manifest=None, recording_oracle=None, reputation_oracle=None, exchange_oracle=None, recording_oracle_fee=None, reputation_oracle_fee=None, exchange_oracle_fee=None)
 
 Bases: `object`
 
-#### \_\_init_\_(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, status, token, total_funded_amount, created_at, final_results_url=None, final_results_hash=None, intermediate_results_url=None, intermediate_results_hash=None, manifest_hash=None, manifest=None, recording_oracle=None, reputation_oracle=None, exchange_oracle=None, recording_oracle_fee=None, reputation_oracle_fee=None, exchange_oracle_fee=None)
+#### \_\_init_\_(chain_id, id, address, amount_paid, balance, count, factory_address, launcher, job_requester_id, status, token, total_funded_amount, created_at, final_results_url=None, final_results_hash=None, intermediate_results_url=None, intermediate_results_hash=None, manifest_hash=None, manifest=None, recording_oracle=None, reputation_oracle=None, exchange_oracle=None, recording_oracle_fee=None, reputation_oracle_fee=None, exchange_oracle_fee=None)
 
 Initializes an EscrowData instance.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain identifier
   * **id** (`str`) – Identifier
   * **address** (`str`) – Address
-  * **amount_paid** (`int`) – Amount paid
-  * **balance** (`int`) – Balance
-  * **count** (`int`) – Count
+  * **amount_paid** (`str`) – Amount paid
+  * **balance** (`str`) – Balance
+  * **count** (`str`) – Count
   * **factory_address** (`str`) – Factory address
   * **launcher** (`str`) – Launcher
+  * **job_requester_id** (`Optional`[`str`]) – Job requester identifier
   * **status** (`str`) – Status
   * **token** (`str`) – Token
-  * **total_funded_amount** (`int`) – Total funded amount
-  * **created_at** (`datetime`) – Creation date
+  * **total_funded_amount** (`str`) – Total funded amount
+  * **created_at** (`str`) – Creation timestamp in milliseconds
   * **final_results_url** (`Optional`[`str`]) – URL for final results.
   * **final_results_hash** (`Optional`[`str`]) – Hash for final results.
   * **intermediate_results_url** (`Optional`[`str`]) – URL for intermediate results.
@@ -69,9 +70,9 @@ Initializes an EscrowData instance.
   * **recording_oracle** (`Optional`[`str`]) – Recording Oracle address.
   * **reputation_oracle** (`Optional`[`str`]) – Reputation Oracle address.
   * **exchange_oracle** (`Optional`[`str`]) – Exchange Oracle address.
-  * **recording_oracle_fee** (`Optional`[`int`]) – Fee for the Recording Oracle.
-  * **reputation_oracle_fee** (`Optional`[`int`]) – Fee for the Reputation Oracle.
-  * **exchange_oracle_fee** (`Optional`[`int`]) – Fee for the Exchange Oracle.
+  * **recording_oracle_fee** (`Optional`[`str`]) – Fee for the Recording Oracle.
+  * **reputation_oracle_fee** (`Optional`[`str`]) – Fee for the Reputation Oracle.
+  * **exchange_oracle_fee** (`Optional`[`str`]) – Fee for the Exchange Oracle.
 
 ### *class* human_protocol_sdk.escrow.escrow_utils.EscrowUtils
 
@@ -204,8 +205,8 @@ Initializes a Payout instance.
   * **chain_id** – The chain identifier where the payout occurred.
   * **escrow_address** (`str`) – The address of the escrow that executed the payout.
   * **recipient** (`str`) – The address of the recipient.
-  * **amount** (`int`) – The amount of the payout.
-  * **created_at** (`int`) – The time of creation of the payout.
+  * **amount** (`str`) – The amount of the payout.
+  * **created_at** (`str`) – The time of creation of the payout in milliseconds.
 
 #### \_\_init_\_(id, escrow_address, recipient, amount, created_at)
 
@@ -216,7 +217,7 @@ Bases: `object`
 Initializes a StatusEvent instance.
 
 * **Parameters:**
-  * **timestamp** (`int`) – The timestamp of the event.
+  * **timestamp** (`int`) – The timestamp of the event in milliseconds.
   * **status** (`str`) – The status of the escrow.
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – The chain identifier where the event occurred.
   * **escrow_address** (`str`) – The address of the escrow.

docs/sdk/python/human_protocol_sdk.escrow.md

@@ -17,6 +17,7 @@ obtain information from both the contracts and subgraph.
     * [`EscrowClient.complete()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.complete)
     * [`EscrowClient.create_bulk_payout_transaction()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.create_bulk_payout_transaction)
     * [`EscrowClient.create_escrow()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.create_escrow)
+    * [`EscrowClient.create_fund_and_setup_escrow()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.create_fund_and_setup_escrow)
     * [`EscrowClient.ensure_correct_bulk_payout_input()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.ensure_correct_bulk_payout_input)
     * [`EscrowClient.fund()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.fund)
     * [`EscrowClient.get_balance()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.get_balance)

docs/sdk/python/human_protocol_sdk.operator.operator_utils.md

@@ -17,34 +17,34 @@ print(
 
 ## Module
 
-### *class* human_protocol_sdk.operator.operator_utils.OperatorData(chain_id, id, address, staked_amount, locked_amount, locked_until_timestamp, withdrawn_amount, slashed_amount, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None, name=None, category=None)
+### *class* human_protocol_sdk.operator.operator_utils.OperatorData(chain_id, id, address, amount_jobs_processed, reputation_networks, staked_amount=None, locked_amount=None, locked_until_timestamp=None, withdrawn_amount=None, slashed_amount=None, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, name=None, category=None)
 
 Bases: `object`
 
-#### \_\_init_\_(chain_id, id, address, staked_amount, locked_amount, locked_until_timestamp, withdrawn_amount, slashed_amount, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None, name=None, category=None)
+#### \_\_init_\_(chain_id, id, address, amount_jobs_processed, reputation_networks, staked_amount=None, locked_amount=None, locked_until_timestamp=None, withdrawn_amount=None, slashed_amount=None, role=None, fee=None, public_key=None, webhook_url=None, website=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, name=None, category=None)
 
 Initializes a OperatorData instance.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain Identifier
   * **id** (`str`) – Identifier
   * **address** (`str`) – Address
-  * **staked_amount** (`int`) – Amount staked
-  * **locked_amount** (`int`) – Amount locked
-  * **locked_until_timestamp** (`int`) – Locked until timestamp
-  * **withdrawn_amount** (`int`) – Amount withdrawn
-  * **slashed_amount** (`int`) – Amount slashed
-  * **amount_jobs_processed** (`int`) – Amount of jobs launched
+  * **staked_amount** (`Optional`[`str`]) – Amount staked
+  * **locked_amount** (`Optional`[`str`]) – Amount locked
+  * **locked_until_timestamp** (`Optional`[`str`]) – Locked until timestamp
+  * **withdrawn_amount** (`Optional`[`str`]) – Amount withdrawn
+  * **slashed_amount** (`Optional`[`str`]) – Amount slashed
+  * **amount_jobs_processed** (`str`) – Amount of jobs launched
   * **role** (`Optional`[`str`]) – Role
-  * **fee** (`Optional`[`int`]) – Fee
+  * **fee** (`Optional`[`str`]) – Fee
   * **public_key** (`Optional`[`str`]) – Public key
   * **webhook_url** (`Optional`[`str`]) – Webhook URL
   * **website** (`Optional`[`str`]) – Website URL
   * **url** (`Optional`[`str`]) – URL
-  * **job_types** (`Optional`[`List`[`str`]]) – Job types
+  * **job_types** (`Union`[`List`[`str`], `str`, `None`]) – Job types
   * **registration_needed** (`Optional`[`bool`]) – Whether registration is needed
   * **registration_instructions** (`Optional`[`str`]) – Registration instructions
-  * **reputation_networks** (`Optional`[`List`[`str`]]) – List of reputation networks
+  * **reputation_networks** (`Union`[`List`[`str`], `str`]) – List of reputation networks
   * **name** (`Optional`[`str`]) – Name
   * **category** (`Optional`[`str`]) – Category
 

docs/sdk/python/human_protocol_sdk.utils.md

@@ -68,7 +68,7 @@ Get HMT balance
   * **token_addr** – ERC-20 contract
   * **w3** – Web3 instance
 * **Returns:**
-  Decimal with HMT balance
+  HMT balance (wei)
 
 ### human_protocol_sdk.utils.get_kvstore_interface()
 

docs/sdk/python/human_protocol_sdk.worker.worker_utils.md

@@ -11,8 +11,8 @@ Initializes a WorkerData instance.
 * **Parameters:**
   * **id** (`str`) – Worker ID
   * **address** (`str`) – Worker address
-  * **total_amount_received** (`int`) – Total amount received by the worker
-  * **payout_count** (`int`) – Number of payouts received by the worker
+  * **total_amount_received** (`str`) – Total amount received by the worker
+  * **payout_count** (`str`) – Number of payouts received by the worker
 
 ### *class* human_protocol_sdk.worker.worker_utils.WorkerUtils
 

docs/sdk/typescript/base/classes/BaseEthersClient.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: BaseEthersClient
 
-Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
 
 ## Introduction
 
@@ -24,7 +24,7 @@ This class is used as a base class for other clients making on-chain calls.
 
 > **new BaseEthersClient**(`runner`, `networkData`): `BaseEthersClient`
 
-Defined in: [base.ts:22](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L22)
+Defined in: [base.ts:22](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L22)
 
 **BaseClient constructor**
 
@@ -52,23 +52,23 @@ The network information required to connect to the contracts
 
 > **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
 
-Defined in: [base.ts:14](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L14)
+Defined in: [base.ts:14](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L14)
 
 ***
 
 ### runner
 
 > `protected` **runner**: `ContractRunner`
 
-Defined in: [base.ts:13](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L13)
+Defined in: [base.ts:13](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L13)
 
 ## Methods
 
 ### applyTxDefaults()
 
 > `protected` **applyTxDefaults**(`txOptions`): `Overrides`
 
-Defined in: [base.ts:35](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L35)
+Defined in: [base.ts:35](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L35)
 
 Internal helper to enrich transaction overrides with network specific defaults.
 

docs/sdk/typescript/encryption/classes/Encryption.md

@@ -6,7 +6,7 @@
 
 # Class: Encryption
 
-Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
+Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
 
 ## Introduction
 
@@ -53,7 +53,7 @@ const encryption = await Encryption.build(privateKey, passphrase);
 
 > **new Encryption**(`privateKey`): `Encryption`
 
-Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
+Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
 
 Constructor for the Encryption class.
 
@@ -75,7 +75,7 @@ The private key.
 
 > **decrypt**(`message`, `publicKey?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
-Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
+Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
 
 This function decrypts messages using the private key. In addition, the public key can be added for signature verification.
 
@@ -129,7 +129,7 @@ const resultMessage = await encryption.decrypt('message');
 
 > **sign**(`message`): `Promise`\<`string`\>
 
-Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
+Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
 
 This function signs a message using the private key used to initialize the client.
 
@@ -165,7 +165,7 @@ const resultMessage = await encryption.sign('message');
 
 > **signAndEncrypt**(`message`, `publicKeys`): `Promise`\<`string`\>
 
-Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
+Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
 
 This function signs and encrypts a message using the private key used to initialize the client and the specified public keys.
 
@@ -232,7 +232,7 @@ const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
 
 > `static` **build**(`privateKeyArmored`, `passphrase?`): `Promise`\<`Encryption`\>
 
-Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/c6ab6b31903af39ac6b3e92bd60cecc017b01413/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
+Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/a460e0373bed2561750dc72b5678e23706f5b4ef/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
 
 Builds an Encryption instance by decrypting the private key from an encrypted private key and passphrase.