@prosopo/procaptcha 0.1.0 → 0.1.3

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/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;
-

package/src/modules/ProsopoCaptchaClient.ts

@@ -1,131 +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 { ICaptchaContextReducer, CaptchaEventCallbacks, TExtensionAccount, ICaptchaStatusReducer, IExtensionInterface } from "../types/client";
-import { ProsopoRandomProviderResponse } from "../types/api";
-
-import { ProsopoContract } from "../api/ProsopoContract";
-import { getProsopoContract } from "./contract";
-import { getExtension } from "./extension";
-import { ProviderApi } from "../api/ProviderApi";
-import { ProsopoCaptchaApi } from "./ProsopoCaptchaApi";
-// import { Extension } from "../api";
-
-
-export class ProsopoCaptchaClient {
-
-    public manager: ICaptchaContextReducer;
-    public status: ICaptchaStatusReducer;
-    public callbacks: CaptchaEventCallbacks | undefined;
-    public providerApi: ProviderApi;
-
-    private static extension: IExtensionInterface;
-    private static contract: ProsopoContract | undefined;
-    private static provider: ProsopoRandomProviderResponse | undefined;
-    private static captchaApi: ProsopoCaptchaApi | undefined;
-
-    constructor(manager: ICaptchaContextReducer, status: ICaptchaStatusReducer, callbacks?: CaptchaEventCallbacks) {
-        this.manager = manager;
-        this.status = status;
-        this.callbacks = callbacks;
-        this.providerApi = new ProviderApi(manager.state.config);
-    }
-
-    public getExtension() {
-        return ProsopoCaptchaClient.extension;
-    }
-
-    public setExtension(extension: IExtensionInterface) {
-        return ProsopoCaptchaClient.extension = extension;
-    }
-
-    public getContract() {
-        return ProsopoCaptchaClient.contract;
-    }
-
-    public getProvider() {
-        return ProsopoCaptchaClient.provider;
-    }
-
-    public getCaptchaApi() {
-        return ProsopoCaptchaClient.captchaApi;
-    }
-
-    public async onLoad() {
-        let contractAddress = ProsopoCaptchaClient.contract?.address;
-    
-        if (!ProsopoCaptchaClient.extension || !contractAddress) {
-            try {
-                [ProsopoCaptchaClient.extension, { contractAddress }] = await Promise.all([getExtension(), this.providerApi.getContractAddress()]);
-            } catch (err) {
-                throw new Error(err);
-            }
-        }
-
-        if (this.callbacks?.onLoad) {
-            this.callbacks.onLoad(ProsopoCaptchaClient.extension, contractAddress);
-        }
-
-        this.manager.update({ contractAddress });
-    }
-
-    public async onAccountChange(account?: TExtensionAccount) {
-        if (!account) {
-            this.onAccountUnset();
-            return;
-        }
-
-        try {
-            ProsopoCaptchaClient.extension.setAccount(account.address);
-        } catch (err) {
-            throw new Error(err);
-        }
-
-        try {
-            ProsopoCaptchaClient.contract = await getProsopoContract(this.manager.state.contractAddress!, this.manager.state.config['dappAccount'], account);
-        } catch (err) {
-            throw new Error(err);
-        }
-
-        try {
-            ProsopoCaptchaClient.provider = await ProsopoCaptchaClient.contract.getRandomProvider(); // TODO how often should provider change?
-        } catch (err) {
-            throw new Error(err);
-        }
-
-        ProsopoCaptchaClient.captchaApi = new ProsopoCaptchaApi(ProsopoCaptchaClient.contract, ProsopoCaptchaClient.provider, this.providerApi);
-
-        if (this.callbacks?.onAccountChange) {
-            this.callbacks.onAccountChange(account);
-        }
-
-        this.manager.update({ account });
-    }
-
-    public onAccountUnset() {
-        ProsopoCaptchaClient.contract = undefined;
-        ProsopoCaptchaClient.provider = undefined;
-        ProsopoCaptchaClient.captchaApi = undefined;
-
-        if (this.callbacks?.onAccountChange) {
-            this.callbacks.onAccountChange(undefined);
-        }
-
-        this.manager.update({ account: undefined });
-    }
-
-}
-
-export default ProsopoCaptchaClient;

package/src/modules/ProsopoCaptchaStateClient.ts

@@ -1,146 +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 { ICaptchaStateReducer, TCaptchaSubmitResult } from "../types/client";
-import { CaptchaSolution, CaptchaSolutionResponse, GetCaptchaResponse } from "../types/api";
-import { TransactionResponse } from "../types/contract";
-
-import { ProsopoCaptchaClient } from "./ProsopoCaptchaClient";
-import { convertCaptchaToCaptchaSolution } from "@prosopo/contract";
-
-
-export class ProsopoCaptchaStateClient {
-
-    public context: ProsopoCaptchaClient;
-    public manager: ICaptchaStateReducer;
-
-    constructor(context: ProsopoCaptchaClient, manager: ICaptchaStateReducer) {
-        this.context = context;
-        this.manager = manager;
-    }
-
-    public async onLoadCaptcha() {
-        let captchaChallenge: GetCaptchaResponse | Error | undefined;
-
-        try {
-            captchaChallenge = await this.context.getCaptchaApi()!.getCaptchaChallenge();
-        } catch (err) {
-            captchaChallenge = err as Error;
-        }
-
-        if (this.context.callbacks?.onLoadCaptcha) {
-            this.context.callbacks.onLoadCaptcha(captchaChallenge);
-        }
-
-        if (captchaChallenge instanceof Error) {
-            captchaChallenge = undefined;
-        }
-
-        this.manager.update({ captchaChallenge, captchaIndex: 0 });
-    }
-
-    public onCancel() {
-        if (this.context.callbacks?.onCancel) {
-            this.context.callbacks.onCancel();
-        }
-        this.dismissCaptcha();
-    }
-
-    public async onSubmit() {
-        const { captchaChallenge, captchaIndex, captchaSolution } = this.manager.state;
-
-        const nextCaptchaIndex = captchaIndex + 1;
-
-        if (nextCaptchaIndex < captchaChallenge!.captchas.length) {
-            captchaSolution[nextCaptchaIndex] = [];
-            this.manager.update({ captchaIndex: nextCaptchaIndex, captchaSolution });
-
-            return;
-        }
-
-        const signer = this.context.getExtension().getExtension().signer;
-
-        const currentCaptcha = captchaChallenge!.captchas[captchaIndex];
-        const { datasetId } = currentCaptcha.captcha; // TODO arbitrary datasetId? Could datasetId be moved up next to requestHash?
-
-        const solutions = this.parseSolution(captchaChallenge!, captchaSolution);
-
-        let submitResult: TCaptchaSubmitResult | Error;
-
-        try {
-            submitResult = await this.context.getCaptchaApi()!.submitCaptchaSolution(signer, captchaChallenge!.requestHash, datasetId!, solutions);
-        } catch (err) {
-            submitResult = err as Error;
-        }
-
-        if (this.context.callbacks?.onSubmit) {
-            this.context.callbacks.onSubmit(submitResult, this.manager.state);
-        }
-
-        this.manager.update({ captchaSolution: [] });
-
-        if (submitResult instanceof Error) {
-            // TODO onFail?
-            return;
-        }
-
-        await this.onSolved(submitResult);
-    }
-
-    // TODO check for solved captchas.
-    public async onSolved(submitResult: TCaptchaSubmitResult) {
-        if (this.context.callbacks?.onSolved) {
-            this.context.callbacks.onSolved(submitResult);
-        }
-        this.dismissCaptcha();
-    }
-
-    public onChange(index: number) {
-        const { captchaIndex, captchaSolution } = this.manager.state;
-
-        let currentSolution: number[] = captchaSolution[captchaIndex] || [];
-        currentSolution = currentSolution.includes(index) ? currentSolution.filter(item => item !== index) : [...currentSolution, index];
-
-        captchaSolution[captchaIndex] = currentSolution;
-
-        if (this.context.callbacks?.onChange) {
-            this.context.callbacks.onChange(captchaSolution, captchaIndex);
-        }
-
-        this.manager.update({ captchaSolution });
-    }
-
-    public dismissCaptcha() {
-        this.manager.update({ captchaChallenge: undefined });
-    }
-
-    // TODO move to ProsopoContract/ProviderApi/Model?
-    public parseSolution(captchaChallenge: GetCaptchaResponse, captchaSolution: number[][]): CaptchaSolution[] {
-        const parsedSolution: CaptchaSolution[] = [];
-
-        for (const [index, challenge] of captchaChallenge!.captchas.entries()) {
-            const solution = captchaSolution[index] || [];
-            challenge.captcha.solution = solution;
-            parsedSolution[index] = convertCaptchaToCaptchaSolution(challenge.captcha);
-        }
-
-        console.log("CAPTCHA SOLUTIONS", parsedSolution);
-
-        return parsedSolution;
-    }
-
-}
-
-export default ProsopoCaptchaStateClient;