@zkp2p/reclaim-witness-sdk/lib/types/claims.d.ts

<div> <div> <img src="https://raw.githubusercontent.com/reclaimprotocol/.github/main/assets/banners/Attestor-Core.png" /> </div> </div>

import type { ProviderClaimData } from '../proto/api';
import type { IAttestorClient, IAttestorClientInitParams } from '../types/client';
import type { CompleteTLSPacket, Logger } from '../types/general';
import type { ProofGenerationStep, ProviderName, ProviderParams, ProviderSecretParams } from '../types/providers';
import type { Transcript } from '../types/tunnel';
import type { PrepareZKProofsBaseOpts } from '../types/zk';
/**
 * Uniquely identifies a claim.
 * Hash of claim info.
 * Utilise `getIdentifierFromClaimInfo` to obtain this.
 */
export type ClaimID = ProviderClaimData['identifier'];
export type ClaimInfo = Pick<ProviderClaimData, 'context' | 'provider' | 'parameters'>;
export type AnyClaimInfo = ClaimInfo | {
    identifier: ClaimID;
};
export type CompleteClaimData = Pick<ProviderClaimData, 'owner' | 'timestampS' | 'epoch'> & AnyClaimInfo;
export type CreateClaimOnAttestorOpts<N extends ProviderName> = {
    /** name of the provider to generate signed receipt for */
    name: N;
    /**
     * secrets that are used to make the API request;
     * not included in the receipt & cannot be viewed by anyone
     * outside this client
     */
    secretParams: ProviderSecretParams<N>;
    params: ProviderParams<N>;
    /**
     * Some metadata context to be included in the claim
     */
    context?: {
        [key: string]: any;
    };
    onStep?(step: ProofGenerationStep): void;
    /**
     * Private key in hex format,
     * prefixed with '0x'
     */
    ownerPrivateKey: string;
    /**
     * Provide either the client or the URL
     * to the server -- so a client can be created internally.
     *
     * The created client will go into the global client pool.
     */
    client: IAttestorClient | IAttestorClientInitParams;
    /**
     * Optionally set the timestamp of the claim
     * in unix seconds. If not provided, the current
     * time will be used.
     */
    timestampS?: number;
    logger?: Logger;
    /**
     * Maximum number of retries to attempt
     * @default 3
     */
    maxRetries?: number;
    /**
     * Optionally update the provider parameters
     * based on the transcript
     */
    updateProviderParams?(transcript: Transcript<CompleteTLSPacket>, tlsVersion: string): Promise<{
        params: Partial<ProviderParams<N>>;
        secretParams: Partial<ProviderSecretParams<N>>;
    }>;
    /**
     * Replaces paramValue with corresponding OPRF hash before proof is made
     * Only if there's matching redaction exists
     * For example: "domain.com" -> "dv4Nrgtr"
     */
    updateParametersFromOprfData?: boolean;
} & PrepareZKProofsBaseOpts;