add tocancel to python sdk and update docs

Author: portuu3

docs/sdk/python/human_protocol_sdk.constants.md

@@ -103,3 +103,5 @@ Enum for escrow statuses.
 #### Partial *= 2*
 
 #### Pending *= 1*
+
+#### ToCancel *= 6*

docs/sdk/python/human_protocol_sdk.kvstore.kvstore_client.md

@@ -70,9 +70,22 @@ Gets the value of a key-value pair in the contract.
 :param address: The Ethereum address associated with the key-value pair
 :type key: `str`
 :param key: The key of the key-value pair to get
-:rtype: `str`
-:return: The value of the key-value pair if it exists
-:example:
+
+* **Return type:**
+  `str`
+* **Returns:**
+  The value of the key-value pair if it exists
+* **Example:**
+  ```python
+  from eth_typing import URI
+  from web3 import Web3
+  from web3.providers.auto import load_provider_from_uri
+  from human_protocol_sdk.kvstore import KVStoreClient
+
+  w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
+  kvstore_client = KVStoreClient(w3)
+  role = kvstore_client.get('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'Role')
+  ```
 
 #### set(\*args, \*\*kwargs)
 

docs/sdk/python/human_protocol_sdk.md

@@ -171,6 +171,7 @@
     * [`Status.Paid`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status.Paid)
     * [`Status.Partial`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status.Partial)
     * [`Status.Pending`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status.Pending)
+    * [`Status.ToCancel`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status.ToCancel)
 * [human_protocol_sdk.filter module](human_protocol_sdk.filter.md)
   * [`CancellationRefundFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.CancellationRefundFilter)
     * [`CancellationRefundFilter.__init__()`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.CancellationRefundFilter.__init__)
@@ -204,6 +205,7 @@
     * [`Encryption.is_encrypted()`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.Encryption.is_encrypted)
   * [`InvalidPublicKey`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.InvalidPublicKey)
 * [human_protocol_sdk.utils module](human_protocol_sdk.utils.md)
+  * [`apply_tx_defaults()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.apply_tx_defaults)
   * [`get_contract_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_contract_interface)
   * [`get_data_from_subgraph()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_data_from_subgraph)
   * [`get_erc20_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_erc20_interface)

docs/sdk/python/human_protocol_sdk.utils.md

@@ -1,5 +1,21 @@
 # human_protocol_sdk.utils module
 
+### human_protocol_sdk.utils.apply_tx_defaults(w3, tx_options)
+
+Apply network specific default transaction parameters.
+
+Aurora networks enforce a fixed gas price. We always override any user supplied
+gasPrice with DEFAULT_AURORA_GAS_PRICE when on Aurora Testnet.
+EIP-1559 fields are removed to avoid conflicts.
+
+* **Parameters:**
+  * **w3** (`Web3`) – Web3 instance (used to read chain id)
+  * **tx_options** (`Optional`[`TxParams`]) – Original transaction options (can be None)
+* **Return type:**
+  `TxParams`
+* **Returns:**
+  Mutated tx options with enforced defaults
+
 ### human_protocol_sdk.utils.get_contract_interface(contract_entrypoint)
 
 Retrieve the contract interface of a given contract.

docs/sdk/python/index.md

@@ -67,6 +67,7 @@ pip install human-protocol-sdk[agreement]
       * [`Encryption`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.Encryption)
       * [`InvalidPublicKey`](human_protocol_sdk.legacy_encryption.md#human_protocol_sdk.legacy_encryption.InvalidPublicKey)
     * [human_protocol_sdk.utils module](human_protocol_sdk.utils.md)
+      * [`apply_tx_defaults()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.apply_tx_defaults)
       * [`get_contract_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_contract_interface)
       * [`get_data_from_subgraph()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_data_from_subgraph)
       * [`get_erc20_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_erc20_interface)

packages/sdk/python/human-protocol-sdk/human_protocol_sdk/constants.py

@@ -176,6 +176,7 @@ class Status(Enum):
     Paid = 3
     Complete = 4
     Cancelled = 5
+    ToCancel = 6
 
 
 class Role(Enum):

packages/sdk/python/human-protocol-sdk/human_protocol_sdk/kvstore/kvstore_client.py

@@ -282,16 +282,21 @@ def get_w3_with_priv_key(priv_key: str):
             handle_error(e, KVStoreClientError)
 
     def get(self, address: str, key: str) -> str:
-        """Gets the value of a key-value pair in the contract.
+        """
+        Gets the value of a key-value pair in the contract.
         :param address: The Ethereum address associated with the key-value pair
         :param key: The key of the key-value pair to get
+
         :return: The value of the key-value pair if it exists
+
         :example:
             .. code-block:: python
+
                 from eth_typing import URI
                 from web3 import Web3
                 from web3.providers.auto import load_provider_from_uri
                 from human_protocol_sdk.kvstore import KVStoreClient
+
                 w3 = Web3(load_provider_from_uri(URI("http://localhost:8545")))
                 kvstore_client = KVStoreClient(w3)
                 role = kvstore_client.get('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'Role')