Skip to content

Commit

Permalink
Merge pull request #3017 from humanprotocol/develop
Browse files Browse the repository at this point in the history
Release 2025-02-05
  • Loading branch information
portuu3 authored Feb 5, 2025
2 parents 06f37d2 + 087ba3c commit fecee9b
Show file tree
Hide file tree
Showing 605 changed files with 5,912 additions and 5,127 deletions.
24 changes: 24 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Common file for apps that rely on root context
.git
.github
.husky
audits
docs
scripts
**/node_modules
**/build
**/dist

# Core package artifacts
# Hardhat files
**/abis
**/artifacts
**/cache
**/.deps
# TypeScript bindings output directory
**/typechain-types

# Docker-related
.dockerignore
**/Dockerfile*
**/docker-compose*
3 changes: 3 additions & 0 deletions .github/workflows/cd-cvat-exchange-oracle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ on:
permissions:
id-token: write
contents: read
concurrency:
group: docker-compose-oracles-${{ github.ref }}
cancel-in-progress: false # Ensure the workflow waits instead of canceling others

jobs:
pull-request-check:
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/cd-cvat-recording-oracle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ permissions:
id-token: write
contents: read

concurrency:
group: docker-compose-oracles-${{ github.ref }}
cancel-in-progress: false # Ensure the workflow waits instead of canceling others

jobs:
pull-request-check:
runs-on: ubuntu-latest
Expand Down
41 changes: 31 additions & 10 deletions .github/workflows/cd-subgraph.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
label:
description: 'New version label'
required: true
networks:
description: 'Comma-separated list of networks to deploy'
required: true

jobs:
subgraph:
Expand All @@ -15,41 +18,59 @@ jobs:
matrix:
network:
- name: amoy
- name: avalanche
- name: bsc-testnet
- name: bsc
- name: celo-alfajores
- name: celo
- name: ethereum
- name: fuji
- name: moonbase-alpha
- name: moonbeam
- name: polygon
- name: sepolia
- name: xlayer-testnet
- name: xlayer
fail-fast: true
max-parallel: 3
steps:
- uses: actions/checkout@v4
- run: npm install --global yarn && yarn --ignore-scripts
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '18.20.1'
- name: Filter Networks
id: filter_networks
run: |
INPUT_NETWORKS="${{ github.event.inputs.networks }}"
IFS=',' read -ra NETWORK_LIST <<< "$INPUT_NETWORKS"
echo "Input networks: $INPUT_NETWORKS"
echo "Current matrix network: ${{ matrix.network.name }}"
MATCH=false
for network in "${NETWORK_LIST[@]}"; do
if [[ "${network}" == "${{ matrix.network.name }}" ]]; then
MATCH=true
break
fi
done
echo "Match found: $MATCH"
echo "::set-output name=continue::$MATCH"
- run: npm install --global yarn && yarn
name: Install dependencies
if: steps.filter_networks.outputs.continue == 'true'
- run: yarn build
name: Build core package
working-directory: ./packages/core
- run: yarn global add @graphprotocol/graph-cli
if: steps.filter_networks.outputs.continue == 'true'
- run: yarn global add @graphprotocol/[email protected]
name: Install Graph CLI
if: steps.filter_networks.outputs.continue == 'true'
- run: graph auth --studio ${API_KEY}
name: Authenticate Graph CLI
env:
API_KEY: ${{ secrets.HP_GRAPH_API_KEY }}
if: steps.filter_networks.outputs.continue == 'true'
- run: yarn generate && yarn build
name: Generate and build Subgraph
working-directory: ./packages/sdk/typescript/subgraph
env:
NETWORK: ${{ matrix.network.name }}
if: steps.filter_networks.outputs.continue == 'true'
- run: graph deploy --studio ${NETWORK} -l ${{ github.event.inputs.label }}
name: Deploy Subgraph
working-directory: ./packages/sdk/typescript/subgraph
env:
NETWORK: ${{ matrix.network.name }}
if: steps.filter_networks.outputs.continue == 'true'
3 changes: 2 additions & 1 deletion .github/workflows/ci-test-subgraph.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ on:
jobs:
subgraph-test:
name: Subgraph Test
runs-on: ubuntu-latest
# TODO: Use ubuntu-latest when graph binary is not failing on ubuntu 24.04
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
- run: npm install --global yarn && yarn
Expand Down
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@ node_modules

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
.env.*.local

# Log files
npm-debug.log*
Expand Down
42 changes: 17 additions & 25 deletions docs/sdk/python/human_protocol_sdk.constants.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,54 +6,36 @@ Bases: `Enum`

Enum for chain IDs.

#### AVALANCHE *= 43114*

#### AVALANCHE_TESTNET *= 43113*

#### BSC_MAINNET *= 56*

#### BSC_TESTNET *= 97*

#### CELO *= 42220*

#### CELO_ALFAJORES *= 44787*

#### GOERLI *= 5*

#### LOCALHOST *= 1338*

#### MAINNET *= 1*

#### MOONBASE_ALPHA *= 1287*

#### MOONBEAM *= 1284*

#### POLYGON *= 137*

#### POLYGON_AMOY *= 80002*

#### POLYGON_MUMBAI *= 80001*

#### RINKEBY *= 4*

#### SEPOLIA *= 11155111*

#### XLAYER *= 196*

#### XLAYER_TESTNET *= 195*

### *class* human_protocol_sdk.constants.KVStoreKeys(value)

Bases: `Enum`

Enum for KVStore keys

#### category *= 'category'*

#### fee *= 'fee'*

#### job_types *= 'job_types'*

#### name *= 'name'*
#### public_key *= 'public_key'*

#### public_key_hash *= 'public_key_hash'*

#### registration_instructions *= 'registration_instructions'*

#### registration_needed *= 'registration_needed'*
Expand All @@ -64,6 +46,18 @@ Enum for KVStore keys

#### webhook_url *= 'webhook_url'*

#### website *= 'website'*

### *class* human_protocol_sdk.constants.LeaderCategory(value)

Bases: `Enum`

Enum for leader categories

#### MACHINE_LEARNING *= 'machine_learning'*

#### MARKET_MAKING *= 'market_making'*

### *class* human_protocol_sdk.constants.OrderDirection(value)

Bases: `Enum`
Expand All @@ -88,8 +82,6 @@ Enum for roles.

#### reputation_oracle *= 'Reputation Oracle'*

#### validator *= 'Validator'*

### *class* human_protocol_sdk.constants.Status(value)

Bases: `Enum`
Expand Down
28 changes: 6 additions & 22 deletions docs/sdk/python/human_protocol_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,16 +59,6 @@
* [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)
* [`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)
* [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)
Expand Down Expand Up @@ -129,33 +119,28 @@

* [human_protocol_sdk.constants module](human_protocol_sdk.constants.md)
* [`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)
* [`ChainId.AVALANCHE`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.AVALANCHE)
* [`ChainId.AVALANCHE_TESTNET`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.AVALANCHE_TESTNET)
* [`ChainId.BSC_MAINNET`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.BSC_MAINNET)
* [`ChainId.BSC_TESTNET`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.BSC_TESTNET)
* [`ChainId.CELO`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.CELO)
* [`ChainId.CELO_ALFAJORES`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.CELO_ALFAJORES)
* [`ChainId.GOERLI`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.GOERLI)
* [`ChainId.LOCALHOST`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.LOCALHOST)
* [`ChainId.MAINNET`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.MAINNET)
* [`ChainId.MOONBASE_ALPHA`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.MOONBASE_ALPHA)
* [`ChainId.MOONBEAM`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.MOONBEAM)
* [`ChainId.POLYGON`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.POLYGON)
* [`ChainId.POLYGON_AMOY`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.POLYGON_AMOY)
* [`ChainId.POLYGON_MUMBAI`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.POLYGON_MUMBAI)
* [`ChainId.RINKEBY`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.RINKEBY)
* [`ChainId.SEPOLIA`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.SEPOLIA)
* [`ChainId.XLAYER`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.XLAYER)
* [`ChainId.XLAYER_TESTNET`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId.XLAYER_TESTNET)
* [`KVStoreKeys`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys)
* [`KVStoreKeys.category`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.category)
* [`KVStoreKeys.fee`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.fee)
* [`KVStoreKeys.job_types`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.job_types)
* [`KVStoreKeys.public_key`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.public_key)
* [`KVStoreKeys.public_key_hash`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.public_key_hash)
* [`KVStoreKeys.registration_instructions`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.registration_instructions)
* [`KVStoreKeys.registration_needed`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.registration_needed)
* [`KVStoreKeys.role`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.KVStoreKeys.role)
* [`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)
* [`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)
Expand All @@ -164,7 +149,6 @@
* [`Role.job_launcher`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Role.job_launcher)
* [`Role.recording_oracle`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Role.recording_oracle)
* [`Role.reputation_oracle`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Role.reputation_oracle)
* [`Role.validator`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Role.validator)
* [`Status`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status)
* [`Status.Cancelled`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status.Cancelled)
* [`Status.Complete`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.Status.Complete)
Expand Down
6 changes: 4 additions & 2 deletions docs/sdk/python/human_protocol_sdk.operator.operator_utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ print(

## 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)
### *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)

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)
#### \_\_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.

Expand All @@ -46,6 +46,8 @@ Initializes a LeaderData instance.
* **registration_needed** (`Optional`[`bool`]) – Whether registration is needed
* **registration_instructions** (`Optional`[`str`]) – Registration instructions
* **reputation_networks** (`Optional`[`List`[`str`]]) – List of reputation networks
* **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)

Expand Down
6 changes: 1 addition & 5 deletions docs/sdk/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,6 @@ pip install human-protocol-sdk[agreement]
* [Submodules](human_protocol_sdk.escrow.md#submodules)
* [human_protocol_sdk.kvstore package](human_protocol_sdk.kvstore.md)
* [Submodules](human_protocol_sdk.kvstore.md#submodules)
* [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.operator package](human_protocol_sdk.operator.md)
* [Submodules](human_protocol_sdk.operator.md#submodules)
* [human_protocol_sdk.staking package](human_protocol_sdk.staking.md)
Expand All @@ -51,6 +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)
* [`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)
Expand Down
6 changes: 3 additions & 3 deletions docs/sdk/typescript/base/classes/BaseEthersClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The network information required to connect to the contracts

#### Defined in

[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
[base.ts:20](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)

## Properties

Expand All @@ -54,7 +54,7 @@ The network information required to connect to the contracts
#### Defined in

[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
[base.ts:12](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)

***

Expand All @@ -64,4 +64,4 @@ The network information required to connect to the contracts
#### Defined in

[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/b190dc1831c2c96fe3d44fd63e915e54011e1ec8/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
[base.ts:11](https://github.com/humanprotocol/human-protocol/blob/000ef2f7891c6788228277729f8de9c3a0456a70/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
Loading

0 comments on commit fecee9b

Please sign in to comment.