diff --git a/.dockerignore b/.dockerignore
index d3337c5373..1087f90813 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -4,6 +4,7 @@
.husky
audits
docs
+docker-setup
scripts
**/node_modules
**/build
@@ -22,3 +23,6 @@ scripts
.dockerignore
**/Dockerfile*
**/docker-compose*
+
+# Local .env files
+**/.env.local
diff --git a/.github/workflows/cd-subgraph.yaml b/.github/workflows/cd-subgraph.yaml
index 4abd139dad..9a61753575 100644
--- a/.github/workflows/cd-subgraph.yaml
+++ b/.github/workflows/cd-subgraph.yaml
@@ -1,5 +1,4 @@
name: Subgraph deployment
-
on:
workflow_dispatch:
inputs:
@@ -53,23 +52,21 @@ jobs:
- name: Build core package
if: steps.filter_networks.outputs.continue == 'true'
run: yarn build:core
- - name: Install Graph CLI
- if: steps.filter_networks.outputs.continue == 'true'
- run: yarn global add @graphprotocol/graph-cli@0.71.2
- - name: Authenticate Graph CLI
- if: steps.filter_networks.outputs.continue == 'true'
- run: graph auth --studio ${API_KEY}
- env:
- API_KEY: ${{ secrets.HP_GRAPH_API_KEY }}
- name: Generate and build Subgraph
if: steps.filter_networks.outputs.continue == 'true'
run: yarn generate && yarn build
working-directory: ./packages/sdk/typescript/subgraph
env:
NETWORK: ${{ matrix.network.name }}
- - name: Deploy Subgraph
+ - name: Authenticate & Deploy
if: steps.filter_networks.outputs.continue == 'true'
- run: graph deploy --studio ${NETWORK} -l ${{ github.event.inputs.label }}
- working-directory: ./packages/sdk/typescript/subgraph
env:
- NETWORK: ${{ matrix.network.name }}
+ API_KEY: ${{ secrets.HP_GRAPH_API_KEY }}
+ NETWORK: ${{ matrix.network.name }}
+ LABEL: ${{ github.event.inputs.label }}
+ working-directory: ./packages/sdk/typescript/subgraph
+ run: |
+ yarn dlx @graphprotocol/graph-cli@0.71.2 \
+ auth --studio "$API_KEY"
+ yarn dlx @graphprotocol/graph-cli@0.71.2 \
+ deploy --studio ${NETWORK} -l ${LABEL}
\ No newline at end of file
diff --git a/.github/workflows/ci-dependency-review.yaml b/.github/workflows/ci-dependency-review.yaml
index 11f1509fae..79a3c2feeb 100644
--- a/.github/workflows/ci-dependency-review.yaml
+++ b/.github/workflows/ci-dependency-review.yaml
@@ -14,6 +14,6 @@ jobs:
steps:
- uses: actions/checkout@v4.1.1
- name: Dependency Review
- uses: actions/dependency-review-action@v4.7.0
+ uses: actions/dependency-review-action@v4.7.1
with:
show-openssf-scorecard: false
diff --git a/.gitignore b/.gitignore
index 2428824dcc..70399e1fe6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,8 +47,5 @@ dist
*.tsbuildinfo
hardhat-dependency-compiler
-#cache
-cache
-
-#docker databases
-docker-db
\ No newline at end of file
+# cache
+cache
\ No newline at end of file
diff --git a/.husky/pre-commit b/.husky/pre-commit
index b1dd4d8a8e..19c3fa6e16 100755
--- a/.husky/pre-commit
+++ b/.husky/pre-commit
@@ -1,4 +1,5 @@
yarn dlx lint-staged
+yarn workspaces foreach --all -p run typecheck
# Format python file changes
cd packages/sdk/python/human-protocol-sdk
diff --git a/docker-setup/.env.compose b/docker-setup/.env.compose
new file mode 100644
index 0000000000..7252e86817
--- /dev/null
+++ b/docker-setup/.env.compose
@@ -0,0 +1,21 @@
+MINIO_PORT=9000
+
+# NOTE: Avoid changing this since it impact KV store urls
+BACKEND_APPS_INTERNAL_PORT=5000
+
+REPUTATION_ORACLE_EXPOSED_PORT=5001
+HUMAN_APP_SERVER_EXPOSED_PORT=5002
+JOB_LAUNCHER_EXPOSED_PORT=5003
+EXCHANGE_ORACLE_CVAT_EXPOSED_PORT=5004
+RECORDING_ORACLE_CVAT_EXPOSED_PORT=5005
+EXCHANGE_ORACLE_FORTUNE_EXPOSED_PORT=5006
+RECORDING_ORACLE_FORTUNE_EXPOSED_PORT=5007
+
+HUMAN_APP_CLIENT_EXPOSED_PORT=3001
+JOB_LAUNCHER_CLIENT_EXPOSED_PORT=3002
+FORTUNE_CLIENT_EXPOSED_PORT=3003
+
+RPC_URL_POLYGON_AMOY=https://rpc-amoy.polygon.technology
+
+# Might be empty
+SUBGRAPH_API_KEY=
diff --git a/docker-setup/Makefile b/docker-setup/Makefile
new file mode 100644
index 0000000000..365895d059
--- /dev/null
+++ b/docker-setup/Makefile
@@ -0,0 +1,31 @@
+.PHONY: check-env-file \
+ infra-up infra-stop \
+ build-services services-up services-stop
+
+DOCKER_PARALLEL ?= 4
+
+check-env-file:
+ @if [ ! -f "./.env.compose.local" ]; then \
+ cp ./.env.compose ./.env.compose.local ; \
+ fi
+
+infra-up: check-env-file
+ @docker compose --env-file .env.compose.local up -d postgres redis minio minio-client
+
+infra-stop:
+ @docker compose --env-file .env.compose.local stop postgres redis minio minio-client
+
+build-services: check-env-file
+ @docker compose --env-file .env.compose.local --parallel $(DOCKER_PARALLEL) up --no-start
+
+services-up: check-env-file
+ @service_names="$(wordlist 2, $(words $(MAKECMDGOALS)), $(MAKECMDGOALS))"; \
+ docker compose --env-file .env.compose.local --parallel $(DOCKER_PARALLEL) up -d $$service_names
+
+services-stop:
+ @service_names="$(wordlist 2, $(words $(MAKECMDGOALS)), $(MAKECMDGOALS))"; \
+ docker compose --env-file .env.compose.local stop $$service_names
+
+# catch-all and noop; to avoid warnings when using MAKECMDGOALS
+%:
+ @:
diff --git a/docker-setup/Makefile.dev b/docker-setup/Makefile.dev
new file mode 100644
index 0000000000..567f633f0c
--- /dev/null
+++ b/docker-setup/Makefile.dev
@@ -0,0 +1,23 @@
+.PHONY: web3-up web3-down \
+ infra-up infra-stop infra-down
+
+web3-up:
+ @docker compose -f docker-compose.dev.yml up -d blockchain-node ipfs graph-node-db graph-node
+
+web3-down:
+# also remove volumes to get the clean start after
+ @docker compose -f docker-compose.dev.yml down -v blockchain-node ipfs graph-node-db graph-node
+
+infra-up:
+ @docker compose -f docker-compose.dev.yml up -d postgres minio minio-client
+
+infra-stop:
+ @docker compose -f docker-compose.dev.yml stop postgres minio minio-client
+
+infra-down:
+# also remove volumes to get the clean start after
+ @docker compose -f docker-compose.dev.yml down -v postgres minio minio-client
+
+# catch-all and noop; to avoid warnings when using MAKECMDGOALS
+%:
+ @:
diff --git a/docker-setup/docker-compose.dev.yml b/docker-setup/docker-compose.dev.yml
new file mode 100644
index 0000000000..b329016fb9
--- /dev/null
+++ b/docker-setup/docker-compose.dev.yml
@@ -0,0 +1,229 @@
+name: human-protocol-local-dev
+
+x-service-default-config:
+ restart: &default-restart unless-stopped
+ logging: &default-logging
+ options:
+ max-size: 10m
+ max-file: 3
+
+x-hardcoded-vars:
+ graph_db_user: &graph_db_user graph-node
+ graph_db_passwrod: &graph_db_passwrod let-me-in
+ graph_db_name: &graph_db_name graph-node
+
+x-general-env-variables:
+ postgres_user: &postgres_user ${POSTGRES_USER:-default}
+ postgres_password: &postgres_password ${POSTGRES_PASSWORD:-qwerty}
+ # MINIO VARS
+ minio_port: &minio_port ${MINIO_PORT:-9000}
+ minio_console_port: &minio_console_port ${MINIO_CONSOLE_PORT:-9001}
+ minio_root_user: &minio_root_user ${MINIO_ROOT_USER:-minioadmin}
+ minio_root_password: &minio_root_password ${MINIO_ROOT_PASSWORD:-minioadmin}
+ minio_services_access_key: &minio_services_access_key ${MINIO_SERVICES_ACCESS_KEY:-human-oracle}
+ minio_services_secret_key: &minio_services_secret_key ${MINIO_SERVICES_SECRET_KEY:-human-oracle-s3-secret}
+ # BUCKET NAMES
+ bucket_name_manifests: &bucket_name_manifests ${BUCKET_NAME_MANIFESTS:-manifests}
+ bucket_name_datasets: &bucket_name_datasets ${BUCKET_NAME_DATASETS:-datasets}
+ bucket_name_rep_o: &bucket_name_rep_o ${BUCKET_NAME_REPUTATION_ORACLE:-reputation-oracle}
+ bucket_name_fortune: &bucket_name_fortune ${BUCKEN_NAME_FORTUNE:-fortune}
+
+services:
+ blockchain-node:
+ container_name: hp-dev-blockchain-node
+ image: human-protocol/hardhat-blockchain-node
+ pull_policy: build
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ build:
+ context: ../
+ dockerfile: packages/core/Dockerfile.local
+ healthcheck:
+ test: yarn local:readiness
+ interval: 15s
+ timeout: 30s
+ retries: 0
+ networks:
+ - human_protocol_web3
+ ports:
+ - name: node-port
+ target: 8545
+ published: ${BLOCKCHAIN_NODE_PORT:-8545}
+
+ ipfs:
+ container_name: hp-dev-ipfs
+ image: ipfs/kubo:v0.14.0
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ healthcheck:
+ test: ["CMD-SHELL", "ipfs id > /dev/null"]
+ interval: 10s
+ timeout: 5s
+ retries: 3
+ networks:
+ - human_protocol_web3
+ ports:
+ - name: ipfs-port
+ target: 5001
+ published: ${IPFS_PORT:-5010}
+ volumes:
+ - ipfs-data:/data/ipfs:Z
+
+ graph-node-db:
+ container_name: hp-dev-graph-node-db
+ image: postgres:latest
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ networks:
+ - human_protocol_web3
+ command:
+ [
+ "postgres",
+ "-cshared_preload_libraries=pg_stat_statements",
+ "-cmax_connections=200"
+ ]
+ healthcheck:
+ test: ["CMD", "pg_isready"]
+ interval: 10s
+ timeout: 5s
+ retries: 5
+ volumes:
+ - graph-node-db-data:/var/lib/postgresql/data:Z
+ environment:
+ POSTGRES_USER: *graph_db_user
+ POSTGRES_PASSWORD: *graph_db_passwrod
+ POSTGRES_DB: *graph_db_name
+ POSTGRES_INITDB_ARGS: "-E UTF8 --locale=C"
+
+ graph-node:
+ container_name: hp-dev-graph-node
+ # In case of issues on Mac M1 rebuild the image for it locally
+ # https://github.com/graphprotocol/graph-node/blob/master/docker/README.md#running-graph-node-on-an-macbook-m1
+ image: graphprotocol/graph-node
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ networks:
+ - human_protocol_web3
+ ports:
+ - '8000:8000'
+ - '8001:8001'
+ - '8020:8020'
+ - '8030:8030'
+ - '8040:8040'
+ depends_on:
+ - blockchain-node
+ - ipfs
+ - graph-node-db
+ environment:
+ postgres_host: graph-node-db
+ postgres_user: *graph_db_user
+ postgres_pass: *graph_db_passwrod
+ postgres_db: *graph_db_name
+ ipfs: ipfs:5001
+ ethereum: localhost:http://blockchain-node:8545
+ GRAPH_LOG: info
+ healthcheck:
+ test: ["CMD-SHELL", "nc -z localhost 8000 || exit 1"]
+ interval: 5s
+ timeout: 5s
+ retries: 10
+ start_period: 10s
+
+ postgres:
+ container_name: hp-dev-postgres
+ image: postgres:16
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ ports:
+ - name: instance_port
+ target: 5432
+ # default 5432 is used by CVAT installation
+ published: ${POSTGRES_PORT:-5433}
+ volumes:
+ - ./initdb:/docker-entrypoint-initdb.d
+ - postgres-data:/var/lib/postgresql/data
+ environment:
+ POSTGRES_USER: *postgres_user
+ POSTGRES_PASSWORD: *postgres_password
+ healthcheck:
+ test: ["CMD", "pg_isready"]
+ interval: 10s
+ timeout: 5s
+ retries: 5
+
+ minio:
+ container_name: hp-dev-minio
+ image: minio/minio:RELEASE.2024-12-18T13-15-44Z
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ entrypoint: 'sh'
+ ports:
+ - name: instance_port
+ target: 9000
+ published: *minio_port
+ - name: console_port
+ target: 9001
+ published: *minio_console_port
+ volumes:
+ - minio-data:/data
+ environment:
+ MINIO_ROOT_USER: *minio_root_user
+ MINIO_ROOT_PASSWORD: *minio_root_password
+ command:
+ -c "minio server /data --console-address ':9001'"
+ healthcheck:
+ test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
+ interval: 5s
+ timeout: 5s
+ retries: 3
+
+ minio-client:
+ container_name: hp-dev-minio-client
+ image: minio/mc:RELEASE.2024-11-21T17-21-54Z
+ depends_on:
+ minio:
+ condition: service_healthy
+ environment:
+ MINIO_ROOT_USER: *minio_root_user
+ MINIO_ROOT_PASSWORD: *minio_root_password
+ SERVICES_ACCESS_KEY: *minio_services_access_key
+ SERVICES_SECRET_KEY: *minio_services_secret_key
+ BUCKET_MANIFESTS: *bucket_name_manifests
+ BUCKET_DATASETS: *bucket_name_datasets
+ BUCKET_REPUTATION_ORACLE: *bucket_name_rep_o
+ BUCKET_FORTUNE: *bucket_name_fortune
+ entrypoint: >
+ /bin/sh -c "
+ mc alias set myminio http://minio:9000 $$MINIO_ROOT_USER $$MINIO_ROOT_PASSWORD
+
+ mc admin user add myminio $$SERVICES_ACCESS_KEY $$SERVICES_SECRET_KEY
+ mc admin policy attach myminio readwrite --user=$$SERVICES_ACCESS_KEY
+
+ mc mb myminio/$$BUCKET_MANIFESTS;
+ mc anonymous set public myminio/$$BUCKET_MANIFESTS;
+
+ mc mb myminio/$$BUCKET_DATASETS;
+ mc anonymous set public myminio/$$BUCKET_DATASETS;
+
+ mc mb myminio/$$BUCKET_REPUTATION_ORACLE;
+ mc anonymous set public myminio/$$BUCKET_REPUTATION_ORACLE;
+
+ mc mb myminio/$$BUCKET_FORTUNE;
+ mc anonymous set public myminio/$$BUCKET_FORTUNE;
+ "
+
+volumes:
+ ipfs-data:
+ graph-node-db-data:
+ postgres-data:
+ minio-data:
+
+networks:
+ human_protocol_web3:
+ name: human-protocol-web3
diff --git a/scripts/cvat/docker-compose.local.yml b/docker-setup/docker-compose.yml
similarity index 70%
rename from scripts/cvat/docker-compose.local.yml
rename to docker-setup/docker-compose.yml
index 59db252e5b..5ecff8c246 100644
--- a/scripts/cvat/docker-compose.local.yml
+++ b/docker-setup/docker-compose.yml
@@ -23,8 +23,7 @@ x-hardcoded-vars:
x-general-env-variables:
# GENERAL VARS
subgraph_api_key: &subgraph_api_key ${SUBGRAPH_API_KEY}
- sendgrid_api_key: &sendgrid_api_key ${SENDGRID_API_KEY:-sendgrid-disabled}
- rpc_url_polygon_amoy: &rpc_url_polygon_amoy ${RPC_URL_POLYGON_AMOY:-}
+ rpc_url_polygon_amoy: &rpc_url_polygon_amoy ${RPC_URL_POLYGON_AMOY:?}
# POSTGRES VARS
postgres_user: &postgres_user ${POSTGRES_USER:-default}
postgres_password: &postgres_password ${POSTGRES_PASSWORD:-qwerty}
@@ -39,16 +38,11 @@ x-general-env-variables:
bucket_name_manifests: &bucket_name_manifests ${BUCKET_NAME_MANIFESTS:-manifests}
bucket_name_datasets: &bucket_name_datasets ${BUCKET_NAME_DATASETS:-datasets}
bucket_name_rep_o: &bucket_name_rep_o ${BUCKET_NAME_REPUTATION_ORACLE:-reputation-oracle}
- bucket_name_exc_o: &bucket_name_exc_o ${BUCKET_NAME_EXCHANGE_ORACLE:-exchange-oracle}
- bucket_name_rec_o: &bucket_name_rec_o ${BUCKET_NAME_RECORDING_ORACLE:-recording-oracle}
- # WEB3 ADDRESSES
- reputation_oracle_address: &reputation_oracle_address ${REPUTATION_ORACLE_ADDRESS:?}
- exchange_oracle_address: &exchange_oracle_address ${EXCHANGE_ORACLE_ADDRESS:?}
- recording_oracle_address: &recording_oracle_address ${RECORDING_ORACLE_ADDRESS:?}
+ bucket_name_cvat_exc_o: &bucket_name_cvat_exc_o ${BUCKET_NAME_CVAT_EXCHANGE_ORACLE:-cvat-exchange-oracle}
+ bucket_name_cvat_rec_o: &bucket_name_cvat_rec_o ${BUCKET_NAME_CVAT_RECORDING_ORACLE:-cvat-recording-oracle}
+ bucket_name_fortune: &bucket_name_fortune ${BUCKEN_NAME_FORTUNE:-fortune}
# OTHER
backend_apps_internal_port: &backend_apps_internal_port ${BACKEND_APPS_INTERNAL_PORT:?}
- human_app_secret_key: &human_app_secret_key ${HUMAN_APP_SECRET_KEY:?}
- reputation_oracle_jwt_public_key: &reputation_oracle_jwt_public_key ${REPUTATION_ORACLE_JWT_PUBLIC_KEY:?}
cvat_oracle_storage_endpoint: &cvat_oracle_storage_endpoint minio:${MINIO_PORT:?}
x-service-env-vars-groups:
@@ -60,13 +54,11 @@ x-service-env-vars-groups:
REDIS_PORT: *redis_port
nodejs_app_vars: &nodejs_app_vars
NODE_ENV: *node_env
- WEB3_ENV: *web3_env
+ SUBGRAPH_API_KEY: *subgraph_api_key
RPC_URL_POLYGON_AMOY: *rpc_url_polygon_amoy
- SENDGRID_API_KEY: *sendgrid_api_key
+ cvat_oracle_vars: &cvat_oracle_vars
SUBGRAPH_API_KEY: *subgraph_api_key
- HCAPTCHA_SITE_KEY: ${HCAPTCHA_SITE_KEY:-10000000-ffff-ffff-ffff-000000000001}
- HCAPTCHA_SECRET: ${HCAPTCHA_SECRET:-0x0000000000000000000000000000000000000000}
- HCAPTCHA_API_KEY: ${HCAPTCHA_API_KEY:-test}
+ POLYGON_AMOY_RPC_API_URL: *rpc_url_polygon_amoy
nodejs_app_postgres_vars: &nodejs_app_postgres_vars
<<: *postgres_auth_vars
POSTGRES_HOST: *postgres_host
@@ -188,8 +180,9 @@ services:
BUCKET_MANIFESTS: *bucket_name_manifests
BUCKET_DATASETS: *bucket_name_datasets
BUCKET_REPUTATION_ORACLE: *bucket_name_rep_o
- BUCKET_EXCHANGE_ORACLE: *bucket_name_exc_o
- BUCKET_RECORDING_ORACLE: *bucket_name_rec_o
+ BUCKET_CVAT_EXCHANGE_ORACLE: *bucket_name_cvat_exc_o
+ BUCKET_CVAT_RECORDING_ORACLE: *bucket_name_cvat_rec_o
+ BUCKET_FORTUNE: *bucket_name_fortune
entrypoint: >
/bin/sh -c "
mc alias set myminio http://minio:9000 $$MINIO_ROOT_USER $$MINIO_ROOT_PASSWORD
@@ -206,11 +199,14 @@ services:
mc mb myminio/$$BUCKET_REPUTATION_ORACLE;
mc anonymous set public myminio/$$BUCKET_REPUTATION_ORACLE;
- mc mb myminio/$$BUCKET_EXCHANGE_ORACLE;
- mc anonymous set public myminio/$$BUCKET_EXCHANGE_ORACLE;
+ mc mb myminio/$$BUCKET_CVAT_EXCHANGE_ORACLE;
+ mc anonymous set public myminio/$$BUCKET_CVAT_EXCHANGE_ORACLE;
+
+ mc mb myminio/$$BUCKET_CVAT_RECORDING_ORACLE;
+ mc anonymous set public myminio/$$BUCKET_CVAT_RECORDING_ORACLE;
- mc mb myminio/$$BUCKET_RECORDING_ORACLE;
- mc anonymous set public myminio/$$BUCKET_RECORDING_ORACLE;
+ mc mb myminio/$$BUCKET_FORTUNE;
+ mc anonymous set public myminio/$$BUCKET_FORTUNE;
"
reputation-oracle:
@@ -228,7 +224,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../
+ context: ../
dockerfile: packages/apps/reputation-oracle/server/Dockerfile
expose:
- *backend_apps_internal_port
@@ -237,19 +233,18 @@ services:
ports:
- name: server_port
target: *backend_apps_internal_port
- published: ${REPUTATION_ORACLE_PORT:-5001}
- env_file: ./.env.reputation-oracle.local
+ published: ${REPUTATION_ORACLE_EXPOSED_PORT:?}
environment:
<<: [*nodejs_app_vars, *nodejs_app_postgres_vars, *nodejs_app_s3_vars]
HOST: *all_interfaces_ip
PORT: *backend_apps_internal_port
POSTGRES_DATABASE: reputation-oracle
S3_BUCKET: *bucket_name_rep_o
- HUMAN_APP_SECRET_KEY: *human_app_secret_key
# It is accessed by user, not from container
# so put here exposed port, not internal
- FE_URL: http://localhost:${HUMAN_APP_CLIENT_PORT:?}
- JWT_PUBLIC_KEY: *reputation_oracle_jwt_public_key
+ FE_URL: http://localhost:${HUMAN_APP_CLIENT_EXPOSED_PORT:?}
+ # User for KV store setup
+ SERVER_URL: http://reputation-oracle:${BACKEND_APPS_INTERNAL_PORT:?}
human-app-server:
container_name: human-app-server
@@ -262,7 +257,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../
+ context: ../
dockerfile: packages/apps/human-app/server/Dockerfile
expose:
- *backend_apps_internal_port
@@ -271,17 +266,14 @@ services:
ports:
- name: server_port
target: *backend_apps_internal_port
- published: ${HUMAN_APP_SERVER_PORT:-5002}
- env_file: ./.env.human-app-server.local
+ published: ${HUMAN_APP_SERVER_EXPOSED_PORT:?}
environment:
<<: [*nodejs_app_vars, *redis_app_vars]
HOST: *all_interfaces_ip
PORT: *backend_apps_internal_port
REDIS_DB: 1
+ REPUTATION_ORACLE_URL: http://reputation-oracle:${BACKEND_APPS_INTERNAL_PORT:?}
RPC_URL: *rpc_url_polygon_amoy
- HUMAN_APP_SECRET_KEY: *human_app_secret_key
- REPUTATION_ORACLE_URL: "http://reputation-oracle:${BACKEND_APPS_INTERNAL_PORT:?}"
- REPUTATION_ORACLE_ADDRESS: *reputation_oracle_address
human-app-client:
container_name: human-app-client
@@ -294,7 +286,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../
+ context: ../
dockerfile: packages/apps/human-app/frontend/Dockerfile
expose:
- *frontend_default_port
@@ -303,11 +295,11 @@ services:
ports:
- name: server_port
target: *frontend_default_port
- published: ${HUMAN_APP_CLIENT_PORT:?}
+ published: ${HUMAN_APP_CLIENT_EXPOSED_PORT:?}
environment:
PORT: *frontend_default_port
- exchange-oracle:
+ exchange-oracle-cvat:
container_name: exchange-oracle-cvat
image: human-protocol/exchange-oracle-cvat
pull_policy: build
@@ -324,7 +316,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../packages/examples/cvat/exchange-oracle
+ context: ../packages/examples/cvat/exchange-oracle
dockerfile: ./Dockerfile
expose:
- *backend_apps_internal_port
@@ -336,29 +328,26 @@ services:
ports:
- name: server_port
target: *backend_apps_internal_port
- published: ${EXCHANGE_ORACLE_PORT:-5003}
- env_file: ./.env.exchange-oracle.local
+ published: ${EXCHANGE_ORACLE_CVAT_EXPOSED_PORT:?}
environment:
HOST: *all_interfaces_ip
PORT: *backend_apps_internal_port
<<: [
+ *cvat_oracle_vars,
*cvat_oracle_postgres_vars,
*redis_app_vars,
*cvat_oracle_storage_connection_vars,
*cvat_connection_vars
]
REDIS_DB: 2
- PG_DB: exchange-oracle
- POLYGON_AMOY_RPC_API_URL: *rpc_url_polygon_amoy
- POLYGON_AMOY_ADDR: *exchange_oracle_address
- STORAGE_BUCKET_NAME: *bucket_name_exc_o
- HUMAN_APP_JWT_KEY: *reputation_oracle_jwt_public_key
+ PG_DB: exchange-oracle-cvat
+ STORAGE_BUCKET_NAME: *bucket_name_cvat_exc_o
CVAT_INCOMING_WEBHOOKS_URL: "http://exchange-oracle.app:${BACKEND_APPS_INTERNAL_PORT:?}/cvat-webhook"
- LOCALHOST_RECORDING_ORACLE_URL: "http://recording-oracle:${BACKEND_APPS_INTERNAL_PORT:?}/webhook"
- LOCALHOST_JOB_LAUNCHER_URL: "http://job-launcher:${BACKEND_APPS_INTERNAL_PORT:?}/webhook"
- LOCALHOST_RECORDING_ORACLE_ADDRESS: *recording_oracle_address
+ ENABLE_CUSTOM_CLOUD_HOST: yes
+ # User for KV store setup
+ SERVER_URL: http://exchange-oracle-cvat:${BACKEND_APPS_INTERNAL_PORT:?}
- recording-oracle:
+ recording-oracle-cvat:
container_name: recording-oracle-cvat
image: human-protocol/recording-oracle-cvat
pull_policy: build
@@ -373,7 +362,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../packages/examples/cvat/recording-oracle
+ context: ../packages/examples/cvat/recording-oracle
dockerfile: ./Dockerfile
expose:
- *backend_apps_internal_port
@@ -383,30 +372,22 @@ services:
ports:
- name: server_port
target: *backend_apps_internal_port
- published: ${RECORDING_ORACLE_PORT:-5004}
- env_file: ./.env.recording-oracle.local
+ published: ${RECORDING_ORACLE_CVAT_EXPOSED_PORT:?}
environment:
HOST: *all_interfaces_ip
PORT: *backend_apps_internal_port
<<: [
+ *cvat_oracle_vars,
*cvat_oracle_postgres_vars,
*cvat_oracle_storage_connection_vars,
*cvat_connection_vars
]
- PG_DB: recording-oracle
- POLYGON_AMOY_RPC_API_URL: *rpc_url_polygon_amoy
- POLYGON_AMOY_ADDR: *recording_oracle_address
- STORAGE_RESULTS_BUCKET_NAME: *bucket_name_rec_o
+ PG_DB: recording-oracle-cvat
+ STORAGE_RESULTS_BUCKET_NAME: *bucket_name_cvat_rec_o
STORAGE_USE_PATH_STYLE: "true"
- EXCHANGE_ORACLE_STORAGE_PROVIDER: *cvat_oracle_storage_provider
- EXCHANGE_ORACLE_STORAGE_ENDPOINT_URL: *cvat_oracle_storage_endpoint
- EXCHANGE_ORACLE_STORAGE_ACCESS_KEY: *minio_services_access_key
- EXCHANGE_ORACLE_STORAGE_SECRET_KEY: *minio_services_secret_key
- EXCHANGE_ORACLE_STORAGE_RESULTS_BUCKET_NAME: *bucket_name_exc_o
- EXCHANGE_ORACLE_STORAGE_USE_SSL: 'false'
- LOCALHOST_EXCHANGE_ORACLE_URL: "http://exchange-oracle:${BACKEND_APPS_INTERNAL_PORT:?}/webhook"
- LOCALHOST_REPUTATION_ORACLE_URL: "http://reputation-oracle:${BACKEND_APPS_INTERNAL_PORT:?}/webhook"
- LOCALHOST_EXCHANGE_ORACLE_ADDRESS: *exchange_oracle_address
+ ENABLE_CUSTOM_CLOUD_HOST: "yes"
+ # User for KV store setup
+ SERVER_URL: http://recording-oracle-cvat:${BACKEND_APPS_INTERNAL_PORT:?}
job-launcher:
container_name: job-launcher
@@ -423,7 +404,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../
+ context: ../
dockerfile: packages/apps/job-launcher/server/Dockerfile
expose:
- *backend_apps_internal_port
@@ -432,19 +413,16 @@ services:
ports:
- name: server_port
target: *backend_apps_internal_port
- published: ${JOB_LAUNCHER_PORT:-5005}
- env_file: ./.env.job-launcher.local
+ published: ${JOB_LAUNCHER_EXPOSED_PORT:?}
environment:
<<: [*nodejs_app_vars, *nodejs_app_postgres_vars, *nodejs_app_s3_vars]
HOST: *all_interfaces_ip
PORT: *backend_apps_internal_port
POSTGRES_DATABASE: job-launcher
S3_BUCKET: *bucket_name_manifests
- REPUTATION_ORACLES: *reputation_oracle_address
- REPUTATION_ORACLE_ADDRESS: *reputation_oracle_address
- CVAT_EXCHANGE_ORACLE_ADDRESS: *exchange_oracle_address
- CVAT_RECORDING_ORACLE_ADDRESS: *recording_oracle_address
- FE_URL: http://localhost:${JOB_LAUNCHER_CLIENT_PORT:?}
+ FE_URL: http://localhost:${JOB_LAUNCHER_CLIENT_EXPOSED_PORT:?}
+ # User for KV store setup
+ SERVER_URL: http://job-launcher:${BACKEND_APPS_INTERNAL_PORT:?}
job-launcher-client:
container_name: job-launcher-client
@@ -457,7 +435,7 @@ services:
logging:
<<: *default-logging
build:
- context: ../../
+ context: ../
dockerfile: packages/apps/job-launcher/client/Dockerfile
expose:
- *frontend_default_port
@@ -466,10 +444,99 @@ services:
ports:
- name: server_port
target: *frontend_default_port
- published: ${JOB_LAUNCHER_CLIENT_PORT:?}
+ published: ${JOB_LAUNCHER_CLIENT_EXPOSED_PORT:?}
+ environment:
+ PORT: *frontend_default_port
+
+ exchange-oracle-fortune:
+ container_name: exchange-oracle-fortune
+ image: human-protocol/exchange-oracle-fortune
+ pull_policy: build
+ depends_on:
+ postgres:
+ condition: service_healthy
+ minio:
+ condition: service_healthy
+ minio-client:
+ condition: service_completed_successfully
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ build:
+ context: ../
+ dockerfile: packages/apps/fortune/exchange-oracle/server/Dockerfile
+ expose:
+ - *backend_apps_internal_port
+ networks:
+ - human_protocol
+ ports:
+ - name: server_port
+ target: *backend_apps_internal_port
+ published: ${EXCHANGE_ORACLE_FORTUNE_EXPOSED_PORT:?}
+ environment:
+ <<: [*nodejs_app_vars, *nodejs_app_postgres_vars, *nodejs_app_s3_vars]
+ HOST: *all_interfaces_ip
+ PORT: *backend_apps_internal_port
+ POSTGRES_DATABASE: exchange-oracle-fortune
+ S3_BUCKET: *bucket_name_fortune
+ # User for KV store setup
+ SERVER_URL: http://exchange-oracle-fortune:${BACKEND_APPS_INTERNAL_PORT:?}
+
+ fortune-client:
+ container_name: fortune-client
+ image: human-protocol/fortune-client
+ pull_policy: build
+ depends_on:
+ exchange-oracle-fortune:
+ condition: service_started
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ build:
+ context: ../
+ dockerfile: packages/apps/fortune/exchange-oracle/client/Dockerfile
+ expose:
+ - *frontend_default_port
+ networks:
+ - human_protocol
+ ports:
+ - name: server_port
+ target: *frontend_default_port
+ published: ${FORTUNE_CLIENT_EXPOSED_PORT:?}
environment:
PORT: *frontend_default_port
+ recording-oracle-fortune:
+ container_name: recording-oracle-fortune
+ image: human-protocol/recording-oracle-fortune
+ pull_policy: build
+ depends_on:
+ minio:
+ condition: service_healthy
+ minio-client:
+ condition: service_completed_successfully
+ restart: *default-restart
+ logging:
+ <<: *default-logging
+ build:
+ context: ../
+ dockerfile: packages/apps/fortune/recording-oracle/Dockerfile
+ expose:
+ - *backend_apps_internal_port
+ networks:
+ - human_protocol
+ ports:
+ - name: server_port
+ target: *backend_apps_internal_port
+ published: ${RECORDING_ORACLE_FORTUNE_EXPOSED_PORT:?}
+ environment:
+ <<: [*nodejs_app_vars, *nodejs_app_s3_vars]
+ HOST: *all_interfaces_ip
+ PORT: *backend_apps_internal_port
+ S3_BUCKET: *bucket_name_fortune
+ # User for KV store setup
+ SERVER_URL: http://recording-oracle-fortune:${BACKEND_APPS_INTERNAL_PORT:?}
+
volumes:
# When init for the first time postgres requires empty directory
# that is exclusive to its user, so providing a separate volume
diff --git a/docker-setup/initdb/create-dbs.sql b/docker-setup/initdb/create-dbs.sql
new file mode 100644
index 0000000000..da24368f29
--- /dev/null
+++ b/docker-setup/initdb/create-dbs.sql
@@ -0,0 +1,5 @@
+CREATE DATABASE "reputation-oracle";
+CREATE DATABASE "job-launcher";
+CREATE DATABASE "exchange-oracle-cvat";
+CREATE DATABASE "recording-oracle-cvat";
+CREATE DATABASE "exchange-oracle-fortune";
diff --git a/docs/sdk/python/human_protocol_sdk.escrow.escrow_client.md b/docs/sdk/python/human_protocol_sdk.escrow.escrow_client.md
index 86d1fd9559..2d067904ba 100644
--- a/docs/sdk/python/human_protocol_sdk.escrow.escrow_client.md
+++ b/docs/sdk/python/human_protocol_sdk.escrow.escrow_client.md
@@ -74,199 +74,13 @@ Initializes a Escrow instance.
* **Parameters:**
**web3** (`Web3`) – The Web3 object
-#### add_trusted_handlers(escrow_address, handlers, tx_options=None)
+#### add_trusted_handlers(\*args, \*\*kwargs)
-Adds an array of addresses to the trusted handlers list.
+#### bulk_payout(\*args, \*\*kwargs)
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow
- * **handlers** (`List`[`str`]) – Array of trusted handler addresses
- * **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 SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
+#### cancel(\*args, \*\*kwargs)
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- trusted_handlers = [
- '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
- '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266'
- ]
- escrow_client.add_trusted_handlers(
- "0x62dD51230A30401C455c8398d06F85e4EaB6309f",
- trusted_handlers
- )
- ```
-
-#### 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.
-
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow
- * **recipients** (`List`[`str`]) – Array of recipient addresses
- * **amounts** (`List`[`Decimal`]) – Array of amounts the recipients will receive
- * **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`
-* **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 SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- recipients = [
- '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
- '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92267'
- ]
- amounts = [
- Web3.to_wei(5, 'ether'),
- Web3.to_wei(10, 'ether')
- ]
- results_url = 'http://localhost/results.json'
- results_hash = 'b5dad76bf6772c0f07fd5e048f6e75a5f86ee079'
-
- escrow_client.bulk_payout(
- "0x62dD51230A30401C455c8398d06F85e4EaB6309f",
- recipients,
- amounts,
- results_url,
- results_hash,
- 1
- )
- ```
-
-#### cancel(escrow_address, tx_options=None)
-
-Cancels the specified escrow and sends the balance to the canceler.
-
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow to cancel
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- [`EscrowCancel`](#human_protocol_sdk.escrow.escrow_client.EscrowCancel)
-* **Returns:**
- EscrowCancel:
- An instance of the EscrowCancel class containing details of the cancellation transaction,
- including the transaction hash and the amount refunded.
-* **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 cancellation
- is not found in the transaction logs
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- escrow_cancel_data = escrow_client.cancel(
- "0x62dD51230A30401C455c8398d06F85e4EaB6309f"
- )
- ```
-
-#### complete(escrow_address, tx_options=None)
-
-Sets the status of an escrow to completed.
-
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow to complete
- * **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 SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- escrow_client.complete("0x62dD51230A30401C455c8398d06F85e4EaB6309f")
- ```
+#### complete(\*args, \*\*kwargs)
#### create_bulk_payout_transaction(escrow_address, recipients, amounts, final_results_url, final_results_hash, txId, force_complete=False, tx_options=None)
@@ -343,55 +157,7 @@ Creates a prepared transaction for bulk payout without signing or sending it.
print(f"Transaction receipt: {tx_receipt}")
```
-#### create_escrow(token_address, trusted_handlers, job_requester_id, tx_options=None)
-
-Creates a new escrow contract.
-
-* **Parameters:**
- * **token_address** (`str`) – Address of the token to be used in the escrow
- * **trusted_handlers** (`List`[`str`]) – List of trusted handler addresses
- * **job_requester_id** (`str`) – ID of the job requester
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Transaction options
-* **Return type:**
- `str`
-* **Returns:**
- Address of the created escrow contract
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- token_address = '0x1234567890abcdef1234567890abcdef12345678'
- trusted_handlers = [
- '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
- '0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef'
- ]
- job_requester_id = 'job-requester'
- escrow_address = escrow_client.create_escrow(
- token_address,
- trusted_handlers,
- job_requester_id
- )
- ```
+#### create_escrow(\*args, \*\*kwargs)
#### ensure_correct_bulk_payout_input(escrow_address, recipients, amounts, final_results_url, final_results_hash)
@@ -410,48 +176,7 @@ Validates input parameters for bulk payout operations.
* **Raises:**
[**EscrowClientError**](#human_protocol_sdk.escrow.escrow_client.EscrowClientError) – If validation fails
-#### fund(escrow_address, amount, tx_options=None)
-
-Adds funds to the escrow.
-
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow to fund
- * **amount** (`Decimal`) – Amount to be added as funds
- * **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 SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- amount = Web3.to_wei(5, 'ether') # convert from ETH to WEI
- escrow_client.fund(
- "0x62dD51230A30401C455c8398d06F85e4EaB6309f", amount
- )
- ```
+#### fund(\*args, \*\*kwargs)
#### get_balance(escrow_address)
@@ -789,151 +514,11 @@ Gets the address of the token used to fund the escrow.
)
```
-#### setup(escrow_address, escrow_config, tx_options=None)
-
-Sets up the parameters of the escrow.
-
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow contract
- * **escrow_config** ([`EscrowConfig`](#human_protocol_sdk.escrow.escrow_client.EscrowConfig)) – Configuration parameters for the escrow
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Transaction options
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- escrow_address = "0x1234567890abcdef1234567890abcdef12345678"
- escrow_config = EscrowConfig(
- recording_oracle_address='0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
- reputation_oracle_address='0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
- exchange_oracle_address='0xabcdefabcdefabcdefabcdefabcdefabcdefabcdef',
- recording_oracle_fee=100,
- reputation_oracle_fee=100,
- exchange_oracle_fee=100,
- recording_oracle_url='https://example.com/recording',
- reputation_oracle_url='https://example.com/reputation',
- exchange_oracle_url='https://example.com/exchange',
- manifest_url='https://example.com/manifest',
- manifest_hash='0xabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdefabcdef'
- )
- escrow_client.setup(
- escrow_address,
- escrow_config
- )
- ```
-* **Return type:**
- `None`
-
-#### store_results(escrow_address, url, hash, tx_options=None)
-
-Stores the results URL.
-
-* **Parameters:**
- * **escrow_address** (`str`) – Address of the escrow
- * **url** (`str`) – Results file URL
- * **hash** (`str`) – Results file hash
- * **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 SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- escrow_client = EscrowClient(w3)
-
- escrow_client.store_results(
- "0x62dD51230A30401C455c8398d06F85e4EaB6309f",
- "http://localhost/results.json",
- "b5dad76bf6772c0f07fd5e048f6e75a5f86ee079"
- )
- ```
-
-#### withdraw(escrow_address, token_address, tx_options=None)
+#### setup(\*args, \*\*kwargs)
-Withdraws additional tokens in the escrow to the canceler.
+#### store_results(\*args, \*\*kwargs)
-* **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 SignAndSendRawMiddlewareBuilder
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- 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"
- )
- ```
+#### withdraw(\*args, \*\*kwargs)
### *exception* human_protocol_sdk.escrow.escrow_client.EscrowClientError
diff --git a/docs/sdk/python/human_protocol_sdk.filter.md b/docs/sdk/python/human_protocol_sdk.filter.md
index ae0d301983..a4b2004a2d 100644
--- a/docs/sdk/python/human_protocol_sdk.filter.md
+++ b/docs/sdk/python/human_protocol_sdk.filter.md
@@ -96,13 +96,13 @@ Initializes a filter for status events.
* **skip** (`int`) – Optional number of events to skip. Default is 0.
* **order_direction** ([`OrderDirection`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.OrderDirection)) – Optional order direction. Default is DESC.
-### *class* human_protocol_sdk.filter.TransactionFilter(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, first=10, skip=0, order_direction=OrderDirection.DESC)
+### *class* human_protocol_sdk.filter.TransactionFilter(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, method=None, escrow=None, token=None, first=10, skip=0, order_direction=OrderDirection.DESC)
Bases: `object`
A class used to filter transactions.
-#### \_\_init_\_(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, first=10, skip=0, order_direction=OrderDirection.DESC)
+#### \_\_init_\_(chain_id, from_address=None, to_address=None, start_date=None, end_date=None, start_block=None, end_block=None, method=None, escrow=None, token=None, first=10, skip=0, order_direction=OrderDirection.DESC)
Initializes a TransactionsFilter instance.
@@ -114,19 +114,22 @@ Initializes a TransactionsFilter instance.
* **end_date** (`Optional`[`datetime`]) – End date for filtering transactions
* **start_block** (`Optional`[`int`]) – Start block number for filtering transactions
* **end_block** (`Optional`[`int`]) – End block number for filtering transactions
+ * **method** (`Optional`[`str`]) – Method name to filter transactions
+ * **escrow** (`Optional`[`str`]) – Escrow address to filter transactions
+ * **token** (`Optional`[`str`]) – Token address to filter transactions
* **first** (`int`) – Number of items per page
* **skip** (`int`) – Page number to retrieve
* **order** – Order of results, “asc” or “desc”
* **Raises:**
**ValueError** – If start_date is after end_date
-### *class* human_protocol_sdk.filter.WorkerFilter(chain_id, worker_address=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
+### *class* human_protocol_sdk.filter.WorkerFilter(chain_id, worker_address=None, order_by='payoutCount', order_direction=OrderDirection.DESC, first=10, skip=0)
Bases: `object`
A class used to filter workers.
-#### \_\_init_\_(chain_id, worker_address=None, order_by=None, order_direction=OrderDirection.DESC, first=10, skip=0)
+#### \_\_init_\_(chain_id, worker_address=None, order_by='payoutCount', order_direction=OrderDirection.DESC, first=10, skip=0)
Initializes a WorkerFilter instance.
diff --git a/docs/sdk/python/human_protocol_sdk.kvstore.kvstore_client.md b/docs/sdk/python/human_protocol_sdk.kvstore.kvstore_client.md
index 4c9cc4767f..5e2028944c 100644
--- a/docs/sdk/python/human_protocol_sdk.kvstore.kvstore_client.md
+++ b/docs/sdk/python/human_protocol_sdk.kvstore.kvstore_client.md
@@ -63,123 +63,11 @@ Initializes a KVStore instance.
* **web3** (`Web3`) – The Web3 object
* **gas_limit** (`Optional`[`int`]) – (Optional) Gas limit for transactions
-#### set(key, value, tx_options=None)
+#### set(\*args, \*\*kwargs)
-Sets the value of a key-value pair in the contract.
+#### set_bulk(\*args, \*\*kwargs)
-* **Parameters:**
- * **key** (`str`) – The key of the key-value pair to set
- * **value** (`str`) – The value of the key-value pair to set
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.kvstore import KVStoreClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- kvstore_client = KVStoreClient(w3)
- kvstore_client.set('Role', 'RecordingOracle')
- ```
-
-#### set_bulk(keys, values, tx_options=None)
-
-Sets multiple key-value pairs in the contract.
-
-* **Parameters:**
- * **keys** (`List`[`str`]) – A list of keys to set
- * **values** (`List`[`str`]) – A list of values to set
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.kvstore import KVStoreClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- kvstore_client = KVStoreClient(w3)
-
- keys = ['Role', 'Webhook_url']
- values = ['RecordingOracle', 'http://localhost']
- kvstore_client.set_bulk(keys, values)
- ```
-
-#### set_file_url_and_hash(url, key='url', tx_options=None)
-
-Sets a URL value for the address that submits the transaction, and its hash.
-
-* **Parameters:**
- * **url** (`str`) – URL to set
- * **key** (`Optional`[`str`]) – Configurable URL key. url by default.
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Raises:**
- [**KVStoreClientError**](#human_protocol_sdk.kvstore.kvstore_client.KVStoreClientError) – If an error occurs while validating URL, or handling transaction
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.kvstore import KVStoreClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- kvstore_client = KVStoreClient(w3)
-
- kvstore_client.set_file_url_and_hash('http://localhost')
- kvstore_client.set_file_url_and_hash('https://linkedin.com/me', 'linkedin_url')
- ```
+#### set_file_url_and_hash(\*args, \*\*kwargs)
### *exception* human_protocol_sdk.kvstore.kvstore_client.KVStoreClientError
diff --git a/docs/sdk/python/human_protocol_sdk.md b/docs/sdk/python/human_protocol_sdk.md
index 7f19d62801..ef2b0b539e 100644
--- a/docs/sdk/python/human_protocol_sdk.md
+++ b/docs/sdk/python/human_protocol_sdk.md
@@ -114,6 +114,12 @@
* [`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)
+* [human_protocol_sdk.worker package](human_protocol_sdk.worker.md)
+ * [Submodules](human_protocol_sdk.worker.md#submodules)
+ * [human_protocol_sdk.worker.worker_utils module](human_protocol_sdk.worker.worker_utils.md)
+ * [`WorkerData`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerData)
+ * [`WorkerUtils`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils)
+ * [`WorkerUtilsError`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtilsError)
## Submodules
@@ -194,7 +200,7 @@
* [`get_hmt_balance()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_hmt_balance)
* [`get_kvstore_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_kvstore_interface)
* [`get_staking_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_staking_interface)
- * [`handle_transaction()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.handle_transaction)
+ * [`handle_error()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.handle_error)
* [`parse_transfer_transaction()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.parse_transfer_transaction)
* [`validate_url()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.validate_url)
* [`with_retry()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.with_retry)
diff --git a/docs/sdk/python/human_protocol_sdk.staking.staking_client.md b/docs/sdk/python/human_protocol_sdk.staking.staking_client.md
index e0a9fbc526..c0155d7cb5 100644
--- a/docs/sdk/python/human_protocol_sdk.staking.staking_client.md
+++ b/docs/sdk/python/human_protocol_sdk.staking.staking_client.md
@@ -62,45 +62,7 @@ Initializes a Staking instance
* **Parameters:**
**w3** (`Web3`) – Web3 instance
-#### approve_stake(amount, tx_options=None)
-
-Approves HMT token for Staking.
-
-* **Parameters:**
- * **amount** (`Decimal`) – Amount to approve
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Validate:**
- Amount must be greater than 0
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.staking import StakingClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- staking_client = StakingClient(w3)
-
- amount = Web3.to_wei(5, 'ether') # convert from ETH to WEI
- staking_client.approve_stake(amount)
- ```
+#### approve_stake(\*args, \*\*kwargs)
#### get_staker_info(staker_address)
@@ -129,177 +91,13 @@ Retrieves comprehensive staking information for a staker.
print(staking_info['stakedAmount'])
```
-#### slash(slasher, staker, escrow_address, amount, tx_options=None)
+#### slash(\*args, \*\*kwargs)
-Slashes HMT token.
+#### stake(\*args, \*\*kwargs)
-* **Parameters:**
- * **slasher** (`str`) – Address of the slasher
- * **staker** (`str`) – Address of the staker
- * **escrow_address** (`str`) – Address of the escrow
- * **amount** (`Decimal`) – Amount to slash
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Validate:**
- - Amount must be greater than 0
- - Amount must be less than or equal to the amount allocated to the escrow (on-chain)
- - Escrow address must be valid
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.staking import StakingClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- staking_client = StakingClient(w3)
-
- amount = Web3.to_wei(5, 'ether') # convert from ETH to WEI
- staking_client.slash(
- '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
- '0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266',
- '0x62dD51230A30401C455c8398d06F85e4EaB6309f',
- amount
- )
- ```
-
-#### stake(amount, tx_options=None)
+#### unstake(\*args, \*\*kwargs)
-Stakes HMT token.
-
-* **Parameters:**
- * **amount** (`Decimal`) – Amount to stake
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Validate:**
- - Amount must be greater than 0
- - Amount must be less than or equal to the approved amount (on-chain)
- - Amount must be less than or equal to the balance of the staker (on-chain)
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.staking import StakingClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- staking_client = StakingClient(w3)
-
- amount = Web3.to_wei(5, 'ether') # convert from ETH to WEI
- staking_client.approve_stake(amount) # if it was already approved before, this is not necessary
- staking_client.stake(amount)
- ```
-
-#### unstake(amount, tx_options=None)
-
-Unstakes HMT token.
-
-* **Parameters:**
- * **amount** (`Decimal`) – Amount to unstake
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Validate:**
- - Amount must be greater than 0
- - Amount must be less than or equal to the staked amount which is not locked / allocated (on-chain)
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.staking import StakingClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- staking_client = StakingClient(w3)
-
- amount = Web3.to_wei(5, 'ether') # convert from ETH to WEI
- staking_client.unstake(amount)
- ```
-
-#### withdraw(tx_options=None)
-
-Withdraws HMT token.
-
-* **Parameters:**
- **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
-* **Return type:**
- `None`
-* **Returns:**
- None
-* **Validate:**
- - There must be unstaked tokens which is unlocked (on-chain)
-* **Example:**
- ```python
- from eth_typing import URI
- from web3 import Web3
- from web3.middleware import SignAndSendRawMiddlewareBuilder
- from web3.providers.auto import load_provider_from_uri
-
- from human_protocol_sdk.staking import StakingClient
-
- 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.inject(
- SignAndSendRawMiddlewareBuilder.build(priv_key),
- 'SignAndSendRawMiddlewareBuilder',
- layer=0,
- )
- return (w3, gas_payer)
-
- (w3, gas_payer) = get_w3_with_priv_key('YOUR_PRIVATE_KEY')
- staking_client = StakingClient(w3)
-
- staking_client.withdraw()
- ```
+#### withdraw(\*args, \*\*kwargs)
### *exception* human_protocol_sdk.staking.staking_client.StakingClientError
diff --git a/docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md b/docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md
index 7b31e4ea65..b982ca0071 100644
--- a/docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md
+++ b/docs/sdk/python/human_protocol_sdk.transaction.transaction_utils.md
@@ -71,6 +71,7 @@ Get an array of transactions based on the specified filter parameters.
* **Parameters:**
**filter** ([`TransactionFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.TransactionFilter)) – Object containing all the necessary parameters to filter
+ (chain_id, from_address, to_address, start_date, end_date, start_block, end_block, method, escrow, token, first, skip, order_direction)
* **Return type:**
`List`[[`TransactionData`](#human_protocol_sdk.transaction.transaction_utils.TransactionData)]
* **Returns:**
@@ -86,6 +87,8 @@ Get an array of transactions based on the specified filter parameters.
chain_id=ChainId.POLYGON_AMOY,
from_address="0x1234567890123456789012345678901234567890",
to_address="0x0987654321098765432109876543210987654321",
+ method="transfer",
+ escrow="0x0987654321098765432109876543210987654321",
start_date=datetime.datetime(2023, 5, 8),
end_date=datetime.datetime(2023, 6, 8),
)
diff --git a/docs/sdk/python/human_protocol_sdk.utils.md b/docs/sdk/python/human_protocol_sdk.utils.md
index 48aa0d3427..f0e73515b6 100644
--- a/docs/sdk/python/human_protocol_sdk.utils.md
+++ b/docs/sdk/python/human_protocol_sdk.utils.md
@@ -68,24 +68,26 @@ Retrieve the Staking interface.
* **Returns:**
The Staking interface of smart contract.
-### human_protocol_sdk.utils.handle_transaction(w3, tx_name, tx, exception, tx_options)
+### human_protocol_sdk.utils.handle_error(e, exception_class)
-Executes the transaction and waits for the receipt.
+Handles and translates errors raised during contract transactions.
+
+This function captures exceptions (especially ContractLogicError from web3.py),
+extracts meaningful revert reasons if present, logs unexpected errors, and raises
+a custom exception with a clear message for SDK users.
* **Parameters:**
- * **w3** (`Web3`) – Web3 instance
- * **tx_name** (`str`) – Name of the transaction
- * **tx** – Transaction object
- * **exception** (`Exception`) – Exception class to raise in case of error
- * **tx_options** (`Optional`[`TxParams`]) – (Optional) Additional transaction parameters
- - If provided, can include values like ‘gas’, ‘gas_price’, ‘nonce’, etc
- - If ‘gas’ is not specified or is None, it will be estimated using tx.estimate_gas()
-* **Returns:**
- The transaction receipt
-* **Validate:**
- - There must be a default account
+ * **e** – The exception object raised during a transaction.
+ * **exception_class** – The custom exception class to raise (e.g., EscrowClientError).
* **Raises:**
- **exception** – If the transaction fails
+ **exception_class** – With a detailed error message, including contract revert reasons if available.
+* **Example:**
+ try:
+ : tx_hash = contract.functions.someMethod(…).transact()
+ w3.eth.wait_for_transaction_receipt(tx_hash)
+
+ except Exception as e:
+ : handle_error(e, EscrowClientError)
### human_protocol_sdk.utils.parse_transfer_transaction(hmtoken_contract, tx_receipt)
diff --git a/docs/sdk/python/human_protocol_sdk.worker.md b/docs/sdk/python/human_protocol_sdk.worker.md
new file mode 100644
index 0000000000..e62f9a998c
--- /dev/null
+++ b/docs/sdk/python/human_protocol_sdk.worker.md
@@ -0,0 +1,13 @@
+# human_protocol_sdk.worker package
+
+This module enables to obtain worker information from subgraph.
+
+## Submodules
+
+* [human_protocol_sdk.worker.worker_utils module](human_protocol_sdk.worker.worker_utils.md)
+ * [`WorkerData`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerData)
+ * [`WorkerData.__init__()`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerData.__init__)
+ * [`WorkerUtils`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils)
+ * [`WorkerUtils.get_worker()`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils.get_worker)
+ * [`WorkerUtils.get_workers()`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtils.get_workers)
+ * [`WorkerUtilsError`](human_protocol_sdk.worker.worker_utils.md#human_protocol_sdk.worker.worker_utils.WorkerUtilsError)
diff --git a/docs/sdk/python/human_protocol_sdk.worker.worker_utils.md b/docs/sdk/python/human_protocol_sdk.worker.worker_utils.md
new file mode 100644
index 0000000000..91dea1a87c
--- /dev/null
+++ b/docs/sdk/python/human_protocol_sdk.worker.worker_utils.md
@@ -0,0 +1,50 @@
+# human_protocol_sdk.worker.worker_utils module
+
+### *class* human_protocol_sdk.worker.worker_utils.WorkerData(id, address, total_amount_received, payout_count)
+
+Bases: `object`
+
+#### \_\_init_\_(id, address, total_amount_received, payout_count)
+
+Initializes a WorkerData instance.
+
+* **Parameters:**
+ * **id** (`str`) – Worker ID
+ * **address** (`str`) – Worker address
+ * **total_amount_received** (`int`) – Total amount received by the worker
+ * **payout_count** (`int`) – Number of payouts received by the worker
+
+### *class* human_protocol_sdk.worker.worker_utils.WorkerUtils
+
+Bases: `object`
+
+A utility class that provides additional worker-related functionalities.
+
+#### *static* get_worker(chain_id, worker_address)
+
+Gets the worker details.
+
+* **Parameters:**
+ * **chain_id** ([`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)) – Network in which the worker exists
+ * **worker_address** (`str`) – Address of the worker
+* **Return type:**
+ `Optional`[[`WorkerData`](#human_protocol_sdk.worker.worker_utils.WorkerData)]
+* **Returns:**
+ Worker data if exists, otherwise None
+
+#### *static* get_workers(filter)
+
+Get workers data of the protocol.
+
+* **Parameters:**
+ **filter** ([`WorkerFilter`](human_protocol_sdk.filter.md#human_protocol_sdk.filter.WorkerFilter)) – Worker filter
+* **Return type:**
+ `List`[[`WorkerData`](#human_protocol_sdk.worker.worker_utils.WorkerData)]
+* **Returns:**
+ List of workers data
+
+### *exception* human_protocol_sdk.worker.worker_utils.WorkerUtilsError
+
+Bases: `Exception`
+
+Raised when an error occurs when getting data from subgraph.
diff --git a/docs/sdk/python/index.md b/docs/sdk/python/index.md
index 75b6eaeb1e..dcba33dab9 100644
--- a/docs/sdk/python/index.md
+++ b/docs/sdk/python/index.md
@@ -42,6 +42,8 @@ pip install human-protocol-sdk[agreement]
* [Submodules](human_protocol_sdk.storage.md#submodules)
* [human_protocol_sdk.transaction package](human_protocol_sdk.transaction.md)
* [Submodules](human_protocol_sdk.transaction.md#submodules)
+ * [human_protocol_sdk.worker package](human_protocol_sdk.worker.md)
+ * [Submodules](human_protocol_sdk.worker.md#submodules)
* [Submodules](human_protocol_sdk.md#submodules)
* [human_protocol_sdk.constants module](human_protocol_sdk.constants.md)
* [`ChainId`](human_protocol_sdk.constants.md#human_protocol_sdk.constants.ChainId)
@@ -71,7 +73,7 @@ pip install human-protocol-sdk[agreement]
* [`get_hmt_balance()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_hmt_balance)
* [`get_kvstore_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_kvstore_interface)
* [`get_staking_interface()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.get_staking_interface)
- * [`handle_transaction()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.handle_transaction)
+ * [`handle_error()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.handle_error)
* [`parse_transfer_transaction()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.parse_transfer_transaction)
* [`validate_url()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.validate_url)
* [`with_retry()`](human_protocol_sdk.utils.md#human_protocol_sdk.utils.with_retry)
diff --git a/docs/sdk/typescript/base/classes/BaseEthersClient.md b/docs/sdk/typescript/base/classes/BaseEthersClient.md
index a0277ae359..f1ab048696 100644
--- a/docs/sdk/typescript/base/classes/BaseEthersClient.md
+++ b/docs/sdk/typescript/base/classes/BaseEthersClient.md
@@ -6,7 +6,7 @@
# Class: `abstract` BaseEthersClient
-Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L10)
+Defined in: [base.ts:10](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L10)
## Introduction
@@ -20,11 +20,11 @@ This class is used as a base class for other clients making on-chain calls.
## Constructors
-### new BaseEthersClient()
+### Constructor
-> **new BaseEthersClient**(`runner`, `networkData`): [`BaseEthersClient`](BaseEthersClient.md)
+> **new BaseEthersClient**(`runner`, `networkData`): `BaseEthersClient`
-Defined in: [base.ts:20](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
+Defined in: [base.ts:20](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L20)
**BaseClient constructor**
@@ -44,7 +44,7 @@ The network information required to connect to the contracts
#### Returns
-[`BaseEthersClient`](BaseEthersClient.md)
+`BaseEthersClient`
## Properties
@@ -52,7 +52,7 @@ The network information required to connect to the contracts
> **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
-Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
***
@@ -60,4 +60,4 @@ Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1f
> `protected` **runner**: `ContractRunner`
-Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
diff --git a/docs/sdk/typescript/encryption/classes/Encryption.md b/docs/sdk/typescript/encryption/classes/Encryption.md
index 822c353959..ecf46779f5 100644
--- a/docs/sdk/typescript/encryption/classes/Encryption.md
+++ b/docs/sdk/typescript/encryption/classes/Encryption.md
@@ -6,7 +6,7 @@
# Class: Encryption
-Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
+Defined in: [encryption.ts:58](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L58)
## Introduction
@@ -49,11 +49,11 @@ const encryption = await Encryption.build(privateKey, passphrase);
## Constructors
-### new Encryption()
+### Constructor
-> **new Encryption**(`privateKey`): [`Encryption`](Encryption.md)
+> **new Encryption**(`privateKey`): `Encryption`
-Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
+Defined in: [encryption.ts:66](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L66)
Constructor for the Encryption class.
@@ -67,15 +67,15 @@ The private key.
#### Returns
-[`Encryption`](Encryption.md)
+`Encryption`
## Methods
### decrypt()
-> **decrypt**(`message`, `publicKey`?): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+> **decrypt**(`message`, `publicKey?`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
-Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L194)
+Defined in: [encryption.ts:194](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/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.
@@ -129,7 +129,7 @@ const resultMessage = await encryption.decrypt('message');
> **sign**(`message`): `Promise`\<`string`\>
-Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
+Defined in: [encryption.ts:251](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L251)
This function signs a message using the private key used to initialize the client.
@@ -165,7 +165,7 @@ const resultMessage = await encryption.sign('message');
> **signAndEncrypt**(`message`, `publicKeys`): `Promise`\<`string`\>
-Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L142)
+Defined in: [encryption.ts:142](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/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.
@@ -230,9 +230,9 @@ const resultMessage = await encryption.signAndEncrypt('message', publicKeys);
### build()
-> `static` **build**(`privateKeyArmored`, `passphrase`?): `Promise`\<[`Encryption`](Encryption.md)\>
+> `static` **build**(`privateKeyArmored`, `passphrase?`): `Promise`\<`Encryption`\>
-Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L77)
+Defined in: [encryption.ts:77](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/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.
@@ -252,6 +252,6 @@ Optional: The passphrase for the private key.
#### Returns
-`Promise`\<[`Encryption`](Encryption.md)\>
+`Promise`\<`Encryption`\>
- The Encryption instance.
diff --git a/docs/sdk/typescript/encryption/classes/EncryptionUtils.md b/docs/sdk/typescript/encryption/classes/EncryptionUtils.md
index 8d1127cea6..7c56fe6d8f 100644
--- a/docs/sdk/typescript/encryption/classes/EncryptionUtils.md
+++ b/docs/sdk/typescript/encryption/classes/EncryptionUtils.md
@@ -6,7 +6,7 @@
# Class: EncryptionUtils
-Defined in: [encryption.ts:290](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L290)
+Defined in: [encryption.ts:290](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L290)
## Introduction
@@ -34,13 +34,13 @@ const keyPair = await EncryptionUtils.generateKeyPair('Human', 'human@hmt.ai');
## Constructors
-### new EncryptionUtils()
+### Constructor
-> **new EncryptionUtils**(): [`EncryptionUtils`](EncryptionUtils.md)
+> **new EncryptionUtils**(): `EncryptionUtils`
#### Returns
-[`EncryptionUtils`](EncryptionUtils.md)
+`EncryptionUtils`
## Methods
@@ -48,7 +48,7 @@ const keyPair = await EncryptionUtils.generateKeyPair('Human', 'human@hmt.ai');
> `static` **encrypt**(`message`, `publicKeys`): `Promise`\<`string`\>
-Defined in: [encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)
+Defined in: [encryption.ts:444](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L444)
This function encrypts a message using the specified public keys.
@@ -111,7 +111,7 @@ const result = await EncryptionUtils.encrypt('message', publicKeys);
> `static` **generateKeyPair**(`name`, `email`, `passphrase`): `Promise`\<[`IKeyPair`](../../interfaces/interfaces/IKeyPair.md)\>
-Defined in: [encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)
+Defined in: [encryption.ts:382](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L382)
This function generates a key pair for encryption and decryption.
@@ -158,7 +158,7 @@ const result = await EncryptionUtils.generateKeyPair(name, email, passphrase);
> `static` **getSignedData**(`message`): `Promise`\<`string`\>
-Defined in: [encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)
+Defined in: [encryption.ts:351](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L351)
This function gets signed data from a signed message.
@@ -190,7 +190,7 @@ const signedData = await EncryptionUtils.getSignedData('message');
> `static` **isEncrypted**(`message`): `boolean`
-Defined in: [encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)
+Defined in: [encryption.ts:494](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L494)
Verifies if a message appears to be encrypted with OpenPGP.
@@ -238,7 +238,7 @@ if (isEncrypted) {
> `static` **verify**(`message`, `publicKey`): `Promise`\<`boolean`\>
-Defined in: [encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
+Defined in: [encryption.ts:318](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/encryption.ts#L318)
This function verifies the signature of a signed message using the public key.
diff --git a/docs/sdk/typescript/enums/enumerations/ChainId.md b/docs/sdk/typescript/enums/enumerations/ChainId.md
index 5627a76ac9..bb3a336000 100644
--- a/docs/sdk/typescript/enums/enumerations/ChainId.md
+++ b/docs/sdk/typescript/enums/enumerations/ChainId.md
@@ -6,7 +6,7 @@
# Enumeration: ChainId
-Defined in: [enums.ts:1](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L1)
+Defined in: [enums.ts:1](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L1)
## Enumeration Members
@@ -14,7 +14,7 @@ Defined in: [enums.ts:1](https://github.com/humanprotocol/human-protocol/blob/1f
> **ALL**: `-1`
-Defined in: [enums.ts:2](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L2)
+Defined in: [enums.ts:2](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L2)
***
@@ -22,7 +22,7 @@ Defined in: [enums.ts:2](https://github.com/humanprotocol/human-protocol/blob/1f
> **BSC\_MAINNET**: `56`
-Defined in: [enums.ts:5](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L5)
+Defined in: [enums.ts:5](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L5)
***
@@ -30,7 +30,7 @@ Defined in: [enums.ts:5](https://github.com/humanprotocol/human-protocol/blob/1f
> **BSC\_TESTNET**: `97`
-Defined in: [enums.ts:6](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L6)
+Defined in: [enums.ts:6](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L6)
***
@@ -38,7 +38,7 @@ Defined in: [enums.ts:6](https://github.com/humanprotocol/human-protocol/blob/1f
> **LOCALHOST**: `1338`
-Defined in: [enums.ts:9](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L9)
+Defined in: [enums.ts:9](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L9)
***
@@ -46,7 +46,7 @@ Defined in: [enums.ts:9](https://github.com/humanprotocol/human-protocol/blob/1f
> **MAINNET**: `1`
-Defined in: [enums.ts:3](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L3)
+Defined in: [enums.ts:3](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L3)
***
@@ -54,7 +54,7 @@ Defined in: [enums.ts:3](https://github.com/humanprotocol/human-protocol/blob/1f
> **POLYGON**: `137`
-Defined in: [enums.ts:7](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L7)
+Defined in: [enums.ts:7](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L7)
***
@@ -62,7 +62,7 @@ Defined in: [enums.ts:7](https://github.com/humanprotocol/human-protocol/blob/1f
> **POLYGON\_AMOY**: `80002`
-Defined in: [enums.ts:8](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L8)
+Defined in: [enums.ts:8](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L8)
***
@@ -70,4 +70,4 @@ Defined in: [enums.ts:8](https://github.com/humanprotocol/human-protocol/blob/1f
> **SEPOLIA**: `11155111`
-Defined in: [enums.ts:4](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L4)
+Defined in: [enums.ts:4](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L4)
diff --git a/docs/sdk/typescript/enums/enumerations/OperatorCategory.md b/docs/sdk/typescript/enums/enumerations/OperatorCategory.md
index 3d5d13af20..fe073231a7 100644
--- a/docs/sdk/typescript/enums/enumerations/OperatorCategory.md
+++ b/docs/sdk/typescript/enums/enumerations/OperatorCategory.md
@@ -6,7 +6,7 @@
# Enumeration: OperatorCategory
-Defined in: [enums.ts:17](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L17)
+Defined in: [enums.ts:17](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L17)
## Enumeration Members
@@ -14,7 +14,7 @@ Defined in: [enums.ts:17](https://github.com/humanprotocol/human-protocol/blob/1
> **MACHINE\_LEARNING**: `"machine_learning"`
-Defined in: [enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L18)
+Defined in: [enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L18)
***
@@ -22,4 +22,4 @@ Defined in: [enums.ts:18](https://github.com/humanprotocol/human-protocol/blob/1
> **MARKET\_MAKING**: `"market_making"`
-Defined in: [enums.ts:19](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L19)
+Defined in: [enums.ts:19](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L19)
diff --git a/docs/sdk/typescript/enums/enumerations/OrderDirection.md b/docs/sdk/typescript/enums/enumerations/OrderDirection.md
index e980964850..44edbc1f67 100644
--- a/docs/sdk/typescript/enums/enumerations/OrderDirection.md
+++ b/docs/sdk/typescript/enums/enumerations/OrderDirection.md
@@ -6,7 +6,7 @@
# Enumeration: OrderDirection
-Defined in: [enums.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L12)
+Defined in: [enums.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L12)
## Enumeration Members
@@ -14,7 +14,7 @@ Defined in: [enums.ts:12](https://github.com/humanprotocol/human-protocol/blob/1
> **ASC**: `"asc"`
-Defined in: [enums.ts:13](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L13)
+Defined in: [enums.ts:13](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L13)
***
@@ -22,4 +22,4 @@ Defined in: [enums.ts:13](https://github.com/humanprotocol/human-protocol/blob/1
> **DESC**: `"desc"`
-Defined in: [enums.ts:14](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L14)
+Defined in: [enums.ts:14](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/enums.ts#L14)
diff --git a/docs/sdk/typescript/escrow/classes/EscrowClient.md b/docs/sdk/typescript/escrow/classes/EscrowClient.md
index 445e354d15..7963dd8ec6 100644
--- a/docs/sdk/typescript/escrow/classes/EscrowClient.md
+++ b/docs/sdk/typescript/escrow/classes/EscrowClient.md
@@ -6,7 +6,7 @@
# Class: EscrowClient
-Defined in: [escrow.ts:141](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L141)
+Defined in: [escrow.ts:142](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L142)
## Introduction
@@ -82,11 +82,11 @@ const escrowClient = await EscrowClient.build(provider);
## Constructors
-### new EscrowClient()
+### Constructor
-> **new EscrowClient**(`runner`, `networkData`): [`EscrowClient`](EscrowClient.md)
+> **new EscrowClient**(`runner`, `networkData`): `EscrowClient`
-Defined in: [escrow.ts:150](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L150)
+Defined in: [escrow.ts:151](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L151)
**EscrowClient constructor**
@@ -106,11 +106,11 @@ The network information required to connect to the Escrow contract
#### Returns
-[`EscrowClient`](EscrowClient.md)
+`EscrowClient`
#### Overrides
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`constructor`](../../base/classes/BaseEthersClient.md#constructors)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`constructor`](../../base/classes/BaseEthersClient.md#constructor)
## Properties
@@ -118,11 +118,11 @@ The network information required to connect to the Escrow contract
> **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
-Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
#### Inherited from
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`networkData`](../../base/classes/BaseEthersClient.md#networkdata-1)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`networkData`](../../base/classes/BaseEthersClient.md#networkdata)
***
@@ -130,19 +130,19 @@ Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1f
> `protected` **runner**: `ContractRunner`
-Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
#### Inherited from
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`runner`](../../base/classes/BaseEthersClient.md#runner-1)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`runner`](../../base/classes/BaseEthersClient.md#runner)
## Methods
### addTrustedHandlers()
-> **addTrustedHandlers**(`escrowAddress`, `trustedHandlers`, `txOptions`?): `Promise`\<`void`\>
+> **addTrustedHandlers**(`escrowAddress`, `trustedHandlers`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [escrow.ts:778](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L778)
+Defined in: [escrow.ts:779](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L779)
This function adds an array of addresses to the trusted handlers list.
@@ -195,9 +195,9 @@ await escrowClient.addTrustedHandlers('0x62dD51230A30401C455c8398d06F85e4EaB6309
### bulkPayOut()
-> **bulkPayOut**(`escrowAddress`, `recipients`, `amounts`, `finalResultsUrl`, `finalResultsHash`, `txId`, `forceComplete`, `txOptions`?): `Promise`\<`void`\>
+> **bulkPayOut**(`escrowAddress`, `recipients`, `amounts`, `finalResultsUrl`, `finalResultsHash`, `txId`, `forceComplete`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [escrow.ts:611](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L611)
+Defined in: [escrow.ts:612](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L612)
This function pays out the amounts specified to the workers and sets the URL of the final results file.
@@ -285,9 +285,9 @@ await escrowClient.bulkPayOut('0x62dD51230A30401C455c8398d06F85e4EaB6309f', reci
### cancel()
-> **cancel**(`escrowAddress`, `txOptions`?): `Promise`\<[`EscrowCancel`](../../types/type-aliases/EscrowCancel.md)\>
+> **cancel**(`escrowAddress`, `txOptions?`): `Promise`\<[`EscrowCancel`](../../types/type-aliases/EscrowCancel.md)\>
-Defined in: [escrow.ts:692](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L692)
+Defined in: [escrow.ts:693](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L693)
This function cancels the specified escrow and sends the balance to the canceler.
@@ -333,9 +333,9 @@ await escrowClient.cancel('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
### complete()
-> **complete**(`escrowAddress`, `txOptions`?): `Promise`\<`void`\>
+> **complete**(`escrowAddress`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [escrow.ts:550](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L550)
+Defined in: [escrow.ts:551](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L551)
This function sets the status of an escrow to completed.
@@ -381,9 +381,9 @@ await escrowClient.complete('0x62dD51230A30401C455c8398d06F85e4EaB6309f');
### createBulkPayoutTransaction()
-> **createBulkPayoutTransaction**(`escrowAddress`, `recipients`, `amounts`, `finalResultsUrl`, `finalResultsHash`, `txId`, `forceComplete`, `txOptions`?): `Promise`\<[`TransactionLikeWithNonce`](../../types/type-aliases/TransactionLikeWithNonce.md)\>
+> **createBulkPayoutTransaction**(`escrowAddress`, `recipients`, `amounts`, `finalResultsUrl`, `finalResultsHash`, `txId`, `forceComplete`, `txOptions?`): `Promise`\<[`TransactionLikeWithNonce`](../../types/type-aliases/TransactionLikeWithNonce.md)\>
-Defined in: [escrow.ts:947](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L947)
+Defined in: [escrow.ts:948](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L948)
Creates a prepared transaction for bulk payout without immediately sending it.
@@ -475,9 +475,9 @@ console.log('Tx hash:', ethers.keccak256(signedTransaction));
### createEscrow()
-> **createEscrow**(`tokenAddress`, `trustedHandlers`, `jobRequesterId`, `txOptions`?): `Promise`\<`string`\>
+> **createEscrow**(`tokenAddress`, `trustedHandlers`, `jobRequesterId`, `txOptions?`): `Promise`\<`string`\>
-Defined in: [escrow.ts:230](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L230)
+Defined in: [escrow.ts:231](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L231)
This function creates an escrow contract that uses the token passed to pay oracle fees and reward workers.
@@ -538,9 +538,9 @@ const escrowAddress = await escrowClient.createEscrow(tokenAddress, trustedHandl
### fund()
-> **fund**(`escrowAddress`, `amount`, `txOptions`?): `Promise`\<`void`\>
+> **fund**(`escrowAddress`, `amount`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [escrow.ts:421](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L421)
+Defined in: [escrow.ts:422](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L422)
This function adds funds of the chosen token to the escrow.
@@ -593,7 +593,7 @@ await escrowClient.fund('0x62dD51230A30401C455c8398d06F85e4EaB6309f', amount);
> **getBalance**(`escrowAddress`): `Promise`\<`bigint`\>
-Defined in: [escrow.ts:1092](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1092)
+Defined in: [escrow.ts:1093](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1093)
This function returns the balance for a specified escrow address.
@@ -631,7 +631,7 @@ const balance = await escrowClient.getBalance('0x62dD51230A30401C455c8398d06F85e
> **getExchangeOracleAddress**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1478](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1478)
+Defined in: [escrow.ts:1479](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1479)
This function returns the exchange oracle address for a given escrow.
@@ -669,7 +669,7 @@ const oracleAddress = await escrowClient.getExchangeOracleAddress('0x62dD51230A3
> **getFactoryAddress**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1516](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1516)
+Defined in: [escrow.ts:1517](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1517)
This function returns the escrow factory address for a given escrow.
@@ -707,7 +707,7 @@ const factoryAddress = await escrowClient.getFactoryAddress('0x62dD51230A30401C4
> **getIntermediateResultsUrl**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1250](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1250)
+Defined in: [escrow.ts:1251](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1251)
This function returns the intermediate results file URL.
@@ -745,7 +745,7 @@ const intermediateResultsUrl = await escrowClient.getIntermediateResultsUrl('0x6
> **getJobLauncherAddress**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1402](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1402)
+Defined in: [escrow.ts:1403](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1403)
This function returns the job launcher address for a given escrow.
@@ -783,7 +783,7 @@ const jobLauncherAddress = await escrowClient.getJobLauncherAddress('0x62dD51230
> **getManifestHash**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1136](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1136)
+Defined in: [escrow.ts:1137](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1137)
This function returns the manifest file hash.
@@ -821,7 +821,7 @@ const manifestHash = await escrowClient.getManifestHash('0x62dD51230A30401C455c8
> **getManifestUrl**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1174](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1174)
+Defined in: [escrow.ts:1175](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1175)
This function returns the manifest file URL.
@@ -859,7 +859,7 @@ const manifestUrl = await escrowClient.getManifestUrl('0x62dD51230A30401C455c839
> **getRecordingOracleAddress**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1364](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1364)
+Defined in: [escrow.ts:1365](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1365)
This function returns the recording oracle address for a given escrow.
@@ -897,7 +897,7 @@ const oracleAddress = await escrowClient.getRecordingOracleAddress('0x62dD51230A
> **getReputationOracleAddress**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1440](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1440)
+Defined in: [escrow.ts:1441](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1441)
This function returns the reputation oracle address for a given escrow.
@@ -935,7 +935,7 @@ const oracleAddress = await escrowClient.getReputationOracleAddress('0x62dD51230
> **getResultsUrl**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1212](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1212)
+Defined in: [escrow.ts:1213](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1213)
This function returns the results file URL.
@@ -973,7 +973,7 @@ const resultsUrl = await escrowClient.getResultsUrl('0x62dD51230A30401C455c8398d
> **getStatus**(`escrowAddress`): `Promise`\<[`EscrowStatus`](../../types/enumerations/EscrowStatus.md)\>
-Defined in: [escrow.ts:1326](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1326)
+Defined in: [escrow.ts:1327](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1327)
This function returns the current status of the escrow.
@@ -1011,7 +1011,7 @@ const status = await escrowClient.getStatus('0x62dD51230A30401C455c8398d06F85e4E
> **getTokenAddress**(`escrowAddress`): `Promise`\<`string`\>
-Defined in: [escrow.ts:1288](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1288)
+Defined in: [escrow.ts:1289](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1289)
This function returns the token address used for funding the escrow.
@@ -1047,9 +1047,9 @@ const tokenAddress = await escrowClient.getTokenAddress('0x62dD51230A30401C455c8
### setup()
-> **setup**(`escrowAddress`, `escrowConfig`, `txOptions`?): `Promise`\<`void`\>
+> **setup**(`escrowAddress`, `escrowConfig`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [escrow.ts:311](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L311)
+Defined in: [escrow.ts:312](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L312)
This function sets up the parameters of the escrow.
@@ -1112,9 +1112,9 @@ await escrowClient.setup(escrowAddress, escrowConfig);
### storeResults()
-> **storeResults**(`escrowAddress`, `url`, `hash`, `txOptions`?): `Promise`\<`void`\>
+> **storeResults**(`escrowAddress`, `url`, `hash`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [escrow.ts:486](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L486)
+Defined in: [escrow.ts:487](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L487)
This function stores the results URL and hash.
@@ -1172,9 +1172,9 @@ await escrowClient.storeResults('0x62dD51230A30401C455c8398d06F85e4EaB6309f', 'h
### withdraw()
-> **withdraw**(`escrowAddress`, `tokenAddress`, `txOptions`?): `Promise`\<[`EscrowWithdraw`](../../types/type-aliases/EscrowWithdraw.md)\>
+> **withdraw**(`escrowAddress`, `tokenAddress`, `txOptions?`): `Promise`\<[`EscrowWithdraw`](../../types/type-aliases/EscrowWithdraw.md)\>
-Defined in: [escrow.ts:844](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L844)
+Defined in: [escrow.ts:845](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L845)
This function withdraws additional tokens in the escrow to the canceler.
@@ -1229,9 +1229,9 @@ await escrowClient.withdraw(
### build()
-> `static` **build**(`runner`): `Promise`\<[`EscrowClient`](EscrowClient.md)\>
+> `static` **build**(`runner`): `Promise`\<`EscrowClient`\>
-Defined in: [escrow.ts:168](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L168)
+Defined in: [escrow.ts:169](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L169)
Creates an instance of EscrowClient from a Runner.
@@ -1245,7 +1245,7 @@ The Runner object to interact with the Ethereum network
#### Returns
-`Promise`\<[`EscrowClient`](EscrowClient.md)\>
+`Promise`\<`EscrowClient`\>
An instance of EscrowClient
diff --git a/docs/sdk/typescript/escrow/classes/EscrowUtils.md b/docs/sdk/typescript/escrow/classes/EscrowUtils.md
index 7622cb9120..e683ad1f73 100644
--- a/docs/sdk/typescript/escrow/classes/EscrowUtils.md
+++ b/docs/sdk/typescript/escrow/classes/EscrowUtils.md
@@ -6,7 +6,7 @@
# Class: EscrowUtils
-Defined in: [escrow.ts:1565](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1565)
+Defined in: [escrow.ts:1566](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1566)
## Introduction
@@ -40,21 +40,21 @@ const escrowAddresses = new EscrowUtils.getEscrows({
## Constructors
-### new EscrowUtils()
+### Constructor
-> **new EscrowUtils**(): [`EscrowUtils`](EscrowUtils.md)
+> **new EscrowUtils**(): `EscrowUtils`
#### Returns
-[`EscrowUtils`](EscrowUtils.md)
+`EscrowUtils`
## Methods
### getEscrow()
-> `static` **getEscrow**(`chainId`, `escrowAddress`): `Promise`\<[`EscrowData`](../../graphql/types/type-aliases/EscrowData.md)\>
+> `static` **getEscrow**(`chainId`, `escrowAddress`): `Promise`\<[`IEscrow`](../../interfaces/interfaces/IEscrow.md)\>
-Defined in: [escrow.ts:1780](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1780)
+Defined in: [escrow.ts:1779](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1779)
This function returns the escrow data for a given address.
@@ -76,7 +76,7 @@ enum ChainId {
```
```ts
-type EscrowData = {
+interface IEscrow {
id: string;
address: string;
amountPaid: string;
@@ -115,7 +115,7 @@ Address of the escrow
#### Returns
-`Promise`\<[`EscrowData`](../../graphql/types/type-aliases/EscrowData.md)\>
+`Promise`\<[`IEscrow`](../../interfaces/interfaces/IEscrow.md)\>
Escrow data
@@ -124,16 +124,16 @@ Escrow data
```ts
import { ChainId, EscrowUtils } from '@human-protocol/sdk';
-const escrowData = new EscrowUtils.getEscrow(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");
+const escrow = new EscrowUtils.getEscrow(ChainId.POLYGON_AMOY, "0x1234567890123456789012345678901234567890");
```
***
### getEscrows()
-> `static` **getEscrows**(`filter`): `Promise`\<[`EscrowData`](../../graphql/types/type-aliases/EscrowData.md)[]\>
+> `static` **getEscrows**(`filter`): `Promise`\<[`IEscrow`](../../interfaces/interfaces/IEscrow.md)[]\>
-Defined in: [escrow.ts:1662](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1662)
+Defined in: [escrow.ts:1663](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1663)
This function returns an array of escrows based on the specified filter parameters.
@@ -188,7 +188,7 @@ enum EscrowStatus {
```
```ts
-type EscrowData = {
+interface IEscrow {
id: string;
address: string;
amountPaid: string;
@@ -221,7 +221,7 @@ Filter parameters.
#### Returns
-`Promise`\<[`EscrowData`](../../graphql/types/type-aliases/EscrowData.md)[]\>
+`Promise`\<[`IEscrow`](../../interfaces/interfaces/IEscrow.md)[]\>
List of escrows that match the filter.
@@ -236,7 +236,7 @@ const filters: IEscrowsFilter = {
to: new Date(2023, 5, 8),
chainId: ChainId.POLYGON_AMOY
};
-const escrowDatas = await EscrowUtils.getEscrows(filters);
+const escrows = await EscrowUtils.getEscrows(filters);
```
***
@@ -245,7 +245,7 @@ const escrowDatas = await EscrowUtils.getEscrows(filters);
> `static` **getPayouts**(`filter`): `Promise`\<[`Payout`](../../types/type-aliases/Payout.md)[]\>
-Defined in: [escrow.ts:1950](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1950)
+Defined in: [escrow.ts:1949](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1949)
This function returns the payouts for a given set of networks.
@@ -289,7 +289,7 @@ console.log(payouts);
> `static` **getStatusEvents**(`filter`): `Promise`\<[`StatusEvent`](../../graphql/types/type-aliases/StatusEvent.md)[]\>
-Defined in: [escrow.ts:1859](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1859)
+Defined in: [escrow.ts:1858](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/escrow.ts#L1858)
This function returns the status events for a given set of networks within an optional date range.
diff --git a/docs/sdk/typescript/graphql/types/README.md b/docs/sdk/typescript/graphql/types/README.md
index 7b33bd7937..627806191d 100644
--- a/docs/sdk/typescript/graphql/types/README.md
+++ b/docs/sdk/typescript/graphql/types/README.md
@@ -25,7 +25,6 @@
- [IMDataEntity](type-aliases/IMDataEntity.md)
- [KVStoreData](type-aliases/KVStoreData.md)
- [PaymentStatistics](type-aliases/PaymentStatistics.md)
-- [PayoutData](type-aliases/PayoutData.md)
- [RewardAddedEventData](type-aliases/RewardAddedEventData.md)
- [StatusEvent](type-aliases/StatusEvent.md)
- [TaskStatistics](type-aliases/TaskStatistics.md)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/DailyEscrowData.md b/docs/sdk/typescript/graphql/types/type-aliases/DailyEscrowData.md
index d1338d66b5..e756468529 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/DailyEscrowData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/DailyEscrowData.md
@@ -6,32 +6,54 @@
# Type Alias: DailyEscrowData
-> **DailyEscrowData**: `object`
+> **DailyEscrowData** = `object`
-Defined in: [graphql/types.ts:83](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L83)
+Defined in: [graphql/types.ts:75](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L75)
-## Type declaration
+## Properties
### escrowsCancelled
> **escrowsCancelled**: `number`
+Defined in: [graphql/types.ts:81](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L81)
+
+***
+
### escrowsPaid
> **escrowsPaid**: `number`
+Defined in: [graphql/types.ts:80](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L80)
+
+***
+
### escrowsPending
> **escrowsPending**: `number`
+Defined in: [graphql/types.ts:78](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L78)
+
+***
+
### escrowsSolved
> **escrowsSolved**: `number`
+Defined in: [graphql/types.ts:79](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L79)
+
+***
+
### escrowsTotal
> **escrowsTotal**: `number`
+Defined in: [graphql/types.ts:77](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L77)
+
+***
+
### timestamp
> **timestamp**: `Date`
+
+Defined in: [graphql/types.ts:76](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L76)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/DailyHMTData.md b/docs/sdk/typescript/graphql/types/type-aliases/DailyHMTData.md
index 9244bdd1ec..00b8281cee 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/DailyHMTData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/DailyHMTData.md
@@ -6,28 +6,46 @@
# Type Alias: DailyHMTData
-> **DailyHMTData**: `object`
+> **DailyHMTData** = `object`
-Defined in: [graphql/types.ts:127](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L127)
+Defined in: [graphql/types.ts:119](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L119)
-## Type declaration
+## Properties
### dailyUniqueReceivers
> **dailyUniqueReceivers**: `number`
+Defined in: [graphql/types.ts:124](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L124)
+
+***
+
### dailyUniqueSenders
> **dailyUniqueSenders**: `number`
+Defined in: [graphql/types.ts:123](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L123)
+
+***
+
### timestamp
> **timestamp**: `Date`
+Defined in: [graphql/types.ts:120](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L120)
+
+***
+
### totalTransactionAmount
> **totalTransactionAmount**: `bigint`
+Defined in: [graphql/types.ts:121](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L121)
+
+***
+
### totalTransactionCount
> **totalTransactionCount**: `number`
+
+Defined in: [graphql/types.ts:122](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L122)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/DailyPaymentData.md b/docs/sdk/typescript/graphql/types/type-aliases/DailyPaymentData.md
index 5407a1faf6..579d949a7c 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/DailyPaymentData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/DailyPaymentData.md
@@ -6,24 +6,38 @@
# Type Alias: DailyPaymentData
-> **DailyPaymentData**: `object`
+> **DailyPaymentData** = `object`
-Defined in: [graphql/types.ts:106](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L106)
+Defined in: [graphql/types.ts:98](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L98)
-## Type declaration
+## Properties
### averageAmountPerWorker
> **averageAmountPerWorker**: `bigint`
+Defined in: [graphql/types.ts:102](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L102)
+
+***
+
### timestamp
> **timestamp**: `Date`
+Defined in: [graphql/types.ts:99](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L99)
+
+***
+
### totalAmountPaid
> **totalAmountPaid**: `bigint`
+Defined in: [graphql/types.ts:100](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L100)
+
+***
+
### totalCount
> **totalCount**: `number`
+
+Defined in: [graphql/types.ts:101](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L101)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/DailyTaskData.md b/docs/sdk/typescript/graphql/types/type-aliases/DailyTaskData.md
index 32d8aac1c6..64c00976cd 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/DailyTaskData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/DailyTaskData.md
@@ -6,20 +6,30 @@
# Type Alias: DailyTaskData
-> **DailyTaskData**: `object`
+> **DailyTaskData** = `object`
-Defined in: [graphql/types.ts:148](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L148)
+Defined in: [graphql/types.ts:140](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L140)
-## Type declaration
+## Properties
### tasksSolved
> **tasksSolved**: `number`
+Defined in: [graphql/types.ts:143](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L143)
+
+***
+
### tasksTotal
> **tasksTotal**: `number`
+Defined in: [graphql/types.ts:142](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L142)
+
+***
+
### timestamp
> **timestamp**: `Date`
+
+Defined in: [graphql/types.ts:141](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L141)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/DailyWorkerData.md b/docs/sdk/typescript/graphql/types/type-aliases/DailyWorkerData.md
index decaf5e782..5afd7db4fb 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/DailyWorkerData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/DailyWorkerData.md
@@ -6,16 +6,22 @@
# Type Alias: DailyWorkerData
-> **DailyWorkerData**: `object`
+> **DailyWorkerData** = `object`
-Defined in: [graphql/types.ts:97](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L97)
+Defined in: [graphql/types.ts:89](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L89)
-## Type declaration
+## Properties
### activeWorkers
> **activeWorkers**: `number`
+Defined in: [graphql/types.ts:91](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L91)
+
+***
+
### timestamp
> **timestamp**: `Date`
+
+Defined in: [graphql/types.ts:90](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L90)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/EscrowData.md b/docs/sdk/typescript/graphql/types/type-aliases/EscrowData.md
index 1b73e121ee..f2db4f6a50 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/EscrowData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/EscrowData.md
@@ -6,84 +6,158 @@
# Type Alias: EscrowData
-> **EscrowData**: `object`
+> **EscrowData** = `object`
-Defined in: [graphql/types.ts:3](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L3)
+Defined in: [graphql/types.ts:3](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L3)
-## Type declaration
+## Properties
### address
> **address**: `string`
+Defined in: [graphql/types.ts:5](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L5)
+
+***
+
### amountPaid
> **amountPaid**: `string`
+Defined in: [graphql/types.ts:6](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L6)
+
+***
+
### balance
> **balance**: `string`
+Defined in: [graphql/types.ts:7](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L7)
+
+***
+
### chainId
> **chainId**: `number`
+Defined in: [graphql/types.ts:22](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L22)
+
+***
+
### count
> **count**: `string`
+Defined in: [graphql/types.ts:8](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L8)
+
+***
+
### createdAt
> **createdAt**: `string`
+Defined in: [graphql/types.ts:21](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L21)
+
+***
+
### exchangeOracle?
> `optional` **exchangeOracle**: `string`
+Defined in: [graphql/types.ts:17](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L17)
+
+***
+
### factoryAddress
> **factoryAddress**: `string`
+Defined in: [graphql/types.ts:9](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L9)
+
+***
+
### finalResultsUrl?
> `optional` **finalResultsUrl**: `string`
+Defined in: [graphql/types.ts:10](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L10)
+
+***
+
### id
> **id**: `string`
+Defined in: [graphql/types.ts:4](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L4)
+
+***
+
### intermediateResultsUrl?
> `optional` **intermediateResultsUrl**: `string`
+Defined in: [graphql/types.ts:11](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L11)
+
+***
+
### launcher
> **launcher**: `string`
+Defined in: [graphql/types.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L12)
+
+***
+
### manifestHash?
> `optional` **manifestHash**: `string`
+Defined in: [graphql/types.ts:13](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L13)
+
+***
+
### manifestUrl?
> `optional` **manifestUrl**: `string`
+Defined in: [graphql/types.ts:14](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L14)
+
+***
+
### recordingOracle?
> `optional` **recordingOracle**: `string`
+Defined in: [graphql/types.ts:15](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L15)
+
+***
+
### reputationOracle?
> `optional` **reputationOracle**: `string`
+Defined in: [graphql/types.ts:16](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L16)
+
+***
+
### status
> **status**: `string`
+Defined in: [graphql/types.ts:18](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L18)
+
+***
+
### token
> **token**: `string`
+Defined in: [graphql/types.ts:19](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L19)
+
+***
+
### totalFundedAmount
> **totalFundedAmount**: `string`
+
+Defined in: [graphql/types.ts:20](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L20)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatistics.md b/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatistics.md
index 6e6c5426c3..ec1bd885db 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatistics.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatistics.md
@@ -6,16 +6,22 @@
# Type Alias: EscrowStatistics
-> **EscrowStatistics**: `object`
+> **EscrowStatistics** = `object`
-Defined in: [graphql/types.ts:92](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L92)
+Defined in: [graphql/types.ts:84](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L84)
-## Type declaration
+## Properties
### dailyEscrowsData
> **dailyEscrowsData**: [`DailyEscrowData`](DailyEscrowData.md)[]
+Defined in: [graphql/types.ts:86](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L86)
+
+***
+
### totalEscrows
> **totalEscrows**: `number`
+
+Defined in: [graphql/types.ts:85](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L85)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatisticsData.md b/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatisticsData.md
index d11549fd67..eaea901611 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatisticsData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/EscrowStatisticsData.md
@@ -6,48 +6,86 @@
# Type Alias: EscrowStatisticsData
-> **EscrowStatisticsData**: `object`
+> **EscrowStatisticsData** = `object`
-Defined in: [graphql/types.ts:42](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L42)
+Defined in: [graphql/types.ts:34](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L34)
-## Type declaration
+## Properties
### bulkPayoutEventCount
> **bulkPayoutEventCount**: `string`
+Defined in: [graphql/types.ts:37](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L37)
+
+***
+
### cancelledStatusEventCount
> **cancelledStatusEventCount**: `string`
+Defined in: [graphql/types.ts:39](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L39)
+
+***
+
### completedStatusEventCount
> **completedStatusEventCount**: `string`
+Defined in: [graphql/types.ts:42](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L42)
+
+***
+
### fundEventCount
> **fundEventCount**: `string`
+Defined in: [graphql/types.ts:35](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L35)
+
+***
+
### paidStatusEventCount
> **paidStatusEventCount**: `string`
+Defined in: [graphql/types.ts:41](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L41)
+
+***
+
### partialStatusEventCount
> **partialStatusEventCount**: `string`
+Defined in: [graphql/types.ts:40](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L40)
+
+***
+
### pendingStatusEventCount
> **pendingStatusEventCount**: `string`
+Defined in: [graphql/types.ts:38](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L38)
+
+***
+
### storeResultsEventCount
> **storeResultsEventCount**: `string`
+Defined in: [graphql/types.ts:36](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L36)
+
+***
+
### totalEscrowCount
> **totalEscrowCount**: `string`
+Defined in: [graphql/types.ts:44](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L44)
+
+***
+
### totalEventCount
> **totalEventCount**: `string`
+
+Defined in: [graphql/types.ts:43](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L43)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/EventDayData.md b/docs/sdk/typescript/graphql/types/type-aliases/EventDayData.md
index 1bdd057e5f..75206a67ad 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/EventDayData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/EventDayData.md
@@ -6,80 +6,150 @@
# Type Alias: EventDayData
-> **EventDayData**: `object`
+> **EventDayData** = `object`
-Defined in: [graphql/types.ts:55](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L55)
+Defined in: [graphql/types.ts:47](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L47)
-## Type declaration
+## Properties
### dailyBulkPayoutEventCount
> **dailyBulkPayoutEventCount**: `string`
+Defined in: [graphql/types.ts:51](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L51)
+
+***
+
### dailyCancelledStatusEventCount
> **dailyCancelledStatusEventCount**: `string`
+Defined in: [graphql/types.ts:53](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L53)
+
+***
+
### dailyCompletedStatusEventCount
> **dailyCompletedStatusEventCount**: `string`
+Defined in: [graphql/types.ts:56](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L56)
+
+***
+
### dailyEscrowCount
> **dailyEscrowCount**: `string`
+Defined in: [graphql/types.ts:58](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L58)
+
+***
+
### dailyFundEventCount
> **dailyFundEventCount**: `string`
+Defined in: [graphql/types.ts:49](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L49)
+
+***
+
+### dailyHMTPayoutAmount
+
+> **dailyHMTPayoutAmount**: `string`
+
+Defined in: [graphql/types.ts:61](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L61)
+
+***
+
### dailyHMTTransferAmount
> **dailyHMTTransferAmount**: `string`
+Defined in: [graphql/types.ts:63](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L63)
+
+***
+
### dailyHMTTransferCount
> **dailyHMTTransferCount**: `string`
+Defined in: [graphql/types.ts:62](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L62)
+
+***
+
### dailyPaidStatusEventCount
> **dailyPaidStatusEventCount**: `string`
+Defined in: [graphql/types.ts:55](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L55)
+
+***
+
### dailyPartialStatusEventCount
> **dailyPartialStatusEventCount**: `string`
-### dailyPayoutAmount
+Defined in: [graphql/types.ts:54](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L54)
-> **dailyPayoutAmount**: `string`
+***
### dailyPayoutCount
> **dailyPayoutCount**: `string`
+Defined in: [graphql/types.ts:60](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L60)
+
+***
+
### dailyPendingStatusEventCount
> **dailyPendingStatusEventCount**: `string`
+Defined in: [graphql/types.ts:52](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L52)
+
+***
+
### dailyStoreResultsEventCount
> **dailyStoreResultsEventCount**: `string`
+Defined in: [graphql/types.ts:50](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L50)
+
+***
+
### dailyTotalEventCount
> **dailyTotalEventCount**: `string`
+Defined in: [graphql/types.ts:57](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L57)
+
+***
+
### dailyUniqueReceivers
> **dailyUniqueReceivers**: `string`
+Defined in: [graphql/types.ts:65](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L65)
+
+***
+
### dailyUniqueSenders
> **dailyUniqueSenders**: `string`
+Defined in: [graphql/types.ts:64](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L64)
+
+***
+
### dailyWorkerCount
> **dailyWorkerCount**: `string`
+Defined in: [graphql/types.ts:59](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L59)
+
+***
+
### timestamp
> **timestamp**: `string`
+
+Defined in: [graphql/types.ts:48](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L48)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/HMTHolder.md b/docs/sdk/typescript/graphql/types/type-aliases/HMTHolder.md
index 3c2354fba4..c071ee89e1 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/HMTHolder.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/HMTHolder.md
@@ -6,16 +6,22 @@
# Type Alias: HMTHolder
-> **HMTHolder**: `object`
+> **HMTHolder** = `object`
-Defined in: [graphql/types.ts:122](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L122)
+Defined in: [graphql/types.ts:114](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L114)
-## Type declaration
+## Properties
### address
> **address**: `string`
+Defined in: [graphql/types.ts:115](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L115)
+
+***
+
### balance
> **balance**: `bigint`
+
+Defined in: [graphql/types.ts:116](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L116)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/HMTHolderData.md b/docs/sdk/typescript/graphql/types/type-aliases/HMTHolderData.md
index 7a2407ca15..ee55c1590c 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/HMTHolderData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/HMTHolderData.md
@@ -6,16 +6,22 @@
# Type Alias: HMTHolderData
-> **HMTHolderData**: `object`
+> **HMTHolderData** = `object`
-Defined in: [graphql/types.ts:117](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L117)
+Defined in: [graphql/types.ts:109](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L109)
-## Type declaration
+## Properties
### address
> **address**: `string`
+Defined in: [graphql/types.ts:110](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L110)
+
+***
+
### balance
> **balance**: `string`
+
+Defined in: [graphql/types.ts:111](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L111)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/HMTStatistics.md b/docs/sdk/typescript/graphql/types/type-aliases/HMTStatistics.md
index e8e3e7364e..f55590cbf4 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/HMTStatistics.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/HMTStatistics.md
@@ -6,20 +6,30 @@
# Type Alias: HMTStatistics
-> **HMTStatistics**: `object`
+> **HMTStatistics** = `object`
-Defined in: [graphql/types.ts:135](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L135)
+Defined in: [graphql/types.ts:127](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L127)
-## Type declaration
+## Properties
### totalHolders
> **totalHolders**: `number`
+Defined in: [graphql/types.ts:130](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L130)
+
+***
+
### totalTransferAmount
> **totalTransferAmount**: `bigint`
+Defined in: [graphql/types.ts:128](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L128)
+
+***
+
### totalTransferCount
> **totalTransferCount**: `number`
+
+Defined in: [graphql/types.ts:129](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L129)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/HMTStatisticsData.md b/docs/sdk/typescript/graphql/types/type-aliases/HMTStatisticsData.md
index d1401b9486..2a17ef82dd 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/HMTStatisticsData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/HMTStatisticsData.md
@@ -6,32 +6,54 @@
# Type Alias: HMTStatisticsData
-> **HMTStatisticsData**: `object`
+> **HMTStatisticsData** = `object`
-Defined in: [graphql/types.ts:33](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L33)
+Defined in: [graphql/types.ts:25](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L25)
-## Type declaration
+## Properties
### holders
> **holders**: `string`
+Defined in: [graphql/types.ts:31](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L31)
+
+***
+
### totalApprovalEventCount
> **totalApprovalEventCount**: `string`
+Defined in: [graphql/types.ts:28](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L28)
+
+***
+
### totalBulkApprovalEventCount
> **totalBulkApprovalEventCount**: `string`
+Defined in: [graphql/types.ts:29](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L29)
+
+***
+
### totalBulkTransferEventCount
> **totalBulkTransferEventCount**: `string`
+Defined in: [graphql/types.ts:27](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L27)
+
+***
+
### totalTransferEventCount
> **totalTransferEventCount**: `string`
+Defined in: [graphql/types.ts:26](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L26)
+
+***
+
### totalValueTransfered
> **totalValueTransfered**: `string`
+
+Defined in: [graphql/types.ts:30](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L30)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/IMData.md b/docs/sdk/typescript/graphql/types/type-aliases/IMData.md
index 9fe78a572b..37ddf93d0d 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/IMData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/IMData.md
@@ -6,6 +6,6 @@
# Type Alias: IMData
-> **IMData**: `Record`\<`string`, [`IMDataEntity`](IMDataEntity.md)\>
+> **IMData** = `Record`\<`string`, [`IMDataEntity`](IMDataEntity.md)\>
-Defined in: [graphql/types.ts:146](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L146)
+Defined in: [graphql/types.ts:138](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L138)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/IMDataEntity.md b/docs/sdk/typescript/graphql/types/type-aliases/IMDataEntity.md
index 04813d3002..96725b9155 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/IMDataEntity.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/IMDataEntity.md
@@ -6,16 +6,22 @@
# Type Alias: IMDataEntity
-> **IMDataEntity**: `object`
+> **IMDataEntity** = `object`
-Defined in: [graphql/types.ts:141](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L141)
+Defined in: [graphql/types.ts:133](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L133)
-## Type declaration
+## Properties
### served
> **served**: `number`
+Defined in: [graphql/types.ts:134](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L134)
+
+***
+
### solved
> **solved**: `number`
+
+Defined in: [graphql/types.ts:135](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L135)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/KVStoreData.md b/docs/sdk/typescript/graphql/types/type-aliases/KVStoreData.md
index bf4a21515f..8780ce7efd 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/KVStoreData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/KVStoreData.md
@@ -6,32 +6,54 @@
# Type Alias: KVStoreData
-> **KVStoreData**: `object`
+> **KVStoreData** = `object`
-Defined in: [graphql/types.ts:165](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L165)
+Defined in: [graphql/types.ts:157](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L157)
-## Type declaration
+## Properties
### address
> **address**: `string`
+Defined in: [graphql/types.ts:159](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L159)
+
+***
+
### block
> **block**: `number`
+Defined in: [graphql/types.ts:163](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L163)
+
+***
+
### id
> **id**: `string`
+Defined in: [graphql/types.ts:158](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L158)
+
+***
+
### key
> **key**: `string`
+Defined in: [graphql/types.ts:160](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L160)
+
+***
+
### timestamp
> **timestamp**: `Date`
+Defined in: [graphql/types.ts:162](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L162)
+
+***
+
### value
> **value**: `string`
+
+Defined in: [graphql/types.ts:161](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L161)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/PaymentStatistics.md b/docs/sdk/typescript/graphql/types/type-aliases/PaymentStatistics.md
index 183cb8fc7b..64b2e63133 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/PaymentStatistics.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/PaymentStatistics.md
@@ -6,12 +6,14 @@
# Type Alias: PaymentStatistics
-> **PaymentStatistics**: `object`
+> **PaymentStatistics** = `object`
-Defined in: [graphql/types.ts:113](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L113)
+Defined in: [graphql/types.ts:105](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L105)
-## Type declaration
+## Properties
### dailyPaymentsData
> **dailyPaymentsData**: [`DailyPaymentData`](DailyPaymentData.md)[]
+
+Defined in: [graphql/types.ts:106](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L106)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/PayoutData.md b/docs/sdk/typescript/graphql/types/type-aliases/PayoutData.md
deleted file mode 100644
index 411724cd7c..0000000000
--- a/docs/sdk/typescript/graphql/types/type-aliases/PayoutData.md
+++ /dev/null
@@ -1,33 +0,0 @@
-[**@human-protocol/sdk**](../../../README.md)
-
-***
-
-[@human-protocol/sdk](../../../modules.md) / [graphql/types](../README.md) / PayoutData
-
-# Type Alias: PayoutData
-
-> **PayoutData**: `object`
-
-Defined in: [graphql/types.ts:25](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L25)
-
-## Type declaration
-
-### amount
-
-> **amount**: `string`
-
-### createdAt
-
-> **createdAt**: `string`
-
-### escrowAddress
-
-> **escrowAddress**: `string`
-
-### id
-
-> **id**: `string`
-
-### recipient
-
-> **recipient**: `string`
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/RewardAddedEventData.md b/docs/sdk/typescript/graphql/types/type-aliases/RewardAddedEventData.md
index 1c754efa3c..abb41fb55f 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/RewardAddedEventData.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/RewardAddedEventData.md
@@ -6,24 +6,38 @@
# Type Alias: RewardAddedEventData
-> **RewardAddedEventData**: `object`
+> **RewardAddedEventData** = `object`
-Defined in: [graphql/types.ts:76](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L76)
+Defined in: [graphql/types.ts:68](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L68)
-## Type declaration
+## Properties
### amount
> **amount**: `string`
+Defined in: [graphql/types.ts:72](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L72)
+
+***
+
### escrowAddress
> **escrowAddress**: `string`
+Defined in: [graphql/types.ts:69](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L69)
+
+***
+
### slasher
> **slasher**: `string`
+Defined in: [graphql/types.ts:71](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L71)
+
+***
+
### staker
> **staker**: `string`
+
+Defined in: [graphql/types.ts:70](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L70)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/StatusEvent.md b/docs/sdk/typescript/graphql/types/type-aliases/StatusEvent.md
index 05c2380ae1..52ab27fbf9 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/StatusEvent.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/StatusEvent.md
@@ -6,24 +6,38 @@
# Type Alias: StatusEvent
-> **StatusEvent**: `object`
+> **StatusEvent** = `object`
-Defined in: [graphql/types.ts:158](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L158)
+Defined in: [graphql/types.ts:150](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L150)
-## Type declaration
+## Properties
### chainId
> **chainId**: [`ChainId`](../../../enums/enumerations/ChainId.md)
+Defined in: [graphql/types.ts:154](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L154)
+
+***
+
### escrowAddress
> **escrowAddress**: `string`
+Defined in: [graphql/types.ts:152](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L152)
+
+***
+
### status
> **status**: `string`
+Defined in: [graphql/types.ts:153](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L153)
+
+***
+
### timestamp
> **timestamp**: `number`
+
+Defined in: [graphql/types.ts:151](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L151)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/TaskStatistics.md b/docs/sdk/typescript/graphql/types/type-aliases/TaskStatistics.md
index 1e57acbfdd..74d99dda6a 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/TaskStatistics.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/TaskStatistics.md
@@ -6,12 +6,14 @@
# Type Alias: TaskStatistics
-> **TaskStatistics**: `object`
+> **TaskStatistics** = `object`
-Defined in: [graphql/types.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L154)
+Defined in: [graphql/types.ts:146](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L146)
-## Type declaration
+## Properties
### dailyTasksData
> **dailyTasksData**: [`DailyTaskData`](DailyTaskData.md)[]
+
+Defined in: [graphql/types.ts:147](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L147)
diff --git a/docs/sdk/typescript/graphql/types/type-aliases/WorkerStatistics.md b/docs/sdk/typescript/graphql/types/type-aliases/WorkerStatistics.md
index 60ffd457ee..bcf440fac5 100644
--- a/docs/sdk/typescript/graphql/types/type-aliases/WorkerStatistics.md
+++ b/docs/sdk/typescript/graphql/types/type-aliases/WorkerStatistics.md
@@ -6,12 +6,14 @@
# Type Alias: WorkerStatistics
-> **WorkerStatistics**: `object`
+> **WorkerStatistics** = `object`
-Defined in: [graphql/types.ts:102](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L102)
+Defined in: [graphql/types.ts:94](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L94)
-## Type declaration
+## Properties
### dailyWorkersData
> **dailyWorkersData**: [`DailyWorkerData`](DailyWorkerData.md)[]
+
+Defined in: [graphql/types.ts:95](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/graphql/types.ts#L95)
diff --git a/docs/sdk/typescript/interfaces/README.md b/docs/sdk/typescript/interfaces/README.md
index efff08ad39..e7046c38a1 100644
--- a/docs/sdk/typescript/interfaces/README.md
+++ b/docs/sdk/typescript/interfaces/README.md
@@ -8,6 +8,7 @@
## Interfaces
+- [IEscrow](interfaces/IEscrow.md)
- [IEscrowConfig](interfaces/IEscrowConfig.md)
- [IEscrowsFilter](interfaces/IEscrowsFilter.md)
- [IHMTHoldersParams](interfaces/IHMTHoldersParams.md)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IEscrow.md b/docs/sdk/typescript/interfaces/interfaces/IEscrow.md
new file mode 100644
index 0000000000..6406bbc853
--- /dev/null
+++ b/docs/sdk/typescript/interfaces/interfaces/IEscrow.md
@@ -0,0 +1,161 @@
+[**@human-protocol/sdk**](../../README.md)
+
+***
+
+[@human-protocol/sdk](../../modules.md) / [interfaces](../README.md) / IEscrow
+
+# Interface: IEscrow
+
+Defined in: [interfaces.ts:67](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L67)
+
+## Properties
+
+### address
+
+> **address**: `string`
+
+Defined in: [interfaces.ts:69](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L69)
+
+***
+
+### amountPaid
+
+> **amountPaid**: `string`
+
+Defined in: [interfaces.ts:70](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L70)
+
+***
+
+### balance
+
+> **balance**: `string`
+
+Defined in: [interfaces.ts:71](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L71)
+
+***
+
+### chainId
+
+> **chainId**: `number`
+
+Defined in: [interfaces.ts:86](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L86)
+
+***
+
+### count
+
+> **count**: `string`
+
+Defined in: [interfaces.ts:72](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L72)
+
+***
+
+### createdAt
+
+> **createdAt**: `string`
+
+Defined in: [interfaces.ts:85](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L85)
+
+***
+
+### exchangeOracle?
+
+> `optional` **exchangeOracle**: `string`
+
+Defined in: [interfaces.ts:81](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L81)
+
+***
+
+### factoryAddress
+
+> **factoryAddress**: `string`
+
+Defined in: [interfaces.ts:73](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L73)
+
+***
+
+### finalResultsUrl?
+
+> `optional` **finalResultsUrl**: `string`
+
+Defined in: [interfaces.ts:74](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L74)
+
+***
+
+### id
+
+> **id**: `string`
+
+Defined in: [interfaces.ts:68](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L68)
+
+***
+
+### intermediateResultsUrl?
+
+> `optional` **intermediateResultsUrl**: `string`
+
+Defined in: [interfaces.ts:75](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L75)
+
+***
+
+### launcher
+
+> **launcher**: `string`
+
+Defined in: [interfaces.ts:76](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L76)
+
+***
+
+### manifestHash?
+
+> `optional` **manifestHash**: `string`
+
+Defined in: [interfaces.ts:77](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L77)
+
+***
+
+### manifestUrl?
+
+> `optional` **manifestUrl**: `string`
+
+Defined in: [interfaces.ts:78](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L78)
+
+***
+
+### recordingOracle?
+
+> `optional` **recordingOracle**: `string`
+
+Defined in: [interfaces.ts:79](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L79)
+
+***
+
+### reputationOracle?
+
+> `optional` **reputationOracle**: `string`
+
+Defined in: [interfaces.ts:80](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L80)
+
+***
+
+### status
+
+> **status**: `string`
+
+Defined in: [interfaces.ts:82](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L82)
+
+***
+
+### token
+
+> **token**: `string`
+
+Defined in: [interfaces.ts:83](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L83)
+
+***
+
+### totalFundedAmount
+
+> **totalFundedAmount**: `string`
+
+Defined in: [interfaces.ts:84](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L84)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IEscrowConfig.md b/docs/sdk/typescript/interfaces/interfaces/IEscrowConfig.md
index 0683a22619..d31f5f0eff 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IEscrowConfig.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IEscrowConfig.md
@@ -6,7 +6,7 @@
# Interface: IEscrowConfig
-Defined in: [interfaces.ts:79](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L79)
+Defined in: [interfaces.ts:101](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L101)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:79](https://github.com/humanprotocol/human-protocol/b
> **exchangeOracle**: `string`
-Defined in: [interfaces.ts:82](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L82)
+Defined in: [interfaces.ts:104](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L104)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:82](https://github.com/humanprotocol/human-protocol/b
> **exchangeOracleFee**: `bigint`
-Defined in: [interfaces.ts:85](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L85)
+Defined in: [interfaces.ts:107](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L107)
***
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:85](https://github.com/humanprotocol/human-protocol/b
> **manifestHash**: `string`
-Defined in: [interfaces.ts:87](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L87)
+Defined in: [interfaces.ts:109](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L109)
***
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:87](https://github.com/humanprotocol/human-protocol/b
> **manifestUrl**: `string`
-Defined in: [interfaces.ts:86](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L86)
+Defined in: [interfaces.ts:108](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L108)
***
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:86](https://github.com/humanprotocol/human-protocol/b
> **recordingOracle**: `string`
-Defined in: [interfaces.ts:80](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L80)
+Defined in: [interfaces.ts:102](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L102)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:80](https://github.com/humanprotocol/human-protocol/b
> **recordingOracleFee**: `bigint`
-Defined in: [interfaces.ts:83](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L83)
+Defined in: [interfaces.ts:105](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L105)
***
@@ -62,7 +62,7 @@ Defined in: [interfaces.ts:83](https://github.com/humanprotocol/human-protocol/b
> **reputationOracle**: `string`
-Defined in: [interfaces.ts:81](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L81)
+Defined in: [interfaces.ts:103](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L103)
***
@@ -70,4 +70,4 @@ Defined in: [interfaces.ts:81](https://github.com/humanprotocol/human-protocol/b
> **reputationOracleFee**: `bigint`
-Defined in: [interfaces.ts:84](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L84)
+Defined in: [interfaces.ts:106](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L106)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IEscrowsFilter.md b/docs/sdk/typescript/interfaces/interfaces/IEscrowsFilter.md
index add8356780..0bef7e56bf 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IEscrowsFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IEscrowsFilter.md
@@ -6,7 +6,7 @@
# Interface: IEscrowsFilter
-Defined in: [interfaces.ts:67](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L67)
+Defined in: [interfaces.ts:89](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L89)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:67](https://github.com/humanprotocol/human-protocol/b
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:76](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L76)
+Defined in: [interfaces.ts:98](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L98)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:76](https://github.com/humanprotocol/human-protocol/b
> `optional` **exchangeOracle**: `string`
-Defined in: [interfaces.ts:71](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L71)
+Defined in: [interfaces.ts:93](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L93)
***
@@ -34,7 +34,7 @@ Defined in: [interfaces.ts:71](https://github.com/humanprotocol/human-protocol/b
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **from**: `Date`
-Defined in: [interfaces.ts:74](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L74)
+Defined in: [interfaces.ts:96](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L96)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:74](https://github.com/humanprotocol/human-protocol/b
> `optional` **jobRequesterId**: `string`
-Defined in: [interfaces.ts:72](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L72)
+Defined in: [interfaces.ts:94](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L94)
***
@@ -62,7 +62,7 @@ Defined in: [interfaces.ts:72](https://github.com/humanprotocol/human-protocol/b
> `optional` **launcher**: `string`
-Defined in: [interfaces.ts:68](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L68)
+Defined in: [interfaces.ts:90](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L90)
***
@@ -70,7 +70,7 @@ Defined in: [interfaces.ts:68](https://github.com/humanprotocol/human-protocol/b
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -82,7 +82,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **recordingOracle**: `string`
-Defined in: [interfaces.ts:70](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L70)
+Defined in: [interfaces.ts:92](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L92)
***
@@ -90,7 +90,7 @@ Defined in: [interfaces.ts:70](https://github.com/humanprotocol/human-protocol/b
> `optional` **reputationOracle**: `string`
-Defined in: [interfaces.ts:69](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L69)
+Defined in: [interfaces.ts:91](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L91)
***
@@ -98,7 +98,7 @@ Defined in: [interfaces.ts:69](https://github.com/humanprotocol/human-protocol/b
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
@@ -110,7 +110,7 @@ Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/
> `optional` **status**: [`EscrowStatus`](../../types/enumerations/EscrowStatus.md)
-Defined in: [interfaces.ts:73](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L73)
+Defined in: [interfaces.ts:95](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L95)
***
@@ -118,4 +118,4 @@ Defined in: [interfaces.ts:73](https://github.com/humanprotocol/human-protocol/b
> `optional` **to**: `Date`
-Defined in: [interfaces.ts:75](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L75)
+Defined in: [interfaces.ts:97](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L97)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IHMTHoldersParams.md b/docs/sdk/typescript/interfaces/interfaces/IHMTHoldersParams.md
index 20e651e721..9c4097219f 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IHMTHoldersParams.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IHMTHoldersParams.md
@@ -6,7 +6,7 @@
# Interface: IHMTHoldersParams
-Defined in: [interfaces.ts:102](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L102)
+Defined in: [interfaces.ts:124](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L124)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:102](https://github.com/humanprotocol/human-protocol/
> `optional` **address**: `string`
-Defined in: [interfaces.ts:103](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L103)
+Defined in: [interfaces.ts:125](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L125)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:103](https://github.com/humanprotocol/human-protocol/
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -50,7 +50,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
diff --git a/docs/sdk/typescript/interfaces/interfaces/IKVStore.md b/docs/sdk/typescript/interfaces/interfaces/IKVStore.md
index d7afd90199..65d7fb2001 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IKVStore.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IKVStore.md
@@ -6,7 +6,7 @@
# Interface: IKVStore
-Defined in: [interfaces.ts:114](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L114)
+Defined in: [interfaces.ts:136](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L136)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:114](https://github.com/humanprotocol/human-protocol/
> **key**: `string`
-Defined in: [interfaces.ts:115](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L115)
+Defined in: [interfaces.ts:137](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L137)
***
@@ -22,4 +22,4 @@ Defined in: [interfaces.ts:115](https://github.com/humanprotocol/human-protocol/
> **value**: `string`
-Defined in: [interfaces.ts:116](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L116)
+Defined in: [interfaces.ts:138](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L138)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IKeyPair.md b/docs/sdk/typescript/interfaces/interfaces/IKeyPair.md
index 66e2c69336..fe1c0e7104 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IKeyPair.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IKeyPair.md
@@ -6,7 +6,7 @@
# Interface: IKeyPair
-Defined in: [interfaces.ts:90](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L90)
+Defined in: [interfaces.ts:112](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L112)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:90](https://github.com/humanprotocol/human-protocol/b
> **passphrase**: `string`
-Defined in: [interfaces.ts:93](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L93)
+Defined in: [interfaces.ts:115](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L115)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:93](https://github.com/humanprotocol/human-protocol/b
> **privateKey**: `string`
-Defined in: [interfaces.ts:91](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L91)
+Defined in: [interfaces.ts:113](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L113)
***
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:91](https://github.com/humanprotocol/human-protocol/b
> **publicKey**: `string`
-Defined in: [interfaces.ts:92](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L92)
+Defined in: [interfaces.ts:114](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L114)
***
@@ -38,4 +38,4 @@ Defined in: [interfaces.ts:92](https://github.com/humanprotocol/human-protocol/b
> `optional` **revocationCertificate**: `string`
-Defined in: [interfaces.ts:94](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L94)
+Defined in: [interfaces.ts:116](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L116)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IOperator.md b/docs/sdk/typescript/interfaces/interfaces/IOperator.md
index 79945ef14c..66175a367e 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IOperator.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IOperator.md
@@ -6,7 +6,7 @@
# Interface: IOperator
-Defined in: [interfaces.ts:9](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L9)
+Defined in: [interfaces.ts:9](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L9)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:9](https://github.com/humanprotocol/human-protocol/bl
> **address**: `string`
-Defined in: [interfaces.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L12)
+Defined in: [interfaces.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L12)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:12](https://github.com/humanprotocol/human-protocol/b
> **amountJobsProcessed**: `bigint`
-Defined in: [interfaces.ts:19](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L19)
+Defined in: [interfaces.ts:19](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L19)
***
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:19](https://github.com/humanprotocol/human-protocol/b
> **amountLocked**: `bigint`
-Defined in: [interfaces.ts:14](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L14)
+Defined in: [interfaces.ts:14](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L14)
***
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:14](https://github.com/humanprotocol/human-protocol/b
> **amountSlashed**: `bigint`
-Defined in: [interfaces.ts:17](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L17)
+Defined in: [interfaces.ts:17](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L17)
***
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:17](https://github.com/humanprotocol/human-protocol/b
> **amountStaked**: `bigint`
-Defined in: [interfaces.ts:13](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L13)
+Defined in: [interfaces.ts:13](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L13)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:13](https://github.com/humanprotocol/human-protocol/b
> **amountWithdrawn**: `bigint`
-Defined in: [interfaces.ts:16](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L16)
+Defined in: [interfaces.ts:16](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L16)
***
@@ -62,7 +62,7 @@ Defined in: [interfaces.ts:16](https://github.com/humanprotocol/human-protocol/b
> `optional` **category**: `string`
-Defined in: [interfaces.ts:31](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L31)
+Defined in: [interfaces.ts:31](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L31)
***
@@ -70,7 +70,7 @@ Defined in: [interfaces.ts:31](https://github.com/humanprotocol/human-protocol/b
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:11](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L11)
+Defined in: [interfaces.ts:11](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L11)
***
@@ -78,7 +78,7 @@ Defined in: [interfaces.ts:11](https://github.com/humanprotocol/human-protocol/b
> `optional` **fee**: `bigint`
-Defined in: [interfaces.ts:21](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L21)
+Defined in: [interfaces.ts:21](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L21)
***
@@ -86,7 +86,7 @@ Defined in: [interfaces.ts:21](https://github.com/humanprotocol/human-protocol/b
> **id**: `string`
-Defined in: [interfaces.ts:10](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L10)
+Defined in: [interfaces.ts:10](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L10)
***
@@ -94,7 +94,7 @@ Defined in: [interfaces.ts:10](https://github.com/humanprotocol/human-protocol/b
> `optional` **jobTypes**: `string`[]
-Defined in: [interfaces.ts:26](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L26)
+Defined in: [interfaces.ts:26](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L26)
***
@@ -102,7 +102,7 @@ Defined in: [interfaces.ts:26](https://github.com/humanprotocol/human-protocol/b
> **lockedUntilTimestamp**: `bigint`
-Defined in: [interfaces.ts:15](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L15)
+Defined in: [interfaces.ts:15](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L15)
***
@@ -110,7 +110,7 @@ Defined in: [interfaces.ts:15](https://github.com/humanprotocol/human-protocol/b
> `optional` **name**: `string`
-Defined in: [interfaces.ts:30](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L30)
+Defined in: [interfaces.ts:30](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L30)
***
@@ -118,7 +118,7 @@ Defined in: [interfaces.ts:30](https://github.com/humanprotocol/human-protocol/b
> `optional` **publicKey**: `string`
-Defined in: [interfaces.ts:22](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L22)
+Defined in: [interfaces.ts:22](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L22)
***
@@ -126,7 +126,7 @@ Defined in: [interfaces.ts:22](https://github.com/humanprotocol/human-protocol/b
> `optional` **registrationInstructions**: `string`
-Defined in: [interfaces.ts:28](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L28)
+Defined in: [interfaces.ts:28](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L28)
***
@@ -134,7 +134,7 @@ Defined in: [interfaces.ts:28](https://github.com/humanprotocol/human-protocol/b
> `optional` **registrationNeeded**: `boolean`
-Defined in: [interfaces.ts:27](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L27)
+Defined in: [interfaces.ts:27](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L27)
***
@@ -142,7 +142,7 @@ Defined in: [interfaces.ts:27](https://github.com/humanprotocol/human-protocol/b
> `optional` **reputationNetworks**: `string`[]
-Defined in: [interfaces.ts:29](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L29)
+Defined in: [interfaces.ts:29](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L29)
***
@@ -150,7 +150,7 @@ Defined in: [interfaces.ts:29](https://github.com/humanprotocol/human-protocol/b
> **reward**: `bigint`
-Defined in: [interfaces.ts:18](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L18)
+Defined in: [interfaces.ts:18](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L18)
***
@@ -158,7 +158,7 @@ Defined in: [interfaces.ts:18](https://github.com/humanprotocol/human-protocol/b
> `optional` **role**: `string`
-Defined in: [interfaces.ts:20](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L20)
+Defined in: [interfaces.ts:20](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L20)
***
@@ -166,7 +166,7 @@ Defined in: [interfaces.ts:20](https://github.com/humanprotocol/human-protocol/b
> `optional` **url**: `string`
-Defined in: [interfaces.ts:25](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L25)
+Defined in: [interfaces.ts:25](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L25)
***
@@ -174,7 +174,7 @@ Defined in: [interfaces.ts:25](https://github.com/humanprotocol/human-protocol/b
> `optional` **webhookUrl**: `string`
-Defined in: [interfaces.ts:23](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L23)
+Defined in: [interfaces.ts:23](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L23)
***
@@ -182,4 +182,4 @@ Defined in: [interfaces.ts:23](https://github.com/humanprotocol/human-protocol/b
> `optional` **website**: `string`
-Defined in: [interfaces.ts:24](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L24)
+Defined in: [interfaces.ts:24](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L24)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IOperatorSubgraph.md b/docs/sdk/typescript/interfaces/interfaces/IOperatorSubgraph.md
index b27a089c01..a3dc14f782 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IOperatorSubgraph.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IOperatorSubgraph.md
@@ -6,7 +6,7 @@
# Interface: IOperatorSubgraph
-Defined in: [interfaces.ts:34](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L34)
+Defined in: [interfaces.ts:34](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L34)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:34](https://github.com/humanprotocol/human-protocol/b
> **address**: `string`
-Defined in: [interfaces.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L12)
+Defined in: [interfaces.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L12)
#### Inherited from
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:12](https://github.com/humanprotocol/human-protocol/b
> **amountJobsProcessed**: `bigint`
-Defined in: [interfaces.ts:19](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L19)
+Defined in: [interfaces.ts:19](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L19)
#### Inherited from
@@ -42,7 +42,7 @@ Defined in: [interfaces.ts:19](https://github.com/humanprotocol/human-protocol/b
> **amountLocked**: `bigint`
-Defined in: [interfaces.ts:14](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L14)
+Defined in: [interfaces.ts:14](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L14)
#### Inherited from
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:14](https://github.com/humanprotocol/human-protocol/b
> **amountSlashed**: `bigint`
-Defined in: [interfaces.ts:17](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L17)
+Defined in: [interfaces.ts:17](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L17)
#### Inherited from
@@ -66,7 +66,7 @@ Defined in: [interfaces.ts:17](https://github.com/humanprotocol/human-protocol/b
> **amountStaked**: `bigint`
-Defined in: [interfaces.ts:13](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L13)
+Defined in: [interfaces.ts:13](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L13)
#### Inherited from
@@ -78,7 +78,7 @@ Defined in: [interfaces.ts:13](https://github.com/humanprotocol/human-protocol/b
> **amountWithdrawn**: `bigint`
-Defined in: [interfaces.ts:16](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L16)
+Defined in: [interfaces.ts:16](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L16)
#### Inherited from
@@ -90,7 +90,7 @@ Defined in: [interfaces.ts:16](https://github.com/humanprotocol/human-protocol/b
> `optional` **category**: `string`
-Defined in: [interfaces.ts:31](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L31)
+Defined in: [interfaces.ts:31](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L31)
#### Inherited from
@@ -102,7 +102,7 @@ Defined in: [interfaces.ts:31](https://github.com/humanprotocol/human-protocol/b
> `optional` **fee**: `bigint`
-Defined in: [interfaces.ts:21](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L21)
+Defined in: [interfaces.ts:21](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L21)
#### Inherited from
@@ -114,7 +114,7 @@ Defined in: [interfaces.ts:21](https://github.com/humanprotocol/human-protocol/b
> **id**: `string`
-Defined in: [interfaces.ts:10](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L10)
+Defined in: [interfaces.ts:10](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L10)
#### Inherited from
@@ -126,7 +126,7 @@ Defined in: [interfaces.ts:10](https://github.com/humanprotocol/human-protocol/b
> `optional` **jobTypes**: `string`
-Defined in: [interfaces.ts:36](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L36)
+Defined in: [interfaces.ts:36](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L36)
***
@@ -134,7 +134,7 @@ Defined in: [interfaces.ts:36](https://github.com/humanprotocol/human-protocol/b
> **lockedUntilTimestamp**: `bigint`
-Defined in: [interfaces.ts:15](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L15)
+Defined in: [interfaces.ts:15](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L15)
#### Inherited from
@@ -146,7 +146,7 @@ Defined in: [interfaces.ts:15](https://github.com/humanprotocol/human-protocol/b
> `optional` **name**: `string`
-Defined in: [interfaces.ts:30](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L30)
+Defined in: [interfaces.ts:30](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L30)
#### Inherited from
@@ -158,7 +158,7 @@ Defined in: [interfaces.ts:30](https://github.com/humanprotocol/human-protocol/b
> `optional` **publicKey**: `string`
-Defined in: [interfaces.ts:22](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L22)
+Defined in: [interfaces.ts:22](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L22)
#### Inherited from
@@ -170,7 +170,7 @@ Defined in: [interfaces.ts:22](https://github.com/humanprotocol/human-protocol/b
> `optional` **registrationInstructions**: `string`
-Defined in: [interfaces.ts:28](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L28)
+Defined in: [interfaces.ts:28](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L28)
#### Inherited from
@@ -182,7 +182,7 @@ Defined in: [interfaces.ts:28](https://github.com/humanprotocol/human-protocol/b
> `optional` **registrationNeeded**: `boolean`
-Defined in: [interfaces.ts:27](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L27)
+Defined in: [interfaces.ts:27](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L27)
#### Inherited from
@@ -194,7 +194,7 @@ Defined in: [interfaces.ts:27](https://github.com/humanprotocol/human-protocol/b
> `optional` **reputationNetworks**: `object`[]
-Defined in: [interfaces.ts:37](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L37)
+Defined in: [interfaces.ts:37](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L37)
#### address
@@ -206,7 +206,7 @@ Defined in: [interfaces.ts:37](https://github.com/humanprotocol/human-protocol/b
> **reward**: `bigint`
-Defined in: [interfaces.ts:18](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L18)
+Defined in: [interfaces.ts:18](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L18)
#### Inherited from
@@ -218,7 +218,7 @@ Defined in: [interfaces.ts:18](https://github.com/humanprotocol/human-protocol/b
> `optional` **role**: `string`
-Defined in: [interfaces.ts:20](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L20)
+Defined in: [interfaces.ts:20](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L20)
#### Inherited from
@@ -230,7 +230,7 @@ Defined in: [interfaces.ts:20](https://github.com/humanprotocol/human-protocol/b
> `optional` **url**: `string`
-Defined in: [interfaces.ts:25](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L25)
+Defined in: [interfaces.ts:25](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L25)
#### Inherited from
@@ -242,7 +242,7 @@ Defined in: [interfaces.ts:25](https://github.com/humanprotocol/human-protocol/b
> `optional` **webhookUrl**: `string`
-Defined in: [interfaces.ts:23](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L23)
+Defined in: [interfaces.ts:23](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L23)
#### Inherited from
@@ -254,7 +254,7 @@ Defined in: [interfaces.ts:23](https://github.com/humanprotocol/human-protocol/b
> `optional` **website**: `string`
-Defined in: [interfaces.ts:24](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L24)
+Defined in: [interfaces.ts:24](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L24)
#### Inherited from
diff --git a/docs/sdk/typescript/interfaces/interfaces/IOperatorsFilter.md b/docs/sdk/typescript/interfaces/interfaces/IOperatorsFilter.md
index 90e83d1034..4cd03b92c6 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IOperatorsFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IOperatorsFilter.md
@@ -6,7 +6,7 @@
# Interface: IOperatorsFilter
-Defined in: [interfaces.ts:40](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L40)
+Defined in: [interfaces.ts:40](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L40)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:40](https://github.com/humanprotocol/human-protocol/b
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:41](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L41)
+Defined in: [interfaces.ts:41](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L41)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:41](https://github.com/humanprotocol/human-protocol/b
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **minAmountStaked**: `number`
-Defined in: [interfaces.ts:43](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L43)
+Defined in: [interfaces.ts:43](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L43)
***
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:43](https://github.com/humanprotocol/human-protocol/b
> `optional` **orderBy**: `string`
-Defined in: [interfaces.ts:44](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L44)
+Defined in: [interfaces.ts:44](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L44)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:44](https://github.com/humanprotocol/human-protocol/b
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -66,7 +66,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **roles**: `string`[]
-Defined in: [interfaces.ts:42](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L42)
+Defined in: [interfaces.ts:42](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L42)
***
@@ -74,7 +74,7 @@ Defined in: [interfaces.ts:42](https://github.com/humanprotocol/human-protocol/b
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
diff --git a/docs/sdk/typescript/interfaces/interfaces/IPagination.md b/docs/sdk/typescript/interfaces/interfaces/IPagination.md
index 18e9db9eb6..75baa60993 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IPagination.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IPagination.md
@@ -6,7 +6,7 @@
# Interface: IPagination
-Defined in: [interfaces.ts:153](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L153)
+Defined in: [interfaces.ts:178](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L178)
## Extended by
@@ -25,7 +25,7 @@ Defined in: [interfaces.ts:153](https://github.com/humanprotocol/human-protocol/
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
***
@@ -33,7 +33,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
***
@@ -41,4 +41,4 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IPayoutFilter.md b/docs/sdk/typescript/interfaces/interfaces/IPayoutFilter.md
index d324186adb..42e26b2ae7 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IPayoutFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IPayoutFilter.md
@@ -6,7 +6,7 @@
# Interface: IPayoutFilter
-Defined in: [interfaces.ts:106](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L106)
+Defined in: [interfaces.ts:128](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L128)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:106](https://github.com/humanprotocol/human-protocol/
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:107](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L107)
+Defined in: [interfaces.ts:129](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L129)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:107](https://github.com/humanprotocol/human-protocol/
> `optional` **escrowAddress**: `string`
-Defined in: [interfaces.ts:108](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L108)
+Defined in: [interfaces.ts:130](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L130)
***
@@ -34,7 +34,7 @@ Defined in: [interfaces.ts:108](https://github.com/humanprotocol/human-protocol/
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **from**: `Date`
-Defined in: [interfaces.ts:110](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L110)
+Defined in: [interfaces.ts:132](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L132)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:110](https://github.com/humanprotocol/human-protocol/
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -66,7 +66,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **recipient**: `string`
-Defined in: [interfaces.ts:109](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L109)
+Defined in: [interfaces.ts:131](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L131)
***
@@ -74,7 +74,7 @@ Defined in: [interfaces.ts:109](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
@@ -86,4 +86,4 @@ Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/
> `optional` **to**: `Date`
-Defined in: [interfaces.ts:111](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L111)
+Defined in: [interfaces.ts:133](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L133)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IReputationNetwork.md b/docs/sdk/typescript/interfaces/interfaces/IReputationNetwork.md
index a78f347469..5d52f9d6ed 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IReputationNetwork.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IReputationNetwork.md
@@ -6,7 +6,7 @@
# Interface: IReputationNetwork
-Defined in: [interfaces.ts:47](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L47)
+Defined in: [interfaces.ts:47](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L47)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:47](https://github.com/humanprotocol/human-protocol/b
> **address**: `string`
-Defined in: [interfaces.ts:49](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L49)
+Defined in: [interfaces.ts:49](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L49)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:49](https://github.com/humanprotocol/human-protocol/b
> **id**: `string`
-Defined in: [interfaces.ts:48](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L48)
+Defined in: [interfaces.ts:48](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L48)
***
@@ -30,4 +30,4 @@ Defined in: [interfaces.ts:48](https://github.com/humanprotocol/human-protocol/b
> **operators**: [`IOperator`](IOperator.md)[]
-Defined in: [interfaces.ts:50](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L50)
+Defined in: [interfaces.ts:50](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L50)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IReputationNetworkSubgraph.md b/docs/sdk/typescript/interfaces/interfaces/IReputationNetworkSubgraph.md
index 79bb41371a..00e8cb3037 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IReputationNetworkSubgraph.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IReputationNetworkSubgraph.md
@@ -6,7 +6,7 @@
# Interface: IReputationNetworkSubgraph
-Defined in: [interfaces.ts:53](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L53)
+Defined in: [interfaces.ts:53](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L53)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:53](https://github.com/humanprotocol/human-protocol/b
> **address**: `string`
-Defined in: [interfaces.ts:49](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L49)
+Defined in: [interfaces.ts:49](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L49)
#### Inherited from
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:49](https://github.com/humanprotocol/human-protocol/b
> **id**: `string`
-Defined in: [interfaces.ts:48](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L48)
+Defined in: [interfaces.ts:48](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L48)
#### Inherited from
@@ -42,4 +42,4 @@ Defined in: [interfaces.ts:48](https://github.com/humanprotocol/human-protocol/b
> **operators**: [`IOperatorSubgraph`](IOperatorSubgraph.md)[]
-Defined in: [interfaces.ts:55](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L55)
+Defined in: [interfaces.ts:55](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L55)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IReward.md b/docs/sdk/typescript/interfaces/interfaces/IReward.md
index dbf06c2f1f..72428ebceb 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IReward.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IReward.md
@@ -6,7 +6,7 @@
# Interface: IReward
-Defined in: [interfaces.ts:4](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L4)
+Defined in: [interfaces.ts:4](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L4)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:4](https://github.com/humanprotocol/human-protocol/bl
> **amount**: `bigint`
-Defined in: [interfaces.ts:6](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L6)
+Defined in: [interfaces.ts:6](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L6)
***
@@ -22,4 +22,4 @@ Defined in: [interfaces.ts:6](https://github.com/humanprotocol/human-protocol/bl
> **escrowAddress**: `string`
-Defined in: [interfaces.ts:5](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L5)
+Defined in: [interfaces.ts:5](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L5)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IStatisticsFilter.md b/docs/sdk/typescript/interfaces/interfaces/IStatisticsFilter.md
index 85c8c655a6..ba7080d45c 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IStatisticsFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IStatisticsFilter.md
@@ -6,7 +6,7 @@
# Interface: IStatisticsFilter
-Defined in: [interfaces.ts:97](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L97)
+Defined in: [interfaces.ts:119](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L119)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:97](https://github.com/humanprotocol/human-protocol/b
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **from**: `Date`
-Defined in: [interfaces.ts:98](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L98)
+Defined in: [interfaces.ts:120](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L120)
***
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:98](https://github.com/humanprotocol/human-protocol/b
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -50,7 +50,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
@@ -62,4 +62,4 @@ Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/
> `optional` **to**: `Date`
-Defined in: [interfaces.ts:99](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L99)
+Defined in: [interfaces.ts:121](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L121)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IStatusEventFilter.md b/docs/sdk/typescript/interfaces/interfaces/IStatusEventFilter.md
index d57093ca0d..ded6770a37 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IStatusEventFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IStatusEventFilter.md
@@ -6,7 +6,7 @@
# Interface: IStatusEventFilter
-Defined in: [interfaces.ts:166](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L166)
+Defined in: [interfaces.ts:191](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L191)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:166](https://github.com/humanprotocol/human-protocol/
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:167](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L167)
+Defined in: [interfaces.ts:192](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L192)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:167](https://github.com/humanprotocol/human-protocol/
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **from**: `Date`
-Defined in: [interfaces.ts:169](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L169)
+Defined in: [interfaces.ts:194](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L194)
***
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:169](https://github.com/humanprotocol/human-protocol/
> `optional` **launcher**: `string`
-Defined in: [interfaces.ts:171](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L171)
+Defined in: [interfaces.ts:196](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L196)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:171](https://github.com/humanprotocol/human-protocol/
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -66,7 +66,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
@@ -78,7 +78,7 @@ Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/
> `optional` **statuses**: [`EscrowStatus`](../../types/enumerations/EscrowStatus.md)[]
-Defined in: [interfaces.ts:168](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L168)
+Defined in: [interfaces.ts:193](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L193)
***
@@ -86,4 +86,4 @@ Defined in: [interfaces.ts:168](https://github.com/humanprotocol/human-protocol/
> `optional` **to**: `Date`
-Defined in: [interfaces.ts:170](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L170)
+Defined in: [interfaces.ts:195](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L195)
diff --git a/docs/sdk/typescript/interfaces/interfaces/ITransaction.md b/docs/sdk/typescript/interfaces/interfaces/ITransaction.md
index b3408ebfb9..f4c9e9b5ba 100644
--- a/docs/sdk/typescript/interfaces/interfaces/ITransaction.md
+++ b/docs/sdk/typescript/interfaces/interfaces/ITransaction.md
@@ -6,7 +6,7 @@
# Interface: ITransaction
-Defined in: [interfaces.ts:129](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L129)
+Defined in: [interfaces.ts:151](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L151)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:129](https://github.com/humanprotocol/human-protocol/
> **block**: `bigint`
-Defined in: [interfaces.ts:130](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L130)
+Defined in: [interfaces.ts:152](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L152)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:130](https://github.com/humanprotocol/human-protocol/
> `optional` **escrow**: `string`
-Defined in: [interfaces.ts:138](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L138)
+Defined in: [interfaces.ts:160](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L160)
***
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:138](https://github.com/humanprotocol/human-protocol/
> **from**: `string`
-Defined in: [interfaces.ts:132](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L132)
+Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
***
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:132](https://github.com/humanprotocol/human-protocol/
> **internalTransactions**: [`InternalTransaction`](InternalTransaction.md)[]
-Defined in: [interfaces.ts:140](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L140)
+Defined in: [interfaces.ts:162](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L162)
***
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:140](https://github.com/humanprotocol/human-protocol/
> **method**: `string`
-Defined in: [interfaces.ts:136](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L136)
+Defined in: [interfaces.ts:158](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L158)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:136](https://github.com/humanprotocol/human-protocol/
> `optional` **receiver**: `string`
-Defined in: [interfaces.ts:137](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L137)
+Defined in: [interfaces.ts:159](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L159)
***
@@ -62,7 +62,7 @@ Defined in: [interfaces.ts:137](https://github.com/humanprotocol/human-protocol/
> **timestamp**: `bigint`
-Defined in: [interfaces.ts:134](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L134)
+Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
***
@@ -70,7 +70,7 @@ Defined in: [interfaces.ts:134](https://github.com/humanprotocol/human-protocol/
> **to**: `string`
-Defined in: [interfaces.ts:133](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L133)
+Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
***
@@ -78,7 +78,7 @@ Defined in: [interfaces.ts:133](https://github.com/humanprotocol/human-protocol/
> `optional` **token**: `string`
-Defined in: [interfaces.ts:139](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L139)
+Defined in: [interfaces.ts:161](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L161)
***
@@ -86,7 +86,7 @@ Defined in: [interfaces.ts:139](https://github.com/humanprotocol/human-protocol/
> **txHash**: `string`
-Defined in: [interfaces.ts:131](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L131)
+Defined in: [interfaces.ts:153](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L153)
***
@@ -94,4 +94,4 @@ Defined in: [interfaces.ts:131](https://github.com/humanprotocol/human-protocol/
> **value**: `string`
-Defined in: [interfaces.ts:135](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L135)
+Defined in: [interfaces.ts:157](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L157)
diff --git a/docs/sdk/typescript/interfaces/interfaces/ITransactionsFilter.md b/docs/sdk/typescript/interfaces/interfaces/ITransactionsFilter.md
index 3fa146d5b4..48c918b5b7 100644
--- a/docs/sdk/typescript/interfaces/interfaces/ITransactionsFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/ITransactionsFilter.md
@@ -6,7 +6,7 @@
# Interface: ITransactionsFilter
-Defined in: [interfaces.ts:143](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L143)
+Defined in: [interfaces.ts:165](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L165)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:143](https://github.com/humanprotocol/human-protocol/
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:144](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L144)
+Defined in: [interfaces.ts:166](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L166)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:144](https://github.com/humanprotocol/human-protocol/
> `optional` **endBlock**: `number`
-Defined in: [interfaces.ts:146](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L146)
+Defined in: [interfaces.ts:168](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L168)
***
@@ -34,7 +34,15 @@ Defined in: [interfaces.ts:146](https://github.com/humanprotocol/human-protocol/
> `optional` **endDate**: `Date`
-Defined in: [interfaces.ts:148](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L148)
+Defined in: [interfaces.ts:170](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L170)
+
+***
+
+### escrow?
+
+> `optional` **escrow**: `string`
+
+Defined in: [interfaces.ts:174](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L174)
***
@@ -42,7 +50,7 @@ Defined in: [interfaces.ts:148](https://github.com/humanprotocol/human-protocol/
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -54,7 +62,15 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **fromAddress**: `string`
-Defined in: [interfaces.ts:149](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L149)
+Defined in: [interfaces.ts:171](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L171)
+
+***
+
+### method?
+
+> `optional` **method**: `string`
+
+Defined in: [interfaces.ts:173](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L173)
***
@@ -62,7 +78,7 @@ Defined in: [interfaces.ts:149](https://github.com/humanprotocol/human-protocol/
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -74,7 +90,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
@@ -86,7 +102,7 @@ Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/
> `optional` **startBlock**: `number`
-Defined in: [interfaces.ts:145](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L145)
+Defined in: [interfaces.ts:167](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L167)
***
@@ -94,7 +110,7 @@ Defined in: [interfaces.ts:145](https://github.com/humanprotocol/human-protocol/
> `optional` **startDate**: `Date`
-Defined in: [interfaces.ts:147](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L147)
+Defined in: [interfaces.ts:169](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L169)
***
@@ -102,4 +118,12 @@ Defined in: [interfaces.ts:147](https://github.com/humanprotocol/human-protocol/
> `optional` **toAddress**: `string`
-Defined in: [interfaces.ts:150](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L150)
+Defined in: [interfaces.ts:172](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L172)
+
+***
+
+### token?
+
+> `optional` **token**: `string`
+
+Defined in: [interfaces.ts:175](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L175)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IWorker.md b/docs/sdk/typescript/interfaces/interfaces/IWorker.md
index 11a8fa9ba5..e089425555 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IWorker.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IWorker.md
@@ -6,7 +6,7 @@
# Interface: IWorker
-Defined in: [interfaces.ts:174](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L174)
+Defined in: [interfaces.ts:199](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L199)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:174](https://github.com/humanprotocol/human-protocol/
> **address**: `string`
-Defined in: [interfaces.ts:176](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L176)
+Defined in: [interfaces.ts:201](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L201)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:176](https://github.com/humanprotocol/human-protocol/
> **id**: `string`
-Defined in: [interfaces.ts:175](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L175)
+Defined in: [interfaces.ts:200](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L200)
***
@@ -30,12 +30,12 @@ Defined in: [interfaces.ts:175](https://github.com/humanprotocol/human-protocol/
> **payoutCount**: `number`
-Defined in: [interfaces.ts:178](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L178)
+Defined in: [interfaces.ts:203](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L203)
***
-### totalAmountReceived
+### totalHMTAmountReceived
-> **totalAmountReceived**: `number`
+> **totalHMTAmountReceived**: `number`
-Defined in: [interfaces.ts:177](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L177)
+Defined in: [interfaces.ts:202](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L202)
diff --git a/docs/sdk/typescript/interfaces/interfaces/IWorkersFilter.md b/docs/sdk/typescript/interfaces/interfaces/IWorkersFilter.md
index 14a31aaf66..ee156bb3f3 100644
--- a/docs/sdk/typescript/interfaces/interfaces/IWorkersFilter.md
+++ b/docs/sdk/typescript/interfaces/interfaces/IWorkersFilter.md
@@ -6,7 +6,7 @@
# Interface: IWorkersFilter
-Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
+Defined in: [interfaces.ts:206](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L206)
## Extends
@@ -18,7 +18,7 @@ Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/
> `optional` **address**: `string`
-Defined in: [interfaces.ts:183](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L183)
+Defined in: [interfaces.ts:208](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L208)
***
@@ -26,7 +26,7 @@ Defined in: [interfaces.ts:183](https://github.com/humanprotocol/human-protocol/
> **chainId**: [`ChainId`](../../enums/enumerations/ChainId.md)
-Defined in: [interfaces.ts:182](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L182)
+Defined in: [interfaces.ts:207](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L207)
***
@@ -34,7 +34,7 @@ Defined in: [interfaces.ts:182](https://github.com/humanprotocol/human-protocol/
> `optional` **first**: `number`
-Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L154)
+Defined in: [interfaces.ts:179](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L179)
#### Inherited from
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:154](https://github.com/humanprotocol/human-protocol/
> `optional` **orderBy**: `string`
-Defined in: [interfaces.ts:184](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L184)
+Defined in: [interfaces.ts:209](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L209)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:184](https://github.com/humanprotocol/human-protocol/
> `optional` **orderDirection**: [`OrderDirection`](../../enums/enumerations/OrderDirection.md)
-Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L156)
+Defined in: [interfaces.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L181)
#### Inherited from
@@ -66,7 +66,7 @@ Defined in: [interfaces.ts:156](https://github.com/humanprotocol/human-protocol/
> `optional` **skip**: `number`
-Defined in: [interfaces.ts:155](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L155)
+Defined in: [interfaces.ts:180](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L180)
#### Inherited from
diff --git a/docs/sdk/typescript/interfaces/interfaces/InternalTransaction.md b/docs/sdk/typescript/interfaces/interfaces/InternalTransaction.md
index 8775833e43..7aea173e31 100644
--- a/docs/sdk/typescript/interfaces/interfaces/InternalTransaction.md
+++ b/docs/sdk/typescript/interfaces/interfaces/InternalTransaction.md
@@ -6,7 +6,7 @@
# Interface: InternalTransaction
-Defined in: [interfaces.ts:119](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L119)
+Defined in: [interfaces.ts:141](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L141)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:119](https://github.com/humanprotocol/human-protocol/
> `optional` **escrow**: `string`
-Defined in: [interfaces.ts:125](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L125)
+Defined in: [interfaces.ts:147](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L147)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:125](https://github.com/humanprotocol/human-protocol/
> **from**: `string`
-Defined in: [interfaces.ts:120](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L120)
+Defined in: [interfaces.ts:142](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L142)
***
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:120](https://github.com/humanprotocol/human-protocol/
> **method**: `string`
-Defined in: [interfaces.ts:123](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L123)
+Defined in: [interfaces.ts:145](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L145)
***
@@ -38,7 +38,7 @@ Defined in: [interfaces.ts:123](https://github.com/humanprotocol/human-protocol/
> `optional` **receiver**: `string`
-Defined in: [interfaces.ts:124](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L124)
+Defined in: [interfaces.ts:146](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L146)
***
@@ -46,7 +46,7 @@ Defined in: [interfaces.ts:124](https://github.com/humanprotocol/human-protocol/
> **to**: `string`
-Defined in: [interfaces.ts:121](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L121)
+Defined in: [interfaces.ts:143](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L143)
***
@@ -54,7 +54,7 @@ Defined in: [interfaces.ts:121](https://github.com/humanprotocol/human-protocol/
> `optional` **token**: `string`
-Defined in: [interfaces.ts:126](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L126)
+Defined in: [interfaces.ts:148](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L148)
***
@@ -62,4 +62,4 @@ Defined in: [interfaces.ts:126](https://github.com/humanprotocol/human-protocol/
> **value**: `string`
-Defined in: [interfaces.ts:122](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L122)
+Defined in: [interfaces.ts:144](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L144)
diff --git a/docs/sdk/typescript/interfaces/interfaces/StakerInfo.md b/docs/sdk/typescript/interfaces/interfaces/StakerInfo.md
index e0fd825cf4..5b1b553d62 100644
--- a/docs/sdk/typescript/interfaces/interfaces/StakerInfo.md
+++ b/docs/sdk/typescript/interfaces/interfaces/StakerInfo.md
@@ -6,7 +6,7 @@
# Interface: StakerInfo
-Defined in: [interfaces.ts:159](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L159)
+Defined in: [interfaces.ts:184](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L184)
## Properties
@@ -14,7 +14,7 @@ Defined in: [interfaces.ts:159](https://github.com/humanprotocol/human-protocol/
> **lockedAmount**: `bigint`
-Defined in: [interfaces.ts:161](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L161)
+Defined in: [interfaces.ts:186](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L186)
***
@@ -22,7 +22,7 @@ Defined in: [interfaces.ts:161](https://github.com/humanprotocol/human-protocol/
> **lockedUntil**: `bigint`
-Defined in: [interfaces.ts:162](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L162)
+Defined in: [interfaces.ts:187](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L187)
***
@@ -30,7 +30,7 @@ Defined in: [interfaces.ts:162](https://github.com/humanprotocol/human-protocol/
> **stakedAmount**: `bigint`
-Defined in: [interfaces.ts:160](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L160)
+Defined in: [interfaces.ts:185](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L185)
***
@@ -38,4 +38,4 @@ Defined in: [interfaces.ts:160](https://github.com/humanprotocol/human-protocol/
> **withdrawableAmount**: `bigint`
-Defined in: [interfaces.ts:163](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L163)
+Defined in: [interfaces.ts:188](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/interfaces.ts#L188)
diff --git a/docs/sdk/typescript/kvstore/classes/KVStoreClient.md b/docs/sdk/typescript/kvstore/classes/KVStoreClient.md
index 5e7a7d8eef..29a0802e56 100644
--- a/docs/sdk/typescript/kvstore/classes/KVStoreClient.md
+++ b/docs/sdk/typescript/kvstore/classes/KVStoreClient.md
@@ -6,7 +6,7 @@
# Class: KVStoreClient
-Defined in: [kvstore.ts:99](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L99)
+Defined in: [kvstore.ts:99](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L99)
## Introduction
@@ -82,11 +82,11 @@ const kvstoreClient = await KVStoreClient.build(provider);
## Constructors
-### new KVStoreClient()
+### Constructor
-> **new KVStoreClient**(`runner`, `networkData`): [`KVStoreClient`](KVStoreClient.md)
+> **new KVStoreClient**(`runner`, `networkData`): `KVStoreClient`
-Defined in: [kvstore.ts:108](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L108)
+Defined in: [kvstore.ts:108](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L108)
**KVStoreClient constructor**
@@ -106,11 +106,11 @@ The network information required to connect to the KVStore contract
#### Returns
-[`KVStoreClient`](KVStoreClient.md)
+`KVStoreClient`
#### Overrides
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`constructor`](../../base/classes/BaseEthersClient.md#constructors)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`constructor`](../../base/classes/BaseEthersClient.md#constructor)
## Properties
@@ -118,11 +118,11 @@ The network information required to connect to the KVStore contract
> **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
-Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
#### Inherited from
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`networkData`](../../base/classes/BaseEthersClient.md#networkdata-1)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`networkData`](../../base/classes/BaseEthersClient.md#networkdata)
***
@@ -130,19 +130,19 @@ Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1f
> `protected` **runner**: `ContractRunner`
-Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
#### Inherited from
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`runner`](../../base/classes/BaseEthersClient.md#runner-1)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`runner`](../../base/classes/BaseEthersClient.md#runner)
## Methods
### set()
-> **set**(`key`, `value`, `txOptions`?): `Promise`\<`void`\>
+> **set**(`key`, `value`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [kvstore.ts:171](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L171)
+Defined in: [kvstore.ts:171](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L171)
This function sets a key-value pair associated with the address that submits the transaction.
@@ -194,9 +194,9 @@ await kvstoreClient.set('Role', 'RecordingOracle');
### setBulk()
-> **setBulk**(`keys`, `values`, `txOptions`?): `Promise`\<`void`\>
+> **setBulk**(`keys`, `values`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [kvstore.ts:214](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L214)
+Defined in: [kvstore.ts:214](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L214)
This function sets key-value pairs in bulk associated with the address that submits the transaction.
@@ -250,9 +250,9 @@ await kvstoreClient.setBulk(keys, values);
### setFileUrlAndHash()
-> **setFileUrlAndHash**(`url`, `urlKey`, `txOptions`?): `Promise`\<`void`\>
+> **setFileUrlAndHash**(`url`, `urlKey`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [kvstore.ts:257](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L257)
+Defined in: [kvstore.ts:257](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L257)
Sets a URL value for the address that submits the transaction, and its hash.
@@ -303,9 +303,9 @@ await kvstoreClient.setFileUrlAndHash('linkedin.com/example', 'linkedin_url');
### build()
-> `static` **build**(`runner`): `Promise`\<[`KVStoreClient`](KVStoreClient.md)\>
+> `static` **build**(`runner`): `Promise`\<`KVStoreClient`\>
-Defined in: [kvstore.ts:126](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L126)
+Defined in: [kvstore.ts:126](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L126)
Creates an instance of KVStoreClient from a runner.
@@ -319,7 +319,7 @@ The Runner object to interact with the Ethereum network
#### Returns
-`Promise`\<[`KVStoreClient`](KVStoreClient.md)\>
+`Promise`\<`KVStoreClient`\>
- An instance of KVStoreClient
diff --git a/docs/sdk/typescript/kvstore/classes/KVStoreUtils.md b/docs/sdk/typescript/kvstore/classes/KVStoreUtils.md
index b2256eac5b..e1869bfefb 100644
--- a/docs/sdk/typescript/kvstore/classes/KVStoreUtils.md
+++ b/docs/sdk/typescript/kvstore/classes/KVStoreUtils.md
@@ -6,7 +6,7 @@
# Class: KVStoreUtils
-Defined in: [kvstore.ts:318](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L318)
+Defined in: [kvstore.ts:318](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L318)
## Introduction
@@ -41,13 +41,13 @@ const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
## Constructors
-### new KVStoreUtils()
+### Constructor
-> **new KVStoreUtils**(): [`KVStoreUtils`](KVStoreUtils.md)
+> **new KVStoreUtils**(): `KVStoreUtils`
#### Returns
-[`KVStoreUtils`](KVStoreUtils.md)
+`KVStoreUtils`
## Methods
@@ -55,7 +55,7 @@ const KVStoreAddresses = await KVStoreUtils.getKVStoreData(
> `static` **get**(`chainId`, `address`, `key`): `Promise`\<`string`\>
-Defined in: [kvstore.ts:389](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L389)
+Defined in: [kvstore.ts:389](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L389)
Gets the value of a key-value pair in the KVStore using the subgraph.
@@ -116,7 +116,7 @@ console.log(value);
> `static` **getFileUrlAndVerifyHash**(`chainId`, `address`, `urlKey`): `Promise`\<`string`\>
-Defined in: [kvstore.ts:436](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L436)
+Defined in: [kvstore.ts:436](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L436)
Gets the URL value of the given entity, and verifies its hash.
@@ -164,7 +164,7 @@ console.log(url);
> `static` **getKVStoreData**(`chainId`, `address`): `Promise`\<[`IKVStore`](../../interfaces/interfaces/IKVStore.md)[]\>
-Defined in: [kvstore.ts:337](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L337)
+Defined in: [kvstore.ts:337](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L337)
This function returns the KVStore data for a given address.
@@ -211,7 +211,7 @@ console.log(kvStoreData);
> `static` **getPublicKey**(`chainId`, `address`): `Promise`\<`string`\>
-Defined in: [kvstore.ts:496](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L496)
+Defined in: [kvstore.ts:496](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/kvstore.ts#L496)
Gets the public key of the given entity, and verifies its hash.
diff --git a/docs/sdk/typescript/operator/classes/OperatorUtils.md b/docs/sdk/typescript/operator/classes/OperatorUtils.md
index 9e675b0bd4..ae01680de8 100644
--- a/docs/sdk/typescript/operator/classes/OperatorUtils.md
+++ b/docs/sdk/typescript/operator/classes/OperatorUtils.md
@@ -6,17 +6,17 @@
# Class: OperatorUtils
-Defined in: [operator.ts:27](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L27)
+Defined in: [operator.ts:27](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L27)
## Constructors
-### new OperatorUtils()
+### Constructor
-> **new OperatorUtils**(): [`OperatorUtils`](OperatorUtils.md)
+> **new OperatorUtils**(): `OperatorUtils`
#### Returns
-[`OperatorUtils`](OperatorUtils.md)
+`OperatorUtils`
## Methods
@@ -24,7 +24,7 @@ Defined in: [operator.ts:27](https://github.com/humanprotocol/human-protocol/blo
> `static` **getOperator**(`chainId`, `address`): `Promise`\<[`IOperator`](../../interfaces/interfaces/IOperator.md)\>
-Defined in: [operator.ts:43](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L43)
+Defined in: [operator.ts:43](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L43)
This function returns the operator data for the given address.
@@ -62,7 +62,7 @@ const operator = await OperatorUtils.getOperator(ChainId.POLYGON_AMOY, '0x62dD51
> `static` **getOperators**(`filter`): `Promise`\<[`IOperator`](../../interfaces/interfaces/IOperator.md)[]\>
-Defined in: [operator.ts:109](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L109)
+Defined in: [operator.ts:109](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L109)
This function returns all the operator details of the protocol.
@@ -95,9 +95,9 @@ const operators = await OperatorUtils.getOperators(filter);
### getReputationNetworkOperators()
-> `static` **getReputationNetworkOperators**(`chainId`, `address`, `role`?): `Promise`\<[`IOperator`](../../interfaces/interfaces/IOperator.md)[]\>
+> `static` **getReputationNetworkOperators**(`chainId`, `address`, `role?`): `Promise`\<[`IOperator`](../../interfaces/interfaces/IOperator.md)[]\>
-Defined in: [operator.ts:190](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L190)
+Defined in: [operator.ts:190](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L190)
Retrieves the reputation network operators of the specified address.
@@ -141,7 +141,7 @@ const operators = await OperatorUtils.getReputationNetworkOperators(ChainId.POLY
> `static` **getRewards**(`chainId`, `slasherAddress`): `Promise`\<[`IReward`](../../interfaces/interfaces/IReward.md)[]\>
-Defined in: [operator.ts:244](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L244)
+Defined in: [operator.ts:244](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/operator.ts#L244)
This function returns information about the rewards for a given slasher address.
diff --git a/docs/sdk/typescript/staking/classes/StakingClient.md b/docs/sdk/typescript/staking/classes/StakingClient.md
index bd9b92b82e..17a9fd7b36 100644
--- a/docs/sdk/typescript/staking/classes/StakingClient.md
+++ b/docs/sdk/typescript/staking/classes/StakingClient.md
@@ -6,7 +6,7 @@
# Class: StakingClient
-Defined in: [staking.ts:97](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L97)
+Defined in: [staking.ts:97](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L97)
## Introduction
@@ -82,11 +82,11 @@ const stakingClient = await StakingClient.build(provider);
## Constructors
-### new StakingClient()
+### Constructor
-> **new StakingClient**(`runner`, `networkData`): [`StakingClient`](StakingClient.md)
+> **new StakingClient**(`runner`, `networkData`): `StakingClient`
-Defined in: [staking.ts:108](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L108)
+Defined in: [staking.ts:108](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L108)
**StakingClient constructor**
@@ -106,11 +106,11 @@ The network information required to connect to the Staking contract
#### Returns
-[`StakingClient`](StakingClient.md)
+`StakingClient`
#### Overrides
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`constructor`](../../base/classes/BaseEthersClient.md#constructors)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`constructor`](../../base/classes/BaseEthersClient.md#constructor)
## Properties
@@ -118,7 +118,7 @@ The network information required to connect to the Staking contract
> **escrowFactoryContract**: `EscrowFactory`
-Defined in: [staking.ts:100](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L100)
+Defined in: [staking.ts:100](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L100)
***
@@ -126,11 +126,11 @@ Defined in: [staking.ts:100](https://github.com/humanprotocol/human-protocol/blo
> **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
-Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
+Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L12)
#### Inherited from
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`networkData`](../../base/classes/BaseEthersClient.md#networkdata-1)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`networkData`](../../base/classes/BaseEthersClient.md#networkdata)
***
@@ -138,11 +138,11 @@ Defined in: [base.ts:12](https://github.com/humanprotocol/human-protocol/blob/1f
> `protected` **runner**: `ContractRunner`
-Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
+Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/base.ts#L11)
#### Inherited from
-[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`runner`](../../base/classes/BaseEthersClient.md#runner-1)
+[`BaseEthersClient`](../../base/classes/BaseEthersClient.md).[`runner`](../../base/classes/BaseEthersClient.md#runner)
***
@@ -150,7 +150,7 @@ Defined in: [base.ts:11](https://github.com/humanprotocol/human-protocol/blob/1f
> **stakingContract**: `Staking`
-Defined in: [staking.ts:99](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L99)
+Defined in: [staking.ts:99](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L99)
***
@@ -158,15 +158,15 @@ Defined in: [staking.ts:99](https://github.com/humanprotocol/human-protocol/blob
> **tokenContract**: `HMToken`
-Defined in: [staking.ts:98](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L98)
+Defined in: [staking.ts:98](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L98)
## Methods
### approveStake()
-> **approveStake**(`amount`, `txOptions`?): `Promise`\<`void`\>
+> **approveStake**(`amount`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [staking.ts:193](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L193)
+Defined in: [staking.ts:193](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L193)
This function approves the staking contract to transfer a specified amount of tokens when the user stakes. It increases the allowance for the staking contract.
@@ -213,7 +213,7 @@ await stakingClient.approveStake(amount);
> **getStakerInfo**(`stakerAddress`): `Promise`\<[`StakerInfo`](../../interfaces/interfaces/StakerInfo.md)\>
-Defined in: [staking.ts:435](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L435)
+Defined in: [staking.ts:435](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L435)
Retrieves comprehensive staking information for a staker.
@@ -247,9 +247,9 @@ console.log(stakingInfo.tokensStaked);
### slash()
-> **slash**(`slasher`, `staker`, `escrowAddress`, `amount`, `txOptions`?): `Promise`\<`void`\>
+> **slash**(`slasher`, `staker`, `escrowAddress`, `amount`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [staking.ts:373](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L373)
+Defined in: [staking.ts:373](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L373)
This function reduces the allocated amount by a staker in an escrow and transfers those tokens to the reward pool. This allows the slasher to claim them later.
@@ -312,9 +312,9 @@ await stakingClient.slash('0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266', '0xf39Fd
### stake()
-> **stake**(`amount`, `txOptions`?): `Promise`\<`void`\>
+> **stake**(`amount`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [staking.ts:247](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L247)
+Defined in: [staking.ts:247](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L247)
This function stakes a specified amount of tokens on a specific network.
@@ -362,9 +362,9 @@ await stakingClient.stake(amount);
### unstake()
-> **unstake**(`amount`, `txOptions`?): `Promise`\<`void`\>
+> **unstake**(`amount`, `txOptions?`): `Promise`\<`void`\>
-Defined in: [staking.ts:291](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L291)
+Defined in: [staking.ts:291](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L291)
This function unstakes tokens from staking contract. The unstaked tokens stay locked for a period of time.
@@ -411,9 +411,9 @@ await stakingClient.unstake(amount);
### withdraw()
-> **withdraw**(`txOptions`?): `Promise`\<`void`\>
+> **withdraw**(`txOptions?`): `Promise`\<`void`\>
-Defined in: [staking.ts:336](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L336)
+Defined in: [staking.ts:336](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L336)
This function withdraws unstaked and non-locked tokens from staking contract to the user wallet.
@@ -453,9 +453,9 @@ await stakingClient.withdraw();
### build()
-> `static` **build**(`runner`): `Promise`\<[`StakingClient`](StakingClient.md)\>
+> `static` **build**(`runner`): `Promise`\<`StakingClient`\>
-Defined in: [staking.ts:136](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L136)
+Defined in: [staking.ts:136](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/staking.ts#L136)
Creates an instance of StakingClient from a Runner.
@@ -469,7 +469,7 @@ The Runner object to interact with the Ethereum network
#### Returns
-`Promise`\<[`StakingClient`](StakingClient.md)\>
+`Promise`\<`StakingClient`\>
- An instance of StakingClient
diff --git a/docs/sdk/typescript/statistics/classes/StatisticsClient.md b/docs/sdk/typescript/statistics/classes/StatisticsClient.md
index 3dd493b5e5..4ec52d9ef6 100644
--- a/docs/sdk/typescript/statistics/classes/StatisticsClient.md
+++ b/docs/sdk/typescript/statistics/classes/StatisticsClient.md
@@ -6,7 +6,7 @@
# Class: StatisticsClient
-Defined in: [statistics.ts:58](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L58)
+Defined in: [statistics.ts:58](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L58)
## Introduction
@@ -41,11 +41,11 @@ const statisticsClient = new StatisticsClient(NETWORKS[ChainId.POLYGON_AMOY]);
## Constructors
-### new StatisticsClient()
+### Constructor
-> **new StatisticsClient**(`networkData`): [`StatisticsClient`](StatisticsClient.md)
+> **new StatisticsClient**(`networkData`): `StatisticsClient`
-Defined in: [statistics.ts:67](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L67)
+Defined in: [statistics.ts:67](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L67)
**StatisticsClient constructor**
@@ -59,7 +59,7 @@ The network information required to connect to the Statistics contract
#### Returns
-[`StatisticsClient`](StatisticsClient.md)
+`StatisticsClient`
## Properties
@@ -67,7 +67,7 @@ The network information required to connect to the Statistics contract
> **networkData**: [`NetworkData`](../../types/type-aliases/NetworkData.md)
-Defined in: [statistics.ts:59](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L59)
+Defined in: [statistics.ts:59](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L59)
***
@@ -75,7 +75,7 @@ Defined in: [statistics.ts:59](https://github.com/humanprotocol/human-protocol/b
> **subgraphUrl**: `string`
-Defined in: [statistics.ts:60](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L60)
+Defined in: [statistics.ts:60](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L60)
## Methods
@@ -83,7 +83,7 @@ Defined in: [statistics.ts:60](https://github.com/humanprotocol/human-protocol/b
> **getEscrowStatistics**(`filter`): `Promise`\<[`EscrowStatistics`](../../graphql/types/type-aliases/EscrowStatistics.md)\>
-Defined in: [statistics.ts:120](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L120)
+Defined in: [statistics.ts:120](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L120)
This function returns the statistical data of escrows.
@@ -149,7 +149,7 @@ const escrowStatisticsApril = await statisticsClient.getEscrowStatistics({
> **getHMTDailyData**(`filter`): `Promise`\<[`DailyHMTData`](../../graphql/types/type-aliases/DailyHMTData.md)[]\>
-Defined in: [statistics.ts:478](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L478)
+Defined in: [statistics.ts:478](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L478)
This function returns the statistical data of HMToken day by day.
@@ -214,7 +214,7 @@ console.log('HMT statistics from 5/8 - 6/8:', hmtStatisticsRange);
> **getHMTHolders**(`params`): `Promise`\<[`HMTHolder`](../../graphql/types/type-aliases/HMTHolder.md)[]\>
-Defined in: [statistics.ts:407](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L407)
+Defined in: [statistics.ts:407](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L407)
This function returns the holders of the HMToken with optional filters and ordering.
@@ -257,7 +257,7 @@ console.log('HMT holders:', hmtHolders.map((h) => ({
> **getHMTStatistics**(): `Promise`\<[`HMTStatistics`](../../graphql/types/type-aliases/HMTStatistics.md)\>
-Defined in: [statistics.ts:364](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L364)
+Defined in: [statistics.ts:364](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L364)
This function returns the statistical data of HMToken.
@@ -296,7 +296,7 @@ console.log('HMT statistics:', {
> **getPaymentStatistics**(`filter`): `Promise`\<[`PaymentStatistics`](../../graphql/types/type-aliases/PaymentStatistics.md)\>
-Defined in: [statistics.ts:300](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L300)
+Defined in: [statistics.ts:300](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L300)
This function returns the statistical data of payments.
@@ -380,7 +380,7 @@ console.log(
> **getWorkerStatistics**(`filter`): `Promise`\<[`WorkerStatistics`](../../graphql/types/type-aliases/WorkerStatistics.md)\>
-Defined in: [statistics.ts:204](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L204)
+Defined in: [statistics.ts:204](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/statistics.ts#L204)
This function returns the statistical data of workers.
diff --git a/docs/sdk/typescript/storage/classes/StorageClient.md b/docs/sdk/typescript/storage/classes/StorageClient.md
index 6204af8592..4fd294967f 100644
--- a/docs/sdk/typescript/storage/classes/StorageClient.md
+++ b/docs/sdk/typescript/storage/classes/StorageClient.md
@@ -6,7 +6,7 @@
# Class: ~~StorageClient~~
-Defined in: [storage.ts:63](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L63)
+Defined in: [storage.ts:63](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L63)
## Deprecated
@@ -57,11 +57,11 @@ const storageClient = new StorageClient(params, credentials);
## Constructors
-### new StorageClient()
+### Constructor
-> **new StorageClient**(`params`, `credentials`?): [`StorageClient`](StorageClient.md)
+> **new StorageClient**(`params`, `credentials?`): `StorageClient`
-Defined in: [storage.ts:73](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L73)
+Defined in: [storage.ts:73](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L73)
**Storage client constructor**
@@ -81,7 +81,7 @@ Optional. Cloud storage access data. If credentials are not provided - use anony
#### Returns
-[`StorageClient`](StorageClient.md)
+`StorageClient`
## Methods
@@ -89,7 +89,7 @@ Optional. Cloud storage access data. If credentials are not provided - use anony
> **bucketExists**(`bucket`): `Promise`\<`boolean`\>
-Defined in: [storage.ts:262](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L262)
+Defined in: [storage.ts:262](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L262)
This function checks if a bucket exists.
@@ -133,7 +133,7 @@ const exists = await storageClient.bucketExists('bucket-name');
> **downloadFiles**(`keys`, `bucket`): `Promise`\<`any`[]\>
-Defined in: [storage.ts:112](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L112)
+Defined in: [storage.ts:112](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L112)
This function downloads files from a bucket.
@@ -181,7 +181,7 @@ const files = await storageClient.downloadFiles(keys, 'bucket-name');
> **listObjects**(`bucket`): `Promise`\<`string`[]\>
-Defined in: [storage.ts:292](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L292)
+Defined in: [storage.ts:292](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L292)
This function lists all file names contained in the bucket.
@@ -225,7 +225,7 @@ const fileNames = await storageClient.listObjects('bucket-name');
> **uploadFiles**(`files`, `bucket`): `Promise`\<[`UploadFile`](../../types/type-aliases/UploadFile.md)[]\>
-Defined in: [storage.ts:198](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L198)
+Defined in: [storage.ts:198](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L198)
This function uploads files to a bucket.
@@ -278,7 +278,7 @@ const uploadedFiles = await storageClient.uploadFiles(files, 'bucket-name');
> `static` **downloadFileFromUrl**(`url`): `Promise`\<`any`\>
-Defined in: [storage.ts:146](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L146)
+Defined in: [storage.ts:146](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/storage.ts#L146)
This function downloads files from a URL.
diff --git a/docs/sdk/typescript/transaction/classes/TransactionUtils.md b/docs/sdk/typescript/transaction/classes/TransactionUtils.md
index e6031b2f4d..77470e7087 100644
--- a/docs/sdk/typescript/transaction/classes/TransactionUtils.md
+++ b/docs/sdk/typescript/transaction/classes/TransactionUtils.md
@@ -6,17 +6,17 @@
# Class: TransactionUtils
-Defined in: [transaction.ts:18](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/transaction.ts#L18)
+Defined in: [transaction.ts:18](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/transaction.ts#L18)
## Constructors
-### new TransactionUtils()
+### Constructor
-> **new TransactionUtils**(): [`TransactionUtils`](TransactionUtils.md)
+> **new TransactionUtils**(): `TransactionUtils`
#### Returns
-[`TransactionUtils`](TransactionUtils.md)
+`TransactionUtils`
## Methods
@@ -24,10 +24,26 @@ Defined in: [transaction.ts:18](https://github.com/humanprotocol/human-protocol/
> `static` **getTransaction**(`chainId`, `hash`): `Promise`\<[`ITransaction`](../../interfaces/interfaces/ITransaction.md)\>
-Defined in: [transaction.ts:34](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/transaction.ts#L34)
+Defined in: [transaction.ts:50](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/transaction.ts#L50)
This function returns the transaction data for the given hash.
+```ts
+type ITransaction = {
+ block: bigint;
+ txHash: string;
+ from: string;
+ to: string;
+ timestamp: bigint;
+ value: string;
+ method: string;
+ receiver?: string;
+ escrow?: string;
+ token?: string;
+ internalTransactions: InternalTransaction[];
+};
+```
+
#### Parameters
##### chainId
@@ -62,7 +78,7 @@ const transaction = await TransactionUtils.getTransaction(ChainId.POLYGON, '0x62
> `static` **getTransactions**(`filter`): `Promise`\<[`ITransaction`](../../interfaces/interfaces/ITransaction.md)[]\>
-Defined in: [transaction.ts:109](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/transaction.ts#L109)
+Defined in: [transaction.ts:132](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/transaction.ts#L132)
This function returns all transaction details based on the provided filter.
@@ -75,6 +91,9 @@ interface ITransactionsFilter {
chainId: ChainId; // List of chain IDs to query.
fromAddress?: string; // (Optional) The address from which transactions are sent.
toAddress?: string; // (Optional) The address to which transactions are sent.
+ method?: string; // (Optional) The method of the transaction to filter by.
+ escrow?: string; // (Optional) The escrow address to filter transactions.
+ token?: string; // (Optional) The token address to filter transactions.
startDate?: Date; // (Optional) The start date to filter transactions (inclusive).
endDate?: Date; // (Optional) The end date to filter transactions (inclusive).
startBlock?: number; // (Optional) The start block number to filter transactions (inclusive).
@@ -87,13 +106,17 @@ interface ITransactionsFilter {
```ts
type ITransaction = {
- block: number;
+ block: bigint;
txHash: string;
from: string;
to: string;
- timestamp: number;
+ timestamp: bigint;
value: string;
method: string;
+ receiver?: string;
+ escrow?: string;
+ token?: string;
+ internalTransactions: InternalTransaction[];
};
```
diff --git a/docs/sdk/typescript/types/enumerations/EscrowStatus.md b/docs/sdk/typescript/types/enumerations/EscrowStatus.md
index d0e0362ce2..716cac332f 100644
--- a/docs/sdk/typescript/types/enumerations/EscrowStatus.md
+++ b/docs/sdk/typescript/types/enumerations/EscrowStatus.md
@@ -6,7 +6,7 @@
# Enumeration: EscrowStatus
-Defined in: [types.ts:8](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L8)
+Defined in: [types.ts:8](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L8)
Enum for escrow statuses.
@@ -16,7 +16,7 @@ Enum for escrow statuses.
> **Cancelled**: `5`
-Defined in: [types.ts:32](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L32)
+Defined in: [types.ts:32](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L32)
Escrow is cancelled.
@@ -26,7 +26,7 @@ Escrow is cancelled.
> **Complete**: `4`
-Defined in: [types.ts:28](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L28)
+Defined in: [types.ts:28](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L28)
Escrow is finished.
@@ -36,7 +36,7 @@ Escrow is finished.
> **Launched**: `0`
-Defined in: [types.ts:12](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L12)
+Defined in: [types.ts:12](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L12)
Escrow is launched.
@@ -46,7 +46,7 @@ Escrow is launched.
> **Paid**: `3`
-Defined in: [types.ts:24](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L24)
+Defined in: [types.ts:24](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L24)
Escrow is fully paid.
@@ -56,7 +56,7 @@ Escrow is fully paid.
> **Partial**: `2`
-Defined in: [types.ts:20](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L20)
+Defined in: [types.ts:20](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L20)
Escrow is partially paid out.
@@ -66,6 +66,6 @@ Escrow is partially paid out.
> **Pending**: `1`
-Defined in: [types.ts:16](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L16)
+Defined in: [types.ts:16](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L16)
Escrow is funded, and waiting for the results to be submitted.
diff --git a/docs/sdk/typescript/types/type-aliases/EscrowCancel.md b/docs/sdk/typescript/types/type-aliases/EscrowCancel.md
index 8d4fd28d84..8cdbec8abc 100644
--- a/docs/sdk/typescript/types/type-aliases/EscrowCancel.md
+++ b/docs/sdk/typescript/types/type-aliases/EscrowCancel.md
@@ -6,22 +6,28 @@
# Type Alias: EscrowCancel
-> **EscrowCancel**: `object`
+> **EscrowCancel** = `object`
-Defined in: [types.ts:145](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L145)
+Defined in: [types.ts:145](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L145)
Represents the response data for an escrow cancellation.
-## Type declaration
+## Properties
### amountRefunded
> **amountRefunded**: `bigint`
+Defined in: [types.ts:153](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L153)
+
The amount refunded in the escrow cancellation.
+***
+
### txHash
> **txHash**: `string`
+Defined in: [types.ts:149](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L149)
+
The hash of the transaction associated with the escrow cancellation.
diff --git a/docs/sdk/typescript/types/type-aliases/EscrowWithdraw.md b/docs/sdk/typescript/types/type-aliases/EscrowWithdraw.md
index cc8658ac8c..8706f5b8a6 100644
--- a/docs/sdk/typescript/types/type-aliases/EscrowWithdraw.md
+++ b/docs/sdk/typescript/types/type-aliases/EscrowWithdraw.md
@@ -6,28 +6,38 @@
# Type Alias: EscrowWithdraw
-> **EscrowWithdraw**: `object`
+> **EscrowWithdraw** = `object`
-Defined in: [types.ts:159](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L159)
+Defined in: [types.ts:159](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L159)
Represents the response data for an escrow withdrawal.
-## Type declaration
+## Properties
### amountWithdrawn
> **amountWithdrawn**: `bigint`
+Defined in: [types.ts:171](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L171)
+
The amount withdrawn from the escrow.
+***
+
### tokenAddress
> **tokenAddress**: `string`
+Defined in: [types.ts:167](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L167)
+
The address of the token used for the withdrawal.
+***
+
### txHash
> **txHash**: `string`
+Defined in: [types.ts:163](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L163)
+
The hash of the transaction associated with the escrow withdrawal.
diff --git a/docs/sdk/typescript/types/type-aliases/NetworkData.md b/docs/sdk/typescript/types/type-aliases/NetworkData.md
index 159e72044f..a2276446b6 100644
--- a/docs/sdk/typescript/types/type-aliases/NetworkData.md
+++ b/docs/sdk/typescript/types/type-aliases/NetworkData.md
@@ -6,76 +6,118 @@
# Type Alias: NetworkData
-> **NetworkData**: `object`
+> **NetworkData** = `object`
-Defined in: [types.ts:95](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L95)
+Defined in: [types.ts:95](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L95)
Network data
-## Type declaration
+## Properties
### chainId
> **chainId**: `number`
+Defined in: [types.ts:99](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L99)
+
Network chain id
+***
+
### factoryAddress
> **factoryAddress**: `string`
+Defined in: [types.ts:115](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L115)
+
Escrow Factory contract address
+***
+
### hmtAddress
> **hmtAddress**: `string`
+Defined in: [types.ts:111](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L111)
+
HMT Token contract address
+***
+
### kvstoreAddress
> **kvstoreAddress**: `string`
+Defined in: [types.ts:123](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L123)
+
KVStore contract address
+***
+
### oldFactoryAddress
> **oldFactoryAddress**: `string`
+Defined in: [types.ts:139](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L139)
+
Old Escrow Factory contract address
+***
+
### oldSubgraphUrl
> **oldSubgraphUrl**: `string`
+Defined in: [types.ts:135](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L135)
+
Old subgraph URL
+***
+
### scanUrl
> **scanUrl**: `string`
+Defined in: [types.ts:107](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L107)
+
Network scanner URL
+***
+
### stakingAddress
> **stakingAddress**: `string`
+Defined in: [types.ts:119](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L119)
+
Staking contract address
+***
+
### subgraphUrl
> **subgraphUrl**: `string`
+Defined in: [types.ts:127](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L127)
+
Subgraph URL
+***
+
### subgraphUrlApiKey
> **subgraphUrlApiKey**: `string`
+Defined in: [types.ts:131](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L131)
+
Subgraph URL API key
+***
+
### title
> **title**: `string`
+Defined in: [types.ts:103](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L103)
+
Network title
diff --git a/docs/sdk/typescript/types/type-aliases/Payout.md b/docs/sdk/typescript/types/type-aliases/Payout.md
index 66df79f1a1..d366f1118f 100644
--- a/docs/sdk/typescript/types/type-aliases/Payout.md
+++ b/docs/sdk/typescript/types/type-aliases/Payout.md
@@ -6,40 +6,58 @@
# Type Alias: Payout
-> **Payout**: `object`
+> **Payout** = `object`
-Defined in: [types.ts:177](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L177)
+Defined in: [types.ts:177](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L177)
Represents a payout from an escrow.
-## Type declaration
+## Properties
### amount
> **amount**: `bigint`
+Defined in: [types.ts:193](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L193)
+
The amount paid to the recipient.
+***
+
### createdAt
> **createdAt**: `number`
+Defined in: [types.ts:197](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L197)
+
The timestamp when the payout was created (in UNIX format).
+***
+
### escrowAddress
> **escrowAddress**: `string`
+Defined in: [types.ts:185](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L185)
+
The address of the escrow associated with the payout.
+***
+
### id
> **id**: `string`
+Defined in: [types.ts:181](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L181)
+
Unique identifier of the payout.
+***
+
### recipient
> **recipient**: `string`
+Defined in: [types.ts:189](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L189)
+
The address of the recipient who received the payout.
diff --git a/docs/sdk/typescript/types/type-aliases/StorageCredentials.md b/docs/sdk/typescript/types/type-aliases/StorageCredentials.md
index ad1b794aec..c87013b209 100644
--- a/docs/sdk/typescript/types/type-aliases/StorageCredentials.md
+++ b/docs/sdk/typescript/types/type-aliases/StorageCredentials.md
@@ -6,26 +6,32 @@
# Type Alias: ~~StorageCredentials~~
-> `readonly` **StorageCredentials**: `object`
+> `readonly` **StorageCredentials** = `object`
-Defined in: [types.ts:40](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L40)
+Defined in: [types.ts:40](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L40)
AWS/GCP cloud storage access data
-## Type declaration
+## Deprecated
+
+StorageClient is deprecated. Use Minio.Client directly.
+
+## Properties
### ~~accessKey~~
> **accessKey**: `string`
+Defined in: [types.ts:44](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L44)
+
Access Key
+***
+
### ~~secretKey~~
> **secretKey**: `string`
-Secret Key
-
-## Deprecated
+Defined in: [types.ts:48](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L48)
-StorageClient is deprecated. Use Minio.Client directly.
+Secret Key
diff --git a/docs/sdk/typescript/types/type-aliases/StorageParams.md b/docs/sdk/typescript/types/type-aliases/StorageParams.md
index d86df41951..87f599ea09 100644
--- a/docs/sdk/typescript/types/type-aliases/StorageParams.md
+++ b/docs/sdk/typescript/types/type-aliases/StorageParams.md
@@ -6,36 +6,50 @@
# Type Alias: ~~StorageParams~~
-> **StorageParams**: `object`
+> **StorageParams** = `object`
-Defined in: [types.ts:54](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L54)
+Defined in: [types.ts:54](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L54)
-## Type declaration
+## Deprecated
+
+StorageClient is deprecated. Use Minio.Client directly.
+
+## Properties
### ~~endPoint~~
> **endPoint**: `string`
+Defined in: [types.ts:58](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L58)
+
Request endPoint
+***
+
### ~~port?~~
> `optional` **port**: `number`
+Defined in: [types.ts:70](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L70)
+
TCP/IP port number. Default value set to 80 for HTTP and 443 for HTTPs
+***
+
### ~~region?~~
> `optional` **region**: `string`
+Defined in: [types.ts:66](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L66)
+
Region
+***
+
### ~~useSSL~~
> **useSSL**: `boolean`
-Enable secure (HTTPS) access. Default value set to false
+Defined in: [types.ts:62](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L62)
-## Deprecated
-
-StorageClient is deprecated. Use Minio.Client directly.
+Enable secure (HTTPS) access. Default value set to false
diff --git a/docs/sdk/typescript/types/type-aliases/TransactionLikeWithNonce.md b/docs/sdk/typescript/types/type-aliases/TransactionLikeWithNonce.md
index ed7f7a1bd4..a98655afd0 100644
--- a/docs/sdk/typescript/types/type-aliases/TransactionLikeWithNonce.md
+++ b/docs/sdk/typescript/types/type-aliases/TransactionLikeWithNonce.md
@@ -6,9 +6,9 @@
# Type Alias: TransactionLikeWithNonce
-> **TransactionLikeWithNonce**: `TransactionLike` & `object`
+> **TransactionLikeWithNonce** = `TransactionLike` & `object`
-Defined in: [types.ts:200](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L200)
+Defined in: [types.ts:200](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L200)
## Type declaration
diff --git a/docs/sdk/typescript/types/type-aliases/UploadFile.md b/docs/sdk/typescript/types/type-aliases/UploadFile.md
index 29759d4af4..7862bb8c22 100644
--- a/docs/sdk/typescript/types/type-aliases/UploadFile.md
+++ b/docs/sdk/typescript/types/type-aliases/UploadFile.md
@@ -6,28 +6,38 @@
# Type Alias: UploadFile
-> `readonly` **UploadFile**: `object`
+> `readonly` **UploadFile** = `object`
-Defined in: [types.ts:77](https://github.com/humanprotocol/human-protocol/blob/1fed10bebf38e474662f3001345d050ccf6fda2f/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L77)
+Defined in: [types.ts:77](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L77)
Upload file data
-## Type declaration
+## Properties
### hash
> **hash**: `string`
+Defined in: [types.ts:89](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L89)
+
Hash of uploaded object key
+***
+
### key
> **key**: `string`
+Defined in: [types.ts:81](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L81)
+
Uploaded object key
+***
+
### url
> **url**: `string`
+Defined in: [types.ts:85](https://github.com/humanprotocol/human-protocol/blob/9da418b6962e251427442717195921599d2815f2/packages/sdk/typescript/human-protocol-sdk/src/types.ts#L85)
+
Uploaded object URL
diff --git a/package.json b/package.json
index 4bb0c41bee..e101aba252 100644
--- a/package.json
+++ b/package.json
@@ -10,7 +10,12 @@
"lint": "yarn workspaces foreach --all -p run lint",
"build:core": "yarn workspace @human-protocol/core build",
"build:sdk": "yarn workspace @human-protocol/sdk build",
- "build:libs": "yarn build:core && yarn build:sdk"
+ "build:libs": "yarn build:core && yarn build:sdk",
+ "docker:infra-up": "make -C ./docker-setup -f Makefile.dev infra-up",
+ "docker:infra-stop": "make -C ./docker-setup -f Makefile.dev infra-stop",
+ "docker:infra-down": "make -C ./docker-setup -f Makefile.dev infra-down",
+ "docker:web3-up": "make -C ./docker-setup -f Makefile.dev web3-up",
+ "docker:web3-down": "make -C ./docker-setup -f Makefile.dev web3-down"
},
"workspaces": [
"packages/**"
diff --git a/packages/apps/dashboard/client/.env.example b/packages/apps/dashboard/client/.env.example
index 62ebf481d3..7308b99ba5 100644
--- a/packages/apps/dashboard/client/.env.example
+++ b/packages/apps/dashboard/client/.env.example
@@ -1,22 +1,26 @@
-# link to api
-VITE_API_URL=
-# links to navbar items
-VITE_NAVBAR_LINK_GITBOOK=
-VITE_NAVBAR_LINK_FAUCETS=
-VITE_NAVBAR_LINK_HUMAN_WEBSITE=
-VITE_NAVBAR_LINK_LAUNCH_JOBS=
-VITE_NAVBAR_LINK_WORK_AND_EARN=
-# link to button on 'Role details' page
-VITE_HUMANPROTOCOL_CORE_ARCHITECTURE=
-# links to footer socials
-VITE_FOOTER_LINK_GITHUB=
-VITE_FOOTER_LINK_DISCORD=
-VITE_FOOTER_LINK_X=
-VITE_FOOTER_LINK_TELEGRAM=
-VITE_FOOTER_LINK_LINKEDIN=
-# other footer links
-VITE_FOOTER_LINK_TERMS_OF_SERVICE=
-VITE_FOOTER_LINK_PRIVACY_POLICY=
-VITE_FOOTER_LINK_HUMAN_PROTOCOL=
+# General
+VITE_API_URL=http://0.0.0.0:5006
+VITE_ENABLED_CHAIN_IDS=97,80002,11155111
+
+# Links to navbar items
+VITE_NAVBAR_LINK_GITBOOK=https://docs.humanprotocol.org/
+VITE_NAVBAR_LINK_FAUCETS=https://faucet.humanprotocol.org
+VITE_NAVBAR_LINK_HUMAN_WEBSITE=https://humanprotocol.org/
+VITE_NAVBAR_LINK_LAUNCH_JOBS=https://job-launcher.humanprotocol.org/
+VITE_NAVBAR_LINK_WORK_AND_EARN=https://app.humanprotocol.org/
+
+# Link to button on 'Role details' page
+VITE_HUMANPROTOCOL_CORE_ARCHITECTURE=https://docs.humanprotocol.org/hub/human-tech-docs/architecture
+
+# Links to footer socials
+VITE_FOOTER_LINK_GITHUB=https://github.com/humanprotocol/human-protocol
+VITE_FOOTER_LINK_DISCORD=https://discord.com/invite/5sHfvE8y8p
+VITE_FOOTER_LINK_X=https://x.com/intent/follow?screen_name=human_protocol
+VITE_FOOTER_LINK_TELEGRAM=https://t.me/human_protocol_community
+VITE_FOOTER_LINK_LINKEDIN=https://www.linkedin.com/company/human-protocol
+
+# Other footer links
+VITE_FOOTER_LINK_TERMS_OF_SERVICE=https://humanprotocol.org/privacy-policy
+VITE_FOOTER_LINK_PRIVACY_POLICY=https://humanprotocol.org/privacy-policy
+VITE_FOOTER_LINK_HUMAN_PROTOCOL=https://humanprotocol.org/
-VITE_ENABLED_CHAIN_IDS=
diff --git a/packages/apps/dashboard/client/.eslintrc.cjs b/packages/apps/dashboard/client/.eslintrc.cjs
deleted file mode 100644
index 071a19765f..0000000000
--- a/packages/apps/dashboard/client/.eslintrc.cjs
+++ /dev/null
@@ -1,19 +0,0 @@
-module.exports = {
- root: true,
- env: { browser: true, es2020: true },
- extends: [
- 'eslint:recommended',
- 'plugin:@typescript-eslint/recommended',
- 'plugin:prettier/recommended',
- 'plugin:react-hooks/recommended',
- ],
- ignorePatterns: ['dist', '.eslintrc.cjs'],
- parser: '@typescript-eslint/parser',
- plugins: ['react-refresh'],
- rules: {
- 'react-refresh/only-export-components': [
- 'warn',
- { allowConstantExport: true },
- ],
- },
-};
diff --git a/packages/apps/dashboard/client/.gitignore b/packages/apps/dashboard/client/.gitignore
index a547bf36d8..adc48a4b49 100644
--- a/packages/apps/dashboard/client/.gitignore
+++ b/packages/apps/dashboard/client/.gitignore
@@ -17,6 +17,7 @@ dist-ssr
!.vscode/extensions.json
.idea
.DS_Store
+.eslintcache
*.suo
*.ntvs*
*.njsproj
diff --git a/packages/apps/dashboard/client/eslint.config.js b/packages/apps/dashboard/client/eslint.config.js
new file mode 100644
index 0000000000..dcf3e17b34
--- /dev/null
+++ b/packages/apps/dashboard/client/eslint.config.js
@@ -0,0 +1,99 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import reactPlugin from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import prettierPlugin from 'eslint-plugin-prettier';
+import importPlugin from 'eslint-plugin-import';
+import globals from 'globals';
+
+export default tseslint.config(
+ {
+ ignores: ['dist/', 'tsconfig.json'],
+ },
+ eslint.configs.recommended,
+ tseslint.configs.recommended,
+ {
+ files: ['**/*.ts', '**/*.tsx'],
+ languageOptions: {
+ ecmaVersion: 2022,
+ sourceType: 'module',
+ parser: tseslint.parser,
+ parserOptions: {
+ ecmaFeatures: {
+ jsx: true,
+ },
+ projectService: true,
+ },
+ globals: {
+ ...globals.browser,
+ ...globals.es2022,
+ },
+ },
+ plugins: {
+ react: reactPlugin,
+ 'react-hooks': reactHooksPlugin,
+ prettier: prettierPlugin,
+ import: importPlugin,
+ },
+ settings: {
+ react: {
+ version: 'detect',
+ },
+ 'import/resolver': {
+ typescript: {
+ alwaysTryTypes: true,
+ },
+ },
+ },
+ rules: {
+ 'react/prop-types': 'off',
+ 'react/display-name': 'off',
+ 'react/react-in-jsx-scope': 'off',
+ 'react-hooks/exhaustive-deps': 'warn',
+ 'react-hooks/rules-of-hooks': 'error',
+ 'import/order': [
+ 'error',
+ {
+ 'groups': ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
+ 'pathGroups': [
+ {
+ 'pattern': 'react',
+ 'group': 'external',
+ 'position': 'before'
+ }
+ ],
+ 'pathGroupsExcludedImportTypes': ['react'],
+ 'newlines-between': 'always',
+ 'alphabetize': {
+ 'order': 'asc',
+ 'caseInsensitive': true
+ }
+ }
+ ],
+ 'import/no-duplicates': 'error',
+ 'import/no-unresolved': 'error',
+ '@typescript-eslint/no-unused-vars': ['error', { 'argsIgnorePattern': '^_' }],
+ '@typescript-eslint/no-explicit-any': 'error',
+ 'no-console': ['error', { allow: ['warn', 'error'] }],
+ quotes: [
+ 'error',
+ 'single',
+ {
+ avoidEscape: true,
+ },
+ ],
+ 'no-restricted-imports': [
+ 'error',
+ {
+ paths: [
+ {
+ name: 'lodash',
+ message:
+ 'Please import only specific modules from lodash to reduce bundle size. Instead of import {compact} from `lodash`, import compact from lodash/compact',
+ },
+ ],
+ },
+ ],
+ },
+ }
+);
diff --git a/packages/apps/dashboard/client/index.html b/packages/apps/dashboard/client/index.html
index c533b6ac6b..3b1a160e05 100644
--- a/packages/apps/dashboard/client/index.html
+++ b/packages/apps/dashboard/client/index.html
@@ -18,6 +18,6 @@
-
+