@prosopo/cli 0.2.2 → 0.2.4

package/README.md

@@ -0,0 +1,120 @@
+# Prosopo Provider Command Line Interface
+
+The Provier CLI allows you to set up a Provider instance and begin to serve CAPTCHA challenges to the Prosopo Network.
+This will allow you to obtain valuable human-labelled image data. As we are currently in beta testing, the CLI is **only
+useable for development purposes**.
+
+The Provider CLI is intended to be used from within the Prosopo Provider Container Image. It is not intended to be used
+directly from the host machine. A bundled version of the CLI is available in the Provider Container Image.
+
+## Container Image
+
+### Get the Container ID
+
+To execute commands against the running Provider, you must first get the Container ID of the running Provider Container.
+
+    ```bash
+    $ PROVIDER_CONTAINER = docker ps -q -f name=docker-provider
+    ```
+
+### Execute a command inside the provider container
+
+You can then execute the commands as follows:
+
+    ```bash
+    $ docker exec -it $PROVIDER_CONTAINER bash -c "npx provider <command>"
+    ```
+
+### Executing Commands in the Container
+
+### Register your Provider
+
+You must first register your Provider in the network contract in order to be selected as a CAPTCHA Provider.
+
+```bash
+$ npx provider provider_register --url https://YOUR_URL --fee 0 --payee Dapp
+```
+
+### Fund your Provider
+
+It is necessary to fund your Provider with at least the minimum fee amount in order to serve CAPTCHA challenges. The
+funds are used to incentivise good behaviour by Providers.
+
+```bash
+$ npx provider provider_update --value 1000 --address YOUR_ADDRESS
+```
+
+### Set a new Dataset
+
+You must load a dataset in to your database in order to provider CAPTCHA challenges. The dataset contains the CAPTCHA
+challenges that will be served to users. The format for the dataset is
+defined [here](https://github.com/prosopo/captcha/blob/main/packages/types/src/datasets/dataset.ts) and an example
+dataset can be seen [here](https://github.com/prosopo/captcha/blob/main/dev/data/captchas.json).
+
+```bash
+$ npx provider provider_set_data_set --file /path/to/dataset.json
+```
+
+### Start the API
+
+Start the API and a begin to serve CAPTCHA challenges.
+
+```bash
+$ npx provider start
+```
+
+### Deregister your Provider
+
+When you no longer wish to be part of the Prosopo Network, you can stop serving CAPTCHA challenges by deregistering.
+
+```bash
+$ npx provider provider_deregister
+```
+
+### List details of a single Provider
+
+```bash
+$ npx provider provider_details --address PROVIDER_ADDRESS
+```
+
+### Get a list of provider accounts from the contract
+
+```bash
+$ npx provider provider_accounts
+```
+
+### View the Provider Version
+
+```bash
+$ npx provider version
+```
+
+## Full CLI Usage
+
+`--help` output from the CLI.
+
+```bash
+Usage: cli.js [global options] <command> [options]
+
+Commands:
+  cli.js provider_register            Register a Provider
+  cli.js provider_update              Update a Provider
+  cli.js provider_deregister          Deregister a Provider
+  cli.js provider_set_data_set        Add a dataset as a Provider
+  cli.js dapp_register                Register a Dapp
+  cli.js dapp_update                  Register a Dapp
+  cli.js provider_accounts            List all provider accounts
+  cli.js dapp_accounts                List all dapp accounts
+  cli.js provider_details             List details of a single Provider
+  cli.js provider_dataset             Exports a dataset from the provider database
+  cli.js dapp_details                 List details of a single Dapp
+  cli.js calculate_captcha_solutions  Calculate captcha solutions
+  cli.js batch_commit                 Batch commit user solutions to contract
+  cli.js version                      Return the version of the software
+
+Options:
+  --help     Show help                                                 [boolean]
+  --version  Show version number                                       [boolean]
+  --api                                               [boolean] [default: false]
+
+```

package/dist/cjs/commands/dappRegister.cjs

@@ -1,5 +1,5 @@
 "use strict";
-const types = require("@prosopo/types");
+require("../contracts/captcha/dist/index.cjs");
 const common = require("@prosopo/common");
 const env = require("@prosopo/env");
 const provider = require("@prosopo/provider");
@@ -7,6 +7,7 @@ const util = require("@prosopo/util");
 const validators = require("./validators.cjs");
 const contract = require("@prosopo/contract");
 const z = require("zod");
+const captcha = require("../contracts/captcha/dist/types-arguments/captcha.cjs");
 const commandDappRegister = (pair, config, cmdArgs) => {
   const logger = (cmdArgs == null ? void 0 : cmdArgs.logger) || common.getLogger(common.LogLevel.enum.info, "cli.dapp_register");
   return {
@@ -28,7 +29,7 @@ const commandDappRegister = (pair, config, cmdArgs) => {
         const tasks = new provider.Tasks(env$1);
         const dappRegisterArgs = [
           z.z.string().parse(argv.contract),
-          util.get(types.DappPayee, z.z.string().parse(argv.payee)),
+          util.get(captcha.DappPayee, z.z.string().parse(argv.payee)),
           {
             value: 0
           }

package/dist/cjs/commands/dappUpdate.cjs

@@ -1,5 +1,5 @@
 "use strict";
-const types = require("@prosopo/types");
+require("../contracts/captcha/dist/index.cjs");
 const common = require("@prosopo/common");
 const env = require("@prosopo/env");
 const provider = require("@prosopo/provider");
@@ -7,6 +7,7 @@ const util = require("@prosopo/util");
 const validators = require("./validators.cjs");
 const contract = require("@prosopo/contract");
 const z = require("zod");
+const captcha = require("../contracts/captcha/dist/types-arguments/captcha.cjs");
 const commandDappUpdate = (pair, config, cmdArgs) => {
   const logger = (cmdArgs == null ? void 0 : cmdArgs.logger) || common.getLogger(common.LogLevel.enum.info, "cli.dapp_update");
   return {
@@ -29,7 +30,7 @@ const commandDappUpdate = (pair, config, cmdArgs) => {
         const stakeThreshold = (await tasks.contract.query.getDappStakeThreshold({})).value.unwrap();
         const dappRegisterArgs = [
           z.z.string().parse(argv.contract),
-          util.get(types.DappPayee, z.z.string().parse(argv.payee)),
+          util.get(captcha.DappPayee, z.z.string().parse(argv.payee)),
           z.z.string().parse(argv.owner),
           {
             value: stakeThreshold.toNumber()

package/dist/cjs/commands/providerRegister.cjs

@@ -1,12 +1,13 @@
 "use strict";
 const z = require("zod");
 const common = require("@prosopo/common");
-const types = require("@prosopo/types");
+require("../contracts/captcha/dist/index.cjs");
 const env = require("@prosopo/env");
 const provider = require("@prosopo/provider");
 const util = require("@polkadot/util");
 const validators = require("./validators.cjs");
 const contract = require("@prosopo/contract");
+const captcha = require("../contracts/captcha/dist/types-arguments/captcha.cjs");
 function _interopNamespaceDefault(e) {
   const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
   if (e) {
@@ -27,7 +28,7 @@ const z__namespace = /* @__PURE__ */ _interopNamespaceDefault(z);
 const providerRegisterArgsParser = z__namespace.object({
   url: z__namespace.string(),
   fee: z__namespace.number(),
-  payee: z__namespace.nativeEnum(types.Payee)
+  payee: z__namespace.nativeEnum(captcha.Payee)
 });
 const commandProviderRegister = (pair, config, cmdArgs) => {
   const logger = (cmdArgs == null ? void 0 : cmdArgs.logger) || common.getLogger(common.LogLevel.enum.info, "cli.provider_register");

package/dist/cjs/commands/providerUpdate.cjs

@@ -1,11 +1,12 @@
 "use strict";
 const common = require("@prosopo/common");
-const types = require("@prosopo/types");
+require("../contracts/captcha/dist/index.cjs");
 const env = require("@prosopo/env");
 const provider = require("@prosopo/provider");
 const validators = require("./validators.cjs");
 const contract = require("@prosopo/contract");
 const z = require("zod");
+const captcha = require("../contracts/captcha/dist/types-arguments/captcha.cjs");
 const commandProviderUpdate = (pair, config, cmdArgs) => {
   const logger = (cmdArgs == null ? void 0 : cmdArgs.logger) || common.getLogger(common.LogLevel.enum.info, "cli.provider_update");
   return {
@@ -36,7 +37,7 @@ const commandProviderUpdate = (pair, config, cmdArgs) => {
         const { url, fee, payee, value, address } = z.z.object({
           url: z.z.string().optional(),
           fee: z.z.number().optional(),
-          payee: z.z.nativeEnum(types.Payee).optional(),
+          payee: z.z.nativeEnum(captcha.Payee).optional(),
           value: z.z.number().optional(),
           address: z.z.string()
         }).parse(argv);

package/dist/cjs/contracts/captcha/dist/build-extrinsic/captcha.cjs

@@ -0,0 +1,339 @@
+"use strict";
+const typechainTypes = require("@727-ventures/typechain-types");
+class Methods {
+  constructor(nativeContract, apiPromise) {
+    this.__nativeContract = nativeContract;
+    this.__apiPromise = apiPromise;
+  }
+  /**
+   * getGitCommitId
+   *
+   */
+  getGitCommitId(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getGitCommitId", [], __options);
+  }
+  /**
+   * getAdmin
+   *
+   */
+  getAdmin(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getAdmin", [], __options);
+  }
+  /**
+   * getPayees
+   *
+   */
+  getPayees(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getPayees", [], __options);
+  }
+  /**
+   * getDappPayees
+   *
+   */
+  getDappPayees(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getDappPayees", [], __options);
+  }
+  /**
+   * getStatuses
+   *
+   */
+  getStatuses(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getStatuses", [], __options);
+  }
+  /**
+   * getProviderStakeThreshold
+   *
+   */
+  getProviderStakeThreshold(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getProviderStakeThreshold", [], __options);
+  }
+  /**
+   * getDappStakeThreshold
+   *
+   */
+  getDappStakeThreshold(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getDappStakeThreshold", [], __options);
+  }
+  /**
+   * getMaxProviderFee
+   *
+   */
+  getMaxProviderFee(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getMaxProviderFee", [], __options);
+  }
+  /**
+   * getMinNumActiveProviders
+   *
+   */
+  getMinNumActiveProviders(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getMinNumActiveProviders", [], __options);
+  }
+  /**
+   * getBlockTime
+   *
+   */
+  getBlockTime(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getBlockTime", [], __options);
+  }
+  /**
+   * getMaxUserHistoryAgeSeconds
+   *
+   */
+  getMaxUserHistoryAgeSeconds(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getMaxUserHistoryAgeSeconds", [], __options);
+  }
+  /**
+   * getMaxUserHistoryLen
+   *
+   */
+  getMaxUserHistoryLen(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getMaxUserHistoryLen", [], __options);
+  }
+  /**
+   * getMaxUserHistoryAgeBlocks
+   *
+   */
+  getMaxUserHistoryAgeBlocks(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getMaxUserHistoryAgeBlocks", [], __options);
+  }
+  /**
+   * providerRegister
+   *
+   * @param { Array<(number | string | BN)> } url,
+   * @param { (number | string | BN) } fee,
+   * @param { ArgumentTypes.Payee } payee,
+   */
+  providerRegister(url, fee, payee, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerRegister", [url, fee, payee], __options);
+  }
+  /**
+   * providerUpdate
+   *
+   * @param { Array<(number | string | BN)> } url,
+   * @param { (number | string | BN) } fee,
+   * @param { ArgumentTypes.Payee } payee,
+   */
+  providerUpdate(url, fee, payee, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerUpdate", [url, fee, payee], __options);
+  }
+  /**
+   * providerDeactivate
+   *
+   */
+  providerDeactivate(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerDeactivate", [], __options);
+  }
+  /**
+   * providerDeregister
+   *
+   */
+  providerDeregister(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerDeregister", [], __options);
+  }
+  /**
+   * getProvider
+   *
+   * @param { ArgumentTypes.AccountId } account,
+   */
+  getProvider(account, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getProvider", [account], __options);
+  }
+  /**
+   * providerFund
+   *
+   */
+  providerFund(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerFund", [], __options);
+  }
+  /**
+   * providerSetDataset
+   *
+   * @param { ArgumentTypes.Hash } datasetId,
+   * @param { ArgumentTypes.Hash } datasetIdContent,
+   */
+  providerSetDataset(datasetId, datasetIdContent, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerSetDataset", [datasetId, datasetIdContent], __options);
+  }
+  /**
+   * getDapp
+   *
+   * @param { ArgumentTypes.AccountId } contract,
+   */
+  getDapp(contract, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getDapp", [contract], __options);
+  }
+  /**
+   * dappRegister
+   *
+   * @param { ArgumentTypes.AccountId } contract,
+   * @param { ArgumentTypes.DappPayee } payee,
+   */
+  dappRegister(contract, payee, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappRegister", [contract, payee], __options);
+  }
+  /**
+   * dappUpdate
+   *
+   * @param { ArgumentTypes.AccountId } contract,
+   * @param { ArgumentTypes.DappPayee } payee,
+   * @param { ArgumentTypes.AccountId } owner,
+   */
+  dappUpdate(contract, payee, owner, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappUpdate", [contract, payee, owner], __options);
+  }
+  /**
+   * dappFund
+   *
+   * @param { ArgumentTypes.AccountId } contract,
+   */
+  dappFund(contract, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappFund", [contract], __options);
+  }
+  /**
+   * dappDeregister
+   *
+   * @param { ArgumentTypes.AccountId } contract,
+   */
+  dappDeregister(contract, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappDeregister", [contract], __options);
+  }
+  /**
+   * dappDeactivate
+   *
+   * @param { ArgumentTypes.AccountId } contract,
+   */
+  dappDeactivate(contract, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappDeactivate", [contract], __options);
+  }
+  /**
+   * getUserHistorySummary
+   *
+   * @param { ArgumentTypes.AccountId } userAccount,
+   */
+  getUserHistorySummary(userAccount, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getUserHistorySummary", [userAccount], __options);
+  }
+  /**
+   * providerCommit
+   *
+   * @param { ArgumentTypes.Commit } commit,
+   */
+  providerCommit(commit, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerCommit", [commit], __options);
+  }
+  /**
+   * providerCommitMany
+   *
+   * @param { Array<ArgumentTypes.Commit> } commits,
+   */
+  providerCommitMany(commits, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "providerCommitMany", [commits], __options);
+  }
+  /**
+   * dappOperatorIsHumanUser
+   *
+   * @param { ArgumentTypes.AccountId } userAccount,
+   * @param { (number | string | BN) } threshold,
+   */
+  dappOperatorIsHumanUser(userAccount, threshold, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappOperatorIsHumanUser", [userAccount, threshold], __options);
+  }
+  /**
+   * dappOperatorLastCorrectCaptcha
+   *
+   * @param { ArgumentTypes.AccountId } userAccount,
+   */
+  dappOperatorLastCorrectCaptcha(userAccount, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "dappOperatorLastCorrectCaptcha", [userAccount], __options);
+  }
+  /**
+   * getCaptchaData
+   *
+   * @param { ArgumentTypes.Hash } datasetId,
+   */
+  getCaptchaData(datasetId, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getCaptchaData", [datasetId], __options);
+  }
+  /**
+   * getUser
+   *
+   * @param { ArgumentTypes.AccountId } userAccount,
+   */
+  getUser(userAccount, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getUser", [userAccount], __options);
+  }
+  /**
+   * getCommit
+   *
+   * @param { ArgumentTypes.Hash } commitId,
+   */
+  getCommit(commitId, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getCommit", [commitId], __options);
+  }
+  /**
+   * listProvidersByAccounts
+   *
+   * @param { Array<ArgumentTypes.AccountId> } providerAccounts,
+   */
+  listProvidersByAccounts(providerAccounts, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "listProvidersByAccounts", [providerAccounts], __options);
+  }
+  /**
+   * listProvidersByStatus
+   *
+   * @param { Array<ArgumentTypes.GovernanceStatus> } statuses,
+   */
+  listProvidersByStatus(statuses, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "listProvidersByStatus", [statuses], __options);
+  }
+  /**
+   * getRandomActiveProvider
+   *
+   * @param { ArgumentTypes.AccountId } userAccount,
+   * @param { ArgumentTypes.AccountId } dappContract,
+   */
+  getRandomActiveProvider(userAccount, dappContract, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getRandomActiveProvider", [userAccount, dappContract], __options);
+  }
+  /**
+   * getAllProviderAccounts
+   *
+   */
+  getAllProviderAccounts(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getAllProviderAccounts", [], __options);
+  }
+  /**
+   * getRandomNumber
+   *
+   * @param { (string | number | BN) } len,
+   * @param { ArgumentTypes.AccountId } userAccount,
+   * @param { ArgumentTypes.AccountId } dappContract,
+   */
+  getRandomNumber(len, userAccount, dappContract, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "getRandomNumber", [len, userAccount, dappContract], __options);
+  }
+  /**
+   * terminate
+   *
+   */
+  terminate(__options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "terminate", [], __options);
+  }
+  /**
+   * withdraw
+   *
+   * @param { (string | number | BN) } amount,
+   */
+  withdraw(amount, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "withdraw", [amount], __options);
+  }
+  /**
+   * setCodeHash
+   *
+   * @param { Array<(number | string | BN)> } codeHash,
+   */
+  setCodeHash(codeHash, __options) {
+    return typechainTypes.buildSubmittableExtrinsic(this.__apiPromise, this.__nativeContract, "setCodeHash", [codeHash], __options);
+  }
+}
+module.exports = Methods;