@human-protocol/sdk 3.0.0 → 3.0.1

package/README.md

@@ -1,6 +1,22 @@
-# Human Protocol Node.js SDK
-
-Node.js SDK to launch/manage escrows on [Human Protocol](https://www.humanprotocol.org/)
+<p align="center">
+  <a href="https://www.humanprotocol.org/" target="blank"><img src="https://s2.coinmarketcap.com/static/img/coins/64x64/10347.png" width="100" alt="Human Protocol" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+<h1 align="center">Human Protocol Node.js SDK</h1>
+<p align="center">Node.js SDK to launch/manage escrows on <a href="https://www.humanprotocol.org/">Human Protocol</a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/humanprotocol/human-protocol/actions/workflows/ci-test-node-sdk.yaml">
+    <img src="https://github.com/humanprotocol/human-protocol/actions/workflows/ci-test-node-sdk.yaml/badge.svg?branch=main" alt="Node SDK Check">
+  </a>
+  <a href="https://github.com/humanprotocol/human-protocol/actions/workflows/cd-node-sdk.yaml">
+    <img src="https://github.com/humanprotocol/human-protocol/actions/workflows/cd-node-sdk.yaml/badge.svg?event=release" alt="Node SDK deployment">
+  </a>
+</p>
 
 ## Installation
 
@@ -8,83 +24,10 @@ This SDK is available on [NPM](https://www.npmjs.com/package/@human-protocol/sdk
 
     yarn add @human-protocol/sdk
 
-## Components
-
-- InitClient
-
-  **InitClient** has one static function that returns a `Signer` or `Provider` (depending on the passed parameter), as well as a chainId associated with this parameter in an asynchronous way. Used for further passing as a constructor parameter to Web3 dependent modules.
-
-- StorageClient
-
-  **StorageClient** is used to upload/download files to the cloud storage with given credentials and params. If credentials are not provided, anonymous access will be used (for downloading files).
-
-- EscrowClient
-
-  **EscrowClient** enables to perform actions on Escrow contracts and obtain information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
-
-- KVStoreClient
-
-  **KVStoreClient** enables to perform actions on KVStore contract and obtain information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
-
-- StakingClient
-
-  **StakingClient** enables to perform actions on staking contracts and obtain staking information from both the contracts and subgraph. Internally, the SDK will use one network or another according to the network ID of the `signerOrProvider`.
-
-## Example
-
-```typescript
-const {
-  EscrowClient,
-  StakingClient,
-  NETWORKS,
-  ChainId,
-} = require('@human-protocol/sdk');
-const { ethers } = require('ethers');
-
-(async () => {
-  // Hardhat Provider
-  const provider = new ethers.providers.JsonRpcProvider(
-    'http://127.0.0.1:8545/'
-  );
-
-  // Load localhost configuration
-  const network = NETWORKS[ChainId.LOCALHOST];
-
-  const signer = new ethers.Wallet(
-    '0x5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a',
-    provider
-  );
-
-  // Initialize StakingClient
-  const stakingClient = new StakingClient({
-    signerOrProvider: signer,
-    network,
-  });
-
-  // Stake 10 HMT
-  await stakingClient.approveStake(ethers.BigNumber.from(10));
-  await stakingClient.stake(ethers.BigNumber.from(10));
+## Documentation
 
-  // Initialize EscrowClient
-  const escrowClient = new EscrowClient({
-    signerOrProvider: signer,
-    network,
-  });
+For detailed information about core, please refer to the [Human Protocol Docs](https://sdk.humanprotocol.org/).
 
-  // Create a new escrow, and setup
-  const escrowAddress = await escrowClient.createEscrow(network.hmtAddress, [
-    signer.address,
-  ]);
+## License
 
-  await escrowClient.setup(escrowAddress, {
-    recordingOracle: '0x90F79bf6EB2c4f870365E785982E1f101E93b906',
-    reputationOracle: '0x15d34AAf54267DB7D7c367839AAf71A00a2C6A65',
-    exchangeOracle: '0x6b7E3C31F34cF38d1DFC1D9A8A59482028395809',
-    recordingOracleFee: ethers.BigNumber.from(1),
-    reputationOracleFee: ethers.BigNumber.from(1),
-    exchangeOracleFee: ethers.BigNumber.from(1),
-    manifestUrl: 'http://example.com',
-    hash: 'test',
-  });
-})();
-```
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/humanprotocol/human-protocol/blob/main/LICENSE) file for details.

package/dist/enums.d.ts

@@ -19,4 +19,8 @@ export declare enum ChainId {
     LOCALHOST = 1338,
     XLAYER = 196
 }
+export declare enum OrderDirection {
+    ASC = "asc",
+    DESC = "desc"
+}
 //# sourceMappingURL=enums.d.ts.map

package/dist/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,GAAG,KAAK;IACR,OAAO,IAAI;IACX,OAAO,IAAI;IACX,MAAM,IAAI;IACV,OAAO,WAAW;IAClB,WAAW,KAAK;IAChB,WAAW,KAAK;IAChB,OAAO,MAAM;IACb,cAAc,QAAQ;IACtB,YAAY,QAAQ;IACpB,QAAQ,OAAO;IACf,cAAc,OAAO;IACrB,iBAAiB,QAAQ;IACzB,SAAS,QAAQ;IACjB,IAAI,QAAQ;IACZ,cAAc,QAAQ;IACtB,cAAc,MAAM;IACpB,SAAS,OAAO;IAChB,MAAM,MAAM;CACb"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,OAAO;IACjB,GAAG,KAAK;IACR,OAAO,IAAI;IACX,OAAO,IAAI;IACX,MAAM,IAAI;IACV,OAAO,WAAW;IAClB,WAAW,KAAK;IAChB,WAAW,KAAK;IAChB,OAAO,MAAM;IACb,cAAc,QAAQ;IACtB,YAAY,QAAQ;IACpB,QAAQ,OAAO;IACf,cAAc,OAAO;IACrB,iBAAiB,QAAQ;IACzB,SAAS,QAAQ;IACjB,IAAI,QAAQ;IACZ,cAAc,QAAQ;IACtB,cAAc,MAAM;IACpB,SAAS,OAAO;IAChB,MAAM,MAAM;CACb;AAED,oBAAY,cAAc;IACxB,GAAG,QAAQ;IACX,IAAI,SAAS;CACd"}

package/dist/enums.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ChainId = void 0;
+exports.OrderDirection = exports.ChainId = void 0;
 var ChainId;
 (function (ChainId) {
     ChainId[ChainId["ALL"] = -1] = "ALL";
@@ -23,3 +23,8 @@ var ChainId;
     ChainId[ChainId["LOCALHOST"] = 1338] = "LOCALHOST";
     ChainId[ChainId["XLAYER"] = 196] = "XLAYER";
 })(ChainId = exports.ChainId || (exports.ChainId = {}));
+var OrderDirection;
+(function (OrderDirection) {
+    OrderDirection["ASC"] = "asc";
+    OrderDirection["DESC"] = "desc";
+})(OrderDirection = exports.OrderDirection || (exports.OrderDirection = {}));

package/dist/error.d.ts

@@ -207,5 +207,12 @@ export declare class InvalidEthereumAddressError extends Error {
  * @constant {Error} - The Hash does not match
  */
 export declare const ErrorInvalidHash: Error;
+/**
+ * @constant {Error} - The Status is not supported
+ */
+export declare const ErrorUnsupportedStatus: Error;
+/**
+ * @constant {Error} - The SUBGRAPH_API_KEY is not being provided
+ */
 export declare const WarnSubgraphApiKeyNotProvided = "\"SUBGRAPH_API_KEY\" is not being provided. It might cause issues with the subgraph.";
 //# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA2C,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAgC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAA8B,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAAiC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAoC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA+B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,0CAA0C,OAEtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yCAAyC,OAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,OAE3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA0C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,mDAAmD,OAE/D,CAAC;AAEF,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAAmC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAuC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAoC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,WAAW,OAA+B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,OAAkC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAsC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAA+B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAuC,CAAC;AAE3E,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,oBAAqB,SAAQ,aAAa;gBACzC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B;AACD;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAA4B,CAAC;AAE1D,eAAO,MAAM,6BAA6B,yFAC4C,CAAC"}
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA2C,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,0BAA0B,OAAgC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAA8B,CAAC;AAEpE;;GAEG;AACH,eAAO,MAAM,2BAA2B,OAAiC,CAAC;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,OAAoC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAEnC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,OAA+B,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,0CAA0C,OAEtD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yCAAyC,OAErD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,+BAA+B,OAE3C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,4BAA4B,OAExC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB,OAAqC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC,OAE7C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA0C,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,mDAAmD,OAE/D,CAAC;AAEF,eAAO,MAAM,2BAA2B,OAEvC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAAmC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,yBAAyB,OAAuC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB,OAAoC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,WAAW,OAA+B,CAAC;AAExD;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,2CAA2C,OAEvD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,6BAA6B,OAEzC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,OAAkC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,qBAAqB,OAAsC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAA+B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC,OAE9C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gCAAgC,OAE5C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mCAAmC,OAE/C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,wCAAwC,OAEpD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,8BAA8B,OAE1C,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAAuC,CAAC;AAE3E,qBAAa,aAAc,SAAQ,KAAK;gBAC1B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,oBAAqB,SAAQ,aAAa;gBACzC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,YAAa,SAAQ,aAAa;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,aAAa;gBACxC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,sBAAuB,SAAQ,aAAa;gBAC3C,MAAM,EAAE,MAAM;CAG3B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B;AACD;;GAEG;AACH,eAAO,MAAM,gBAAgB,OAA4B,CAAC;AAE1D;;GAEG;AACH,eAAO,MAAM,sBAAsB,OAA4C,CAAC;AAEhF;;GAEG;AACH,eAAO,MAAM,6BAA6B,yFAC4C,CAAC"}

package/dist/error.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NumericFault = exports.ReplacementUnderpriced = exports.InvalidArgumentError = exports.EthereumError = exports.ErrorHashIsEmptyString = exports.ErrorLaunchedEventIsNotEmitted = exports.ErrorRecipientAndAmountsMustBeSameLength = exports.ErrorAmountsCannotBeEmptyArray = exports.ErrorEscrowDoesNotHaveEnoughBalance = exports.ErrorAmountMustBeGreaterThanZero = exports.ErrorRecipientCannotBeEmptyArray = exports.ErrorTotalFeeMustBeLessThanHundred = exports.ErrorFeeMustBeBetweenZeroAndHundred = exports.ErrorNoURLprovided = exports.ErrorListOfHandlersCannotBeEmpty = exports.ErrorUrlIsEmptyString = exports.ErrorInvalidUrl = exports.ErrorStorageClientDoesNotExist = exports.ErrorManifestFileDoesNotExist = exports.ErrorTransferEventNotFoundInTransactionLogs = exports.ErrorEscrowAddressIsNotProvidedByFactory = exports.ErrorSigner = exports.ErrorUnsupportedChainID = exports.ErrorProviderDoesNotExist = exports.ErrorHMTokenAmountNotApproved = exports.ErrorFailedToCheckAllowance = exports.ErrorFailedToApproveStakingAmountSignerDoesNotExist = exports.ErrorStakingGetStakers = exports.ErrorInvalidEscrowAddressProvided = exports.ErrorCannotUseDateAndBlockSimultaneously = exports.ErrorInvalidHahsProvided = exports.ErrorInvalidStakerAddressProvided = exports.ErrorInvalidSlasherAddressProvided = exports.ErrorInvalidStakingValueSign = exports.ErrorInvalidStakingValueType = exports.ErrorStakingValueMustBePositive = exports.ErrorInvalidExchangeOracleAddressProvided = exports.ErrorInvalidReputationOracleAddressProvided = exports.ErrorInvalidRecordingOracleAddressProvided = exports.ErrorInvalidTokenAddress = exports.ErrorInvalidAddress = exports.ErrorKVStoreArrayLength = exports.ErrorKVStoreEmptyKey = exports.ErrorStorageFileNotUploaded = exports.ErrorStorageFileNotFound = exports.ErrorStorageBucketNotFound = exports.ErrorStorageCredentialsMissing = exports.ErrorStorageClientNotExists = exports.ErrorStorageClientNotInitialized = exports.ErrorStakingMissing = void 0;
-exports.WarnSubgraphApiKeyNotProvided = exports.ErrorInvalidHash = exports.InvalidEthereumAddressError = exports.ContractExecutionError = exports.TransactionReplaced = exports.NonceExpired = void 0;
+exports.WarnSubgraphApiKeyNotProvided = exports.ErrorUnsupportedStatus = exports.ErrorInvalidHash = exports.InvalidEthereumAddressError = exports.ContractExecutionError = exports.TransactionReplaced = exports.NonceExpired = void 0;
 /**
  * @constant {Error} - The Staking contract is missing.
  */
@@ -235,4 +235,11 @@ exports.InvalidEthereumAddressError = InvalidEthereumAddressError;
  * @constant {Error} - The Hash does not match
  */
 exports.ErrorInvalidHash = new Error('Invalid hash');
+/**
+ * @constant {Error} - The Status is not supported
+ */
+exports.ErrorUnsupportedStatus = new Error('Unsupported status for query');
+/**
+ * @constant {Error} - The SUBGRAPH_API_KEY is not being provided
+ */
 exports.WarnSubgraphApiKeyNotProvided = '"SUBGRAPH_API_KEY" is not being provided. It might cause issues with the subgraph.';

package/dist/escrow.d.ts

@@ -1,7 +1,7 @@
 import { ContractRunner, Overrides } from 'ethers';
 import { BaseEthersClient } from './base';
-import { ChainId } from './enums';
-import { EscrowData } from './graphql';
+import { ChainId, OrderDirection } from './enums';
+import { EscrowData, StatusEvent } from './graphql';
 import { IEscrowConfig, IEscrowsFilter } from './interfaces';
 import { EscrowCancel, EscrowStatus, NetworkData } from './types';
 /**
@@ -693,7 +693,7 @@ export declare class EscrowClient extends BaseEthersClient {
  * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
  *
  * const escrowAddresses = new EscrowUtils.getEscrows({
- *   networks: [ChainId.POLYGON_AMOY]
+ *   network: ChainId.POLYGON_AMOY
  * });
  * ```
  */
@@ -706,7 +706,7 @@ export declare class EscrowUtils {
      *
      * ```ts
      * interface IEscrowsFilter {
-     *   networks: ChainId[];
+     *   chainId: ChainId;
      *   launcher?: string;
      *   reputationOracle?: string;
      *   recordingOracle?: string;
@@ -715,6 +715,9 @@ export declare class EscrowUtils {
      *   status?: EscrowStatus;
      *   from?: Date;
      *   to?: Date;
+     *   first?: number;
+     *   skip?: number;
+     *   orderDirection?: OrderDirection;
      * }
      * ```
      *
@@ -741,6 +744,13 @@ export declare class EscrowUtils {
      * ```
      *
      * ```ts
+     * enum OrderDirection {
+     *   ASC = 'asc',
+     *   DESC = 'desc',
+     * }
+     * ```
+     *
+     * ```ts
      * enum EscrowStatus {
      *   Launched,
      *   Pending,
@@ -791,7 +801,7 @@ export declare class EscrowUtils {
      *   status: EscrowStatus.Pending,
      *   from: new Date(2023, 4, 8),
      *   to: new Date(2023, 5, 8),
-     *   networks: [ChainId.POLYGON_AMOY]
+     *   chainId: ChainId.POLYGON_AMOY
      * };
      * const escrowDatas = await EscrowUtils.getEscrows(filters);
      * ```
@@ -866,5 +876,80 @@ export declare class EscrowUtils {
      * ```
      */
     static getEscrow(chainId: ChainId, escrowAddress: string): Promise<EscrowData>;
+    /**
+     * This function returns the status events for a given set of networks within an optional date range.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * enum ChainId {
+     *   ALL = -1,
+     *   MAINNET = 1,
+     *   RINKEBY = 4,
+     *   GOERLI = 5,
+     *   SEPOLIA = 11155111,
+     *   BSC_MAINNET = 56,
+     *   BSC_TESTNET = 97,
+     *   POLYGON = 137,
+     *   POLYGON_MUMBAI = 80001,
+     *   POLYGON_AMOY = 80002,
+     *   MOONBEAM = 1284,
+     *   MOONBASE_ALPHA = 1287,
+     *   AVALANCHE = 43114,
+     *   AVALANCHE_TESTNET = 43113,
+     *   CELO = 42220,
+     *   CELO_ALFAJORES = 44787,
+     *   LOCALHOST = 1338,
+     *   XLAYER_TESTNET = 195,
+     *   XLAYER = 196,
+     * }
+     * ```
+     *
+     * ```ts
+     * enum OrderDirection {
+     *   ASC = 'asc',
+     *   DESC = 'desc',
+     * }
+     * ```
+     *
+     * ```ts
+     * type Status = {
+     *   escrowAddress: string;
+     *   timestamp: string;
+     *   status: string;
+     * };
+     * ```
+     *
+     * @param {ChainId} chainId - List of network IDs to query for status events.
+     * @param {EscrowStatus[]} [statuses] - Optional array of statuses to query for. If not provided, queries for all statuses.
+     * @param {Date} [from] - Optional start date to filter events.
+     * @param {Date} [to] - Optional end date to filter events.
+     * @param {string} [launcher] - Optional launcher address to filter events. Must be a valid Ethereum address.
+     * @param {number} [first] - Optional number of transactions per page. Default is 10.
+     * @param {number} [skip] - Optional number of transactions to skip. Default is 0.
+     * @param {OrderDirection} [orderDirection] - Optional order of the results. Default is DESC.
+     * @returns {Promise<StatusEvent[]>} - Array of status events with their corresponding statuses.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { ChainId, EscrowUtils, EscrowStatus } from '@human-protocol/sdk';
+     *
+     * (async () => {
+     *   const fromDate = new Date('2023-01-01');
+     *   const toDate = new Date('2023-12-31');
+     *   const statusEvents = await EscrowUtils.getStatusEvents(
+     *     [ChainId.POLYGON, ChainId.MAINNET],
+     *     [EscrowStatus.Pending, EscrowStatus.Complete],
+     *     fromDate,
+     *     toDate
+     *   );
+     *   console.log(statusEvents);
+     * })();
+     * ```
+     */
+    static getStatusEvents(chainId: ChainId, statuses?: EscrowStatus[], from?: Date, to?: Date, launcher?: string, first?: number, skip?: number, orderDirection?: OrderDirection): Promise<StatusEvent[]>;
 }
 //# sourceMappingURL=escrow.d.ts.map

package/dist/escrow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAY,SAAS,EAAU,MAAM,QAAQ,CAAC;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAyBlC,OAAO,EACL,UAAU,EAGX,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,OAAO,CAAC,qBAAqB,CAAgB;IAE7C;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,EAC3B,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+EhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAqEhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,YAAY,CAAC;IAsDxB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,GAAE,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB5E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,EACzB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB5D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBtE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiGG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IA0DxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,UAAU,CAAC;CAuBvB"}
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../src/escrow.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,cAAc,EAAY,SAAS,EAAU,MAAM,QAAQ,CAAC;AAErE,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAyBlD,OAAO,EACL,UAAU,EAIV,WAAW,EACZ,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAGlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,OAAO,CAAC,qBAAqB,CAAgB;IAE7C;;;;;OAKG;gBACS,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,WAAW;IAS5D;;;;;;;;OAQG;WACiB,KAAK,CAAC,MAAM,EAAE,cAAc;IAiBhD;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAQzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IAEU,YAAY,CACvB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,MAAM,CAAC;IAqClB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IAEG,KAAK,CACT,aAAa,EAAE,MAAM,EACrB,YAAY,EAAE,aAAa,EAC3B,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+EhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IAEG,oBAAoB,CACxB,YAAY,EAAE,MAAM,EACpB,eAAe,EAAE,MAAM,EAAE,EACzB,cAAc,EAAE,MAAM,EACtB,YAAY,EAAE,aAAa,GAC1B,OAAO,CAAC,MAAM,CAAC;IAgBlB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,IAAI,CACR,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,EACd,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,YAAY,CAChB,aAAa,EAAE,MAAM,EACrB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,QAAQ,CACZ,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAmBhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IAEG,UAAU,CACd,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAAE,EACpB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,EAAE,MAAM,EACvB,gBAAgB,EAAE,MAAM,EACxB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IAqEhB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,MAAM,CACV,aAAa,EAAE,MAAM,EACrB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,YAAY,CAAC;IAsDxB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IAEG,KAAK,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,GAAE,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB5E;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IAEG,kBAAkB,CACtB,aAAa,EAAE,MAAM,EACrB,eAAe,EAAE,MAAM,EAAE,EACzB,SAAS,GAAE,SAAc,GACxB,OAAO,CAAC,IAAI,CAAC;IA+BhB;;;;;;;;;;;;;;;;;;;OAmBG;IACG,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxD;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB5D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB3D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkB7D;;;;;;;;;;;;;;;;;;;OAmBG;IACG,yBAAyB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBvE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,0BAA0B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBxE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,wBAAwB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBtE;;;;;;;;;;;;;;;;;;;OAmBG;IACG,iBAAiB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAiBhE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2GG;WACiB,UAAU,CAC5B,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,UAAU,EAAE,CAAC;IA2DxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmEG;WACiB,SAAS,CAC3B,OAAO,EAAE,OAAO,EAChB,aAAa,EAAE,MAAM,GACpB,OAAO,CAAC,UAAU,CAAC;IAoBtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAyEG;WAEiB,eAAe,CACjC,OAAO,EAAE,OAAO,EAChB,QAAQ,CAAC,EAAE,YAAY,EAAE,EACzB,IAAI,CAAC,EAAE,IAAI,EACX,EAAE,CAAC,EAAE,IAAI,EACT,QAAQ,CAAC,EAAE,MAAM,EACjB,KAAK,CAAC,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,cAAc,GAC9B,OAAO,CAAC,WAAW,EAAE,CAAC;CAuD1B"}

package/dist/escrow.js

@@ -20,6 +20,7 @@ const graphql_request_1 = __importDefault(require("graphql-request"));
 const base_1 = require("./base");
 const constants_1 = require("./constants");
 const decorators_1 = require("./decorators");
+const enums_1 = require("./enums");
 const error_1 = require("./error");
 const graphql_1 = require("./graphql");
 const types_1 = require("./types");
@@ -1215,7 +1216,7 @@ exports.EscrowClient = EscrowClient;
  * import { ChainId, EscrowUtils } from '@human-protocol/sdk';
  *
  * const escrowAddresses = new EscrowUtils.getEscrows({
- *   networks: [ChainId.POLYGON_AMOY]
+ *   network: ChainId.POLYGON_AMOY
  * });
  * ```
  */
@@ -1228,7 +1229,7 @@ class EscrowUtils {
      *
      * ```ts
      * interface IEscrowsFilter {
-     *   networks: ChainId[];
+     *   chainId: ChainId;
      *   launcher?: string;
      *   reputationOracle?: string;
      *   recordingOracle?: string;
@@ -1237,6 +1238,9 @@ class EscrowUtils {
      *   status?: EscrowStatus;
      *   from?: Date;
      *   to?: Date;
+     *   first?: number;
+     *   skip?: number;
+     *   orderDirection?: OrderDirection;
      * }
      * ```
      *
@@ -1263,6 +1267,13 @@ class EscrowUtils {
      * ```
      *
      * ```ts
+     * enum OrderDirection {
+     *   ASC = 'asc',
+     *   DESC = 'desc',
+     * }
+     * ```
+     *
+     * ```ts
      * enum EscrowStatus {
      *   Launched,
      *   Pending,
@@ -1313,15 +1324,12 @@ class EscrowUtils {
      *   status: EscrowStatus.Pending,
      *   from: new Date(2023, 4, 8),
      *   to: new Date(2023, 5, 8),
-     *   networks: [ChainId.POLYGON_AMOY]
+     *   chainId: ChainId.POLYGON_AMOY
      * };
      * const escrowDatas = await EscrowUtils.getEscrows(filters);
      * ```
      */
     static async getEscrows(filter) {
-        if (!filter?.networks?.length) {
-            throw error_1.ErrorUnsupportedChainID;
-        }
         if (filter.launcher && !ethers_1.ethers.isAddress(filter.launcher)) {
             throw error_1.ErrorInvalidAddress;
         }
@@ -1334,34 +1342,33 @@ class EscrowUtils {
         if (filter.exchangeOracle && !ethers_1.ethers.isAddress(filter.exchangeOracle)) {
             throw error_1.ErrorInvalidAddress;
         }
-        try {
-            const escrowAddresses = [];
-            for (const chainId of filter.networks) {
-                const networkData = constants_1.NETWORKS[chainId];
-                if (!networkData) {
-                    throw error_1.ErrorUnsupportedChainID;
-                }
-                const { escrows } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_ESCROWS_QUERY)(filter), {
-                    ...filter,
-                    launcher: filter.launcher?.toLowerCase(),
-                    reputationOracle: filter.reputationOracle?.toLowerCase(),
-                    recordingOracle: filter.recordingOracle?.toLowerCase(),
-                    exchangeOracle: filter.exchangeOracle?.toLowerCase(),
-                    status: filter.status !== undefined
-                        ? Object.entries(types_1.EscrowStatus).find(([, value]) => value === filter.status)?.[0]
-                        : undefined,
-                    from: filter.from ? +filter.from.getTime() / 1000 : undefined,
-                    to: filter.to ? +filter.to.getTime() / 1000 : undefined,
-                });
-                escrows.map((escrow) => (escrow.chainId = networkData.chainId));
-                escrowAddresses.push(...escrows);
-            }
-            escrowAddresses.sort((a, b) => Number(b.createdAt) - Number(a.createdAt));
-            return escrowAddresses;
+        const first = filter.first !== undefined ? Math.min(filter.first, 1000) : 10;
+        const skip = filter.skip || 0;
+        const orderDirection = filter.orderDirection || enums_1.OrderDirection.DESC;
+        const networkData = constants_1.NETWORKS[filter.chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
         }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
+        const { escrows } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_ESCROWS_QUERY)(filter), {
+            ...filter,
+            launcher: filter.launcher?.toLowerCase(),
+            reputationOracle: filter.reputationOracle?.toLowerCase(),
+            recordingOracle: filter.recordingOracle?.toLowerCase(),
+            exchangeOracle: filter.exchangeOracle?.toLowerCase(),
+            status: filter.status !== undefined
+                ? Object.entries(types_1.EscrowStatus).find(([, value]) => value === filter.status)?.[0]
+                : undefined,
+            from: filter.from ? +filter.from.getTime() / 1000 : undefined,
+            to: filter.to ? +filter.to.getTime() / 1000 : undefined,
+            orderDirection: orderDirection,
+            first: first,
+            skip: skip,
+        });
+        escrows.map((escrow) => (escrow.chainId = networkData.chainId));
+        if (!escrows) {
+            return [];
         }
+        return escrows;
     }
     /**
      * This function returns the escrow data for a given address.
@@ -1439,13 +1446,122 @@ class EscrowUtils {
         if (escrowAddress && !ethers_1.ethers.isAddress(escrowAddress)) {
             throw error_1.ErrorInvalidAddress;
         }
-        try {
-            const { escrow } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_ESCROW_BY_ADDRESS_QUERY)(), { escrowAddress: escrowAddress.toLowerCase() });
-            return escrow || null;
+        const { escrow } = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_ESCROW_BY_ADDRESS_QUERY)(), { escrowAddress: escrowAddress.toLowerCase() });
+        return escrow || null;
+    }
+    /**
+     * This function returns the status events for a given set of networks within an optional date range.
+     *
+     * > This uses Subgraph
+     *
+     * **Input parameters**
+     *
+     * ```ts
+     * enum ChainId {
+     *   ALL = -1,
+     *   MAINNET = 1,
+     *   RINKEBY = 4,
+     *   GOERLI = 5,
+     *   SEPOLIA = 11155111,
+     *   BSC_MAINNET = 56,
+     *   BSC_TESTNET = 97,
+     *   POLYGON = 137,
+     *   POLYGON_MUMBAI = 80001,
+     *   POLYGON_AMOY = 80002,
+     *   MOONBEAM = 1284,
+     *   MOONBASE_ALPHA = 1287,
+     *   AVALANCHE = 43114,
+     *   AVALANCHE_TESTNET = 43113,
+     *   CELO = 42220,
+     *   CELO_ALFAJORES = 44787,
+     *   LOCALHOST = 1338,
+     *   XLAYER_TESTNET = 195,
+     *   XLAYER = 196,
+     * }
+     * ```
+     *
+     * ```ts
+     * enum OrderDirection {
+     *   ASC = 'asc',
+     *   DESC = 'desc',
+     * }
+     * ```
+     *
+     * ```ts
+     * type Status = {
+     *   escrowAddress: string;
+     *   timestamp: string;
+     *   status: string;
+     * };
+     * ```
+     *
+     * @param {ChainId} chainId - List of network IDs to query for status events.
+     * @param {EscrowStatus[]} [statuses] - Optional array of statuses to query for. If not provided, queries for all statuses.
+     * @param {Date} [from] - Optional start date to filter events.
+     * @param {Date} [to] - Optional end date to filter events.
+     * @param {string} [launcher] - Optional launcher address to filter events. Must be a valid Ethereum address.
+     * @param {number} [first] - Optional number of transactions per page. Default is 10.
+     * @param {number} [skip] - Optional number of transactions to skip. Default is 0.
+     * @param {OrderDirection} [orderDirection] - Optional order of the results. Default is DESC.
+     * @returns {Promise<StatusEvent[]>} - Array of status events with their corresponding statuses.
+     *
+     * **Code example**
+     *
+     * ```ts
+     * import { ChainId, EscrowUtils, EscrowStatus } from '@human-protocol/sdk';
+     *
+     * (async () => {
+     *   const fromDate = new Date('2023-01-01');
+     *   const toDate = new Date('2023-12-31');
+     *   const statusEvents = await EscrowUtils.getStatusEvents(
+     *     [ChainId.POLYGON, ChainId.MAINNET],
+     *     [EscrowStatus.Pending, EscrowStatus.Complete],
+     *     fromDate,
+     *     toDate
+     *   );
+     *   console.log(statusEvents);
+     * })();
+     * ```
+     */
+    static async getStatusEvents(chainId, statuses, from, to, launcher, first, skip, orderDirection) {
+        if (launcher && !ethers_1.ethers.isAddress(launcher)) {
+            throw error_1.ErrorInvalidAddress;
         }
-        catch (e) {
-            return (0, utils_1.throwError)(e);
+        first = first !== undefined ? Math.min(first, 1000) : 10;
+        skip = skip || 0;
+        orderDirection = orderDirection || enums_1.OrderDirection.DESC;
+        // If statuses are not provided, use all statuses except Launched
+        const effectiveStatuses = statuses ?? [
+            types_1.EscrowStatus.Launched,
+            types_1.EscrowStatus.Pending,
+            types_1.EscrowStatus.Partial,
+            types_1.EscrowStatus.Paid,
+            types_1.EscrowStatus.Complete,
+            types_1.EscrowStatus.Cancelled,
+        ];
+        const networkData = constants_1.NETWORKS[chainId];
+        if (!networkData) {
+            throw error_1.ErrorUnsupportedChainID;
         }
+        const statusNames = effectiveStatuses.map((status) => types_1.EscrowStatus[status]);
+        const data = await (0, graphql_request_1.default)((0, utils_1.getSubgraphUrl)(networkData), (0, graphql_1.GET_STATUS_UPDATES_QUERY)(from, to, launcher), {
+            status: statusNames,
+            from: from ? Math.floor(from.getTime() / 1000) : undefined,
+            to: to ? Math.floor(to.getTime() / 1000) : undefined,
+            launcher: launcher || undefined,
+            orderDirection: orderDirection,
+            first: first,
+            skip: skip,
+        });
+        if (!data || !data['escrowStatusEvents']) {
+            return [];
+        }
+        const statusEvents = data['escrowStatusEvents'];
+        const eventsWithChainId = statusEvents.map((event) => ({
+            ...event,
+            chainId,
+        }));
+        return eventsWithChainId;
     }
 }
 exports.EscrowUtils = EscrowUtils;

package/dist/graphql/queries/escrow.d.ts

@@ -1,4 +1,5 @@
 import { IEscrowsFilter } from '../../interfaces';
 export declare const GET_ESCROW_BY_ADDRESS_QUERY: () => import("graphql").DocumentNode;
 export declare const GET_ESCROWS_QUERY: (filter: IEscrowsFilter) => import("graphql").DocumentNode;
+export declare const GET_STATUS_UPDATES_QUERY: (from?: Date, to?: Date, launcher?: string) => import("graphql").DocumentNode;
 //# sourceMappingURL=escrow.d.ts.map

package/dist/graphql/queries/escrow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/escrow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AA6BlD,eAAO,MAAM,2BAA2B,sCAOvC,CAAC;AAEF,eAAO,MAAM,iBAAiB,WAAY,cAAc,mCA4CvD,CAAC"}
+{"version":3,"file":"escrow.d.ts","sourceRoot":"","sources":["../../../src/graphql/queries/escrow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AA6BlD,eAAO,MAAM,2BAA2B,sCAOvC,CAAC;AAEF,eAAO,MAAM,iBAAiB,WAAY,cAAc,mCAmDvD,CAAC;AAEF,eAAO,MAAM,wBAAwB,UAC5B,IAAI,OACN,IAAI,aACE,MAAM,mCAiClB,CAAC"}