@prosopo/types 0.1.18 → 0.1.19

package/dist/provider/api.d.ts

@@ -0,0 +1,114 @@
+import { z } from 'zod';
+export declare enum ApiPaths {
+    GetCaptchaChallenge = "/v1/prosopo/provider/captcha",
+    SubmitCaptchaSolution = "/v1/prosopo/provider/solution",
+    VerifyCaptchaSolution = "/v1/prosopo/provider/verify",
+    GetProviderStatus = "/v1/prosopo/provider/status",
+    GetProviderDetails = "/v1/prosopo/provider/details"
+}
+export declare enum ApiParams {
+    datasetId = "datasetId",
+    user = "user",
+    dapp = "dapp",
+    blockNumber = "blockNumber",
+    signature = "signature",
+    requestHash = "requestHash",
+    captchas = "captchas",
+    commitmentId = "commitmentId",
+    providerUrl = "providerUrl",
+    procaptchaResponse = "procaptcha-response"
+}
+export interface DappUserSolutionResult {
+    [ApiParams.captchas]: CaptchaIdAndProof[];
+    partialFee?: string;
+    solutionApproved: boolean;
+}
+export interface CaptchaIdAndProof {
+    captchaId: string;
+    proof: string[][];
+}
+export declare const CaptchaRequestBody: z.ZodObject<{
+    user: z.ZodString;
+    dapp: z.ZodString;
+    datasetId: z.ZodString;
+    blockNumber: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    datasetId: string;
+    user: string;
+    dapp: string;
+    blockNumber: string;
+}, {
+    datasetId: string;
+    user: string;
+    dapp: string;
+    blockNumber: string;
+}>;
+export type CaptchaRequestBodyType = z.infer<typeof CaptchaRequestBody>;
+export declare const CaptchaSolutionBody: z.ZodObject<{
+    user: z.ZodString;
+    dapp: z.ZodString;
+    captchas: z.ZodArray<z.ZodObject<{
+        captchaId: z.ZodString;
+        captchaContentId: z.ZodString;
+        solution: z.ZodArray<z.ZodString, "many">;
+        salt: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        captchaId: string;
+        captchaContentId: string;
+        salt: string;
+        solution: string[];
+    }, {
+        captchaId: string;
+        captchaContentId: string;
+        salt: string;
+        solution: string[];
+    }>, "many">;
+    requestHash: z.ZodString;
+    signature: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    user: string;
+    dapp: string;
+    signature: string;
+    requestHash: string;
+    captchas: {
+        captchaId: string;
+        captchaContentId: string;
+        salt: string;
+        solution: string[];
+    }[];
+}, {
+    user: string;
+    dapp: string;
+    signature: string;
+    requestHash: string;
+    captchas: {
+        captchaId: string;
+        captchaContentId: string;
+        salt: string;
+        solution: string[];
+    }[];
+}>;
+export type CaptchaSolutionBodyType = z.infer<typeof CaptchaSolutionBody>;
+export declare const VerifySolutionBody: z.ZodObject<{
+    user: z.ZodString;
+    commitmentId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    user: string;
+    commitmentId?: string | undefined;
+}, {
+    user: string;
+    commitmentId?: string | undefined;
+}>;
+export type VerifySolutionBodyType = z.infer<typeof VerifySolutionBody>;
+export interface PendingCaptchaRequest {
+    accountId: string;
+    pending: boolean;
+    salt: string;
+    [ApiParams.requestHash]: string;
+    deadlineTimestamp: number;
+    requestedAtBlock: number;
+}
+export interface ProviderRegistered {
+    status: 'Registered' | 'Unregistered';
+}
+//# sourceMappingURL=api.d.ts.map

package/dist/provider/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/provider/api.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,oBAAY,QAAQ;IAChB,mBAAmB,iCAAiC;IACpD,qBAAqB,kCAAkC;IACvD,qBAAqB,gCAAgC;IACrD,iBAAiB,gCAAgC;IACjD,kBAAkB,iCAAiC;CACtD;AAED,oBAAY,SAAS;IACjB,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,QAAQ,aAAa;IACrB,YAAY,iBAAiB;IAC7B,WAAW,gBAAgB;IAC3B,kBAAkB,wBAAwB;CAC7C;AAED,MAAM,WAAW,sBAAsB;IACnC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,OAAO,CAAA;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,EAAE,EAAE,CAAA;CACpB;AAED,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;EAK7B,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEvE,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAM9B,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAEzE,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEvE,MAAM,WAAW,qBAAqB;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IAC/B,iBAAiB,EAAE,MAAM,CAAA;IACzB,gBAAgB,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,YAAY,GAAG,cAAc,CAAA;CACxC"}

package/dist/provider/api.js

@@ -0,0 +1,54 @@
+// Copyright 2021-2023 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { CaptchaSolutionSchema } from '../datasets/index.js';
+import { z } from 'zod';
+export var ApiPaths;
+(function (ApiPaths) {
+    ApiPaths["GetCaptchaChallenge"] = "/v1/prosopo/provider/captcha";
+    ApiPaths["SubmitCaptchaSolution"] = "/v1/prosopo/provider/solution";
+    ApiPaths["VerifyCaptchaSolution"] = "/v1/prosopo/provider/verify";
+    ApiPaths["GetProviderStatus"] = "/v1/prosopo/provider/status";
+    ApiPaths["GetProviderDetails"] = "/v1/prosopo/provider/details";
+})(ApiPaths || (ApiPaths = {}));
+export var ApiParams;
+(function (ApiParams) {
+    ApiParams["datasetId"] = "datasetId";
+    ApiParams["user"] = "user";
+    ApiParams["dapp"] = "dapp";
+    ApiParams["blockNumber"] = "blockNumber";
+    ApiParams["signature"] = "signature";
+    ApiParams["requestHash"] = "requestHash";
+    ApiParams["captchas"] = "captchas";
+    ApiParams["commitmentId"] = "commitmentId";
+    ApiParams["providerUrl"] = "providerUrl";
+    ApiParams["procaptchaResponse"] = "procaptcha-response";
+})(ApiParams || (ApiParams = {}));
+export const CaptchaRequestBody = z.object({
+    [ApiParams.user]: z.string(),
+    [ApiParams.dapp]: z.string(),
+    [ApiParams.datasetId]: z.string(),
+    [ApiParams.blockNumber]: z.string(),
+});
+export const CaptchaSolutionBody = z.object({
+    [ApiParams.user]: z.string(),
+    [ApiParams.dapp]: z.string(),
+    [ApiParams.captchas]: z.array(CaptchaSolutionSchema),
+    [ApiParams.requestHash]: z.string(),
+    [ApiParams.signature]: z.string(), // the signature to prove account ownership
+});
+export const VerifySolutionBody = z.object({
+    [ApiParams.user]: z.string(),
+    [ApiParams.commitmentId]: z.string().optional(),
+});
+//# sourceMappingURL=api.js.map

package/dist/provider/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/provider/api.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAN,IAAY,QAMX;AAND,WAAY,QAAQ;IAChB,gEAAoD,CAAA;IACpD,mEAAuD,CAAA;IACvD,iEAAqD,CAAA;IACrD,6DAAiD,CAAA;IACjD,+DAAmD,CAAA;AACvD,CAAC,EANW,QAAQ,KAAR,QAAQ,QAMnB;AAED,MAAM,CAAN,IAAY,SAWX;AAXD,WAAY,SAAS;IACjB,oCAAuB,CAAA;IACvB,0BAAa,CAAA;IACb,0BAAa,CAAA;IACb,wCAA2B,CAAA;IAC3B,oCAAuB,CAAA;IACvB,wCAA2B,CAAA;IAC3B,kCAAqB,CAAA;IACrB,0CAA6B,CAAA;IAC7B,wCAA2B,CAAA;IAC3B,uDAA0C,CAAA;AAC9C,CAAC,EAXW,SAAS,KAAT,SAAS,QAWpB;AAaD,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACjC,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;CACtC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACpD,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IACnC,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,2CAA2C;CACjF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE;IAC5B,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAA"}

package/dist/provider/argv.d.ts

@@ -0,0 +1,4 @@
+import { Payee } from '../contract/typechain/index.js';
+import { z } from 'zod';
+export declare const PayeeSchema: z.ZodNativeEnum<typeof Payee>;
+//# sourceMappingURL=argv.d.ts.map

package/dist/provider/argv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"argv.d.ts","sourceRoot":"","sources":["../../src/provider/argv.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAA;AACtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,WAAW,+BAAsB,CAAA"}

package/dist/provider/argv.js

@@ -0,0 +1,17 @@
+// Copyright 2021-2023 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+import { Payee } from '../contract/typechain/index.js';
+import { z } from 'zod';
+export const PayeeSchema = z.nativeEnum(Payee);
+//# sourceMappingURL=argv.js.map

package/dist/provider/argv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"argv.js","sourceRoot":"","sources":["../../src/provider/argv.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAA;AACtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA"}

package/dist/provider/index.d.ts

@@ -0,0 +1,5 @@
+export * from './accounts.js';
+export * from './api.js';
+export * from './scheduler.js';
+export * from './argv.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/provider/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/provider/index.ts"],"names":[],"mappings":"AAaA,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/provider/index.js

@@ -0,0 +1,18 @@
+// Copyright 2021-2023 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+export * from './accounts.js';
+export * from './api.js';
+export * from './scheduler.js';
+export * from './argv.js';
+//# sourceMappingURL=index.js.map

package/dist/provider/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/provider/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA"}

package/dist/provider/scheduler.d.ts

@@ -0,0 +1,15 @@
+export declare enum ScheduledTaskNames {
+    BatchCommitment = "BatchCommitment",
+    CalculateSolution = "CalculateSolution"
+}
+export declare enum ScheduledTaskStatus {
+    Pending = "Pending",
+    Running = "Running",
+    Completed = "Completed",
+    Failed = "Failed"
+}
+export interface ScheduledTaskResult {
+    error?: string;
+    data?: Record<string, any>;
+}
+//# sourceMappingURL=scheduler.d.ts.map

package/dist/provider/scheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["../../src/provider/scheduler.ts"],"names":[],"mappings":"AAaA,oBAAY,kBAAkB;IAC1B,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;CAC1C;AAED,oBAAY,mBAAmB;IAC3B,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;CACpB;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC7B"}

package/dist/provider/scheduler.js

@@ -0,0 +1,26 @@
+// Copyright 2021-2023 Prosopo (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+export var ScheduledTaskNames;
+(function (ScheduledTaskNames) {
+    ScheduledTaskNames["BatchCommitment"] = "BatchCommitment";
+    ScheduledTaskNames["CalculateSolution"] = "CalculateSolution";
+})(ScheduledTaskNames || (ScheduledTaskNames = {}));
+export var ScheduledTaskStatus;
+(function (ScheduledTaskStatus) {
+    ScheduledTaskStatus["Pending"] = "Pending";
+    ScheduledTaskStatus["Running"] = "Running";
+    ScheduledTaskStatus["Completed"] = "Completed";
+    ScheduledTaskStatus["Failed"] = "Failed";
+})(ScheduledTaskStatus || (ScheduledTaskStatus = {}));
+//# sourceMappingURL=scheduler.js.map

package/dist/provider/scheduler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.js","sourceRoot":"","sources":["../../src/provider/scheduler.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,EAAE;AACF,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,iDAAiD;AACjD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AACjC,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC1B,yDAAmC,CAAA;IACnC,6DAAuC,CAAA;AAC3C,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B;AAED,MAAM,CAAN,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC3B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,8CAAuB,CAAA;IACvB,wCAAiB,CAAA;AACrB,CAAC,EALW,mBAAmB,KAAnB,mBAAmB,QAK9B"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prosopo/types",
-    "version": "0.1.18",
+    "version": "0.1.19",
     "description": "Types for prosopo TypeScript packages",
     "main": "dist/index.js",
     "type": "module",
@@ -26,7 +26,7 @@
         "@polkadot/api-contract": "10.9.1",
         "@polkadot/types": "10.9.1",
         "@polkadot/types-codec": "10.9.1",
-        "@prosopo/common": "^0.1.18",
+        "@prosopo/common": "^0.1.19",
         "consola": "^2.15.3",
         "zod": "^3.17.9"
     },