402mob-merchant-sdk 0.4.2 → 0.6.0

package/dist/protected-work-types.d.ts

@@ -0,0 +1,524 @@
+export type ProtectedWorkPrepareRequest = {
+    "task": {
+        "input": unknown;
+        "rules": {
+            "version": "json-conversion-v1";
+            "fields": Array<{
+                "output": string;
+                "source": string;
+                "type": "string" | "number" | "boolean";
+                "convert": boolean;
+            }>;
+        };
+    };
+    "terms": {
+        "buyer": string;
+        "seller": string;
+        "amount": string;
+        "deliveryDeadline": number;
+        "evaluationPeriod": number;
+        "correctionPeriod": number;
+        "resolutionDeadline": number;
+        "reviewPeriod": number;
+        "appealPeriod": number;
+        "appealVerifier": string;
+        "fallbackVerifier": string;
+        "appealOriginHash": string;
+        "fallbackOriginHash": string;
+        "nonce": string;
+    };
+};
+export type ProtectedWorkFundingRequest = {
+    "terms": {
+        "buyer": string;
+        "seller": string;
+        "amount": string;
+        "workHash": string;
+        "deliveryDeadline": number;
+        "evaluationPeriod": number;
+        "correctionPeriod": number;
+        "resolutionDeadline": number;
+        "reviewPeriod": number;
+        "appealPeriod": number;
+        "appealVerifier": string;
+        "fallbackVerifier": string;
+        "appealOriginHash": string;
+        "fallbackOriginHash": string;
+        "verifierHash": "0x549e14e0594e4ff6f3b10b7e08720365903107a23fe531e5383e2dc0b3be2e1a";
+        "nonce": string;
+    };
+    "sellerSignature": string;
+    "consentUntil": number;
+    "appealConsent": string;
+    "fallbackConsent": string;
+};
+export type ProtectedWorkChallengeRequest = {
+    "action": "read";
+    "wallet": string;
+};
+export type ProtectedWorkSubmissionRequest = {
+    "task": {
+        "input": unknown;
+        "rules": {
+            "version": "json-conversion-v1";
+            "fields": Array<{
+                "output": string;
+                "source": string;
+                "type": "string" | "number" | "boolean";
+                "convert": boolean;
+            }>;
+        };
+    };
+    "result": unknown;
+    "attempt": number;
+    "signature": string;
+};
+export type ProtectedWorkResultRequest = {
+    "proof": {
+        "wallet": string;
+        "expiresAt": number;
+        "signature": string;
+    };
+};
+export type ProtectedWorkPrepareResponse = {
+    "jobId": string;
+    "terms": {
+        "buyer": string;
+        "seller": string;
+        "amount": string;
+        "workHash": string;
+        "deliveryDeadline": number;
+        "evaluationPeriod": number;
+        "correctionPeriod": number;
+        "resolutionDeadline": number;
+        "reviewPeriod": number;
+        "appealPeriod": number;
+        "appealVerifier": string;
+        "fallbackVerifier": string;
+        "appealOriginHash": string;
+        "fallbackOriginHash": string;
+        "verifierHash": "0x549e14e0594e4ff6f3b10b7e08720365903107a23fe531e5383e2dc0b3be2e1a";
+        "nonce": string;
+    };
+    "workHash": string;
+    "sellerSigning": {
+        "domain": {
+            "name": "402Mob Protected Work";
+            "version": "3";
+            "chainId": 8453;
+            "verifyingContract": string;
+        };
+        "types": {
+            "Terms": [{
+                "name": "buyer";
+                "type": "address";
+            }, {
+                "name": "seller";
+                "type": "address";
+            }, {
+                "name": "amount";
+                "type": "uint256";
+            }, {
+                "name": "workHash";
+                "type": "bytes32";
+            }, {
+                "name": "deliveryDeadline";
+                "type": "uint256";
+            }, {
+                "name": "evaluationPeriod";
+                "type": "uint256";
+            }, {
+                "name": "correctionPeriod";
+                "type": "uint256";
+            }, {
+                "name": "resolutionDeadline";
+                "type": "uint256";
+            }, {
+                "name": "reviewPeriod";
+                "type": "uint256";
+            }, {
+                "name": "appealPeriod";
+                "type": "uint256";
+            }, {
+                "name": "appealVerifier";
+                "type": "address";
+            }, {
+                "name": "fallbackVerifier";
+                "type": "address";
+            }, {
+                "name": "appealOriginHash";
+                "type": "bytes32";
+            }, {
+                "name": "fallbackOriginHash";
+                "type": "bytes32";
+            }, {
+                "name": "verifierHash";
+                "type": "bytes32";
+            }, {
+                "name": "nonce";
+                "type": "bytes32";
+            }];
+        };
+        "primaryType": "Terms";
+        "message": {
+            "buyer": string;
+            "seller": string;
+            "amount": string;
+            "workHash": string;
+            "deliveryDeadline": number;
+            "evaluationPeriod": number;
+            "correctionPeriod": number;
+            "resolutionDeadline": number;
+            "reviewPeriod": number;
+            "appealPeriod": number;
+            "appealVerifier": string;
+            "fallbackVerifier": string;
+            "appealOriginHash": string;
+            "fallbackOriginHash": string;
+            "verifierHash": "0x549e14e0594e4ff6f3b10b7e08720365903107a23fe531e5383e2dc0b3be2e1a";
+            "nonce": string;
+        };
+    };
+};
+export type ProtectedWorkFundingResponse = {
+    "jobId": string;
+    "transactions": Array<{
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    }>;
+    "instruction": string;
+};
+export type ProtectedWorkStatus = {
+    "jobId": string;
+    "terms": {
+        "buyer": string;
+        "seller": string;
+        "amount": string;
+        "workHash": string;
+        "deliveryDeadline": number;
+        "evaluationPeriod": number;
+        "correctionPeriod": number;
+        "resolutionDeadline": number;
+        "reviewPeriod": number;
+        "appealPeriod": number;
+        "appealVerifier": string;
+        "fallbackVerifier": string;
+        "appealOriginHash": string;
+        "fallbackOriginHash": string;
+        "verifierHash": "0x549e14e0594e4ff6f3b10b7e08720365903107a23fe531e5383e2dc0b3be2e1a";
+        "nonce": string;
+    };
+    "state": "unknown" | "funded" | "submitted" | "rejected" | "review" | "challenged" | "approved" | "completed" | "refunded";
+    "attempt": number;
+    "resultHash": string | null;
+    "evaluationUntil": number;
+    "correctionUntil": number;
+    "fallbackUntil": number;
+    "buyerReceived": boolean;
+    "outcome": "none" | "buyer_accepted" | "review_elapsed" | "appeal_approved" | "verifier_rejected" | "no_submission" | "evaluation_timeout" | "uncorrected_rejection" | "verifiers_unavailable";
+    "activeAppealRound": number | null;
+    "reviewUntil": number;
+    "appealUntil": number;
+    "appealUsed": boolean;
+    "reason": number;
+    "evidenceHash": string;
+    "chainTimestamp": number;
+    "refundEligible": boolean;
+    "payoutEligible": boolean;
+    "refundTransaction": {
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    };
+    "finalizeTransaction": {
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    };
+};
+export type ProtectedWorkChallenge = {
+    "message": string;
+    "expiresAt": number;
+    "wallet": string;
+    "action": "read";
+};
+export type ProtectedWorkSubmissionResponse = {
+    "jobId": string;
+    "resultHash": string;
+    "attempt": number;
+    "replay": boolean;
+    "submissionTransaction": {
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    } | null;
+    "relay": {
+        "queued": boolean;
+        "id": string | null;
+    };
+    "retainedUntil": string;
+};
+export type ProtectedWorkResult = {
+    "jobId": string;
+    "state": "unknown" | "funded" | "submitted" | "rejected" | "review" | "challenged" | "approved" | "completed" | "refunded";
+    "attempt": number;
+    "resultHash": string;
+    "task": {
+        "input": unknown;
+        "rules": {
+            "version": "json-conversion-v1";
+            "fields": Array<{
+                "output": string;
+                "source": string;
+                "type": "string" | "number" | "boolean";
+                "convert": boolean;
+            }>;
+        };
+    };
+    "result": unknown;
+};
+export type ProtectedWorkCapability = {
+    "protocol": string;
+    "status": string;
+    "configured": boolean;
+    "defaultEnabled": boolean;
+    "descriptor": string;
+    "guide": string;
+    "verifierSpecification": string;
+    "verifierHash": string;
+    "network": string;
+    "asset": string;
+    "task": string;
+    "maxAmountAtomic": string;
+    "maxOpenJobs": number;
+    "maxSubmissionBytes": number;
+    "inputBytes": number;
+    "resultBytes": number;
+    "maxFields": number;
+    "maxAttempts": number;
+    "maxAppeals": number;
+    "resultRetentionDaysAfterDeadline": number;
+    "payment": string;
+    "evaluator": string;
+    "timeout": string;
+    "scope": string;
+    "clients": string;
+    "sourceSdk": {
+        "package": string;
+        "version": string;
+        "published": boolean;
+        "requiresSourceBuild": boolean;
+        "entryPoint": string;
+        "guide": string;
+    };
+    "limits": string;
+};
+export type ProtectedWorkCandidateRequest = {
+    "attempt": number;
+    "resultHash": string;
+};
+export type ProtectedWorkActionRequest = {
+    "action": "receipt";
+    "signature"?: string;
+} | {
+    "action": "accept";
+    "signature"?: string;
+} | {
+    "action": "challenge";
+    "reason": "wrong_output" | "rules_mismatch" | "result_unavailable" | "evaluator_timeout";
+    "evidenceHash": string;
+    "signature"?: string;
+} | {
+    "action": "finalize";
+} | {
+    "action": "refund";
+};
+export type ProtectedWorkAppealRequest = {
+    "round": number;
+    "valid": boolean;
+    "signature": string;
+};
+export type ProtectedWorkEvaluationRequest = {};
+export type ProtectedWorkCandidateSigning = {
+    "signing": {
+        "domain": {
+            "name": "402Mob Protected Work";
+            "version": "3";
+            "chainId": 8453;
+            "verifyingContract": string;
+        };
+        "types": {
+            "Candidate": [{
+                "name": "jobId";
+                "type": "bytes32";
+            }, {
+                "name": "attempt";
+                "type": "uint256";
+            }, {
+                "name": "resultHash";
+                "type": "bytes32";
+            }];
+        };
+        "primaryType": "Candidate";
+        "message": {
+            "jobId": string;
+            "attempt": number;
+            "resultHash": string;
+        };
+    };
+};
+export type ProtectedWorkEvaluationResponse = {
+    "jobId": string;
+    "resultHash": string;
+    "attempt": number;
+    "valid": boolean;
+    "evaluationTransaction": {
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    };
+    "relay": {
+        "queued": boolean;
+        "id": string | null;
+    };
+};
+export type ProtectedWorkActionResponse = {
+    "signing": {
+        "domain": {
+            "name": "402Mob Protected Work";
+            "version": "3";
+            "chainId": 8453;
+            "verifyingContract": string;
+        };
+        "types": {
+            "Accept": [{
+                "name": "jobId";
+                "type": "bytes32";
+            }, {
+                "name": "attempt";
+                "type": "uint256";
+            }, {
+                "name": "resultHash";
+                "type": "bytes32";
+            }];
+        };
+        "primaryType": "Accept";
+        "message": {
+            "jobId": string;
+            "attempt": number;
+            "resultHash": string;
+        };
+    } | {
+        "domain": {
+            "name": "402Mob Protected Work";
+            "version": "3";
+            "chainId": 8453;
+            "verifyingContract": string;
+        };
+        "types": {
+            "Challenge": [{
+                "name": "jobId";
+                "type": "bytes32";
+            }, {
+                "name": "attempt";
+                "type": "uint256";
+            }, {
+                "name": "resultHash";
+                "type": "bytes32";
+            }, {
+                "name": "reason";
+                "type": "uint8";
+            }, {
+                "name": "evidenceHash";
+                "type": "bytes32";
+            }];
+        };
+        "primaryType": "Challenge";
+        "message": {
+            "jobId": string;
+            "attempt": number;
+            "resultHash": string;
+            "reason": number;
+            "evidenceHash": string;
+        };
+    } | {
+        "domain": {
+            "name": "402Mob Protected Work";
+            "version": "3";
+            "chainId": 8453;
+            "verifyingContract": string;
+        };
+        "types": {
+            "Receipt": [{
+                "name": "jobId";
+                "type": "bytes32";
+            }, {
+                "name": "attempt";
+                "type": "uint256";
+            }, {
+                "name": "resultHash";
+                "type": "bytes32";
+            }];
+        };
+        "primaryType": "Receipt";
+        "message": {
+            "jobId": string;
+            "attempt": number;
+            "resultHash": string;
+        };
+    };
+    "transaction": null;
+    "relay": {
+        "queued": boolean;
+        "id": string | null;
+    };
+} | {
+    "signing": null;
+    "transaction": {
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    };
+    "relay": {
+        "queued": boolean;
+        "id": string | null;
+    };
+};
+export type ProtectedWorkAppealResponse = {
+    "transaction": {
+        "chainId": 8453;
+        "to": string;
+        "data": string;
+        "value": "0";
+        "from"?: string;
+    };
+    "relay": {
+        "queued": boolean;
+        "id": string | null;
+    };
+};
+export type ProtectedWorkReplicasRequest = {
+    "attempt": number;
+    "resultHash": string;
+    "replicaA": string;
+    "replicaB": string;
+};
+export type ProtectedWorkReplicasResponse = {
+    "jobId": string;
+    "attempt": number;
+    "resultHash": string;
+    "replicated": true;
+};

package/dist/protected-work-types.js

@@ -0,0 +1 @@
+export {};

package/dist/protected-work.d.ts

@@ -0,0 +1,40 @@
+import type * as T from './protected-work-types.js';
+export * from './protected-work-types.js';
+export declare class ProtectedWorkApiError extends Error {
+    readonly status: number;
+    readonly code: string;
+    constructor(status: number, code: string, message: string);
+}
+export interface ProtectedWorkClientOptions {
+    /** Exact HTTPS origin. HTTP is allowed only for loopback integration tests. */
+    baseUrl?: string;
+    /** Pin the reviewed contract and verifier before requesting signing data or transactions. */
+    contract?: string;
+    verifierHash?: string;
+    fetch?: typeof globalThis.fetch;
+}
+/** HTTP transport only. No keys, merchant bearer tokens, wallet signing or transaction broadcasting. */
+export declare class ProtectedWorkClient {
+    private readonly origin;
+    private readonly contract;
+    private readonly verifierHash;
+    private readonly fetcher;
+    constructor(options?: ProtectedWorkClientOptions);
+    getCapabilities(): Promise<T.ProtectedWorkCapability>;
+    prepare(input: T.ProtectedWorkPrepareRequest): Promise<T.ProtectedWorkPrepareResponse>;
+    prepareFunding(input: T.ProtectedWorkFundingRequest): Promise<T.ProtectedWorkFundingResponse>;
+    getJob(id: string): Promise<T.ProtectedWorkStatus>;
+    createReadChallenge(id: string, input: T.ProtectedWorkChallengeRequest): Promise<T.ProtectedWorkChallenge>;
+    createCandidateSigning(id: string, input: T.ProtectedWorkCandidateRequest): Promise<T.ProtectedWorkCandidateSigning>;
+    submitCandidate(id: string, input: T.ProtectedWorkSubmissionRequest): Promise<T.ProtectedWorkSubmissionResponse>;
+    attachReplicas(id: string, input: T.ProtectedWorkReplicasRequest): Promise<T.ProtectedWorkReplicasResponse>;
+    evaluate(id: string): Promise<T.ProtectedWorkEvaluationResponse>;
+    readResult(id: string, input: T.ProtectedWorkResultRequest): Promise<T.ProtectedWorkResult>;
+    /** With no signature, requests a draft. A signed action may be relayed by a configured server. */
+    requestAction(id: string, input: T.ProtectedWorkActionRequest): Promise<T.ProtectedWorkActionResponse>;
+    submitAppeal(id: string, input: T.ProtectedWorkAppealRequest): Promise<T.ProtectedWorkAppealResponse>;
+    private job;
+    private invalid;
+    private transaction;
+    private call;
+}