Merge branch 'subgraph-upgrades' into feat/dashboard/leaders-link

Author: flopez7

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

@@ -73,45 +73,6 @@ Initializes a Escrow instance.
 * **Parameters:**
   **web3** (`Web3`) – The Web3 object
 
-#### abort(escrow_address, tx_options=None)
-
-Cancels the specified escrow,
-sends the balance to the canceler and selfdestructs the escrow contract.
-
-* **Parameters:**
-  * **escrow_address** (`str`) – Address of the escrow to abort
-  * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
-  `None`
-* **Returns:**
-  None
-* **Raises:**
-  [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an error occurs while checking the parameters
-* **Example:**
-  ```python
-  from eth_typing import URI
-  from web3 import Web3
-  from web3.middleware import construct_sign_and_send_raw_middleware
-  from web3.providers.auto import load_provider_from_uri
-
-  from human_protocol_sdk.escrow import EscrowClient
-
-  def get_w3_with_priv_key(priv_key: str):
-      w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
-      gas_payer = w3.eth.account.from_key(priv_key)
-      w3.eth.default_account = gas_payer.address
-      w3.middleware_onion.add(
-          construct_sign_and_send_raw_middleware(gas_payer),
-          "construct_sign_and_send_raw_middleware",
-      )
-      return (w3, gas_payer)
-
-  (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
-  escrow_client = EscrowClient(w3)
-
-  escrow_client.abort("0x62dD51230A30401C455c8398d06F85e4EaB6309f")
-  ```
-
 #### add_trusted_handlers(escrow_address, handlers, tx_options=None)
 
 Adds an array of addresses to the trusted handlers list.
@@ -301,67 +262,6 @@ Sets the status of an escrow to completed.
   escrow_client.complete("0x62dD51230A30401C455c8398d06F85e4EaB6309f")
   ```
 
-#### create_and_setup_escrow(token_address, trusted_handlers, job_requester_id, escrow_config)
-
-Creates and sets up an escrow.
-
-* **Parameters:**
-  * **token_address** (`str`) – Token to use for pay outs
-  * **trusted_handlers** (`List`[`str`]) – Array of addresses that can perform actions on the contract
-  * **job_requester_id** (`str`) – The id of the job requester
-  * **escrow_config** ([`EscrowConfig`](#human_protocol_sdk.escrow.escrow_client.EscrowConfig)) – Object containing all the necessary information to setup an escrow
-* **Return type:**
-  `str`
-* **Returns:**
-  The address of the escrow created
-* **Raises:**
-  [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an error occurs while checking the parameters
-* **Example:**
-  ```python
-  from eth_typing import URI
-  from web3 import Web3
-  from web3.middleware import construct_sign_and_send_raw_middleware
-  from web3.providers.auto import load_provider_from_uri
-
-  from human_protocol_sdk.escrow import EscrowClient
-
-  def get_w3_with_priv_key(priv_key: str):
-      w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
-      gas_payer = w3.eth.account.from_key(priv_key)
-      w3.eth.default_account = gas_payer.address
-      w3.middleware_onion.add(
-          construct_sign_and_send_raw_middleware(gas_payer),
-          "construct_sign_and_send_raw_middleware",
-      )
-      return (w3, gas_payer)
-
-  (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
-  escrow_client = EscrowClient(w3)
-
-  token_address = '0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4'
-  trusted_handlers = [
-      '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
-      '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
-  ]
-  job_requester_id = 'job-requester'
-  escrow_config = EscrowConfig(
-      "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-      "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-      "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
-      10,
-      10,
-      10,
-      "htttp://localhost/manifest.json",
-      "b5dad76bf6772c0f07fd5e048f6e75a5f86ee079",
-  )
-  escrow_address = escrow_client.create_and_setup_escrow(
-      token_address,
-      trusted_handlers,
-      job_requester_id,
-      escrow_config
-  )
-  ```
-
 #### create_escrow(token_address, trusted_handlers, job_requester_id, tx_options=None)
 
 Creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
@@ -882,6 +782,52 @@ Stores the results url.
   )
   ```
 
+#### withdraw(escrow_address, token_address, tx_options=None)
+
+Withdraws additional tokens in the escrow to the canceler.
+
+* **Parameters:**
+  * **escrow_address** (`str`) – Address of the escrow to withdraw
+  * **token_address** (`str`) – Address of the token to withdraw
+  * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
+* **Return type:**
+  [`EscrowWithdraw`](#human_protocol_sdk.escrow.escrow_client.EscrowWithdraw)
+* **Returns:**
+  EscrowWithdraw:
+  An instance of the EscrowWithdraw class containing details of the withdrawal transaction,
+  including the transaction hash and the token address and amount withdrawn.
+* **Raises:**
+  * [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If an error occurs while checking the parameters
+  * [**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If the transfer event associated with the withdrawal
+    is not found in the transaction logs
+* **Example:**
+  ```python
+  from eth_typing import URI
+  from web3 import Web3
+  from web3.middleware import construct_sign_and_send_raw_middleware
+  from web3.providers.auto import load_provider_from_uri
+
+  from human_protocol_sdk.escrow import EscrowClient
+
+  def get_w3_with_priv_key(priv_key: str):
+      w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
+      gas_payer = w3.eth.account.from_key(priv_key)
+      w3.eth.default_account = gas_payer.address
+      w3.middleware_onion.add(
+          construct_sign_and_send_raw_middleware(gas_payer),
+          "construct_sign_and_send_raw_middleware",
+      )
+      return (w3, gas_payer)
+
+  (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
+  escrow_client = EscrowClient(w3)
+
+  escrow_cancel_data = escrow_client.withdraw(
+      "0x62dD51230A30401C455c8398d06F85e4EaB6309f",
+      "0x0376D26246Eb35FF4F9924cF13E6C05fd0bD7Fb4"
+  )
+  ```
+
 ### *exception* human_protocol_sdk.escrow.escrow_client.EscrowClientError
 
 Bases: `Exception`
@@ -905,3 +851,16 @@ Initializes a Escrow instance.
   * **reputation_oracle_fee** (`Decimal`) – Fee percentage of the Reputation Oracle
   * **manifest_url** (`str`) – Manifest file url
   * **hash** (`str`) – Manifest file hash
+
+### *class* human_protocol_sdk.escrow.escrow_client.EscrowWithdraw(tx_hash, token_address, amount_withdrawn)
+
+Bases: `object`
+
+#### \_\_init_\_(tx_hash, token_address, amount_withdrawn)
+
+Represents the result of an escrow cancellation transaction.
+
+* **Parameters:**
+  * **tx_hash** (`str`) – The hash of the transaction associated with the escrow withdrawal.
+  * **token_address** (`str`) – The address of the token used for the withdrawal.
+  * **amount_withdrawn** (`any`) – The amount withdrawn from the escrow.

docs/sdk/python/human_protocol_sdk.escrow.md

@@ -12,12 +12,10 @@ obtain information from both the contracts and subgraph.
     * [`EscrowCancel.__init__()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowCancel.__init__)
   * [`EscrowClient`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient)
     * [`EscrowClient.__init__()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.__init__)
-    * [`EscrowClient.abort()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.abort)
     * [`EscrowClient.add_trusted_handlers()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.add_trusted_handlers)
     * [`EscrowClient.bulk_payout()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.bulk_payout)
     * [`EscrowClient.cancel()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.cancel)
     * [`EscrowClient.complete()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.complete)
-    * [`EscrowClient.create_and_setup_escrow()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.create_and_setup_escrow)
     * [`EscrowClient.create_escrow()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.create_escrow)
     * [`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)
@@ -34,9 +32,12 @@ obtain information from both the contracts and subgraph.
     * [`EscrowClient.get_token_address()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.get_token_address)
     * [`EscrowClient.setup()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.setup)
     * [`EscrowClient.store_results()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.store_results)
+    * [`EscrowClient.withdraw()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient.withdraw)
   * [`EscrowClientError`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClientError)
   * [`EscrowConfig`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowConfig)
     * [`EscrowConfig.__init__()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowConfig.__init__)
+  * [`EscrowWithdraw`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowWithdraw)
+    * [`EscrowWithdraw.__init__()`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowWithdraw.__init__)
 * [human_protocol_sdk.escrow.escrow_utils module](human_protocol_sdk.escrow.escrow_utils.md)
   * [Code Example](human_protocol_sdk.escrow.escrow_utils.md#code-example)
   * [Module](human_protocol_sdk.escrow.escrow_utils.md#module)

docs/sdk/python/human_protocol_sdk.kvstore.md

@@ -13,3 +13,13 @@ This module allows the contract interaction with the key value storage on chain.
     * [`KVStoreClient.set_bulk()`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClient.set_bulk)
     * [`KVStoreClient.set_file_url_and_hash()`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClient.set_file_url_and_hash)
   * [`KVStoreClientError`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClientError)
+* [human_protocol_sdk.kvstore.kvstore_utils module](human_protocol_sdk.kvstore.kvstore_utils.md)
+  * [Code Example](human_protocol_sdk.kvstore.kvstore_utils.md#code-example)
+  * [Module](human_protocol_sdk.kvstore.kvstore_utils.md#module)
+  * [`KVStoreData`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData)
+    * [`KVStoreData.__init__()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData.__init__)
+  * [`KVStoreUtils`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils)
+    * [`KVStoreUtils.get()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get)
+    * [`KVStoreUtils.get_file_url_and_verify_hash()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_file_url_and_verify_hash)
+    * [`KVStoreUtils.get_kvstore_data()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_kvstore_data)
+    * [`KVStoreUtils.get_public_key()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_public_key)

docs/sdk/python/human_protocol_sdk.md

@@ -40,6 +40,7 @@
       * [`EscrowClient`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClient)
       * [`EscrowClientError`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowClientError)
       * [`EscrowConfig`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowConfig)
+      * [`EscrowWithdraw`](human_protocol_sdk.escrow.escrow_client.md#human_protocol_sdk.escrow.escrow_client.EscrowWithdraw)
     * [human_protocol_sdk.escrow.escrow_utils module](human_protocol_sdk.escrow.escrow_utils.md)
       * [Code Example](human_protocol_sdk.escrow.escrow_utils.md#code-example)
       * [Module](human_protocol_sdk.escrow.escrow_utils.md#module)
@@ -53,6 +54,13 @@
       * [Module](human_protocol_sdk.kvstore.kvstore_client.md#module)
       * [`KVStoreClient`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClient)
       * [`KVStoreClientError`](human_protocol_sdk.kvstore.kvstore_client.md#human_protocol_sdk.kvstore.kvstore_client.KVStoreClientError)
+<<<<<<< HEAD
+    * [human_protocol_sdk.kvstore.kvstore_utils module](human_protocol_sdk.kvstore.kvstore_utils.md)
+      * [Code Example](human_protocol_sdk.kvstore.kvstore_utils.md#code-example)
+      * [Module](human_protocol_sdk.kvstore.kvstore_utils.md#module)
+      * [`KVStoreData`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreData)
+      * [`KVStoreUtils`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils)
+=======
 * [human_protocol_sdk.kvstore.kvstore_utils module](human_protocol_sdk.kvstore.kvstore_utils.md)
   * [Code Example](human_protocol_sdk.kvstore.kvstore_utils.md#code-example)
   * [Module](human_protocol_sdk.kvstore.kvstore_utils.md#module)
@@ -63,6 +71,7 @@
     * [`KVStoreUtils.get_file_url_and_verify_hash()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_file_url_and_verify_hash)
     * [`KVStoreUtils.get_kvstore_data()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_kvstore_data)
     * [`KVStoreUtils.get_public_key()`](human_protocol_sdk.kvstore.kvstore_utils.md#human_protocol_sdk.kvstore.kvstore_utils.KVStoreUtils.get_public_key)
+>>>>>>> develop
 * [human_protocol_sdk.operator package](human_protocol_sdk.operator.md)
   * [Submodules](human_protocol_sdk.operator.md#submodules)
     * [human_protocol_sdk.operator.operator_utils module](human_protocol_sdk.operator.operator_utils.md)
@@ -118,6 +127,10 @@
       * [`TransactionData`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionData)
       * [`TransactionUtils`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils)
       * [`TransactionUtilsError`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtilsError)
+<<<<<<< HEAD
+      * [`Transfer`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.Transfer)
+=======
+>>>>>>> develop
 
 ## Submodules
 

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

@@ -17,11 +17,27 @@ print(
 
 ## Module
 
+<<<<<<< HEAD
+<<<<<<< HEAD
+### *class* human_protocol_sdk.operator.operator_utils.LeaderData(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None)
+
+Bases: `object`
+
+#### \_\_init_\_(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None, registration_needed=None, registration_instructions=None, reputation_networks=None)
+=======
+### *class* human_protocol_sdk.operator.operator_utils.LeaderData(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None)
+
+Bases: `object`
+
+#### \_\_init_\_(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None)
+>>>>>>> parent of cc79357b2 ([Subgraph][SDK] Add registration data to leaders entity (#2451))
+=======
 ### *class* human_protocol_sdk.operator.operator_utils.LeaderData(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reputation, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None, registration_needed=None, registration_instructions=None)
 
 Bases: `object`
 
 #### \_\_init_\_(chain_id, id, address, amount_staked, amount_allocated, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reputation, reward, amount_jobs_processed, role=None, fee=None, public_key=None, webhook_url=None, url=None, job_types=None, registration_needed=None, registration_instructions=None)
+>>>>>>> develop
 
 Initializes an LeaderData instance.
 
@@ -35,7 +51,6 @@ Initializes an LeaderData instance.
   * **locked_until_timestamp** (`int`) – Locked until timestamp
   * **amount_withdrawn** (`int`) – Amount withdrawn
   * **amount_slashed** (`int`) – Amount slashed
-  * **reputation** (`int`) – Reputation
   * **reward** (`int`) – Reward
   * **amount_jobs_processed** (`int`) – Amount of jobs launched
   * **role** (`Optional`[`str`]) – Role
@@ -44,8 +59,17 @@ Initializes an LeaderData instance.
   * **webhook_url** (`Optional`[`str`]) – Webhook url
   * **url** (`Optional`[`str`]) – Url
   * **job_types** (`Optional`[`List`[`str`]]) – Job types
+<<<<<<< HEAD
+<<<<<<< HEAD
+  * **reputation_networks** (`Optional`[`List`[`str`]]) – List of reputation networks
+  * **registration_needed** (`Optional`[`bool`]) – True,
+  * **registration_instructions** (`Optional`[`str`]) – Instructions url,
+=======
+>>>>>>> parent of cc79357b2 ([Subgraph][SDK] Add registration data to leaders entity (#2451))
+=======
   * **registration_needed** (`Optional`[`bool`]) – True,
   * **registration_instructions** (`Optional`[`str`]) – Instructions url,
+>>>>>>> develop
 
 ### *class* human_protocol_sdk.operator.operator_utils.LeaderFilter(chain_id, role=None)
 

docs/sdk/python/human_protocol_sdk.transaction.md

@@ -14,3 +14,5 @@ both the contracts and subgraph.
     * [`TransactionUtils.get_transaction()`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils.get_transaction)
     * [`TransactionUtils.get_transactions()`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtils.get_transactions)
   * [`TransactionUtilsError`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.TransactionUtilsError)
+  * [`Transfer`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.Transfer)
+    * [`Transfer.__init__()`](human_protocol_sdk.transaction.transaction_utils.md#human_protocol_sdk.transaction.transaction_utils.Transfer.__init__)