Rename Leader to Operator (#3063)

* Rename Leader to Operator to unify the name

* fix: applied ruff linter

* Fix tests

* Fix human app operator assignation and its test

* Update docs

* update subgraph ids for v1.0.0

* fix roles must be used in snake_case

* update subgraph ids

* bump: human-protocol-sdk to 4.0.3b0 version

* update docs

* [CVAT] bump: `human-protocol-sdk` upgrade to 4.0.3 (#3122)

* bump: `human-protocol-sdk` upgrade to 4.0.3

* lint: applied linter

* fix: linter errors

---------

Co-authored-by: Dzeranov <[email protected]>
Co-authored-by: portuu3 <[email protected]>

Author: 3 people

docs/sdk/python/human_protocol_sdk.constants.md

@@ -50,11 +50,11 @@ Enum for KVStore keys
 
 #### website *= 'website'*
 
-### *class* human_protocol_sdk.constants.LeaderCategory(value)
+### *class* human_protocol_sdk.constants.OperatorCategory(value)
 
 Bases: `Enum`
 
-Enum for leader categories
+Enum for operator categories
 
 #### MACHINE_LEARNING *= 'machine_learning'*
 

docs/sdk/python/human_protocol_sdk.md

@@ -64,9 +64,8 @@
     * [human_protocol_sdk.operator.operator_utils module](human_protocol_sdk.operator.operator_utils.md)
       * [Code Example](human_protocol_sdk.operator.operator_utils.md#code-example)
       * [Module](human_protocol_sdk.operator.operator_utils.md#module)
-      * [`LeaderData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderData)
-      * [`LeaderFilter`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderFilter)
-      * [`Operator`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.Operator)
+      * [`OperatorData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorData)
+      * [`OperatorFilter`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorFilter)
       * [`OperatorUtils`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils)
       * [`OperatorUtilsError`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtilsError)
       * [`RewardData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.RewardData)
@@ -139,9 +138,9 @@
     * [`KVStoreKeys.url`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.url)
     * [`KVStoreKeys.webhook_url`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.webhook_url)
     * [`KVStoreKeys.website`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.website)
-  * [`LeaderCategory`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.LeaderCategory)
-    * [`LeaderCategory.MACHINE_LEARNING`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.LeaderCategory.MACHINE_LEARNING)
-    * [`LeaderCategory.MARKET_MAKING`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.LeaderCategory.MARKET_MAKING)
+  * [`OperatorCategory`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OperatorCategory)
+    * [`OperatorCategory.MACHINE_LEARNING`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OperatorCategory.MACHINE_LEARNING)
+    * [`OperatorCategory.MARKET_MAKING`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OperatorCategory.MARKET_MAKING)
   * [`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)
     * [`OrderDirection.ASC`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection.ASC)
     * [`OrderDirection.DESC`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection.DESC)

docs/sdk/python/human_protocol_sdk.operator.md

@@ -8,15 +8,13 @@ obtain staking information from both the contracts and subgraph.
 * [human_protocol_sdk.operator.operator_utils module](human_protocol_sdk.operator.operator_utils.md)
   * [Code Example](human_protocol_sdk.operator.operator_utils.md#code-example)
   * [Module](human_protocol_sdk.operator.operator_utils.md#module)
-  * [`LeaderData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderData)
-    * [`LeaderData.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderData.__init__)
-  * [`LeaderFilter`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderFilter)
-    * [`LeaderFilter.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.LeaderFilter.__init__)
-  * [`Operator`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.Operator)
-    * [`Operator.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.Operator.__init__)
+  * [`OperatorData`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorData)
+    * [`OperatorData.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorData.__init__)
+  * [`OperatorFilter`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorFilter)
+    * [`OperatorFilter.__init__()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorFilter.__init__)
   * [`OperatorUtils`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils)
-    * [`OperatorUtils.get_leader()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_leader)
-    * [`OperatorUtils.get_leaders()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_leaders)
+    * [`OperatorUtils.get_operator()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_operator)
+    * [`OperatorUtils.get_operators()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_operators)
     * [`OperatorUtils.get_reputation_network_operators()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_reputation_network_operators)
     * [`OperatorUtils.get_rewards_info()`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtils.get_rewards_info)
   * [`OperatorUtilsError`](human_protocol_sdk.operator.operator_utils.md#human_protocol_sdk.operator.operator_utils.OperatorUtilsError)

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

@@ -6,24 +6,24 @@ Utility class for operator-related operations.
 
 ```python
 from human_protocol_sdk.constants import ChainId
-from human_protocol_sdk.operator import OperatorUtils, LeaderFilter
+from human_protocol_sdk.operator import OperatorUtils, OperatorFilter
 
 print(
-    OperatorUtils.get_leaders(
-        LeaderFilter(chain_id=ChainId.POLYGON_AMOY, roles=["Job Launcher"])
+    OperatorUtils.get_operators(
+        OperatorFilter(chain_id=ChainId.POLYGON_AMOY, roles=["Job Launcher"])
     )
 )
 ```
 
 ## Module
 
-### *class* human_protocol_sdk.operator.operator_utils.LeaderData(chain_id, id, address, amount_staked, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, 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_staked, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, 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)
 
 Bases: `object`
 
 #### \_\_init_\_(chain_id, id, address, amount_staked, amount_locked, locked_until_timestamp, amount_withdrawn, amount_slashed, reward, 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)
 
-Initializes a LeaderData instance.
+Initializes a OperatorData instance.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain Identifier
@@ -49,15 +49,15 @@ Initializes a LeaderData instance.
   * **name** (`Optional`[`str`]) – Name
   * **category** (`Optional`[`str`]) – Category
 
-### *class* human_protocol_sdk.operator.operator_utils.LeaderFilter(chain_id, roles=[], min_amount_staked=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
+### *class* human_protocol_sdk.operator.operator_utils.OperatorFilter(chain_id, roles=[], min_amount_staked=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
 
 Bases: `object`
 
-A class used to filter leaders.
+A class used to filter operators.
 
 #### \_\_init_\_(chain_id, roles=[], min_amount_staked=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
 
-Initializes a LeaderFilter instance.
+Initializes a OperatorFilter instance.
 
 * **Parameters:**
   * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Chain ID to request data
@@ -68,69 +68,53 @@ Initializes a LeaderFilter instance.
   * **first** (`int`) – Number of items per page
   * **skip** (`int`) – Number of items to skip (for pagination)
 
-### *class* human_protocol_sdk.operator.operator_utils.Operator(address, role, url='', job_types=[], registration_needed=None, registration_instructions=None)
-
-Bases: `object`
-
-#### \_\_init_\_(address, role, url='', job_types=[], registration_needed=None, registration_instructions=None)
-
-Initializes an Operator instance.
-
-* **Parameters:**
-  * **address** (`str`) – Operator address
-  * **role** (`str`) – Role of the operator
-  * **url** (`str`) – URL of the operator
-  * **job_types** (`List`[`str`]) – List of job types
-  * **registration_needed** (`Optional`[`bool`]) – Whether registration is needed
-  * **registration_instructions** (`Optional`[`str`]) – Registration instructions
-
 ### *class* human_protocol_sdk.operator.operator_utils.OperatorUtils
 
 Bases: `object`
 
 A utility class that provides additional operator-related functionalities.
 
-#### *static* get_leader(chain_id, leader_address)
+#### *static* get_operator(chain_id, operator_address)
 
-Gets the leader details.
+Gets the operator details.
 
 * **Parameters:**
-  * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the leader exists
-  * **leader_address** (`str`) – Address of the leader
+  * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the operator exists
+  * **operator_address** (`str`) – Address of the operator
 * **Return type:**
-  `Optional`[[`LeaderData`](#human_protocol_sdk.operator.operator_utils.LeaderData)]
+  `Optional`[[`OperatorData`](#human_protocol_sdk.operator.operator_utils.OperatorData)]
 * **Returns:**
-  Leader data if exists, otherwise None
+  Operator data if exists, otherwise None
 * **Example:**
   ```python
   from human_protocol_sdk.constants import ChainId
   from human_protocol_sdk.operator import OperatorUtils
 
   chain_id = ChainId.POLYGON_AMOY
-  leader_address = '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
+  operator_address = '0x62dD51230A30401C455c8398d06F85e4EaB6309f'
 
-  leader_data = OperatorUtils.get_leader(chain_id, leader_address)
-  print(leader_data)
+  operator_data = OperatorUtils.get_operator(chain_id, operator_address)
+  print(operator_data)
   ```
 
-#### *static* get_leaders(filter)
+#### *static* get_operators(filter)
 
-Get leaders data of the protocol.
+Get operators data of the protocol.
 
 * **Parameters:**
-  **filter** ([`LeaderFilter`](#human_protocol_sdk.operator.operator_utils.LeaderFilter)) – Leader filter
+  **filter** ([`OperatorFilter`](#human_protocol_sdk.operator.operator_utils.OperatorFilter)) – Operator filter
 * **Return type:**
-  `List`[[`LeaderData`](#human_protocol_sdk.operator.operator_utils.LeaderData)]
+  `List`[[`OperatorData`](#human_protocol_sdk.operator.operator_utils.OperatorData)]
 * **Returns:**
-  List of leaders data
+  List of operators data
 * **Example:**
   ```python
   from human_protocol_sdk.constants import ChainId
-  from human_protocol_sdk.operator import OperatorUtils, LeaderFilter
+  from human_protocol_sdk.operator import OperatorUtils, OperatorFilter
 
   print(
-      OperatorUtils.get_leaders(
-          LeaderFilter(chain_id=ChainId.POLYGON_AMOY, roles=["Job Launcher"])
+      OperatorUtils.get_operators(
+          OperatorFilter(chain_id=ChainId.POLYGON_AMOY, roles=["Job Launcher"])
       )
   )
   ```
@@ -144,7 +128,7 @@ Get the reputation network operators of the specified address.
   * **address** (`str`) – Address of the reputation oracle
   * **role** (`Optional`[`str`]) – (Optional) Role of the operator
 * **Return type:**
-  `List`[[`Operator`](#human_protocol_sdk.operator.operator_utils.Operator)]
+  `List`[[`OperatorData`](#human_protocol_sdk.operator.operator_utils.OperatorData)]
 * **Returns:**
   Returns an array of operator details
 * **Example:**

docs/sdk/python/index.md

@@ -46,7 +46,7 @@ pip install human-protocol-sdk[agreement]
     * [human_protocol_sdk.constants module](human_protocol_sdk.constants.md)
       * [`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)
       * [`KVStoreKeys`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys)
-      * [`LeaderCategory`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.LeaderCategory)
+      * [`OperatorCategory`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OperatorCategory)
       * [`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)
       * [`Role`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Role)
       * [`Status`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status)

docs/sdk/typescript/base/README.md

@@ -6,8 +6,6 @@
 
 # base
 
-## Index
-
-### Classes
+## Classes
 
 - [BaseEthersClient](classes/BaseEthersClient.md)

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

@@ -6,6 +6,8 @@
 
 # Class: `abstract` BaseEthersClient
 
+Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L10)
+
 ## Introduction
 
 This class is used as a base class for other clients making on-chain calls.
@@ -22,6 +24,8 @@ This class is used as a base class for other clients making on-chain calls.
 
 > **new BaseEthersClient**(`runner`, `networkData`): [`BaseEthersClient`](BaseEthersClient.md)
 
+Defined in: [base.ts:20](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+
 **BaseClient constructor**
 
 #### Parameters
@@ -42,26 +46,18 @@ The network information required to connect to the contracts
 
 [`BaseEthersClient`](BaseEthersClient.md)
 
-#### Defined in
-
-[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
-
 ## Properties
 
 ### networkData
 
 > **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
 
-#### Defined in
-
-[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
 
 ***
 
 ### runner
 
 > `protected` **runner**: `ContractRunner`
 
-#### Defined in
-
-[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)

docs/sdk/typescript/encryption/README.md

@@ -6,9 +6,7 @@
 
 # encryption
 
-## Index
-
-### Classes
+## Classes
 
 - [Encryption](classes/Encryption.md)
 - [EncryptionUtils](classes/EncryptionUtils.md)

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

@@ -6,6 +6,8 @@
 
 # Class: Encryption
 
+Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
+
 ## Introduction
 
 Class for signing and decrypting messages.
@@ -51,6 +53,8 @@ const encryption = await Encryption.build(privateKey, passphrase);
 
 > **new Encryption**(`privateKey`): [`Encryption`](Encryption.md)
 
+Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
+
 Constructor for the Encryption class.
 
 #### Parameters
@@ -65,16 +69,14 @@ The private key.
 
 [`Encryption`](Encryption.md)
 
-#### Defined in
-
-[encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
-
 ## Methods
 
 ### decrypt()
 
 > **decrypt**(`message`, `publicKey`?): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
 
+Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/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.
 
 #### Parameters
@@ -121,16 +123,14 @@ UYLqAQDfdym4kiUvKO1+REKASt0Gwykndl7hra9txqlUL5DXBQ===Vwgv
 const resultMessage = await encryption.decrypt('message');
 ```
 
-#### Defined in
-
-[encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
-
 ***
 
 ### sign()
 
 > **sign**(`message`): `Promise`\<`string`\>
 
+Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
+
 This function signs a message using the private key used to initialize the client.
 
 #### Parameters
@@ -159,16 +159,14 @@ const encryption = await Encryption.build(privateKey, passphrase);
 const resultMessage = await encryption.sign('message');
 ```
 
-#### Defined in
-
-[encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
-
 ***
 
 ### signAndEncrypt()
 
 > **signAndEncrypt**(`message`, `publicKeys`): `Promise`\<`string`\>
 
+Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/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.
 
 #### Parameters
@@ -228,16 +226,14 @@ const publicKeys = [publicKey1, publicKey2];
 const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
 ```
 
-#### Defined in
-
-[encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
-
 ***
 
 ### build()
 
 > `static` **build**(`privateKeyArmored`, `passphrase`?): `Promise`\<[`Encryption`](Encryption.md)\>
 
+Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/06afdec15d4185a13ccdd98fd231f6651db0e480/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.
 
 #### Parameters
@@ -259,7 +255,3 @@ Optional: The passphrase for the private key.
 `Promise`\<[`Encryption`](Encryption.md)\>
 
 - The Encryption instance.
-
-#### Defined in
-
-[encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/b718aa9d178d605c5b27fec98a4e6afa6f1db599/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)