@reclaimprotocol/browser-extension-sdk/src/types/index.d.ts

This guide will walk you through integrating the Reclaim Protocol Browser Extension SDK into your own browser extension or web application. It covers installation, manifest configuration, background initialization, content script setup, and how to trigg

export interface InitOptions {
  extensionID?: string;
  providerVersion?: string;
  callbackUrl?: string;
}

export interface Proofs {
  [key: string]: unknown;
}

export type RequestEvents = "started" | "completed" | "error" | "progress";

export class ReclaimExtensionProofRequest {
  applicationId: string;
  providerId: string;
  sessionId: string;
  signature: string;
  timestamp: string;
  getStatusUrl(): string;

  setAppCallbackUrl(url: string, jsonProofResponse?: boolean): void;
  setRedirectUrl(url: string): void;
  addContext(address: string | number, message: string): void;
  setParams(params: Record<string, unknown>): void;

  on(event: RequestEvents, cb: (payload?: any) => void): () => void;
  off(event: RequestEvents, cb: (payload?: any) => void): void;

  startVerification(): Promise<Proofs>;
  cancel(timeoutMs?: number): Promise<boolean | void>;
}

export class ReclaimExtensionSDK {
  initializeBackground(): unknown;
  isExtensionInstalled(opts?: { extensionID?: string; timeout?: number }): Promise<boolean>;
  getVersion(): string;
  init(
    applicationId: string,
    appSecret: string,
    providerId: string,
    options?: InitOptions,
  ): Promise<ReclaimExtensionProofRequest>;
}

export const reclaimExtensionSDK: ReclaimExtensionSDK;
export default ReclaimExtensionSDK;