Release

.github/workflows/cd-deploy-contracts.yaml

@@ -9,12 +9,6 @@ on:
       escrowFactory:
         description: 'deploy escrow factory'
         required: true
-      staking:
-        description: 'deploy staking'
-        required: true
-      rewardPool:
-        description: 'deploy reward pool'
-        required: true
 
 jobs:
   deploy-contracts:
@@ -51,63 +45,43 @@ jobs:
         run: |
           case ${{ github.event.inputs.network }} in
             "sepolia")
-              echo "escrow_factory=0xD6D347ba6987519B4e42EcED43dF98eFf5465a23" >> $GITHUB_OUTPUT
-              echo "staking=0x2B9C5EC6220BA8Ad08CB51A60FFdbC6a6235B203" >> $GITHUB_OUTPUT
-              echo "reward_pool=0xAFf5a986A530ff839d49325A5dF69F96627E8D29" >> $GITHUB_OUTPUT
+              echo "escrow_factory=0x5987A5558d961ee674efe4A8c8eB7B1b5495D3bf" >> $GITHUB_OUTPUT
               echo "private_key=TESTNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "polygon")
               echo "escrow_factory=0xBDBfD2cC708199C5640C6ECdf3B0F4A4C67AdfcB" >> $GITHUB_OUTPUT
-              echo "staking=0xcbAd56bE3f504E98bd70875823d3CC0242B7bB29" >> $GITHUB_OUTPUT
-              echo "reward_pool=0x1371057BAec59944B924A7963F2EeCF43ff94CE4" >> $GITHUB_OUTPUT
               echo "private_key=MAINNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "polygonAmoy")
               echo "escrow_factory=0xAFf5a986A530ff839d49325A5dF69F96627E8D29" >> $GITHUB_OUTPUT
-              echo "staking=0xCc0AF0635aa19fE799B6aFDBe28fcFAeA7f00a60" >> $GITHUB_OUTPUT
-              echo "reward_pool=0xd866bCEFf6D0F77E1c3EAE28230AE6C79b03fDa7" >> $GITHUB_OUTPUT
               echo "private_key=TESTNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "bsc")
               echo "escrow_factory=0x92FD968AcBd521c232f5fB8c33b342923cC72714" >> $GITHUB_OUTPUT
-              echo "staking=0xdFbB79dC35a3A53741be54a2C9b587d6BafAbd1C" >> $GITHUB_OUTPUT
-              echo "reward_pool=0xf376443BCc6d4d4D63eeC086bc4A9E4a83878e0e" >> $GITHUB_OUTPUT
               echo "private_key=MAINNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "bscTestnet")
               echo "escrow_factory=0x2bfA592DBDaF434DDcbb893B1916120d181DAD18" >> $GITHUB_OUTPUT
-              echo "staking=0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18" >> $GITHUB_OUTPUT
-              echo "reward_pool=0xB0A0500103eCEc431b73F6BAd923F0a2774E6e29" >> $GITHUB_OUTPUT
               echo "private_key=TESTNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "moonbeam")
               echo "escrow_factory=0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a" >> $GITHUB_OUTPUT
-              echo "staking=0x05398211bA2046E296fBc9a9D3EB49e3F15C3123" >> $GITHUB_OUTPUT
-              echo "reward_pool=0x4A5963Dd6792692e9147EdC7659936b96251917a" >> $GITHUB_OUTPUT
               echo "private_key=MAINNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "moonbaseAlpha")
               echo "escrow_factory=0x5e622FF522D81aa426f082bDD95210BC25fCA7Ed" >> $GITHUB_OUTPUT
-              echo "staking=0xBFC7009F3371F93F3B54DdC8caCd02914a37495c" >> $GITHUB_OUTPUT
-              echo "reward_pool=0xf46B45Df3d956369726d8Bd93Ba33963Ab692920" >> $GITHUB_OUTPUT
               echo "private_key=TESTNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "mainnet")
               echo "escrow_factory=0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a" >> $GITHUB_OUTPUT
-              echo "staking=0x05398211bA2046E296fBc9a9D3EB49e3F15C3123" >> $GITHUB_OUTPUT
-              echo "reward_pool=0x4A5963Dd6792692e9147EdC7659936b96251917a" >> $GITHUB_OUTPUT
               echo "private_key=MAINNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "avalanche")
               echo "escrow_factory=0xD9c75a1Aa4237BB72a41E5E26bd8384f10c1f55a" >> $GITHUB_OUTPUT
-              echo "staking=0x05398211bA2046E296fBc9a9D3EB49e3F15C3123" >> $GITHUB_OUTPUT
-              echo "reward_pool=0x4A5963Dd6792692e9147EdC7659936b96251917a" >> $GITHUB_OUTPUT
               echo "private_key=MAINNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             "avalancheFujiTestnet")
               echo "escrow_factory=0x56C2ba540726ED4f46E7a134b6b9Ee9C867FcF92" >> $GITHUB_OUTPUT
-              echo "staking=0x9890473B0b93E24d6D1a8Dfb739D577C6f25FFd3" >> $GITHUB_OUTPUT
-              echo "reward_pool=0x5517fE916Fe9F8dB15B0DDc76ebDf0BdDCd4ed18" >> $GITHUB_OUTPUT
               echo "private_key=TESTNET_PRIVATE_KEY" >> $GITHUB_OUTPUT
             ;;
             *)
@@ -116,30 +90,18 @@ jobs:
               ;;
           esac
       - name: Upgrade Proxies
-        if: github.event.inputs.escrowFactory == 'true' || github.event.inputs.staking == 'true' || github.event.inputs.rewardPool== 'true'
+        if: github.event.inputs.escrowFactory == 'true'
         run: yarn upgrade:proxy --network ${{ github.event.inputs.network }}
         working-directory: ./packages/core
         env:
           PRIVATE_KEY: ${{ secrets[steps.networks.outputs.private_key] }}
           DEPLOY_ESCROW_FACTORY: ${{ github.event.inputs.escrowFactory }}
-          DEPLOY_STAKING: ${{ github.event.inputs.staking }}
-          DEPLOY_REWARD_POOL: ${{ github.event.inputs.rewardPool }}
           ESCROW_FACTORY_ADDRESS: ${{ steps.networks.outputs.escrow_factory }}
-          STAKING_ADDRESS: ${{ steps.networks.outputs.staking }}
-          REWARD_POOL_ADDRESS: ${{ steps.networks.outputs.reward_pool }}
 
       - name: Verify Escrow Factory Proxy
         if: always() && github.event.inputs.escrowFactory == 'true'
         run: npx hardhat verify --network ${{ github.event.inputs.network }} ${{ steps.networks.outputs.escrow_factory }}
         working-directory: ./packages/core
-      - name: Verify Staking Proxy
-        if: always() && github.event.inputs.staking == 'true'
-        run: npx hardhat verify --network ${{ github.event.inputs.network }} ${{ steps.networks.outputs.staking }}
-        working-directory: ./packages/core
-      - name: Verify Reward Pool Proxy
-        if: always() && github.event.inputs.rewardPool== 'true'
-        run: npx hardhat verify --network ${{ github.event.inputs.network }} ${{ steps.networks.outputs.reward_pool }}
-        working-directory: ./packages/core
         #Commit changes to develop
       - name: Check for Changes
         if: always()

.github/workflows/ci-dependency-review.yaml

@@ -11,4 +11,4 @@ jobs:
       - name: "Checkout Repository"
         uses: actions/checkout@v4.1.1
       - name: "Dependency Review"
-        uses: actions/dependency-review-action@v4.4.0
+        uses: actions/dependency-review-action@v4.5.0

docs/sdk/python/human_protocol_sdk.encryption.encryption.md

@@ -60,7 +60,7 @@ Decrypts a message using the private key.
   * **message** (`str`) – Armored message to decrypt
   * **public_key** (`Optional`[`str`]) – Armored public key used for signature verification. Defaults to None.
 * **Return type:**
-  `str`
+  `bytes`
 * **Returns:**
   Decrypted message
 * **Example:**
@@ -94,7 +94,7 @@ Decrypts a message using the private key.
 Signs a message using the private key.
 
 * **Parameters:**
-  **message** (`str`) – Message to sign
+  **message** (`Union`[`str`, `bytes`]) – Message to sign
 * **Return type:**
   `str`
 * **Returns:**
@@ -130,7 +130,7 @@ Signs a message using the private key.
 Signs and encrypts a message using the private key and recipient’s public keys.
 
 * **Parameters:**
-  * **message** (`str`) – Message to sign and encrypt
+  * **message** (`Union`[`str`, `bytes`]) – Message to sign and encrypt
   * **public_keys** (`List`[`str`]) – List of armored public keys of the recipients
 * **Return type:**
   `str`

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.
@@ -158,7 +119,7 @@ Adds an array of addresses to the trusted handlers list.
   )
   ```
 
-#### bulk_payout(escrow_address, recipients, amounts, final_results_url, final_results_hash, txId, tx_options=None)
+#### bulk_payout(escrow_address, recipients, amounts, final_results_url, final_results_hash, txId, force_complete=False, tx_options=None)
 
 Pays out the amounts specified to the workers and sets the URL of the final results file.
 
@@ -169,6 +130,7 @@ Pays out the amounts specified to the workers and sets the URL of the final resu
   * **final_results_url** (`str`) – Final results file url
   * **final_results_hash** (`str`) – Final results file hash
   * **txId** (`Decimal`) – Serial number of the bulks
+  * **force_complete** (`Optional`[`bool`]) – (Optional) Indicates if remaining balance should be transferred to the escrow creator
   * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
 * **Return type:**
   `None`
@@ -301,67 +263,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 +783,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 +852,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)