@human-protocol/sdk 0.0.10

package/README.md

@@ -0,0 +1,9 @@
+# Human Protocol Node.js SDK
+
+Node.js SDK to launch/manage jobs on [Human Protocol](https://www.humanprotocol.org/)
+
+## Installation
+
+This SDK is available on [NPM](https://www.npmjs.com/package/@human-protocol/sdk).
+
+    yarn @human-protocol/sdk

package/example/simple-existing-job.ts

@@ -0,0 +1,86 @@
+/* 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

@@ -0,0 +1,74 @@
+/* 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

@@ -0,0 +1,72 @@
+/* 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();

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@human-protocol/sdk",
+  "description": "Human Protocol SDK",
+  "version": "0.0.10",
+  "files": [
+    "src",
+    "dist",
+    "example",
+    "test"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "clean": "rm -rf ./dist",
+    "build": "npm run clean && tsc",
+    "prepublish": "npm run build",
+    "test": "concurrently -k -s first -g --hide 0 \"yarn workspace @human-protocol/core local\" \"sleep 5 && jest --runInBand\"",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write '**/*.{ts,json}'"
+  },
+  "repository": {
+    "url": "https://github.com/humanprotocol/human-protocol.git",
+    "directory": "packages/sdk/typescript/human-protocol-sdk"
+  },
+  "keywords": [
+    "human-protocol",
+    "sdk",
+    "node",
+    "typescript",
+    "ethereum"
+  ],
+  "license": "MIT",
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "dependencies": {
+    "@human-protocol/core": "^1.0.12",
+    "aws-sdk": "^2.1255.0",
+    "crypto": "^1.0.1",
+    "dotenv": "^16.0.3",
+    "ethers": "^5.7.2",
+    "secp256k1": "^4.0.3",
+    "winston": "^3.8.2"
+  },
+  "peerDependencies": {
+    "@human-protocol/core": "^1.0.12"
+  }
+}

package/src/constants.ts

@@ -0,0 +1,9 @@
+/**
+ * @constant Default bucket name
+ */
+export const DEFAULT_BUCKET = 'escrow-results';
+
+/**
+ * @constant Default public bucket name
+ */
+export const DEFAULT_PUBLIC_BUCKET = 'escrow-public-results';

package/src/error.ts

@@ -0,0 +1,43 @@
+/**
+ * @constant {Error} - The job is not initialized yet.
+ */
+export const ErrorJobNotInitialized = new Error('Job is not initialized');
+
+/**
+ * @constant {Error} - The job is not launched yet.
+ */
+export const ErrorJobNotLaunched = new Error('Job is not launched');
+
+/**
+ * @constant {Error} - The job is already launched.
+ */
+export const ErrorJobAlreadyLaunched = new Error('Job is already launched');
+
+/**
+ * @constant {Error} - The reputation oracle is missing.
+ */
+export const ErrorReputationOracleMissing = new Error(
+  'Reputation oracle is missing'
+);
+
+/**
+ * @constant {Error} - The manifest is missing.
+ */
+export const ErrorManifestMissing = new Error('Manifest is missing');
+
+/**
+ * @constant {Error} - The HMToken is missing.
+ */
+export const ErrorHMTokenMissing = new Error('HMToken is missing');
+
+/**
+ * @constant {Error} - The Storage access data is missing.
+ */
+export const ErrorStorageAccessDataMissing = new Error(
+  'Storage access data is missing'
+);
+
+/**
+ * @constant {Error} - The Staking contract is missing.
+ */
+export const ErrorStakingMissing = new Error('Staking contract is missing');

package/src/index.ts

@@ -0,0 +1,4 @@
+export { Job } from './job';
+
+export * from './constants';
+export * from './types';