@human-protocol/sdk 1.1.2 → 1.1.3

package/src/utils.ts

@@ -1,165 +1,102 @@
-import { BigNumber, ethers } from 'ethers';
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import axios from 'axios';
+import { ethers } from 'ethers';
 
 import {
-  Escrow,
-  Escrow__factory,
-  EscrowFactory,
-  EscrowFactory__factory,
-  HMToken,
-  HMToken__factory,
-  Staking,
-  Staking__factory,
-  RewardPool,
-  RewardPool__factory,
-} from '@human-protocol/core/typechain-types';
+  ContractExecutionError,
+  ErrorNoURLprovided,
+  EthereumError,
+  InvalidArgumentError,
+  NonceExpired,
+  NumericFault,
+  OutOfGasError,
+  ReplacementUnderpriced,
+  TransactionReplaced,
+  UnpredictableGasLimit,
+} from './error';
 
 /**
- * **Get HMToken contract instance at given address**
+ * **Get specific error text.*
  *
- * @param {string} hmTokenAddr HMToken contract address
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<HMToken>} Attached contract instance
+ * @param {any} error - An error message.
+ * @returns
  */
-export const getHmToken = async (
-  hmTokenAddr: string,
-  signer?: ethers.Signer
-): Promise<HMToken> => {
-  const factory = new HMToken__factory(signer);
-
-  const contract = await factory.attach(hmTokenAddr);
-
-  return contract;
+export const getRevertReason = (error: any): string => {
+  const prefix = "reverted with reason string '";
+  const suffix = "'";
+  const message = error.data.substring(
+    error.data.indexOf(prefix) + prefix.length
+  );
+  return message.substring(0, message.indexOf(suffix));
 };
 
 /**
- * **Deploy EscrowFactory contract**
+ * **Handle and throw the error.*
  *
- * @param {string} stakingAddr Staking address
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<EscrowFactory>} Deployed contract instance
+ * @param {any} e
+ * @returns
  */
-export const deployEscrowFactory = async (
-  stakingAddr: string,
-  signer?: ethers.Signer
-): Promise<EscrowFactory> => {
-  const factory = new EscrowFactory__factory(signer);
-
-  const contract = await factory.deploy();
-  await contract.initialize(stakingAddr);
-
-  return contract;
+export const throwError = (e: any) => {
+  if (e.code === ethers.utils.Logger.errors.INVALID_ARGUMENT) {
+    throw new InvalidArgumentError(e.message);
+  } else if (e.code === 'OUT_OF_GAS') {
+    throw new OutOfGasError(e.message);
+  } else if (e.code === ethers.utils.Logger.errors.CALL_EXCEPTION) {
+    const reason = getRevertReason(e.data);
+    throw new ContractExecutionError(reason);
+  } else if (e.code === ethers.utils.Logger.errors.UNPREDICTABLE_GAS_LIMIT) {
+    throw new UnpredictableGasLimit(e.message);
+  } else if (e.code === ethers.utils.Logger.errors.TRANSACTION_REPLACED) {
+    throw new TransactionReplaced(e.message);
+  } else if (e.code === ethers.utils.Logger.errors.REPLACEMENT_UNDERPRICED) {
+    throw new ReplacementUnderpriced(e.message);
+  } else if (e.code === ethers.utils.Logger.errors.NUMERIC_FAULT) {
+    throw new NumericFault(e.message);
+  } else if (e.code === ethers.utils.Logger.errors.NONCE_EXPIRED) {
+    throw new NonceExpired(e.message);
+  } else {
+    throw new EthereumError(e.message);
+  }
 };
 
 /**
- * **Get EscrowFactory contract instance at given address**
+ * **URL validation.*
  *
- * @param {string} factoryAddr EscrowFactory contract address
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<EscrowFactory>} Attached contract instance
+ * @param {string} url
+ * @returns
  */
-export const getEscrowFactory = async (
-  factoryAddr: string,
-  signer?: ethers.Signer
-): Promise<EscrowFactory> => {
-  const factory = new EscrowFactory__factory(signer);
-
-  const contract = await factory.attach(factoryAddr);
-
-  return contract;
+export const isValidUrl = (url: string) => {
+  try {
+    new URL(url);
+    return true;
+  } catch (err) {
+    return false;
+  }
 };
 
 /**
- * **Get Escrow contract instance at given address**
- *
- * @param {string} escrowAddr Escrow contract address
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<Escrow>} Attached contract instance
- */
-export const getEscrow = async (
-  escrowAddr: string,
-  signer?: ethers.Signer
-): Promise<Escrow> => {
-  const factory = new Escrow__factory(signer);
-
-  const contract = await factory.attach(escrowAddr);
-
-  return contract;
-};
-
-/**
- * **Deploy Staking contract**
- *
- * @param {string} hmTokenAddr HMToken address
- * @param {number} minimumStake Minimum amount to stake
- * @param {number} lockPeriod Lock period after unstake
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<Staking>} Deployed contract instance
- */
-export const deployStaking = async (
-  hmTokenAddr: string,
-  minimumStake: number,
-  lockPeriod: number,
-  signer?: ethers.Signer
-): Promise<Staking> => {
-  const staking = new Staking__factory(signer);
-  const contract = await staking.deploy();
-  await contract.initialize(hmTokenAddr, minimumStake, lockPeriod);
-
-  return contract;
-};
-
-/**
- * **Get Staking contract instance at given address**
- *
- * @param {string} stakingAddr Staking contract address
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<Staking>} Attached contract instance
- */
-export const getStaking = async (
-  stakingAddr: string,
-  signer?: ethers.Signer
-): Promise<Staking> => {
-  const factory = new Staking__factory(signer);
-
-  const contract = await factory.attach(stakingAddr);
-
-  return contract;
-};
-
-/**
- * **Deploy RewardPool contract**
- *
- * @param {string} hmTokenAddr HMToken address
- * @param {string} stakingAddr Staking address
- * @param {number} fee Reward fee of the protocol
- * @param {ethers.Signer | undefined} signer Deployer signer
- * @returns {Promise<Staking>} Deployed contract instance
- */
-export const deployRewardPool = async (
-  hmTokenAddr: string,
-  stakingAddr: string,
-  fee: number,
-  signer?: ethers.Signer
-): Promise<RewardPool> => {
-  const rewardPool = new RewardPool__factory(signer);
-  const contract = await rewardPool.deploy();
-  await contract.initialize(hmTokenAddr, stakingAddr, fee);
-
-  return contract;
-};
-
-/**
- * **Get specific amount representation in given decimals**
- *
- * Apply given decimals to the specified amount.
+ * **Fetching data with queries.*
  *
- * @param {string | number} amount - Amount to convert
- * @param {number} decimals - Decimal to convert
- * @returns {BigNumber} Converted amount
+ * @param {string} url
+ * @param {string} query
+ * @param {any} variables
+ * @param {any} headers
+ * @returns
  */
-export const toFullDigit = (
-  amount: number | string,
-  decimals = 18
-): BigNumber => {
-  return BigNumber.from(amount).mul(BigNumber.from(10).pow(decimals));
+export const gqlFetch = (
+  url: string,
+  query: string,
+  variables?: any,
+  headers?: any
+) => {
+  if (url && url.length) {
+    return axios.post(url, JSON.stringify({ query, variables }), {
+      headers: {
+        'Content-Type': 'application/json',
+        ...headers,
+      },
+    });
+  } else {
+    return Promise.reject(ErrorNoURLprovided);
+  }
 };

package/example/simple-existing-job.ts

@@ -1,86 +0,0 @@
-/* eslint-disable no-console */
-import { Job } from '../src';
-import {
-  DEFAULT_GAS_PAYER_PRIVKEY,
-  DEFAULT_HMTOKEN_ADDR,
-  REPUTATION_ORACLE_PRIVKEY,
-  WORKER1_ADDR,
-  WORKER2_ADDR,
-} from '../test/utils/constants';
-import { manifest } from '../test/utils/manifest';
-import * as dotenv from 'dotenv';
-
-dotenv.config();
-
-const main = async () => {
-  // Create job object
-  const newJob = new Job({
-    gasPayer: DEFAULT_GAS_PAYER_PRIVKEY,
-    reputationOracle: REPUTATION_ORACLE_PRIVKEY,
-    manifest: manifest,
-    hmTokenAddr: DEFAULT_HMTOKEN_ADDR,
-    logLevel: 'debug',
-  });
-
-  // Initialize new job object
-  await newJob.initialize();
-
-  // Launch the job
-  await newJob.launch();
-
-  // Access the existing job
-  const job = new Job({
-    gasPayer: DEFAULT_GAS_PAYER_PRIVKEY,
-    reputationOracle: REPUTATION_ORACLE_PRIVKEY,
-    manifest: manifest,
-    hmTokenAddr: DEFAULT_HMTOKEN_ADDR,
-    factoryAddr: newJob.contractData?.factoryAddr,
-    escrowAddr: newJob.contractData?.escrowAddr,
-    storageAccessKeyId: process.env.AWS_ACCESS_KEY_ID,
-    storageSecretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-    storageEndpoint: process.env.AWS_ENDPOINT,
-    storageBucket: process.env.AWS_BUCKET,
-    storagePublicBucket: process.env.AWS_PUBLIC_BUCKET,
-    logLevel: 'debug',
-  });
-
-  // Initialize the job object
-  await job.initialize();
-
-  // Setup the job
-  await job.setup();
-
-  console.log(
-    `Status: ${await job.status()}, Balance: ${(
-      await job.balance()
-    )?.toString()}`
-  );
-
-  // Bulk payout workers
-  await job.bulkPayout(
-    [
-      {
-        address: WORKER1_ADDR,
-        amount: 70,
-      },
-      {
-        address: WORKER2_ADDR,
-        amount: 30,
-      },
-    ],
-    {
-      result: 'result',
-    }
-  );
-
-  // Complete the job
-  await job.complete();
-
-  console.log(
-    `Status: ${await job.status()}, Balance: ${(
-      await job.balance()
-    )?.toString()}`
-  );
-};
-
-main();

package/example/simple-new-job-public.ts

@@ -1,74 +0,0 @@
-/* eslint-disable no-console */
-import { Job } from '../src';
-import {
-  DEFAULT_GAS_PAYER_PRIVKEY,
-  DEFAULT_HMTOKEN_ADDR,
-  REPUTATION_ORACLE_PRIVKEY,
-  WORKER1_ADDR,
-  WORKER2_ADDR,
-} from '../test/utils/constants';
-import { manifest } from '../test/utils/manifest';
-import * as dotenv from 'dotenv';
-
-dotenv.config();
-
-const main = async () => {
-  // Create job object
-  const job = new Job({
-    gasPayer: DEFAULT_GAS_PAYER_PRIVKEY,
-    reputationOracle: REPUTATION_ORACLE_PRIVKEY,
-    manifest: manifest,
-    hmTokenAddr: DEFAULT_HMTOKEN_ADDR,
-    storageAccessKeyId: process.env.AWS_ACCESS_KEY_ID,
-    storageSecretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-    storageEndpoint: process.env.AWS_ENDPOINT,
-    storageBucket: process.env.AWS_BUCKET,
-    storagePublicBucket: process.env.AWS_PUBLIC_BUCKET,
-    logLevel: 'debug',
-  });
-
-  // Initialize new job
-  await job.initialize();
-
-  // Launch the job
-  await job.launch();
-
-  // Setup the job
-  await job.setup();
-
-  console.log(
-    `Status: ${await job.status()}, Balance: ${(
-      await job.balance()
-    )?.toString()}`
-  );
-
-  // Bulk payout workers
-  await job.bulkPayout(
-    [
-      {
-        address: WORKER1_ADDR,
-        amount: 70,
-      },
-      {
-        address: WORKER2_ADDR,
-        amount: 30,
-      },
-    ],
-    {
-      result: 'result',
-    },
-    false,
-    true
-  );
-
-  // Complete the job
-  await job.complete();
-
-  console.log(
-    `Status: ${await job.status()}, Balance: ${(
-      await job.balance()
-    )?.toString()}`
-  );
-};
-
-main();

package/example/simple-new-job.ts

@@ -1,72 +0,0 @@
-/* eslint-disable no-console */
-import { Job } from '../src';
-import {
-  DEFAULT_GAS_PAYER_PRIVKEY,
-  DEFAULT_HMTOKEN_ADDR,
-  REPUTATION_ORACLE_PRIVKEY,
-  WORKER1_ADDR,
-  WORKER2_ADDR,
-} from '../test/utils/constants';
-import { manifest } from '../test/utils/manifest';
-import * as dotenv from 'dotenv';
-
-dotenv.config();
-
-const main = async () => {
-  // Create job object
-  const job = new Job({
-    gasPayer: DEFAULT_GAS_PAYER_PRIVKEY,
-    reputationOracle: REPUTATION_ORACLE_PRIVKEY,
-    manifest: manifest,
-    hmTokenAddr: DEFAULT_HMTOKEN_ADDR,
-    storageAccessKeyId: process.env.AWS_ACCESS_KEY_ID,
-    storageSecretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
-    storageEndpoint: process.env.AWS_ENDPOINT,
-    storageBucket: process.env.AWS_BUCKET,
-    storagePublicBucket: process.env.AWS_PUBLIC_BUCKET,
-    logLevel: 'debug',
-  });
-
-  // Initialize new job
-  await job.initialize();
-
-  // Launch the job
-  await job.launch();
-
-  // Setup the job
-  await job.setup();
-
-  console.log(
-    `Status: ${await job.status()}, Balance: ${(
-      await job.balance()
-    )?.toString()}`
-  );
-
-  // Bulk payout workers
-  await job.bulkPayout(
-    [
-      {
-        address: WORKER1_ADDR,
-        amount: 70,
-      },
-      {
-        address: WORKER2_ADDR,
-        amount: 30,
-      },
-    ],
-    {
-      result: 'result',
-    }
-  );
-
-  // Complete the job
-  await job.complete();
-
-  console.log(
-    `Status: ${await job.status()}, Balance: ${(
-      await job.balance()
-    )?.toString()}`
-  );
-};
-
-main();