@reclaimprotocol/attestor-core 3.1.0 → 4.0.0

package/lib/proto/api.d.ts

@@ -55,6 +55,13 @@ export declare enum ErrorCode {
     ERROR_NETWORK_ERROR = 6,
     /** ERROR_PAYMENT_REFUSED - attestor refused to pay the costs */
     ERROR_PAYMENT_REFUSED = 7,
+    /**
+     * ERROR_BGP_ANNOUNCEMENT_OVERLAP - BGP announcement overlapped, potentially
+     * compromising the claim's authenticity
+     */
+    ERROR_BGP_ANNOUNCEMENT_OVERLAP = 8,
+    /** ERROR_AUTHENTICATION_FAILED - authentication failed */
+    ERROR_AUTHENTICATION_FAILED = 9,
     UNRECOGNIZED = -1
 }
 export declare function errorCodeFromJSON(object: any): ErrorCode;
@@ -188,7 +195,10 @@ export interface MessageReveal_MessageRevealZk {
     proofs: MessageReveal_ZKProof[];
 }
 export interface MessageReveal_ZKProof {
-    /** JSON encoded snarkJS proof */
+    /**
+     * JSON encoded snarkJS proof
+     * @deprecated -- use `proofData` instead
+     */
     proofJson: string;
     /** the decrypted ciphertext as output by the ZK proof */
     decryptedRedactedCiphertext: Uint8Array;
@@ -199,6 +209,23 @@ export interface MessageReveal_ZKProof {
      * in the redactedPlaintext
      */
     startIdx: number;
+    proofData: Uint8Array;
+    /**
+     * If this block's proof contains an OPRF'd piece of data,
+     * then provide the OPRF data here
+     */
+    toprf: TOPRFPayload | undefined;
+}
+export interface TOPRFPayload {
+    /** Location of the data in the chunk that was masked */
+    dataLocation: DataSlice | undefined;
+    /** OPRF hash of the data */
+    nullifier: Uint8Array;
+    responses: TOPRFResponse[];
+}
+export interface DataSlice {
+    fromIndex: number;
+    length: number;
 }
 export interface ClaimRequestData {
     provider: string;
@@ -306,11 +333,52 @@ export interface CompleteClaimOnAvsResponse {
     txHash: string;
     taskCompletedObjectJson: string;
 }
+export interface AuthenticatedUserData {
+    /** Unique identifier for the user */
+    id: string;
+    createdAt: number;
+    /**
+     * Unix timestamp in seconds when the user's
+     * authentication will expire.
+     */
+    expiresAt: number;
+    /**
+     * List of allowed hosts the user is allowed to connect to.
+     * Will throw a BAD_REQUEST error if the user tries to connect.
+     * Pass an empty list to allow all hosts.
+     */
+    hostWhitelist: string[];
+}
+export interface AuthenticationRequest {
+    data: AuthenticatedUserData | undefined;
+    /** Signature of the `userData` */
+    signature: Uint8Array;
+}
 export interface InitRequest {
     /** Attestor client version */
     clientVersion: AttestorVersion;
     /** Signature type used & expected by the user */
     signatureType: ServiceSignatureType;
+    /**
+     * Request the attestor to authenticate the user
+     * with the given data. If auth fails, will return
+     * an AUTHENTICATION_FAILED error.
+     */
+    auth: AuthenticationRequest | undefined;
+}
+export interface InitResponse {
+    toprfPublicKey: Uint8Array;
+}
+export interface TOPRFRequest {
+    maskedData: Uint8Array;
+    engine: ZKProofEngine;
+}
+export interface TOPRFResponse {
+    publicKeyShare: Uint8Array;
+    /** OPRF output */
+    evaluated: Uint8Array;
+    c: Uint8Array;
+    r: Uint8Array;
 }
 export interface RPCMessage {
     /**
@@ -323,7 +391,7 @@ export interface RPCMessage {
     id: number;
     initRequest?: InitRequest | undefined;
     /** Response to the init request. */
-    initResponse?: Empty | undefined;
+    initResponse?: InitResponse | undefined;
     /**
      * Data representing an error in the WebSocket connection.
      * The party sending this message should close the connection
@@ -368,6 +436,9 @@ export interface RPCMessage {
     /** Submit the work done for the claim on the chain. */
     completeClaimOnChainRequest?: CompleteClaimOnAvsRequest | undefined;
     completeClaimOnChainResponse?: CompleteClaimOnAvsResponse | undefined;
+    /** Request to perform thresholded OPRF */
+    toprfRequest?: TOPRFRequest | undefined;
+    toprfResponse?: TOPRFResponse | undefined;
 }
 export interface RPCMessages {
     messages: RPCMessage[];
@@ -386,6 +457,8 @@ export declare const MessageReveal: MessageFns<MessageReveal>;
 export declare const MessageReveal_MessageRevealDirect: MessageFns<MessageReveal_MessageRevealDirect>;
 export declare const MessageReveal_MessageRevealZk: MessageFns<MessageReveal_MessageRevealZk>;
 export declare const MessageReveal_ZKProof: MessageFns<MessageReveal_ZKProof>;
+export declare const TOPRFPayload: MessageFns<TOPRFPayload>;
+export declare const DataSlice: MessageFns<DataSlice>;
 export declare const ClaimRequestData: MessageFns<ClaimRequestData>;
 export declare const ClaimTunnelRequest: MessageFns<ClaimTunnelRequest>;
 export declare const ClaimTunnelRequest_Signatures: MessageFns<ClaimTunnelRequest_Signatures>;
@@ -396,7 +469,12 @@ export declare const RequestClaimOnAvsRequest: MessageFns<RequestClaimOnAvsReque
 export declare const RequestClaimOnAvsResponse: MessageFns<RequestClaimOnAvsResponse>;
 export declare const CompleteClaimOnAvsRequest: MessageFns<CompleteClaimOnAvsRequest>;
 export declare const CompleteClaimOnAvsResponse: MessageFns<CompleteClaimOnAvsResponse>;
+export declare const AuthenticatedUserData: MessageFns<AuthenticatedUserData>;
+export declare const AuthenticationRequest: MessageFns<AuthenticationRequest>;
 export declare const InitRequest: MessageFns<InitRequest>;
+export declare const InitResponse: MessageFns<InitResponse>;
+export declare const TOPRFRequest: MessageFns<TOPRFRequest>;
+export declare const TOPRFResponse: MessageFns<TOPRFResponse>;
 export declare const RPCMessage: MessageFns<RPCMessage>;
 export declare const RPCMessages: MessageFns<RPCMessages>;
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;