@p2pdotme/sdk 1.2.0 → 1.2.2

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" | "PEER_DEPENDENCY_MISSING";
+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" | "PEER_DEPENDENCY_MISSING";
 declare class ZkkycError extends SdkError<ZkkycErrorCode> {
     constructor(message: string, options: {
         code: ZkkycErrorCode;
@@ -90,6 +90,13 @@ declare const ZodZkPassportRegisterParamsSchema: z.ZodObject<{
     isIDCard: z.ZodBoolean;
 }, z.core.$strip>;
 type ZkPassportRegisterParams = z.infer<typeof ZodZkPassportRegisterParamsSchema>;
+declare const ZodSimpleKycSubmitParamsSchema: z.ZodObject<{
+    nullifier: z.ZodString;
+    limit: z.ZodBigInt;
+    expiry: z.ZodBigInt;
+    signature: z.ZodString;
+}, z.core.$strip>;
+type SimpleKycSubmitParams = z.infer<typeof ZodSimpleKycSubmitParamsSchema>;
 
 interface Zkkyc {
     prepareSocialVerify(params: SocialVerifyParams): Result<{
@@ -104,6 +111,10 @@ interface Zkkyc {
         to: Address;
         data: `0x${string}`;
     }, ZkkycError>;
+    prepareSubmitKycAttestation(params: SimpleKycSubmitParams): Result<{
+        to: Address;
+        data: `0x${string}`;
+    }, ZkkycError>;
 }
 /**
  * Creates a Zkkyc client that binds a reputation manager address,
@@ -111,7 +122,7 @@ interface Zkkyc {
  */
 declare function createZkkyc(config: ZkkycConfig): Zkkyc;
 
-type SocialPlatform = "linkedin" | "github" | "x" | "instagram" | "facebook";
+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>;
 /**
@@ -170,6 +181,16 @@ interface ReclaimProofResult {
     }[];
     readonly sessionId: string;
 }
+interface ReclaimSession {
+    /** The Reclaim session id (empty until known when resuming). */
+    readonly sessionId: string;
+    /** URL to display as a QR code or open as a deep link. Empty when resuming an existing session. */
+    readonly requestUrl: string;
+    /** Triggers the in-app Reclaim flow (browser only) and polls until the proof is ready. Call on user action (e.g. button click). */
+    readonly start: () => ResultAsync<ReclaimProofResult, ZkkycError>;
+    /** Aborts an in-flight polling loop started by `start`. */
+    readonly abort: () => void;
+}
 /**
  * Single-object params for `createZkPassportFlow`. Merges app-level config
  * (domain, name, logo, purpose) with per-call options (walletAddress, onStatus).
@@ -213,6 +234,59 @@ interface ZkPassportSession {
     /** Aborts the flow. The result promise will reject with ZK_PASSPORT_ABORTED. */
     readonly abort: () => void;
 }
+/**
+ * Params for `createSimpleKycFlow`. The app opens the hosted simple-kyc wizard,
+ * which runs onboard → passport → liveness → face match/dedup and, on approval,
+ * redirects back to `redirectUrl` with `?code=<code>&state=<state>`. The app
+ * then calls `resumeSimpleKycFlow` to redeem the code for the EIP-712 attestation.
+ */
+interface SimpleKycFlowParams {
+    /**
+     * Base URL exposing the browser-facing `/v1/widget/public-sessions` and
+     * `/v1/widget/attestation` endpoints — the `kyc-proxy` in a client-only setup
+     * (e.g. http://localhost:8787). The proxy holds the X-API-Key and forwards to
+     * simple-kyc's key-gated endpoints.
+     */
+    readonly baseUrl: string;
+    /** The user's EVM wallet — bound into the attestation and credited on-chain. */
+    readonly walletAddress: Address;
+    /** Tenant slug (one per consuming contract), e.g. "p2p-reputation". */
+    readonly tenant: string;
+    /** Return URL — pass `${window.location.origin}<route>` so each app self-routes. */
+    readonly redirectUrl: string;
+    /**
+     * ISO-2 country code (e.g. "IN"). Required — the embedded wizard skips the
+     * country step, so the app must prebind it. Must be one of simple-kyc's
+     * supported markets (IN, NG, BR, MX, CO, AR, VE, ID).
+     */
+    readonly country: string;
+    /** Opaque state round-tripped back to the app (CSRF/nonce + page to restore). */
+    readonly state?: string;
+    /** Status callback. */
+    readonly onStatus?: (status: SimpleKycStatus) => void;
+}
+type SimpleKycStatus = {
+    type: "session_created";
+    widgetUrl: string;
+} | {
+    type: "redirecting";
+    widgetUrl: string;
+};
+interface SimpleKycSession {
+    /** The hosted wizard URL to navigate to. */
+    readonly widgetUrl: string;
+    /** Convenience: navigate the browser to the wizard (no-op outside the browser). */
+    readonly redirect: () => void;
+}
+/** The on-chain-ready attestation, shaped for `prepareSubmitKycAttestation`. */
+interface SimpleKycAttestation {
+    readonly nullifier: `0x${string}`;
+    readonly limit: bigint;
+    readonly expiry: bigint;
+    readonly signature: `0x${string}`;
+    /** The opaque unique-human handle (no PII), for app-side bookkeeping. */
+    readonly identityHash?: string;
+}
 
 /** Default Reclaim provider IDs for each social platform. */
 declare const DEFAULT_RECLAIM_PROVIDER_IDS: Record<SocialPlatform, string>;
@@ -225,11 +299,38 @@ declare const ZK_PASSPORT_APP_LINKS: {
 declare const RECLAIM_APP_LINKS: {
     readonly ANDROID: "https://play.google.com/store/apps/details?id=org.reclaimprotocol.app";
 };
+/** Default tenant slug for the P2P reputation contract on the simple-kyc service. */
+declare const SIMPLE_KYC_DEFAULT_TENANT = "p2p-reputation";
 
-/** Runs the Reclaim social verification flow and returns proof data for on-chain submission. */
-declare function createReclaimFlow(params: ReclaimFlowParams): ResultAsync<ReclaimProofResult, 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.
+ */
+declare function createReclaimFlow(params: ReclaimFlowParams): ResultAsync<ReclaimSession, ZkkycError>;
+
+/**
+ * Starts the hosted simple-kyc wizard flow. Creates a browser-initiable widget
+ * session (no API key in the browser — `baseUrl` points at the kyc-proxy, which
+ * injects the key and whose tenant allowlist validates the redirect_uri), then
+ * returns the wizard URL to navigate to.
+ *
+ * The wizard runs passport → liveness → face match/dedup and, on approval,
+ * redirects back to `redirectUrl` with `?code=<code>&state=<state>`. Call
+ * `resumeSimpleKycFlow({ baseUrl, code })` on return to fetch the attestation.
+ */
+declare function createSimpleKycFlow(params: SimpleKycFlowParams): ResultAsync<SimpleKycSession, ZkkycError>;
+/**
+ * Redeems the one-time `kyc_code` from the wizard's redirect for the EIP-712
+ * attestation. The result feeds straight into `zkkyc.prepareSubmitKycAttestation`.
+ * The endpoint returns only the (non-PII, self-verifying) attestation.
+ */
+declare function resumeSimpleKycFlow(args: {
+    baseUrl: string;
+    code: string;
+}): ResultAsync<SimpleKycAttestation, ZkkycError>;
 
 /** Initializes a ZK Passport verification flow and returns a session. */
 declare function createZkPassportFlow(params: ZkPassportFlowParams): ResultAsync<ZkPassportSession, ZkkycError>;
 
-export { type AnonAadharProofParams, DEFAULT_RECLAIM_PROVIDER_IDS, RECLAIM_APP_LINKS, type ReclaimFlowParams, type ReclaimProofResult, type ReclaimStatus, SOCIAL_PLATFORM_NAMES, 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, createReclaimFlow, createZkPassportFlow, createZkkyc };
+export { type AnonAadharProofParams, DEFAULT_RECLAIM_PROVIDER_IDS, 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, createReclaimFlow, createSimpleKycFlow, createZkPassportFlow, createZkkyc, 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" | "PEER_DEPENDENCY_MISSING";
+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" | "PEER_DEPENDENCY_MISSING";
 declare class ZkkycError extends SdkError<ZkkycErrorCode> {
     constructor(message: string, options: {
         code: ZkkycErrorCode;
@@ -90,6 +90,13 @@ declare const ZodZkPassportRegisterParamsSchema: z.ZodObject<{
     isIDCard: z.ZodBoolean;
 }, z.core.$strip>;
 type ZkPassportRegisterParams = z.infer<typeof ZodZkPassportRegisterParamsSchema>;
+declare const ZodSimpleKycSubmitParamsSchema: z.ZodObject<{
+    nullifier: z.ZodString;
+    limit: z.ZodBigInt;
+    expiry: z.ZodBigInt;
+    signature: z.ZodString;
+}, z.core.$strip>;
+type SimpleKycSubmitParams = z.infer<typeof ZodSimpleKycSubmitParamsSchema>;
 
 interface Zkkyc {
     prepareSocialVerify(params: SocialVerifyParams): Result<{
@@ -104,6 +111,10 @@ interface Zkkyc {
         to: Address;
         data: `0x${string}`;
     }, ZkkycError>;
+    prepareSubmitKycAttestation(params: SimpleKycSubmitParams): Result<{
+        to: Address;
+        data: `0x${string}`;
+    }, ZkkycError>;
 }
 /**
  * Creates a Zkkyc client that binds a reputation manager address,
@@ -111,7 +122,7 @@ interface Zkkyc {
  */
 declare function createZkkyc(config: ZkkycConfig): Zkkyc;
 
-type SocialPlatform = "linkedin" | "github" | "x" | "instagram" | "facebook";
+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>;
 /**
@@ -170,6 +181,16 @@ interface ReclaimProofResult {
     }[];
     readonly sessionId: string;
 }
+interface ReclaimSession {
+    /** The Reclaim session id (empty until known when resuming). */
+    readonly sessionId: string;
+    /** URL to display as a QR code or open as a deep link. Empty when resuming an existing session. */
+    readonly requestUrl: string;
+    /** Triggers the in-app Reclaim flow (browser only) and polls until the proof is ready. Call on user action (e.g. button click). */
+    readonly start: () => ResultAsync<ReclaimProofResult, ZkkycError>;
+    /** Aborts an in-flight polling loop started by `start`. */
+    readonly abort: () => void;
+}
 /**
  * Single-object params for `createZkPassportFlow`. Merges app-level config
  * (domain, name, logo, purpose) with per-call options (walletAddress, onStatus).
@@ -213,6 +234,59 @@ interface ZkPassportSession {
     /** Aborts the flow. The result promise will reject with ZK_PASSPORT_ABORTED. */
     readonly abort: () => void;
 }
+/**
+ * Params for `createSimpleKycFlow`. The app opens the hosted simple-kyc wizard,
+ * which runs onboard → passport → liveness → face match/dedup and, on approval,
+ * redirects back to `redirectUrl` with `?code=<code>&state=<state>`. The app
+ * then calls `resumeSimpleKycFlow` to redeem the code for the EIP-712 attestation.
+ */
+interface SimpleKycFlowParams {
+    /**
+     * Base URL exposing the browser-facing `/v1/widget/public-sessions` and
+     * `/v1/widget/attestation` endpoints — the `kyc-proxy` in a client-only setup
+     * (e.g. http://localhost:8787). The proxy holds the X-API-Key and forwards to
+     * simple-kyc's key-gated endpoints.
+     */
+    readonly baseUrl: string;
+    /** The user's EVM wallet — bound into the attestation and credited on-chain. */
+    readonly walletAddress: Address;
+    /** Tenant slug (one per consuming contract), e.g. "p2p-reputation". */
+    readonly tenant: string;
+    /** Return URL — pass `${window.location.origin}<route>` so each app self-routes. */
+    readonly redirectUrl: string;
+    /**
+     * ISO-2 country code (e.g. "IN"). Required — the embedded wizard skips the
+     * country step, so the app must prebind it. Must be one of simple-kyc's
+     * supported markets (IN, NG, BR, MX, CO, AR, VE, ID).
+     */
+    readonly country: string;
+    /** Opaque state round-tripped back to the app (CSRF/nonce + page to restore). */
+    readonly state?: string;
+    /** Status callback. */
+    readonly onStatus?: (status: SimpleKycStatus) => void;
+}
+type SimpleKycStatus = {
+    type: "session_created";
+    widgetUrl: string;
+} | {
+    type: "redirecting";
+    widgetUrl: string;
+};
+interface SimpleKycSession {
+    /** The hosted wizard URL to navigate to. */
+    readonly widgetUrl: string;
+    /** Convenience: navigate the browser to the wizard (no-op outside the browser). */
+    readonly redirect: () => void;
+}
+/** The on-chain-ready attestation, shaped for `prepareSubmitKycAttestation`. */
+interface SimpleKycAttestation {
+    readonly nullifier: `0x${string}`;
+    readonly limit: bigint;
+    readonly expiry: bigint;
+    readonly signature: `0x${string}`;
+    /** The opaque unique-human handle (no PII), for app-side bookkeeping. */
+    readonly identityHash?: string;
+}
 
 /** Default Reclaim provider IDs for each social platform. */
 declare const DEFAULT_RECLAIM_PROVIDER_IDS: Record<SocialPlatform, string>;
@@ -225,11 +299,38 @@ declare const ZK_PASSPORT_APP_LINKS: {
 declare const RECLAIM_APP_LINKS: {
     readonly ANDROID: "https://play.google.com/store/apps/details?id=org.reclaimprotocol.app";
 };
+/** Default tenant slug for the P2P reputation contract on the simple-kyc service. */
+declare const SIMPLE_KYC_DEFAULT_TENANT = "p2p-reputation";
 
-/** Runs the Reclaim social verification flow and returns proof data for on-chain submission. */
-declare function createReclaimFlow(params: ReclaimFlowParams): ResultAsync<ReclaimProofResult, 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.
+ */
+declare function createReclaimFlow(params: ReclaimFlowParams): ResultAsync<ReclaimSession, ZkkycError>;
+
+/**
+ * Starts the hosted simple-kyc wizard flow. Creates a browser-initiable widget
+ * session (no API key in the browser — `baseUrl` points at the kyc-proxy, which
+ * injects the key and whose tenant allowlist validates the redirect_uri), then
+ * returns the wizard URL to navigate to.
+ *
+ * The wizard runs passport → liveness → face match/dedup and, on approval,
+ * redirects back to `redirectUrl` with `?code=<code>&state=<state>`. Call
+ * `resumeSimpleKycFlow({ baseUrl, code })` on return to fetch the attestation.
+ */
+declare function createSimpleKycFlow(params: SimpleKycFlowParams): ResultAsync<SimpleKycSession, ZkkycError>;
+/**
+ * Redeems the one-time `kyc_code` from the wizard's redirect for the EIP-712
+ * attestation. The result feeds straight into `zkkyc.prepareSubmitKycAttestation`.
+ * The endpoint returns only the (non-PII, self-verifying) attestation.
+ */
+declare function resumeSimpleKycFlow(args: {
+    baseUrl: string;
+    code: string;
+}): ResultAsync<SimpleKycAttestation, ZkkycError>;
 
 /** Initializes a ZK Passport verification flow and returns a session. */
 declare function createZkPassportFlow(params: ZkPassportFlowParams): ResultAsync<ZkPassportSession, ZkkycError>;
 
-export { type AnonAadharProofParams, DEFAULT_RECLAIM_PROVIDER_IDS, RECLAIM_APP_LINKS, type ReclaimFlowParams, type ReclaimProofResult, type ReclaimStatus, SOCIAL_PLATFORM_NAMES, 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, createReclaimFlow, createZkPassportFlow, createZkkyc };
+export { type AnonAadharProofParams, DEFAULT_RECLAIM_PROVIDER_IDS, 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, createReclaimFlow, createSimpleKycFlow, createZkPassportFlow, createZkkyc, resumeSimpleKycFlow };