@p2pdotme/sdk 1.2.21 → 1.2.23

package/dist/zkkyc.d.cts

@@ -13,7 +13,7 @@ declare class SdkError<TCode extends string = string> extends Error {
     });
 }
 
-type ZkkycErrorCode = "VALIDATION_ERROR" | "CONTRACT_READ_ERROR" | "ENCODE_ERROR" | "RECLAIM_INIT_FAILED" | "RECLAIM_SESSION_NOT_FOUND" | "RECLAIM_PROOF_GENERATION_FAILED" | "RECLAIM_PROOF_INVALID" | "RECLAIM_POLLING_ABORTED" | "ZK_PASSPORT_INIT_FAILED" | "ZK_PASSPORT_REJECTED" | "ZK_PASSPORT_VERIFICATION_FAILED" | "ZK_PASSPORT_ABORTED" | "SIMPLE_KYC_SESSION_FAILED" | "SIMPLE_KYC_REDEEM_FAILED" | "LIVENESS_SESSION_FAILED" | "LIVENESS_REDEEM_FAILED" | "BVN_ONBOARD_FAILED" | "BVN_SUBMIT_FAILED" | "BVN_OTP_SEND_FAILED" | "BVN_OTP_CONFIRM_FAILED" | "BVN_ATTESTATION_FAILED" | "BVN_SESSION_EXPIRED" | "PEER_DEPENDENCY_MISSING";
+type ZkkycErrorCode = "VALIDATION_ERROR" | "CONTRACT_READ_ERROR" | "ENCODE_ERROR" | "RECLAIM_INIT_FAILED" | "RECLAIM_SESSION_ENDPOINT_FAILED" | "RECLAIM_SESSION_NOT_FOUND" | "RECLAIM_PROOF_GENERATION_FAILED" | "RECLAIM_PROOF_INVALID" | "RECLAIM_POLLING_ABORTED" | "ZK_PASSPORT_INIT_FAILED" | "ZK_PASSPORT_REJECTED" | "ZK_PASSPORT_VERIFICATION_FAILED" | "ZK_PASSPORT_ABORTED" | "SIMPLE_KYC_SESSION_FAILED" | "SIMPLE_KYC_REDEEM_FAILED" | "LIVENESS_SESSION_FAILED" | "LIVENESS_REDEEM_FAILED" | "BVN_ONBOARD_FAILED" | "BVN_SUBMIT_FAILED" | "BVN_OTP_SEND_FAILED" | "BVN_OTP_CONFIRM_FAILED" | "BVN_ATTESTATION_FAILED" | "BVN_SESSION_EXPIRED" | "PEER_DEPENDENCY_MISSING";
 declare class ZkkycError extends SdkError<ZkkycErrorCode> {
     constructor(message: string, options: {
         code: ZkkycErrorCode;
@@ -147,23 +147,38 @@ declare function createZkkyc(config: ZkkycConfig): Zkkyc;
 type SocialPlatform = "linkedin" | "github" | "x" | "instagram" | "facebook" | "binance";
 /** Maps SocialPlatform to the capitalized name the contract expects for _socialName. */
 declare const SOCIAL_PLATFORM_NAMES: Record<SocialPlatform, string>;
+/** Locales the session service can render the Reclaim context message in. */
+type ReclaimLocale = "en" | "es" | "hi" | "id" | "pt";
+/** Tenants the session service knows, one per consuming app. */
+type ReclaimTenant = "p2p" | "coinsme";
 /**
  * Single-object params for `createReclaimFlow`. Merges the app-level config
- * (appId, appSecret, providerIds) with the per-call options (platform,
- * walletAddress, callbacks, …) into one argument.
+ * (sessionEndpoint, tenant) with the per-call options (platform, walletAddress,
+ * callbacks, …) into one argument.
  */
 interface ReclaimFlowParams {
-    readonly appId: string;
-    readonly appSecret: string;
-    readonly providerIds: Record<SocialPlatform, string>;
+    /**
+     * Base URL of the reclaim-session-service, which holds the Reclaim app
+     * secret and mints proof-request configs (e.g. https://reclaim.p2p.me).
+     *
+     * The secret must never reach the browser: it is a private key whose address
+     * is the appId, and bundlers inline build-time env vars into shipped JS.
+     */
+    readonly sessionEndpoint: string;
+    /** Selects the app's branding/copy on the session service. */
+    readonly tenant: ReclaimTenant;
     readonly platform: SocialPlatform;
     readonly walletAddress: Address;
-    /** Base URL for redirect after Reclaim flow. SDK appends ?sessionId={id}&socialPlatform={Name}. */
+    /** Base URL for redirect after Reclaim flow. Service appends ?sessionId={id}&socialPlatform={Name}. */
     readonly redirectUrl?: string;
     /** Resume polling for an existing session (redirect-back case). */
     readonly sessionId?: string;
-    /** Description added to Reclaim context. */
-    readonly contextDescription?: string;
+    /**
+     * Locale for the message shown inside the Reclaim Verifier app. The wording
+     * itself is owned by the service — that string renders under our app
+     * identity, so callers choose a language, not the words.
+     */
+    readonly locale?: ReclaimLocale;
     /** Called with status updates during the flow. */
     readonly onStatus?: (status: ReclaimStatus) => void;
     /** AbortSignal to cancel polling. */
@@ -495,9 +510,12 @@ declare function resumeLivenessFlow(args: {
 }): ResultAsync<LivenessAttestation, ZkkycError>;
 
 /**
- * Initializes a Reclaim social verification flow and returns a session. `init()`
- * runs eagerly here, so call this on page load; the returned session's `start()`
- * triggers the in-app flow and polls for the proof, so call that on user action.
+ * Initializes a Reclaim social verification flow and returns a session. The
+ * proof request is minted by reclaim-session-service (which holds the app
+ * secret) and rebuilt here with `fromJsonString`, so the secret never reaches
+ * the browser. That network call runs eagerly, so call this on page load; the
+ * returned session's `start()` triggers the in-app flow and polls for the proof,
+ * so call that on user action.
  */
 declare function createReclaimFlow(params: ReclaimFlowParams): ResultAsync<ReclaimSession, ZkkycError>;
 
@@ -525,4 +543,4 @@ declare function resumeSimpleKycFlow(args: {
 /** Initializes a ZK Passport verification flow and returns a session. */
 declare function createZkPassportFlow(params: ZkPassportFlowParams): ResultAsync<ZkPassportSession, ZkkycError>;
 
-export { type AnonAadharProofParams, BVN_OTP_METHODS, type BvnAttestation, type BvnDecision, type BvnFlow, type BvnFlowConfig, type BvnMethod, type BvnOnboardParams, type BvnOtpMethod, type BvnScope, type BvnSendOtpParams, type BvnSession, type BvnSubmitParams, DEFAULT_RECLAIM_PROVIDER_IDS, LIVENESS_DEFAULT_TENANT, type LivenessAttestation, type LivenessFlowParams, type LivenessSession, type LivenessStatus, type LivenessSubmitParams, RECLAIM_APP_LINKS, type ReclaimFlowParams, type ReclaimProofResult, type ReclaimSession, type ReclaimStatus, SIMPLE_KYC_DEFAULT_TENANT, SOCIAL_PLATFORM_NAMES, type SimpleKycAttestation, type SimpleKycFlowParams, type SimpleKycSession, type SimpleKycStatus, type SimpleKycSubmitParams, type SocialPlatform, type SocialVerifyParams, ZK_PASSPORT_APP_LINKS, type ZkPassportFlowParams, type ZkPassportProofResult, type ZkPassportRegisterParams, type ZkPassportSession, type ZkPassportStatus, type Zkkyc, type ZkkycConfig, ZkkycError, type ZkkycErrorCode, createBvnFlow, createLivenessFlow, createReclaimFlow, createSimpleKycFlow, createZkPassportFlow, createZkkyc, resumeLivenessFlow, resumeSimpleKycFlow };
+export { type AnonAadharProofParams, BVN_OTP_METHODS, type BvnAttestation, type BvnDecision, type BvnFlow, type BvnFlowConfig, type BvnMethod, type BvnOnboardParams, type BvnOtpMethod, type BvnScope, type BvnSendOtpParams, type BvnSession, type BvnSubmitParams, DEFAULT_RECLAIM_PROVIDER_IDS, LIVENESS_DEFAULT_TENANT, type LivenessAttestation, type LivenessFlowParams, type LivenessSession, type LivenessStatus, type LivenessSubmitParams, RECLAIM_APP_LINKS, type ReclaimFlowParams, type ReclaimLocale, type ReclaimProofResult, type ReclaimSession, type ReclaimStatus, type ReclaimTenant, SIMPLE_KYC_DEFAULT_TENANT, SOCIAL_PLATFORM_NAMES, type SimpleKycAttestation, type SimpleKycFlowParams, type SimpleKycSession, type SimpleKycStatus, type SimpleKycSubmitParams, type SocialPlatform, type SocialVerifyParams, ZK_PASSPORT_APP_LINKS, type ZkPassportFlowParams, type ZkPassportProofResult, type ZkPassportRegisterParams, type ZkPassportSession, type ZkPassportStatus, type Zkkyc, type ZkkycConfig, ZkkycError, type ZkkycErrorCode, createBvnFlow, createLivenessFlow, createReclaimFlow, createSimpleKycFlow, createZkPassportFlow, createZkkyc, resumeLivenessFlow, resumeSimpleKycFlow };

package/dist/zkkyc.d.ts

@@ -13,7 +13,7 @@ declare class SdkError<TCode extends string = string> extends Error {
     });
 }
 
-type ZkkycErrorCode = "VALIDATION_ERROR" | "CONTRACT_READ_ERROR" | "ENCODE_ERROR" | "RECLAIM_INIT_FAILED" | "RECLAIM_SESSION_NOT_FOUND" | "RECLAIM_PROOF_GENERATION_FAILED" | "RECLAIM_PROOF_INVALID" | "RECLAIM_POLLING_ABORTED" | "ZK_PASSPORT_INIT_FAILED" | "ZK_PASSPORT_REJECTED" | "ZK_PASSPORT_VERIFICATION_FAILED" | "ZK_PASSPORT_ABORTED" | "SIMPLE_KYC_SESSION_FAILED" | "SIMPLE_KYC_REDEEM_FAILED" | "LIVENESS_SESSION_FAILED" | "LIVENESS_REDEEM_FAILED" | "BVN_ONBOARD_FAILED" | "BVN_SUBMIT_FAILED" | "BVN_OTP_SEND_FAILED" | "BVN_OTP_CONFIRM_FAILED" | "BVN_ATTESTATION_FAILED" | "BVN_SESSION_EXPIRED" | "PEER_DEPENDENCY_MISSING";
+type ZkkycErrorCode = "VALIDATION_ERROR" | "CONTRACT_READ_ERROR" | "ENCODE_ERROR" | "RECLAIM_INIT_FAILED" | "RECLAIM_SESSION_ENDPOINT_FAILED" | "RECLAIM_SESSION_NOT_FOUND" | "RECLAIM_PROOF_GENERATION_FAILED" | "RECLAIM_PROOF_INVALID" | "RECLAIM_POLLING_ABORTED" | "ZK_PASSPORT_INIT_FAILED" | "ZK_PASSPORT_REJECTED" | "ZK_PASSPORT_VERIFICATION_FAILED" | "ZK_PASSPORT_ABORTED" | "SIMPLE_KYC_SESSION_FAILED" | "SIMPLE_KYC_REDEEM_FAILED" | "LIVENESS_SESSION_FAILED" | "LIVENESS_REDEEM_FAILED" | "BVN_ONBOARD_FAILED" | "BVN_SUBMIT_FAILED" | "BVN_OTP_SEND_FAILED" | "BVN_OTP_CONFIRM_FAILED" | "BVN_ATTESTATION_FAILED" | "BVN_SESSION_EXPIRED" | "PEER_DEPENDENCY_MISSING";
 declare class ZkkycError extends SdkError<ZkkycErrorCode> {
     constructor(message: string, options: {
         code: ZkkycErrorCode;
@@ -147,23 +147,38 @@ declare function createZkkyc(config: ZkkycConfig): Zkkyc;
 type SocialPlatform = "linkedin" | "github" | "x" | "instagram" | "facebook" | "binance";
 /** Maps SocialPlatform to the capitalized name the contract expects for _socialName. */
 declare const SOCIAL_PLATFORM_NAMES: Record<SocialPlatform, string>;
+/** Locales the session service can render the Reclaim context message in. */
+type ReclaimLocale = "en" | "es" | "hi" | "id" | "pt";
+/** Tenants the session service knows, one per consuming app. */
+type ReclaimTenant = "p2p" | "coinsme";
 /**
  * Single-object params for `createReclaimFlow`. Merges the app-level config
- * (appId, appSecret, providerIds) with the per-call options (platform,
- * walletAddress, callbacks, …) into one argument.
+ * (sessionEndpoint, tenant) with the per-call options (platform, walletAddress,
+ * callbacks, …) into one argument.
  */
 interface ReclaimFlowParams {
-    readonly appId: string;
-    readonly appSecret: string;
-    readonly providerIds: Record<SocialPlatform, string>;
+    /**
+     * Base URL of the reclaim-session-service, which holds the Reclaim app
+     * secret and mints proof-request configs (e.g. https://reclaim.p2p.me).
+     *
+     * The secret must never reach the browser: it is a private key whose address
+     * is the appId, and bundlers inline build-time env vars into shipped JS.
+     */
+    readonly sessionEndpoint: string;
+    /** Selects the app's branding/copy on the session service. */
+    readonly tenant: ReclaimTenant;
     readonly platform: SocialPlatform;
     readonly walletAddress: Address;
-    /** Base URL for redirect after Reclaim flow. SDK appends ?sessionId={id}&socialPlatform={Name}. */
+    /** Base URL for redirect after Reclaim flow. Service appends ?sessionId={id}&socialPlatform={Name}. */
     readonly redirectUrl?: string;
     /** Resume polling for an existing session (redirect-back case). */
     readonly sessionId?: string;
-    /** Description added to Reclaim context. */
-    readonly contextDescription?: string;
+    /**
+     * Locale for the message shown inside the Reclaim Verifier app. The wording
+     * itself is owned by the service — that string renders under our app
+     * identity, so callers choose a language, not the words.
+     */
+    readonly locale?: ReclaimLocale;
     /** Called with status updates during the flow. */
     readonly onStatus?: (status: ReclaimStatus) => void;
     /** AbortSignal to cancel polling. */
@@ -495,9 +510,12 @@ declare function resumeLivenessFlow(args: {
 }): ResultAsync<LivenessAttestation, ZkkycError>;
 
 /**
- * Initializes a Reclaim social verification flow and returns a session. `init()`
- * runs eagerly here, so call this on page load; the returned session's `start()`
- * triggers the in-app flow and polls for the proof, so call that on user action.
+ * Initializes a Reclaim social verification flow and returns a session. The
+ * proof request is minted by reclaim-session-service (which holds the app
+ * secret) and rebuilt here with `fromJsonString`, so the secret never reaches
+ * the browser. That network call runs eagerly, so call this on page load; the
+ * returned session's `start()` triggers the in-app flow and polls for the proof,
+ * so call that on user action.
  */
 declare function createReclaimFlow(params: ReclaimFlowParams): ResultAsync<ReclaimSession, ZkkycError>;
 
@@ -525,4 +543,4 @@ declare function resumeSimpleKycFlow(args: {
 /** Initializes a ZK Passport verification flow and returns a session. */
 declare function createZkPassportFlow(params: ZkPassportFlowParams): ResultAsync<ZkPassportSession, ZkkycError>;
 
-export { type AnonAadharProofParams, BVN_OTP_METHODS, type BvnAttestation, type BvnDecision, type BvnFlow, type BvnFlowConfig, type BvnMethod, type BvnOnboardParams, type BvnOtpMethod, type BvnScope, type BvnSendOtpParams, type BvnSession, type BvnSubmitParams, DEFAULT_RECLAIM_PROVIDER_IDS, LIVENESS_DEFAULT_TENANT, type LivenessAttestation, type LivenessFlowParams, type LivenessSession, type LivenessStatus, type LivenessSubmitParams, RECLAIM_APP_LINKS, type ReclaimFlowParams, type ReclaimProofResult, type ReclaimSession, type ReclaimStatus, SIMPLE_KYC_DEFAULT_TENANT, SOCIAL_PLATFORM_NAMES, type SimpleKycAttestation, type SimpleKycFlowParams, type SimpleKycSession, type SimpleKycStatus, type SimpleKycSubmitParams, type SocialPlatform, type SocialVerifyParams, ZK_PASSPORT_APP_LINKS, type ZkPassportFlowParams, type ZkPassportProofResult, type ZkPassportRegisterParams, type ZkPassportSession, type ZkPassportStatus, type Zkkyc, type ZkkycConfig, ZkkycError, type ZkkycErrorCode, createBvnFlow, createLivenessFlow, createReclaimFlow, createSimpleKycFlow, createZkPassportFlow, createZkkyc, resumeLivenessFlow, resumeSimpleKycFlow };
+export { type AnonAadharProofParams, BVN_OTP_METHODS, type BvnAttestation, type BvnDecision, type BvnFlow, type BvnFlowConfig, type BvnMethod, type BvnOnboardParams, type BvnOtpMethod, type BvnScope, type BvnSendOtpParams, type BvnSession, type BvnSubmitParams, DEFAULT_RECLAIM_PROVIDER_IDS, LIVENESS_DEFAULT_TENANT, type LivenessAttestation, type LivenessFlowParams, type LivenessSession, type LivenessStatus, type LivenessSubmitParams, RECLAIM_APP_LINKS, type ReclaimFlowParams, type ReclaimLocale, type ReclaimProofResult, type ReclaimSession, type ReclaimStatus, type ReclaimTenant, SIMPLE_KYC_DEFAULT_TENANT, SOCIAL_PLATFORM_NAMES, type SimpleKycAttestation, type SimpleKycFlowParams, type SimpleKycSession, type SimpleKycStatus, type SimpleKycSubmitParams, type SocialPlatform, type SocialVerifyParams, ZK_PASSPORT_APP_LINKS, type ZkPassportFlowParams, type ZkPassportProofResult, type ZkPassportRegisterParams, type ZkPassportSession, type ZkPassportStatus, type Zkkyc, type ZkkycConfig, ZkkycError, type ZkkycErrorCode, createBvnFlow, createLivenessFlow, createReclaimFlow, createSimpleKycFlow, createZkPassportFlow, createZkkyc, resumeLivenessFlow, resumeSimpleKycFlow };

package/dist/zkkyc.mjs

@@ -1530,46 +1530,51 @@ function createReclaimFlow(params) {
       });
       const { ReclaimProofRequest, transformForOnchain } = mod;
       const {
-        appId,
-        appSecret,
-        providerIds,
+        sessionEndpoint,
+        tenant,
         platform,
         walletAddress,
         redirectUrl,
         sessionId: existingSessionId,
-        contextDescription,
+        locale,
         onStatus,
         signal,
         pollingIntervalMs = 5e3
       } = params;
       const socialName = SOCIAL_PLATFORM_NAMES[platform];
-      const providerId = providerIds[platform];
       let reclaimProofRequest = null;
       let sessionId;
       let requestUrl = "";
       if (existingSessionId) {
         sessionId = existingSessionId;
       } else {
-        reclaimProofRequest = await ReclaimProofRequest.init(appId, appSecret, providerId, {
-          launchOptions: {
-            canUseDeferredDeepLinksFlow: true,
-            verificationMode: "app"
-          },
-          useAppClip: true,
-          log: true
+        if (!redirectUrl) {
+          throw new ZkkycError("redirectUrl is required to start a Reclaim session", {
+            code: "VALIDATION_ERROR"
+          });
+        }
+        const response = await fetch(`${sessionEndpoint.replace(/\/$/, "")}/v1/reclaim/sessions`, {
+          method: "POST",
+          headers: { "Content-Type": "application/json" },
+          body: JSON.stringify({ tenant, platform, walletAddress, redirectUrl, locale }),
+          signal
         });
-        const statusUrl = reclaimProofRequest.getStatusUrl();
-        sessionId = statusUrl.split("/").pop() || "";
-        if (redirectUrl) {
-          const separator = redirectUrl.includes("?") ? "&" : "?";
-          reclaimProofRequest.setRedirectUrl(
-            `${redirectUrl}${separator}sessionId=${sessionId}&socialPlatform=${socialName}`
-          );
+        if (!response.ok) {
+          const body = await response.text().catch(() => "");
+          throw new ZkkycError(`Reclaim session creation failed: ${response.status} ${body}`, {
+            code: "RECLAIM_SESSION_ENDPOINT_FAILED",
+            context: { status: response.status, platform }
+          });
         }
-        reclaimProofRequest.addContext(
-          walletAddress,
-          contextDescription ?? `Social verification for ${socialName}`
-        );
+        const data = await response.json();
+        if (!data?.config || !data?.sessionId) {
+          throw new ZkkycError("Reclaim session service returned an incomplete response", {
+            code: "RECLAIM_SESSION_ENDPOINT_FAILED",
+            context: { platform }
+          });
+        }
+        reclaimProofRequest = await ReclaimProofRequest.fromJsonString(data.config);
+        sessionId = data.sessionId;
         requestUrl = await reclaimProofRequest.getRequestUrl();
         onStatus?.({ type: "session_created", sessionId, requestUrl });
       }