@gesturegate/sdk 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1,5 +1,19 @@
 import { type Address, type Hex, type PublicClient } from "viem";
 export declare const monadTestnetChainId = 10143;
+/** The official GestureGate deployment. Partners do not configure these values. */
+export declare const gestureGateDeployments: {
+    readonly 10143: {
+        readonly chainId: 10143;
+        readonly apiOrigin: "https://gesturegate.vercel.app";
+        readonly registryAddress: Address;
+    };
+};
+export type GestureGateDeployment = {
+    chainId: number;
+    apiOrigin: string;
+    registryAddress: Address;
+};
+export declare function getGestureGateDeployment(chainId: number): GestureGateDeployment | undefined;
 export declare const gestureGateIntentDomain: {
     readonly name: "GestureGate";
     readonly version: "1";
@@ -9,6 +23,9 @@ export declare const gestureGateIntentTypes: {
     readonly GateIntent: readonly [{
         readonly name: "subject";
         readonly type: "address";
+    }, {
+        readonly name: "projectId";
+        readonly type: "string";
     }, {
         readonly name: "action";
         readonly type: "string";
@@ -41,6 +58,7 @@ export type SignTypedData = (args: {
     primaryType: "GateIntent";
     message: {
         subject: Address;
+        projectId: string;
         action: "REQUEST_CHALLENGE";
         nonce: Hex;
         expiresAt: bigint;
@@ -59,33 +77,36 @@ export type HostedVerifiedMessage = {
 };
 export type VerificationCheck = {
     publicClient: PublicClient;
-    registryAddress: Address;
     address: Address;
     ttlSeconds: number;
+    /** For local development or a future self-hosted GestureGate deployment. */
+    deployment?: GestureGateDeployment;
 };
 export type VerificationStatus = Pick<VerificationCheck, "address" | "ttlSeconds"> & {
     isVerified: boolean;
 };
 export type EnsureVerifiedOptions = VerificationCheck & {
-    apiOrigin: string;
+    projectId: string;
     signTypedData: SignTypedData;
     popupName?: string;
     popupFeatures?: string;
 };
 export type GestureGateClientOptions = Omit<VerificationCheck, "address" | "ttlSeconds"> & {
-    apiOrigin: string;
+    projectId: string;
     defaultTtlSeconds: number;
 };
-export declare function createChallengeIntent(subject: Address, signTypedData: SignTypedData, now?: number): Promise<{
+export declare function createChallengeIntent(subject: Address, projectId: string, signTypedData: SignTypedData, now?: number): Promise<{
     subject: `0x${string}`;
+    projectId: string;
     nonce: `0x${string}`;
     expiresAt: string;
     signature: `0x${string}`;
 }>;
 export declare function startHostedVerification(options: {
-    apiOrigin: string;
+    projectId: string;
     address: Address;
     signTypedData: SignTypedData;
+    deployment?: GestureGateDeployment;
 }): Promise<{
     challengeId: string;
     expiresAt: string;
@@ -96,9 +117,10 @@ export declare function isVerifiedWithin(options: VerificationCheck): Promise<bo
 /** Returns an explicit address-bound status for application UI and guards. */
 export declare function getVerificationStatus(options: VerificationCheck): Promise<VerificationStatus>;
 export declare function openHostedVerification(options: {
-    apiOrigin: string;
+    projectId: string;
     address: Address;
     signTypedData: SignTypedData;
+    deployment?: GestureGateDeployment;
     popupName?: string;
     popupFeatures?: string;
 }): Promise<HostedVerifiedMessage>;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,YAAY,EAAE,MAAM,MAAM,CAAC;AAEnF,eAAO,MAAM,mBAAmB,QAAQ,CAAC;AAEzC,eAAO,MAAM,uBAAuB;;;;CAI1B,CAAC;AAEX,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;CAOzB,CAAC;AAEX,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;EAMxB,CAAC;AAEZ,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE;IACjC,MAAM,EAAE,OAAO,uBAAuB,CAAC;IACvC,KAAK,EAAE,OAAO,sBAAsB,CAAC;IACrC,WAAW,EAAE,YAAY,CAAC;IAC1B,OAAO,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,mBAAmB,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3F,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAEnB,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,GAAG,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,YAAY,EAAE,YAAY,CAAC;IAC3B,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,YAAY,CAAC,GAAG;IACnF,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,YAAY,CAAC,GAAG;IACzF,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAaF,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,SAAa;;;;;GAU3G;AAED,wBAAsB,uBAAuB,CAAC,OAAO,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,aAAa,EAAE,aAAa,CAAA;CAAE;;;;;GAoB3H;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,oBAUhE;AAED,8EAA8E;AAC9E,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAMnG;AAED,wBAAsB,sBAAsB,CAAC,OAAO,EAAE;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,kCAqCA;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,qBAAqB;;;;;;;;GAUlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,wBAAwB;qBAI/C,OAAO;kBAQf;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,aAAa,EAAE,aAAa,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE;4BAIpF;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,aAAa,EAAE,aAAa,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;GAQ9I"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,OAAO,EAAE,KAAK,GAAG,EAAE,KAAK,YAAY,EAAE,MAAM,MAAM,CAAC;AAEnF,eAAO,MAAM,mBAAmB,QAAQ,CAAC;AAEzC,mFAAmF;AACnF,eAAO,MAAM,sBAAsB;;;;kCAIkC,OAAO;;CAElE,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS,CAE3F;AAED,eAAO,MAAM,uBAAuB;;;;CAI1B,CAAC;AAEX,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;CAQzB,CAAC;AAEX,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;EAMxB,CAAC;AAEZ,MAAM,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE;IACjC,MAAM,EAAE,OAAO,uBAAuB,CAAC;IACvC,KAAK,EAAE,OAAO,sBAAsB,CAAC;IACrC,WAAW,EAAE,YAAY,CAAC;IAC1B,OAAO,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,mBAAmB,CAAC;QAAC,KAAK,EAAE,GAAG,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9G,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;AAEnB,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,GAAG,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,sBAAsB,CAAC;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,GAAG,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,4EAA4E;IAC5E,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,YAAY,CAAC,GAAG;IACnF,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,IAAI,CAAC,iBAAiB,EAAE,SAAS,GAAG,YAAY,CAAC,GAAG;IACzF,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AA2BF,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,GAAG,SAAa;;;;;;GAW9H;AAED,wBAAsB,uBAAuB,CAAC,OAAO,EAAE;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC;IAAC,aAAa,EAAE,aAAa,CAAC;IAAC,UAAU,CAAC,EAAE,qBAAqB,CAAA;CAAE;;;;;GAqB/J;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,oBAWhE;AAED,8EAA8E;AAC9E,wBAAsB,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAMnG;AAED,wBAAsB,sBAAsB,CAAC,OAAO,EAAE;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,aAAa,CAAC;IAC7B,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,kCAsCA;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,qBAAqB;;;;;;;;GAUlE;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,wBAAwB;qBAI/C,OAAO;kBAQf;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,aAAa,EAAE,aAAa,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE;4BAKpF;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,aAAa,EAAE,aAAa,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAA;KAAE;;;;;;;;;GAQ9I"}

package/dist/index.js

@@ -1,5 +1,16 @@
 import { keccak256, toHex } from "viem";
 export const monadTestnetChainId = 10143;
+/** The official GestureGate deployment. Partners do not configure these values. */
+export const gestureGateDeployments = {
+    [monadTestnetChainId]: {
+        chainId: monadTestnetChainId,
+        apiOrigin: "https://gesturegate.vercel.app",
+        registryAddress: "0x0B8a46b6c46a37B8B91C78D3f73549747e2027e3",
+    },
+};
+export function getGestureGateDeployment(chainId) {
+    return gestureGateDeployments[chainId];
+}
 export const gestureGateIntentDomain = {
     name: "GestureGate",
     version: "1",
@@ -8,6 +19,7 @@ export const gestureGateIntentDomain = {
 export const gestureGateIntentTypes = {
     GateIntent: [
         { name: "subject", type: "address" },
+        { name: "projectId", type: "string" },
         { name: "action", type: "string" },
         { name: "nonce", type: "bytes32" },
         { name: "expiresAt", type: "uint256" },
@@ -30,20 +42,38 @@ function randomNonce() {
 function apiPath(apiOrigin, path) {
     return `${apiOrigin.replace(/\/$/, "")}${path}`;
 }
-export async function createChallengeIntent(subject, signTypedData, now = Date.now()) {
+async function resolveDeployment(publicClient, override) {
+    const chainId = await publicClient.getChainId();
+    const deployment = override ?? getGestureGateDeployment(chainId);
+    if (!deployment)
+        throw new Error("GestureGate is not available on this network. Switch to Monad Testnet.");
+    if (deployment.chainId !== chainId)
+        throw new Error("Your wallet is connected to the wrong network for this GestureGate deployment.");
+    return deployment;
+}
+function defaultDeployment() {
+    const deployment = getGestureGateDeployment(monadTestnetChainId);
+    if (!deployment)
+        throw new Error("The official GestureGate Monad Testnet deployment is missing.");
+    return deployment;
+}
+export async function createChallengeIntent(subject, projectId, signTypedData, now = Date.now()) {
+    if (!/^ggp_[A-Za-z0-9_-]{8,}$/.test(projectId))
+        throw new Error("projectId must be a valid GestureGate project ID.");
     const expiresAt = BigInt(Math.floor(now / 1_000) + 180);
     const nonce = randomNonce();
     const signature = await signTypedData({
         domain: gestureGateIntentDomain,
         types: gestureGateIntentTypes,
         primaryType: "GateIntent",
-        message: { subject, action: "REQUEST_CHALLENGE", nonce, expiresAt },
+        message: { subject, projectId, action: "REQUEST_CHALLENGE", nonce, expiresAt },
     });
-    return { subject, nonce, expiresAt: expiresAt.toString(), signature };
+    return { subject, projectId, nonce, expiresAt: expiresAt.toString(), signature };
 }
 export async function startHostedVerification(options) {
-    const intent = await createChallengeIntent(options.address, options.signTypedData);
-    const response = await fetch(apiPath(options.apiOrigin, "/api/challenges"), {
+    const deployment = options.deployment ?? defaultDeployment();
+    const intent = await createChallengeIntent(options.address, options.projectId, options.signTypedData);
+    const response = await fetch(apiPath(deployment.apiOrigin, "/api/challenges"), {
         method: "POST",
         headers: { "content-type": "application/json" },
         body: JSON.stringify(intent),
@@ -67,8 +97,9 @@ export async function isVerifiedWithin(options) {
     if (!Number.isInteger(options.ttlSeconds) || options.ttlSeconds <= 0) {
         throw new Error("ttlSeconds must be a positive whole number.");
     }
+    const deployment = await resolveDeployment(options.publicClient, options.deployment);
     return options.publicClient.readContract({
-        address: options.registryAddress,
+        address: deployment.registryAddress,
         abi: gestureGateRegistryAbi,
         functionName: "isVerifiedWithin",
         args: [options.address, BigInt(options.ttlSeconds)],
@@ -91,9 +122,10 @@ export async function openHostedVerification(options) {
     if (!popup)
         throw new Error("Popup was blocked. Allow popups to verify with GestureGate.");
     try {
+        const deployment = options.deployment ?? defaultDeployment();
         const start = await startHostedVerification(options);
         popup.location.assign(start.verifyUrl);
-        const expectedOrigin = new URL(options.apiOrigin).origin;
+        const expectedOrigin = new URL(deployment.apiOrigin).origin;
         return await new Promise((resolve, reject) => {
             const closeTimer = window.setInterval(() => {
                 if (popup.closed) {
@@ -149,20 +181,21 @@ export function createGestureGateClient(options) {
     }
     const check = (address, ttlSeconds = options.defaultTtlSeconds) => getVerificationStatus({
         publicClient: options.publicClient,
-        registryAddress: options.registryAddress,
         address,
         ttlSeconds,
+        deployment: options.deployment,
     });
     return Object.freeze({
         check,
         open: (input) => openHostedVerification({
-            apiOrigin: options.apiOrigin,
+            projectId: options.projectId,
+            deployment: options.deployment,
             ...input,
         }),
         ensureVerified: (input) => ensureVerified({
             publicClient: options.publicClient,
-            registryAddress: options.registryAddress,
-            apiOrigin: options.apiOrigin,
+            projectId: options.projectId,
+            deployment: options.deployment,
             ttlSeconds: input.ttlSeconds ?? options.defaultTtlSeconds,
             ...input,
         }),

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@gesturegate/sdk",
-  "version": "0.1.0",
-  "description": "Framework-neutral hosted verification client for GestureGate on Monad.",
-  "license": "MIT",
-  "type": "module",
-  "sideEffects": false,
-  "keywords": ["captcha", "human-verification", "monad", "viem", "web3"],
+  "version": "0.1.1",
+  "description": "Framework-neutral hosted verification client for GestureGate on Monad.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "keywords": ["captcha", "human-verification", "monad", "viem", "web3"],
   "files": ["dist"],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -15,12 +15,12 @@
       "import": "./dist/index.js"
     }
   },
-  "scripts": {
-    "build": "tsc -p tsconfig.json"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "peerDependencies": {
     "viem": ">=2.0.0"
   }