@prosopo/procaptcha 0.1.2 → 0.1.3

package/src/api/AsyncFactory.ts

@@ -1,30 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-export abstract class AsyncFactory {
-
-    constructor() {
-        throw new Error("Use `create` factory method");
-    }
-    
-    public static async create(...args: any[]) {
-        return await Object.create(this.prototype).init(...args);
-    }
-
-    public abstract init(...args: any[]): Promise<this>;
-
-}
-
-export default AsyncFactory;

package/src/api/Extension.ts

@@ -1,120 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-import { web3Enable, web3FromSource, web3Accounts } from "@polkadot/extension-dapp";
-import { InjectedAccountWithMeta, InjectedExtension } from "@polkadot/extension-inject/types"
-import { SignerPayloadRaw } from "@polkadot/types/types";
-import storage from "../modules/storage";
-import { IExtensionInterface } from "../types/client";
-import AsyncFactory from "./AsyncFactory";
-
-
-export class Extension extends AsyncFactory implements IExtensionInterface {
-
-    private extension: InjectedExtension;
-    private account: InjectedAccountWithMeta | undefined;
-    private accounts: InjectedAccountWithMeta[];
-    private injectedExtensions: InjectedExtension[];
-
-    public async init() {
-        await this.checkExtension();
-        await this.setAccounts();
-        await this.setExtension();
-        return this;
-    }
-
-    public async checkExtension() {
-        try {
-            this.injectedExtensions = await web3Enable('Prosopo');
-        } catch (err) {
-            throw new Error(err);
-        }
-        if (!this.injectedExtensions.length) {
-            throw new Error("No extension found");
-        }
-    }
-
-    public getExtension() {
-        return this.extension;
-    }
-
-    private async setExtension() {
-        try {
-            // https://polkadot.js.org/docs/extension/cookbook/
-            this.extension = await web3FromSource(this.accounts[0].meta.source);
-        } catch (err) {
-            throw new Error(err);
-        }
-        if (!this.extension) {
-            throw new Error("Extension not found");
-        }
-    }
-
-    public getAccounts() {
-        return this.accounts;
-    }
-
-    private async setAccounts() {
-        try {
-            this.accounts = await web3Accounts();
-        } catch (err) {
-            throw new Error(err);
-        }
-        this.setDefaultAccount();
-    }
-
-    public getAccount() {
-        return this.account;
-    }
-
-    public setAccount(address: string) {
-        if (!this.accounts.length) {
-            throw new Error("No accounts found");
-        }
-        const account = this.accounts.find(acc => acc.address === address);
-        if (!account) {
-            throw new Error("Account not found");
-        }
-        this.account = account;
-        storage.setAccount(account.address);
-    }
-
-    public unsetAccount() {
-        this.account = undefined;
-        storage.setAccount("");
-    }
-
-    public getDefaultAccount() {
-        const defaultAccount = storage.getAccount();
-        return this.accounts.find(acc => acc.address === defaultAccount);
-    }
-
-    public setDefaultAccount() {
-        const defaultAccount = storage.getAccount();
-        if (defaultAccount) {
-            this.setAccount(defaultAccount);
-        }
-    }
-
-    // public async signRaw(raw: SignerPayloadRaw) {
-    //     if (!this.extension.signer) {
-    //         throw new Error("No signer found");
-    //     }
-    //     return this.extension.signer?.signRaw!({ ...raw, address: this.account!.address });
-    // }
-
-}
-
-export default Extension;

package/src/api/HttpClientBase.ts

@@ -1,37 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-import axios, { AxiosInstance, AxiosResponse } from "axios";
-
-export class HttpClientBase {
-
-  protected readonly axios: AxiosInstance;
-
-  constructor(baseURL: string, prefix = "") {
-    baseURL = baseURL + prefix;
-    this.axios = axios.create({ baseURL });
-    this.axios.interceptors.response.use(this.responseHandler, this.errorHandler);
-  }
-
-  protected responseHandler = (response: AxiosResponse) => {
-    console.log("API REQUEST", response.request);
-    return response.data;
-  }
-
-  protected errorHandler = (error: any) => Promise.reject(error.response);
-
-}
-
-export default HttpClientBase;

package/src/api/ProsopoContract.ts

@@ -1,42 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-// import {Hash} from '@polkadot/types/interfaces';
-import ProsopoContractBase from "./ProsopoContractBase";
-import { Signer } from '@polkadot/api/types';
-import { TransactionResponse } from '../types';
-import { ProsopoRandomProviderResponse } from "../types";
-import { CaptchaSolutionCommitment } from "@prosopo/contract";
-
-// TODO: import return types from provider: separate types/common package.
-export class ProsopoContract extends ProsopoContractBase {
-
-    public async getRandomProvider(): Promise<ProsopoRandomProviderResponse> {
-        return await this.query('getRandomActiveProvider', [this.account.address, this.dappAddress]) as ProsopoRandomProviderResponse;
-    }
-
-    public async getCaptchaSolutionCommitment(commitmentId: string) {
-        return await this.query('getCaptchaSolutionCommitment', [commitmentId]) as CaptchaSolutionCommitment;
-    }
-
-    public async dappUserCommit(signer: Signer, captchaDatasetId: string, userMerkleTreeRoot: string, providerAddress: string): Promise<TransactionResponse> {
-        return await this.transaction(signer, 'dappUserCommit', [this.dappAddress, captchaDatasetId, userMerkleTreeRoot, providerAddress]);
-    }
-
-
-
-}
-
-export default ProsopoContract;

package/src/api/ProsopoContractBase.ts

@@ -1,169 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-import { ApiPromise, SubmittableResult } from "@polkadot/api";
-import { Abi, ContractPromise } from "@polkadot/api-contract";
-import { InjectedAccountWithMeta } from "@polkadot/extension-inject/types";
-
-import { abiJson, unwrap, encodeStringArgs, ProsopoContractError } from "@prosopo/contract";
-import { AnyJson } from "@polkadot/types/types/codec";
-import { ProviderInterface } from "@polkadot/rpc-provider/types";
-import { Signer } from "@polkadot/api/types";
-import { TransactionResponse } from '../types';
-import AsyncFactory from "./AsyncFactory";
-
-export class ProsopoContractBase extends AsyncFactory {
-
-  protected api: ApiPromise;
-  protected abi: Abi;
-  protected contract: ContractPromise;
-  protected account: InjectedAccountWithMeta;
-  protected dappAddress: string;
-
-  public address: string;
-
-  /**
-   * @param address
-   * @param dappAddress
-   * @param account
-   * @param providerInterface
-   */
-  public async init(address: string, dappAddress: string, account: InjectedAccountWithMeta, providerInterface: ProviderInterface) {
-    this.api = await ApiPromise.create({ provider: providerInterface });
-    this.abi = new Abi(abiJson, this.api.registry.getChainProperties());
-    this.contract = new ContractPromise(this.api, this.abi, address);
-    this.address = address;
-    this.dappAddress = dappAddress;
-    this.account = account;
-    return this;
-  }
-
-  public getApi(): ApiPromise {
-    return this.api;
-  }
-
-  public getContract(): ContractPromise {
-    return this.contract;
-  }
-
-  public getAccount(): InjectedAccountWithMeta {
-    return this.account;
-  }
-
-  public getDappAddress(): string {
-    return this.dappAddress;
-  }
-
-  public async query<T>(method: string, args: any[]): Promise<T | AnyJson | null> {
-    try {
-      const abiMessage = this.abi.findMessage(method);
-      const response = await this.contract.query[method](
-        this.account.address,
-        {},
-        ...encodeStringArgs(abiMessage, args)
-      );
-      console.log("QUERY RESPONSE", method, args, response);
-      if (response.result.isOk) {
-        if (response.output) {
-          return unwrap(response.output.toHuman());
-        } else {
-          return null;
-        }
-      } else {
-        throw new ProsopoContractError(response.result.asErr);
-      }
-    } catch (e) {
-      console.error("ERROR", e);
-      return null;
-    }
-  }
-
-  // https://polkadot.js.org/docs/api/cookbook/tx/
-  // https://polkadot.js.org/docs/api/start/api.tx.subs/
-  public async transaction(signer: Signer, method: string, args: any[]): Promise<TransactionResponse> {
-
-    // TODO if DEBUG==true || env.development
-    const queryBeforeTx = await this.query(method, args);
-
-    console.log("QUERY BEFORE TX....................", queryBeforeTx);
-
-    const abiMessage = this.abi.findMessage(method);
-
-    const extrinsic = this.contract.tx[method]({}, ...encodeStringArgs(abiMessage, args));
-
-    // this.api.setSigner(signer);
-    // const response = await buildTx(this.api.registry, extrinsic, this.account.address, { signer });
-    // console.log("buildTx RESPONSE", response);
-    // return;
-
-    return new Promise((resolve, reject) => {
-
-      extrinsic.signAndSend(this.account.address, { signer }, (result: SubmittableResult) => {
-
-        const { dispatchError, dispatchInfo, events, internalError, status, txHash, txIndex } = result;
-
-        console.log("TX STATUS", status.type);
-        console.log("IS FINALIZED", status?.isFinalized);
-        console.log("IN BLOCK", status?.isInBlock);
-        console.log("EVENTS", events);
-
-        if (internalError) {
-          console.error("internalError", internalError);
-          reject(internalError);
-
-          return;
-        }
-
-        if (dispatchError) {
-          console.error("dispatchError", dispatchError);
-          reject(dispatchError);
-
-          return;
-        }
-
-        // [Ready, InBlock, Finalized...]
-
-        // Instant seal ON.
-        if (status?.isInBlock) {
-
-          const blockHash = status.asInBlock.toHex();
-
-          resolve({ dispatchError, dispatchInfo, events, internalError, status, txHash, txIndex, blockHash });
-
-        }
-
-        // TODO
-        // Instant seal OFF.
-        // if (status?.isFinalized) {
-
-        //   const blockHash = status.asFinalized.toHex();
-
-        //   resolve({ dispatchError, dispatchInfo, events, internalError, status, txHash, txIndex, blockHash });
-
-        // }
-
-      })
-      .catch((e) => {
-        console.error("signAndSend ERROR", e);
-        reject(e);
-      });
-
-    });
-
-  }
-
-}
-
-export default ProsopoContractBase;

package/src/api/ProviderApi.ts

@@ -1,59 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-import HttpClientBase from "./HttpClientBase";
-import Storage from "../modules/storage";
-import { ProsopoCaptchaConfig, ProsopoRandomProviderResponse, GetCaptchaResponse, CaptchaSolution, CaptchaSolutionResponse } from '../types';
-
-export class ProviderApi extends HttpClientBase {
-
-  protected config: ProsopoCaptchaConfig;
-
-  constructor(config: ProsopoCaptchaConfig) {
-    super(config['providerApi.baseURL'], config['providerApi.prefix']);
-    this.config = config;
-  }
-
-  /**
-   *
-   * @deprecated use ProsopoContract$getRandomProvider instead.
-   */
-  public getRandomProvider() {
-    const userAccount = Storage.getAccount();
-    return this.axios.get(`/random_provider/${userAccount}/${this.config['dappAccount']}`);
-  }
-
-  public getProviders(): Promise<{accounts: string[]}> {
-    return this.axios.get(`/providers`);
-  }
-
-  public getContractAddress(): Promise<{contractAddress: string}> {
-    return this.axios.get(`/contract_address`);
-  }
-
-  public getCaptchaChallenge(randomProvider: ProsopoRandomProviderResponse) : Promise<GetCaptchaResponse> {
-    let { provider, blockNumber } = randomProvider;
-    blockNumber = blockNumber.replace(/,/g, ''); // TODO: middleware schema parser/validator.
-    const userAccount = Storage.getAccount();
-    return this.axios.get(`/provider/captcha/${provider.captchaDatasetId}/${userAccount}/${this.config['dappAccount']}/${blockNumber}`);
-  }
-
-  public submitCaptchaSolution(blockHash: string, captchas: CaptchaSolution[], requestHash: string, txHash: string, userAccount: string) : Promise<CaptchaSolutionResponse> {
-    return this.axios.post(`/provider/solution`, {blockHash, captchas, requestHash, txHash, userAccount, dappAccount: this.config['dappAccount']});
-  }
-
-}
-
-export default ProviderApi;

package/src/api/handlers.ts

@@ -1,29 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-import {AxiosResponse} from "axios";
-
-export class ProsopoApiError extends Error {
-  constructor(error: AxiosResponse, context?: string, ...params: any[]) {
-
-    super(`${error.data.message ? error.data.message : error.statusText}`)
-
-    this.name = context && `${ProsopoApiError.name}@${context}` || ProsopoApiError.name;
-
-    // TODO: if env.debug
-    console.error('\n********************* ERROR *********************\n');
-    console.error(this.cause, this.stack, ...params);
-  }
-}

package/src/api/index.ts

@@ -1,21 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-export * from './AsyncFactory';
-export * from './Extension';
-export * from './HttpClientBase';
-export * from './ProsopoContract';
-export * from './ProsopoContractBase';
-export * from './ProviderApi';

package/src/index.ts

@@ -1,18 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-export * from './api';
-export * from './modules';
-export * from './types';

package/src/modules/ProsopoCaptchaApi.ts

@@ -1,105 +0,0 @@
-// Copyright (C) 2021-2022 Prosopo (UK) Ltd.
-// This file is part of procaptcha <https://github.com/prosopo-io/procaptcha>.
-//
-// procaptcha is free software: you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// procaptcha is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with procaptcha.  If not, see <http://www.gnu.org/licenses/>.
-import { randomAsHex, blake2AsHex } from '@polkadot/util-crypto';
-// import {computeCaptchaSolutionHash} from '@prosopo/provider'; // TODO
-import { CaptchaSolution, CaptchaMerkleTree, CaptchaSolutionCommitment } from '@prosopo/contract';
-import { Signer } from "@polkadot/api/types";
-
-import { ProsopoRandomProviderResponse, GetCaptchaResponse, CaptchaSolutionResponse } from "../types/api";
-import { TransactionResponse } from "../types/contract";
-
-import ProviderApi from "../api/ProviderApi";
-import ProsopoContract from "../api/ProsopoContract";
-import { TCaptchaSubmitResult } from '../types/client';
-import {ProsopoApiError} from "../api/handlers";
-
-
-function hexHash(data: string | Uint8Array): string {
-    return blake2AsHex(data);
-}
-
-function computeCaptchaSolutionHash(captcha: CaptchaSolution) {
-    return hexHash([captcha.captchaId, captcha.solution, captcha.salt].join());
-}
-
-export class ProsopoCaptchaApi {
-
-    protected contract: ProsopoContract;
-    protected provider: ProsopoRandomProviderResponse;
-    protected providerApi: ProviderApi;
-
-    constructor(contract: ProsopoContract, provider: ProsopoRandomProviderResponse, providerApi: ProviderApi) {
-        this.contract = contract;
-        this.provider = provider;
-        this.providerApi = providerApi;
-    }
-
-    public async getCaptchaChallenge(): Promise<GetCaptchaResponse> {
-        let captchaChallenge: GetCaptchaResponse;
-        try {
-            captchaChallenge = await this.providerApi.getCaptchaChallenge(this.provider);
-        } catch (err) {
-            throw new ProsopoApiError(err)
-        }
-        return captchaChallenge;
-    }
-
-    public async submitCaptchaSolution(signer: Signer, requestHash: string, datasetId: string, solutions: CaptchaSolution[]) : Promise<TCaptchaSubmitResult> {
-        const salt = randomAsHex();
-        const tree = new CaptchaMerkleTree();
-        const captchaSolutionsSalted: CaptchaSolution[] = solutions.map(solution => ({...solution, salt: salt}));
-        const captchasHashed = captchaSolutionsSalted.map((captcha) => computeCaptchaSolutionHash(captcha));
-
-        tree.build(captchasHashed);
-        const commitmentId = tree.root!.hash;
-
-        console.log("solveCaptchaChallenge commitmentId", commitmentId);
-        // console.log("solveCaptchaChallenge USER ACCOUNT", this.contract.getAccount().address);
-        // console.log("solveCaptchaChallenge DAPP ACCOUNT", this.contract.getDappAddress());
-        // console.log("solveCaptchaChallenge CONTRACT ADDRESS", this.contract.getContract().address.toString());
-
-        let tx: TransactionResponse;
-
-        try {
-            tx = await this.contract.dappUserCommit(signer, datasetId as string, commitmentId, this.provider.providerId);
-        } catch (err) {
-            throw new ProsopoApiError(err)
-        }
-
-        let result: CaptchaSolutionResponse;
-
-        try {
-            result = await this.providerApi.submitCaptchaSolution(tx.blockHash!, captchaSolutionsSalted, requestHash, tx.txHash.toString(), this.contract.getAccount().address);
-        } catch (err) {
-            throw new ProsopoApiError(err)
-        }
-
-        let commitment: CaptchaSolutionCommitment;
-
-        // TODO concurrency?
-        try {
-            commitment = await this.contract.getCaptchaSolutionCommitment(commitmentId);
-        } catch (err) {
-            throw new ProsopoApiError(err)
-        }
-
-        return [result, tx, commitment];
-    }
-
-}
-
-export default ProsopoCaptchaApi;
-