@settlemint/sdk-portal 2.2.0-prc00b96af → 2.2.0-prd03e197f

package/README.md

@@ -27,9 +27,15 @@
 ## Table of Contents
 
 - [About](#about)
+- [Examples](#examples)
+  - [Get pending transactions](#get-pending-transactions)
+  - [Hd wallet](#hd-wallet)
 - [API Reference](#api-reference)
   - [Functions](#functions)
     - [createPortalClient()](#createportalclient)
+    - [handleWalletVerificationChallenge()](#handlewalletverificationchallenge)
+  - [Interfaces](#interfaces)
+    - [HandleWalletVerificationChallengeOptions\<Setup\>](#handlewalletverificationchallengeoptionssetup)
   - [Type Aliases](#type-aliases)
     - [ClientOptions](#clientoptions)
     - [RequestConfig](#requestconfig)
@@ -43,8 +49,172 @@
 The SettleMint Smart Contract Portal SDK provides a seamless way to interact with the Smart Contract Portal Middleware API. It enables you to easily interact with your smart contracts using a REST or GraphQL API.
 
 The SDK offers a type-safe interface for all Portal API operations, with comprehensive error handling and validation. It integrates smoothly with modern TypeScript applications while providing a simple and intuitive developer experience.
+## Examples
 
-For detailed information about using the Smart Contract Portal Middleware, check out our [official documentation](https://console.settlemint.com/documentation).
+### Get pending transactions
+
+```ts
+import { loadEnv } from "@settlemint/sdk-utils/environment";
+import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
+import { createPortalClient } from "../portal.js"; // Replace this path with "@settlemint/sdk-portal"
+import type { introspection } from "./schemas/portal-env.d.ts"; // Replace this path with the generated introspection type
+
+const env = await loadEnv(false, false);
+const logger = createLogger();
+
+const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
+  introspection: introspection;
+  disableMasking: true;
+  scalars: {
+    // Change unknown to the type you are using to store metadata
+    JSON: unknown;
+  };
+}>(
+  {
+    instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,
+    accessToken: env.SETTLEMINT_ACCESS_TOKEN!,
+  },
+  {
+    fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
+  },
+);
+
+// Making GraphQL queries
+const query = portalGraphql(`
+  query GetPendingTransactions {
+    getPendingTransactions {
+      count
+    }
+  }
+`);
+
+const result = await portalClient.request(query);
+console.log(`There are ${result.getPendingTransactions?.count} pending transactions`);
+
+```
+### Hd wallet
+
+```ts
+import { loadEnv } from "@settlemint/sdk-utils/environment";
+import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
+import type { Address } from "viem";
+import { createPortalClient } from "../portal.js"; // Replace this path with "@settlemint/sdk-portal"
+import { handleWalletVerificationChallenge } from "../wallet-verification-challenge.js"; // Replace this path with "@settlemint/sdk-portal"
+import type { introspection } from "./schemas/portal-env.d.ts"; // Replace this path with the generated introspection type
+
+const env = await loadEnv(false, false);
+const logger = createLogger();
+
+const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
+  introspection: introspection;
+  disableMasking: true;
+  scalars: {
+    // Change unknown to the type you are using to store metadata
+    JSON: unknown;
+  };
+}>(
+  {
+    instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,
+    accessToken: env.SETTLEMINT_ACCESS_TOKEN!,
+  },
+  {
+    fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
+  },
+);
+
+/**
+ * First create a wallet using the HD private key, this needs to be done for every user that is using your app
+ */
+const wallet = await portalClient.request(
+  portalGraphql(`
+    mutation createUserWallet($keyVaultId: String!, $name: String!) {
+      createWallet(keyVaultId: $keyVaultId, walletInfo: { name: $name }) {
+        address
+      }
+    }
+  `),
+  {
+    keyVaultId: env.SETTLEMINT_HD_PRIVATE_KEY!,
+    name: "My Wallet",
+  },
+);
+
+/**
+ * Set a pincode for the wallet, this is used to verify the wallet when the user is sending a transaction to the chain
+ */
+const pincodeVerification = await portalClient.request(
+  portalGraphql(`
+    mutation setPinCode($address: String!, $pincode: String!) {
+      createWalletVerification(
+        userWalletAddress: $address
+        verificationInfo: {pincode: {name: "PINCODE", pincode: $pincode}}
+      ) {
+        id
+        name
+        parameters
+        verificationType
+      }
+    }
+    `),
+  {
+    address: wallet.createWallet?.address!,
+    pincode: "123456",
+  },
+);
+
+/**
+ * Generate a challenge response for the pincode verification
+ */
+const challengeResponse = await handleWalletVerificationChallenge({
+  portalClient,
+  portalGraphql,
+  verificationId: pincodeVerification.createWalletVerification?.id!,
+  userWalletAddress: wallet.createWallet?.address! as Address,
+  code: "123456",
+  verificationType: "pincode",
+});
+
+/**
+ * Send a transaction to the chain
+ * This is a sample of how to send a transaction to the chain using the portal client and the asset tokenization keyVaultId
+ * @see https://github.com/settlemint/asset-tokenization-kit
+ */
+const result = await portalClient.request(
+  portalGraphql(`
+    mutation BondMint(
+      $challengeResponse: String!,
+      $verificationId: String,
+      $address: String!,
+      $from: String!,
+      $input: BondMintInput!
+    ) {
+      BondMint(
+        challengeResponse: $challengeResponse
+        verificationId: $verificationId
+        address: $address
+        from: $from
+        input: $input
+      ) {
+        transactionHash
+      }
+    }
+  `),
+  {
+    challengeResponse: challengeResponse.challengeResponse,
+    verificationId: pincodeVerification.createWalletVerification?.id!,
+    address: wallet.createWallet?.address!,
+    from: wallet.createWallet?.address!,
+    input: {
+      to: "0x0000000000000000000000000000000000000000",
+      amount: "1000000000000000000",
+    },
+  },
+);
+
+// Log the transaction hash
+console.log("Transaction hash:", result.BondMint?.transactionHash);
+
+```
 
 ## API Reference
 
@@ -54,7 +224,7 @@ For detailed information about using the Smart Contract Portal Middleware, check
 
 > **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
 
-Defined in: [sdk/portal/src/portal.ts:66](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L66)
+Defined in: [sdk/portal/src/portal.ts:37](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L37)
 
 Creates a Portal GraphQL client with the provided configuration.
 
@@ -82,8 +252,8 @@ An object containing the configured GraphQL client and graphql helper function
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:70](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L70) |
-| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:71](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L71) |
+| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:41](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L41) |
+| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:42](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/portal.ts#L42) |
 
 ##### Throws
 
@@ -92,28 +262,32 @@ If the provided options fail validation
 ##### Example
 
 ```ts
-import { createPortalClient } from '@settlemint/sdk-portal';
-import type { introspection } from "@schemas/portal-env";
-import { createLogger, requestLogger } from '@settlemint/sdk-utils/logging';
-
+import { createPortalClient } from "@settlemint/sdk-portal";
+import { loadEnv } from "@settlemint/sdk-utils/environment";
+import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
+import type { introspection } from "./test-app/portal-env";
+const env = await loadEnv(false, false);
 const logger = createLogger();
 
-export const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
+const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
   introspection: introspection;
   disableMasking: true;
   scalars: {
     // Change unknown to the type you are using to store metadata
     JSON: unknown;
   };
-}>({
-  instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,
-  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
-}, {
-  fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
-});
+}>(
+  {
+    instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,
+    accessToken: env.SETTLEMINT_ACCESS_TOKEN!,
+  },
+  {
+    fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
+  },
+);
 
 // Making GraphQL queries
-const query = graphql(`
+const query = portalGraphql(`
   query GetPendingTransactions {
     getPendingTransactions {
       count
@@ -121,9 +295,74 @@ const query = graphql(`
   }
 `);
 
-const result = await client.request(query);
+const result = await portalClient.request(query);
 ```
 
+***
+
+#### handleWalletVerificationChallenge()
+
+> **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
+
+Defined in: [sdk/portal/src/wallet-verification-challenge.ts:106](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/wallet-verification-challenge.ts#L106)
+
+Handles a wallet verification challenge by generating an appropriate response
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `Setup` *extends* `AbstractSetupSchema` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`HandleWalletVerificationChallengeOptions`](#handlewalletverificationchallengeoptions)\<`Setup`\> | The options for handling the wallet verification challenge |
+
+##### Returns
+
+`Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
+
+Promise resolving to an object containing the challenge response and optionally the verification ID
+
+##### Throws
+
+If the challenge cannot be created or is invalid
+
+##### Example
+
+import { createPortalClient } from "@settlemint/sdk-portal";
+import { handleWalletVerificationChallenge } from "@settlemint/sdk-portal";
+
+const { client, graphql } = createPortalClient({
+  instance: "https://portal.example.com/graphql",
+  accessToken: "your-access-token"
+});
+
+const result = await handleWalletVerificationChallenge({
+  portalClient: client,
+  portalGraphql: graphql,
+  verificationId: "verification-123",
+  userWalletAddress: "0x123...",
+  code: "123456",
+  verificationType: "otp"
+});
+
+### Interfaces
+
+#### HandleWalletVerificationChallengeOptions\<Setup\>
+
+Defined in: [sdk/portal/src/wallet-verification-challenge.ts:73](https://github.com/settlemint/sdk/blob/v2.2.0/sdk/portal/src/wallet-verification-challenge.ts#L73)
+
+Options for handling a wallet verification challenge
+
+##### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `Setup` *extends* `AbstractSetupSchema` | The GraphQL schema setup type |
+
 ### Type Aliases
 
 #### ClientOptions

package/dist/portal.cjs

@@ -22,7 +22,9 @@ var portal_exports = {};
 __export(portal_exports, {
   ClientOptionsSchema: () => ClientOptionsSchema,
   createPortalClient: () => createPortalClient,
-  readFragment: () => import_gql2.readFragment
+  handleWalletVerificationChallenge: () => handleWalletVerificationChallenge,
+  readFragment: () => import_gql2.readFragment,
+  waitForTransactionReceipt: () => waitForTransactionReceipt
 });
 module.exports = __toCommonJS(portal_exports);
 var import_runtime = require("@settlemint/sdk-utils/runtime");
@@ -30,6 +32,135 @@ var import_validation = require("@settlemint/sdk-utils/validation");
 var import_gql = require("gql.tada");
 var import_graphql_request = require("graphql-request");
 var import_zod = require("zod");
+
+// src/utils/wallet-verification-challenge.ts
+var import_node_crypto = require("crypto");
+var ChallengeError = class extends Error {
+  code;
+  constructor(message, code) {
+    super(message);
+    this.name = "ChallengeError";
+    this.code = code;
+  }
+};
+function hashPincode(pincode, salt) {
+  return (0, import_node_crypto.createHash)("sha256").update(`${salt}${pincode}`).digest("hex");
+}
+function generateResponse(pincode, salt, challenge) {
+  const hashedPincode = hashPincode(pincode, salt);
+  return (0, import_node_crypto.createHash)("sha256").update(`${hashedPincode}_${challenge}`).digest("hex");
+}
+async function handleWalletVerificationChallenge({
+  portalClient,
+  portalGraphql,
+  verificationId,
+  userWalletAddress,
+  code,
+  verificationType
+}) {
+  try {
+    if (verificationType === "otp") {
+      return {
+        challengeResponse: code.toString(),
+        verificationId
+      };
+    }
+    if (verificationType === "secret-code") {
+      const formattedCode = code.toString().replace(/(.{5})(?=.)/, "$1-");
+      return {
+        challengeResponse: formattedCode,
+        verificationId
+      };
+    }
+    const verificationChallenges = await portalClient.request(
+      portalGraphql(`
+        mutation CreateWalletVerificationChallenges($userWalletAddress: String!, $verificationId: String!) {
+          createWalletVerificationChallenges(userWalletAddress: $userWalletAddress, verificationId: $verificationId) {
+            challenge
+            id
+            name
+            verificationType
+          }
+        }
+      `),
+      {
+        userWalletAddress,
+        verificationId
+      }
+    );
+    if (!verificationChallenges.createWalletVerificationChallenges?.length) {
+      throw new ChallengeError("No verification challenges received", "NO_CHALLENGES");
+    }
+    const walletVerificationChallenge = verificationChallenges.createWalletVerificationChallenges.find(
+      (challenge) => challenge.id === verificationId
+    );
+    if (!walletVerificationChallenge?.challenge?.secret || !walletVerificationChallenge?.challenge?.salt) {
+      throw new ChallengeError("Invalid challenge format", "INVALID_CHALLENGE");
+    }
+    const { secret, salt } = walletVerificationChallenge.challenge;
+    const challengeResponse = generateResponse(code.toString(), salt, secret);
+    return {
+      challengeResponse,
+      verificationId
+    };
+  } catch (error) {
+    if (error instanceof ChallengeError) {
+      throw error;
+    }
+    throw new ChallengeError("Failed to process wallet verification challenge", "CHALLENGE_PROCESSING_ERROR");
+  }
+}
+
+// src/utils/wait-for-transaction-receipt.ts
+var import_graphql_ws = require("graphql-ws");
+async function waitForTransactionReceipt(transactionHash, options) {
+  const wsClient = (0, import_graphql_ws.createClient)({
+    url: options.portalGraphqlEndpoint.toLowerCase().replace("/graphql", `/${options.accessToken}/graphql`)
+  });
+  const subscription = wsClient.iterate({
+    query: `subscription getTransaction($transactionHash: String!) {
+        getTransaction(transactionHash: $transactionHash) {
+          receipt {
+            transactionHash
+            to
+            status
+            from
+            type
+            revertReason
+            revertReasonDecoded
+            logs
+            events
+            contractAddress
+          }
+          transactionHash
+          from
+          createdAt
+          address
+          functionName
+          isContract
+        }
+      }`,
+    variables: { transactionHash }
+  });
+  return Promise.race([
+    new Promise((_resolve, reject) => {
+      if (options.timeout) {
+        setTimeout(() => {
+          reject(new Error("Transaction receipt not found"));
+        }, options.timeout);
+      }
+    }),
+    (async () => {
+      for await (const result of subscription) {
+        if (result?.data?.getTransaction?.receipt) {
+          return result.data.getTransaction;
+        }
+      }
+    })()
+  ]);
+}
+
+// src/portal.ts
 var import_gql2 = require("gql.tada");
 var ClientOptionsSchema = import_zod.z.object({
   instance: import_validation.UrlOrPathSchema,
@@ -53,6 +184,8 @@ function createPortalClient(options, clientOptions) {
 0 && (module.exports = {
   ClientOptionsSchema,
   createPortalClient,
-  readFragment
+  handleWalletVerificationChallenge,
+  readFragment,
+  waitForTransactionReceipt
 });
 //# sourceMappingURL=portal.cjs.map

package/dist/portal.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/portal.ts"],"sourcesContent":["import { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { ApplicationAccessTokenSchema, UrlOrPathSchema, validate } from \"@settlemint/sdk-utils/validation\";\nimport { type AbstractSetupSchema, initGraphQLTada } from \"gql.tada\";\nimport { GraphQLClient } from \"graphql-request\";\nimport { z } from \"zod\";\n\n/**\n * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.\n */\nexport type RequestConfig = ConstructorParameters<typeof GraphQLClient>[1];\n\n/**\n * Schema for validating Portal client configuration options.\n */\nexport const ClientOptionsSchema = z.object({\n  instance: UrlOrPathSchema,\n  accessToken: ApplicationAccessTokenSchema,\n  cache: z.enum([\"default\", \"force-cache\", \"no-cache\", \"no-store\", \"only-if-cached\", \"reload\"]).optional(),\n});\n\n/**\n * Type representing the validated client options.\n */\nexport type ClientOptions = z.infer<typeof ClientOptionsSchema>;\n\n/**\n * Creates a Portal GraphQL client with the provided configuration.\n *\n * @param options - Configuration options for the Portal client\n * @param clientOptions - Additional GraphQL client configuration options\n * @returns An object containing the configured GraphQL client and graphql helper function\n * @throws If the provided options fail validation\n *\n * @example\n * import { createPortalClient } from '@settlemint/sdk-portal';\n * import type { introspection } from \"@schemas/portal-env\";\n * import { createLogger, requestLogger } from '@settlemint/sdk-utils/logging';\n *\n * const logger = createLogger();\n *\n * export const { client: portalClient, graphql: portalGraphql } = createPortalClient<{\n *   introspection: introspection;\n *   disableMasking: true;\n *   scalars: {\n *     // Change unknown to the type you are using to store metadata\n *     JSON: unknown;\n *   };\n * }>({\n *   instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,\n *   accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,\n * }, {\n *   fetch: requestLogger(logger, \"portal\", fetch) as typeof fetch,\n * });\n *\n * // Making GraphQL queries\n * const query = graphql(`\n *   query GetPendingTransactions {\n *     getPendingTransactions {\n *       count\n *     }\n *   }\n * `);\n *\n * const result = await client.request(query);\n */\nexport function createPortalClient<const Setup extends AbstractSetupSchema>(\n  options: ClientOptions,\n  clientOptions?: RequestConfig,\n): {\n  client: GraphQLClient;\n  graphql: initGraphQLTada<Setup>;\n} {\n  ensureServer();\n  const validatedOptions = validate(ClientOptionsSchema, options);\n  const graphql = initGraphQLTada<Setup>();\n  const fullUrl = new URL(validatedOptions.instance).toString();\n\n  return {\n    client: new GraphQLClient(fullUrl, {\n      ...clientOptions,\n      headers: { ...(clientOptions?.headers ?? {}), \"x-auth-token\": validatedOptions.accessToken },\n    }),\n    graphql,\n  };\n}\n\nexport { readFragment } from \"gql.tada\";\nexport type { FragmentOf, ResultOf, VariablesOf } from \"gql.tada\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,qBAA6B;AAC7B,wBAAwE;AACxE,iBAA0D;AAC1D,6BAA8B;AAC9B,iBAAkB;AAkFlB,IAAAA,cAA6B;AAxEtB,IAAM,sBAAsB,aAAE,OAAO;AAAA,EAC1C,UAAU;AAAA,EACV,aAAa;AAAA,EACb,OAAO,aAAE,KAAK,CAAC,WAAW,eAAe,YAAY,YAAY,kBAAkB,QAAQ,CAAC,EAAE,SAAS;AACzG,CAAC;AA+CM,SAAS,mBACd,SACA,eAIA;AACA,mCAAa;AACb,QAAM,uBAAmB,4BAAS,qBAAqB,OAAO;AAC9D,QAAM,cAAU,4BAAuB;AACvC,QAAM,UAAU,IAAI,IAAI,iBAAiB,QAAQ,EAAE,SAAS;AAE5D,SAAO;AAAA,IACL,QAAQ,IAAI,qCAAc,SAAS;AAAA,MACjC,GAAG;AAAA,MACH,SAAS,EAAE,GAAI,eAAe,WAAW,CAAC,GAAI,gBAAgB,iBAAiB,YAAY;AAAA,IAC7F,CAAC;AAAA,IACD;AAAA,EACF;AACF;","names":["import_gql"]}
+{"version":3,"sources":["../src/portal.ts","../src/utils/wallet-verification-challenge.ts","../src/utils/wait-for-transaction-receipt.ts"],"sourcesContent":["import {} from \"@settlemint/sdk-utils/logging\";\nimport { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { ApplicationAccessTokenSchema, UrlOrPathSchema, validate } from \"@settlemint/sdk-utils/validation\";\nimport { type AbstractSetupSchema, initGraphQLTada } from \"gql.tada\";\nimport { GraphQLClient } from \"graphql-request\";\nimport { z } from \"zod\";\n\n/**\n * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.\n */\nexport type RequestConfig = ConstructorParameters<typeof GraphQLClient>[1];\n\n/**\n * Schema for validating Portal client configuration options.\n */\nexport const ClientOptionsSchema = z.object({\n  instance: UrlOrPathSchema,\n  accessToken: ApplicationAccessTokenSchema,\n  cache: z.enum([\"default\", \"force-cache\", \"no-cache\", \"no-store\", \"only-if-cached\", \"reload\"]).optional(),\n});\n\n/**\n * Type representing the validated client options.\n */\nexport type ClientOptions = z.infer<typeof ClientOptionsSchema>;\n\n/**\n * Creates a Portal GraphQL client with the provided configuration.\n *\n * @param options - Configuration options for the Portal client\n * @param clientOptions - Additional GraphQL client configuration options\n * @returns An object containing the configured GraphQL client and graphql helper function\n * @throws If the provided options fail validation\n *\n * @example\n * import { createPortalClient } from \"@settlemint/sdk-portal\";\n * import { loadEnv } from \"@settlemint/sdk-utils/environment\";\n * import { createLogger, requestLogger } from \"@settlemint/sdk-utils/logging\";\n * import type { introspection } from \"@schemas/portal-env\";\n *\n * const env = await loadEnv(false, false);\n * const logger = createLogger();\n *\n * const { client: portalClient, graphql: portalGraphql } = createPortalClient<{\n *   introspection: introspection;\n *   disableMasking: true;\n *   scalars: {\n *     // Change unknown to the type you are using to store metadata\n *     JSON: unknown;\n *   };\n * }>(\n *   {\n *     instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,\n *     accessToken: env.SETTLEMINT_ACCESS_TOKEN!,\n *   },\n *   {\n *     fetch: requestLogger(logger, \"portal\", fetch) as typeof fetch,\n *   },\n * );\n *\n * // Making GraphQL queries\n * const query = portalGraphql(`\n *   query GetPendingTransactions {\n *     getPendingTransactions {\n *       count\n *     }\n *   }\n * `);\n *\n * const result = await portalClient.request(query);\n */\nexport function createPortalClient<const Setup extends AbstractSetupSchema>(\n  options: ClientOptions,\n  clientOptions?: RequestConfig,\n): {\n  client: GraphQLClient;\n  graphql: initGraphQLTada<Setup>;\n} {\n  ensureServer();\n  const validatedOptions = validate(ClientOptionsSchema, options);\n  const graphql = initGraphQLTada<Setup>();\n  const fullUrl = new URL(validatedOptions.instance).toString();\n\n  return {\n    client: new GraphQLClient(fullUrl, {\n      ...clientOptions,\n      headers: { ...(clientOptions?.headers ?? {}), \"x-auth-token\": validatedOptions.accessToken },\n    }),\n    graphql,\n  };\n}\n\nexport {\n  handleWalletVerificationChallenge,\n  type HandleWalletVerificationChallengeOptions,\n} from \"./utils/wallet-verification-challenge.js\";\nexport { waitForTransactionReceipt, type Transaction } from \"./utils/wait-for-transaction-receipt.js\";\nexport { readFragment } from \"gql.tada\";\nexport type { FragmentOf, ResultOf, VariablesOf } from \"gql.tada\";\n","import { createHash } from \"node:crypto\";\nimport type { AbstractSetupSchema, initGraphQLTada } from \"gql.tada\";\nimport type { Address } from \"viem\";\nimport type { createPortalClient } from \"../portal.js\";\n\n/**\n * Custom error class for challenge-related errors\n */\nexport class ChallengeError extends Error {\n  readonly code: string;\n\n  constructor(message: string, code: string) {\n    super(message);\n    this.name = \"ChallengeError\";\n    this.code = code;\n  }\n}\n\n/**\n * Represents the structure of a wallet verification challenge\n */\ninterface WalletVerificationChallenge {\n  challenge: {\n    secret: string;\n    salt: string;\n  };\n  id: string;\n  name: string;\n  verificationType: string;\n}\n\n/**\n * Response type for the CreateWalletVerificationChallenges mutation\n */\ninterface CreateWalletVerificationChallengesResponse {\n  createWalletVerificationChallenges: WalletVerificationChallenge[];\n}\n\n/**\n * Hashes a pincode with a salt using SHA-256\n * @param pincode - The pincode to hash\n * @param salt - The salt to use in hashing\n * @returns The hashed pincode as a hex string\n */\nfunction hashPincode(pincode: string, salt: string): string {\n  return createHash(\"sha256\").update(`${salt}${pincode}`).digest(\"hex\");\n}\n\n/**\n * Generates a challenge response by combining a hashed pincode with a challenge\n * @param pincode - The user's pincode\n * @param salt - The salt provided in the challenge\n * @param challenge - The challenge secret\n * @returns The challenge response as a hex string\n */\nfunction generateResponse(pincode: string, salt: string, challenge: string): string {\n  const hashedPincode = hashPincode(pincode, salt);\n  return createHash(\"sha256\").update(`${hashedPincode}_${challenge}`).digest(\"hex\");\n}\n\n/**\n * Options for handling a wallet verification challenge\n *\n * @typedef {Object} HandleWalletVerificationChallengeOptions\n * @template {AbstractSetupSchema} Setup - The GraphQL schema setup type\n * @property {ReturnType<typeof createPortalClient>[\"client\"]} portalClient - The portal client instance\n * @property {initGraphQLTada<Setup>} portalGraphql - The GraphQL query builder\n * @property {string} verificationId - The ID of the verification challenge\n * @property {Address} userWalletAddress - The wallet address to verify\n * @property {string | number} code - The verification code provided by the user\n * @property {\"otp\" | \"secret-code\" | \"pincode\"} verificationType - The type of verification being performed\n */\nexport interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSchema> {\n  portalClient: ReturnType<typeof createPortalClient>[\"client\"];\n  portalGraphql: initGraphQLTada<Setup>;\n  verificationId: string;\n  userWalletAddress: Address;\n  code: string | number;\n  verificationType: \"otp\" | \"secret-code\" | \"pincode\";\n}\n\n/**\n * Handles a wallet verification challenge by generating an appropriate response\n *\n * @param options - The options for handling the wallet verification challenge\n * @returns Promise resolving to an object containing the challenge response and optionally the verification ID\n * @throws {ChallengeError} If the challenge cannot be created or is invalid\n * @example\n * import { createPortalClient } from \"@settlemint/sdk-portal\";\n * import { handleWalletVerificationChallenge } from \"@settlemint/sdk-portal\";\n *\n * const { client, graphql } = createPortalClient({\n *   instance: \"https://portal.example.com/graphql\",\n *   accessToken: \"your-access-token\"\n * });\n *\n * const result = await handleWalletVerificationChallenge({\n *   portalClient: client,\n *   portalGraphql: graphql,\n *   verificationId: \"verification-123\",\n *   userWalletAddress: \"0x123...\",\n *   code: \"123456\",\n *   verificationType: \"otp\"\n * });\n */\nexport async function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({\n  portalClient,\n  portalGraphql,\n  verificationId,\n  userWalletAddress,\n  code,\n  verificationType,\n}: HandleWalletVerificationChallengeOptions<Setup>): Promise<{\n  challengeResponse: string;\n  verificationId?: string;\n}> {\n  try {\n    if (verificationType === \"otp\") {\n      return {\n        challengeResponse: code.toString(),\n        verificationId,\n      };\n    }\n\n    if (verificationType === \"secret-code\") {\n      // Add - separator to the code\n      const formattedCode = code.toString().replace(/(.{5})(?=.)/, \"$1-\");\n      return {\n        challengeResponse: formattedCode,\n        verificationId,\n      };\n    }\n\n    const verificationChallenges = await portalClient.request<CreateWalletVerificationChallengesResponse>(\n      portalGraphql(`\n        mutation CreateWalletVerificationChallenges($userWalletAddress: String!, $verificationId: String!) {\n          createWalletVerificationChallenges(userWalletAddress: $userWalletAddress, verificationId: $verificationId) {\n            challenge\n            id\n            name\n            verificationType\n          }\n        }\n      `),\n      {\n        userWalletAddress,\n        verificationId,\n      },\n    );\n\n    if (!verificationChallenges.createWalletVerificationChallenges?.length) {\n      throw new ChallengeError(\"No verification challenges received\", \"NO_CHALLENGES\");\n    }\n\n    const walletVerificationChallenge = verificationChallenges.createWalletVerificationChallenges.find(\n      (challenge) => challenge.id === verificationId,\n    );\n\n    if (!walletVerificationChallenge?.challenge?.secret || !walletVerificationChallenge?.challenge?.salt) {\n      throw new ChallengeError(\"Invalid challenge format\", \"INVALID_CHALLENGE\");\n    }\n\n    const { secret, salt } = walletVerificationChallenge.challenge;\n    const challengeResponse = generateResponse(code.toString(), salt, secret);\n    return {\n      challengeResponse,\n      verificationId,\n    };\n  } catch (error) {\n    if (error instanceof ChallengeError) {\n      throw error;\n    }\n    throw new ChallengeError(\"Failed to process wallet verification challenge\", \"CHALLENGE_PROCESSING_ERROR\");\n  }\n}\n","import { createClient } from \"graphql-ws\";\n\n/**\n * Represents the structure of a blockchain transaction with its receipt\n *\n * @typedef {Object} Transaction\n * @property {Object} receipt - The transaction receipt details\n * @property {string} receipt.transactionHash - The hash of the transaction\n * @property {string} receipt.to - The recipient address of the transaction\n * @property {string} receipt.status - The status of the transaction (success/failure)\n * @property {string} receipt.from - The sender address of the transaction\n * @property {string} receipt.type - The type of the transaction\n * @property {string} receipt.revertReason - The reason for transaction reversion, if applicable\n * @property {string} receipt.revertReasonDecoded - Human-readable version of the revert reason\n * @property {string} receipt.contractAddress - The address of the contract deployed in the transaction\n * @property {string[]} receipt.logs - Array of log entries generated by the transaction\n * @property {string[]} receipt.events - Array of events emitted during the transaction\n * @property {string} transactionHash - The hash of the transaction (duplicate of receipt.transactionHash)\n * @property {string} from - The sender address (duplicate of receipt.from)\n * @property {string} createdAt - Timestamp when the transaction was created\n * @property {string} address - The contract address involved in the transaction\n * @property {string} functionName - The name of the function called in the transaction\n * @property {boolean} isContract - Whether the transaction is a contract deployment\n */\nexport interface Transaction {\n  receipt: {\n    transactionHash: string;\n    to: string;\n    status: string;\n    from: string;\n    type: string;\n    revertReason: string;\n    revertReasonDecoded: string;\n    logs: string[];\n    events: string[];\n    contractAddress: string;\n  };\n  transactionHash: string;\n  from: string;\n  createdAt: string;\n  address: string;\n  functionName: string;\n  isContract: boolean;\n}\n\ninterface GetTransactionResponse {\n  getTransaction: Transaction;\n}\n\n/**\n * Options for waiting for a transaction receipt\n *\n * @typedef {Object} WaitForTransactionReceiptOptions\n * @property {string} portalGraphqlEndpoint - The GraphQL endpoint URL for the Portal API\n * @property {string} accessToken - The access token for authentication with the Portal API\n * @property {number} [timeout] - Optional timeout in milliseconds before the operation fails\n */\ninterface WaitForTransactionReceiptOptions {\n  portalGraphqlEndpoint: string;\n  accessToken: string;\n  timeout?: number;\n}\n\n/**\n * Wait for the transaction receipt\n * @param transactionHash transaction hash\n * @param options options\n * @returns receipt\n */\nexport async function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions) {\n  const wsClient = createClient({\n    url: options.portalGraphqlEndpoint.toLowerCase().replace(\"/graphql\", `/${options.accessToken}/graphql`),\n  });\n  const subscription = wsClient.iterate<GetTransactionResponse>({\n    query: `subscription getTransaction($transactionHash: String!) {\n        getTransaction(transactionHash: $transactionHash) {\n          receipt {\n            transactionHash\n            to\n            status\n            from\n            type\n            revertReason\n            revertReasonDecoded\n            logs\n            events\n            contractAddress\n          }\n          transactionHash\n          from\n          createdAt\n          address\n          functionName\n          isContract\n        }\n      }`,\n    variables: { transactionHash },\n  });\n  return Promise.race([\n    new Promise<undefined>((_resolve, reject) => {\n      if (options.timeout) {\n        setTimeout(() => {\n          reject(new Error(\"Transaction receipt not found\"));\n        }, options.timeout);\n      }\n    }),\n    (async () => {\n      for await (const result of subscription) {\n        if (result?.data?.getTransaction?.receipt) {\n          return result.data.getTransaction;\n        }\n      }\n    })(),\n  ]);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,qBAA6B;AAC7B,wBAAwE;AACxE,iBAA0D;AAC1D,6BAA8B;AAC9B,iBAAkB;;;ACLlB,yBAA2B;AAQpB,IAAM,iBAAN,cAA6B,MAAM;AAAA,EAC/B;AAAA,EAET,YAAY,SAAiB,MAAc;AACzC,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,EACd;AACF;AA4BA,SAAS,YAAY,SAAiB,MAAsB;AAC1D,aAAO,+BAAW,QAAQ,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,EAAE,EAAE,OAAO,KAAK;AACtE;AASA,SAAS,iBAAiB,SAAiB,MAAc,WAA2B;AAClF,QAAM,gBAAgB,YAAY,SAAS,IAAI;AAC/C,aAAO,+BAAW,QAAQ,EAAE,OAAO,GAAG,aAAa,IAAI,SAAS,EAAE,EAAE,OAAO,KAAK;AAClF;AA+CA,eAAsB,kCAA2E;AAAA,EAC/F;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAGG;AACD,MAAI;AACF,QAAI,qBAAqB,OAAO;AAC9B,aAAO;AAAA,QACL,mBAAmB,KAAK,SAAS;AAAA,QACjC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,qBAAqB,eAAe;AAEtC,YAAM,gBAAgB,KAAK,SAAS,EAAE,QAAQ,eAAe,KAAK;AAClE,aAAO;AAAA,QACL,mBAAmB;AAAA,QACnB;AAAA,MACF;AAAA,IACF;AAEA,UAAM,yBAAyB,MAAM,aAAa;AAAA,MAChD,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,OASb;AAAA,MACD;AAAA,QACE;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,uBAAuB,oCAAoC,QAAQ;AACtE,YAAM,IAAI,eAAe,uCAAuC,eAAe;AAAA,IACjF;AAEA,UAAM,8BAA8B,uBAAuB,mCAAmC;AAAA,MAC5F,CAAC,cAAc,UAAU,OAAO;AAAA,IAClC;AAEA,QAAI,CAAC,6BAA6B,WAAW,UAAU,CAAC,6BAA6B,WAAW,MAAM;AACpG,YAAM,IAAI,eAAe,4BAA4B,mBAAmB;AAAA,IAC1E;AAEA,UAAM,EAAE,QAAQ,KAAK,IAAI,4BAA4B;AACrD,UAAM,oBAAoB,iBAAiB,KAAK,SAAS,GAAG,MAAM,MAAM;AACxE,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,QAAI,iBAAiB,gBAAgB;AACnC,YAAM;AAAA,IACR;AACA,UAAM,IAAI,eAAe,mDAAmD,4BAA4B;AAAA,EAC1G;AACF;;;AC9KA,wBAA6B;AAqE7B,eAAsB,0BAA0B,iBAAyB,SAA2C;AAClH,QAAM,eAAW,gCAAa;AAAA,IAC5B,KAAK,QAAQ,sBAAsB,YAAY,EAAE,QAAQ,YAAY,IAAI,QAAQ,WAAW,UAAU;AAAA,EACxG,CAAC;AACD,QAAM,eAAe,SAAS,QAAgC;AAAA,IAC5D,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAsBP,WAAW,EAAE,gBAAgB;AAAA,EAC/B,CAAC;AACD,SAAO,QAAQ,KAAK;AAAA,IAClB,IAAI,QAAmB,CAAC,UAAU,WAAW;AAC3C,UAAI,QAAQ,SAAS;AACnB,mBAAW,MAAM;AACf,iBAAO,IAAI,MAAM,+BAA+B,CAAC;AAAA,QACnD,GAAG,QAAQ,OAAO;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,KACA,YAAY;AACX,uBAAiB,UAAU,cAAc;AACvC,YAAI,QAAQ,MAAM,gBAAgB,SAAS;AACzC,iBAAO,OAAO,KAAK;AAAA,QACrB;AAAA,MACF;AAAA,IACF,GAAG;AAAA,EACL,CAAC;AACH;;;AFjBA,IAAAA,cAA6B;AAlFtB,IAAM,sBAAsB,aAAE,OAAO;AAAA,EAC1C,UAAU;AAAA,EACV,aAAa;AAAA,EACb,OAAO,aAAE,KAAK,CAAC,WAAW,eAAe,YAAY,YAAY,kBAAkB,QAAQ,CAAC,EAAE,SAAS;AACzG,CAAC;AAoDM,SAAS,mBACd,SACA,eAIA;AACA,mCAAa;AACb,QAAM,uBAAmB,4BAAS,qBAAqB,OAAO;AAC9D,QAAM,cAAU,4BAAuB;AACvC,QAAM,UAAU,IAAI,IAAI,iBAAiB,QAAQ,EAAE,SAAS;AAE5D,SAAO;AAAA,IACL,QAAQ,IAAI,qCAAc,SAAS;AAAA,MACjC,GAAG;AAAA,MACH,SAAS,EAAE,GAAI,eAAe,WAAW,CAAC,GAAI,gBAAgB,iBAAiB,YAAY;AAAA,IAC7F,CAAC;AAAA,IACD;AAAA,EACF;AACF;","names":["import_gql"]}

package/dist/portal.d.cts

@@ -2,6 +2,119 @@ import { AbstractSetupSchema, initGraphQLTada } from 'gql.tada';
 export { FragmentOf, ResultOf, VariablesOf, readFragment } from 'gql.tada';
 import { GraphQLClient } from 'graphql-request';
 import { z } from 'zod';
+import { Address } from 'viem';
+
+/**
+ * Options for handling a wallet verification challenge
+ *
+ * @typedef {Object} HandleWalletVerificationChallengeOptions
+ * @template {AbstractSetupSchema} Setup - The GraphQL schema setup type
+ * @property {ReturnType<typeof createPortalClient>["client"]} portalClient - The portal client instance
+ * @property {initGraphQLTada<Setup>} portalGraphql - The GraphQL query builder
+ * @property {string} verificationId - The ID of the verification challenge
+ * @property {Address} userWalletAddress - The wallet address to verify
+ * @property {string | number} code - The verification code provided by the user
+ * @property {"otp" | "secret-code" | "pincode"} verificationType - The type of verification being performed
+ */
+interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSchema> {
+    portalClient: ReturnType<typeof createPortalClient>["client"];
+    portalGraphql: initGraphQLTada<Setup>;
+    verificationId: string;
+    userWalletAddress: Address;
+    code: string | number;
+    verificationType: "otp" | "secret-code" | "pincode";
+}
+/**
+ * Handles a wallet verification challenge by generating an appropriate response
+ *
+ * @param options - The options for handling the wallet verification challenge
+ * @returns Promise resolving to an object containing the challenge response and optionally the verification ID
+ * @throws {ChallengeError} If the challenge cannot be created or is invalid
+ * @example
+ * import { createPortalClient } from "@settlemint/sdk-portal";
+ * import { handleWalletVerificationChallenge } from "@settlemint/sdk-portal";
+ *
+ * const { client, graphql } = createPortalClient({
+ *   instance: "https://portal.example.com/graphql",
+ *   accessToken: "your-access-token"
+ * });
+ *
+ * const result = await handleWalletVerificationChallenge({
+ *   portalClient: client,
+ *   portalGraphql: graphql,
+ *   verificationId: "verification-123",
+ *   userWalletAddress: "0x123...",
+ *   code: "123456",
+ *   verificationType: "otp"
+ * });
+ */
+declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({ portalClient, portalGraphql, verificationId, userWalletAddress, code, verificationType, }: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
+    challengeResponse: string;
+    verificationId?: string;
+}>;
+
+/**
+ * Represents the structure of a blockchain transaction with its receipt
+ *
+ * @typedef {Object} Transaction
+ * @property {Object} receipt - The transaction receipt details
+ * @property {string} receipt.transactionHash - The hash of the transaction
+ * @property {string} receipt.to - The recipient address of the transaction
+ * @property {string} receipt.status - The status of the transaction (success/failure)
+ * @property {string} receipt.from - The sender address of the transaction
+ * @property {string} receipt.type - The type of the transaction
+ * @property {string} receipt.revertReason - The reason for transaction reversion, if applicable
+ * @property {string} receipt.revertReasonDecoded - Human-readable version of the revert reason
+ * @property {string} receipt.contractAddress - The address of the contract deployed in the transaction
+ * @property {string[]} receipt.logs - Array of log entries generated by the transaction
+ * @property {string[]} receipt.events - Array of events emitted during the transaction
+ * @property {string} transactionHash - The hash of the transaction (duplicate of receipt.transactionHash)
+ * @property {string} from - The sender address (duplicate of receipt.from)
+ * @property {string} createdAt - Timestamp when the transaction was created
+ * @property {string} address - The contract address involved in the transaction
+ * @property {string} functionName - The name of the function called in the transaction
+ * @property {boolean} isContract - Whether the transaction is a contract deployment
+ */
+interface Transaction {
+    receipt: {
+        transactionHash: string;
+        to: string;
+        status: string;
+        from: string;
+        type: string;
+        revertReason: string;
+        revertReasonDecoded: string;
+        logs: string[];
+        events: string[];
+        contractAddress: string;
+    };
+    transactionHash: string;
+    from: string;
+    createdAt: string;
+    address: string;
+    functionName: string;
+    isContract: boolean;
+}
+/**
+ * Options for waiting for a transaction receipt
+ *
+ * @typedef {Object} WaitForTransactionReceiptOptions
+ * @property {string} portalGraphqlEndpoint - The GraphQL endpoint URL for the Portal API
+ * @property {string} accessToken - The access token for authentication with the Portal API
+ * @property {number} [timeout] - Optional timeout in milliseconds before the operation fails
+ */
+interface WaitForTransactionReceiptOptions {
+    portalGraphqlEndpoint: string;
+    accessToken: string;
+    timeout?: number;
+}
+/**
+ * Wait for the transaction receipt
+ * @param transactionHash transaction hash
+ * @param options options
+ * @returns receipt
+ */
+declare function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions): Promise<Transaction | undefined>;
 
 /**
  * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
@@ -36,28 +149,33 @@ type ClientOptions = z.infer<typeof ClientOptionsSchema>;
  * @throws If the provided options fail validation
  *
  * @example
- * import { createPortalClient } from '@settlemint/sdk-portal';
+ * import { createPortalClient } from "@settlemint/sdk-portal";
+ * import { loadEnv } from "@settlemint/sdk-utils/environment";
+ * import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
  * import type { introspection } from "@schemas/portal-env";
- * import { createLogger, requestLogger } from '@settlemint/sdk-utils/logging';
  *
+ * const env = await loadEnv(false, false);
  * const logger = createLogger();
  *
- * export const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
+ * const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
  *   introspection: introspection;
  *   disableMasking: true;
  *   scalars: {
  *     // Change unknown to the type you are using to store metadata
  *     JSON: unknown;
  *   };
- * }>({
- *   instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,
- *   accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
- * }, {
- *   fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
- * });
+ * }>(
+ *   {
+ *     instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,
+ *     accessToken: env.SETTLEMINT_ACCESS_TOKEN!,
+ *   },
+ *   {
+ *     fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
+ *   },
+ * );
  *
  * // Making GraphQL queries
- * const query = graphql(`
+ * const query = portalGraphql(`
  *   query GetPendingTransactions {
  *     getPendingTransactions {
  *       count
@@ -65,11 +183,11 @@ type ClientOptions = z.infer<typeof ClientOptionsSchema>;
  *   }
  * `);
  *
- * const result = await client.request(query);
+ * const result = await portalClient.request(query);
  */
 declare function createPortalClient<const Setup extends AbstractSetupSchema>(options: ClientOptions, clientOptions?: RequestConfig): {
     client: GraphQLClient;
     graphql: initGraphQLTada<Setup>;
 };
 
-export { type ClientOptions, ClientOptionsSchema, type RequestConfig, createPortalClient };
+export { type ClientOptions, ClientOptionsSchema, type HandleWalletVerificationChallengeOptions, type RequestConfig, type Transaction, createPortalClient, handleWalletVerificationChallenge, waitForTransactionReceipt };

package/dist/portal.d.ts

@@ -2,6 +2,119 @@ import { AbstractSetupSchema, initGraphQLTada } from 'gql.tada';
 export { FragmentOf, ResultOf, VariablesOf, readFragment } from 'gql.tada';
 import { GraphQLClient } from 'graphql-request';
 import { z } from 'zod';
+import { Address } from 'viem';
+
+/**
+ * Options for handling a wallet verification challenge
+ *
+ * @typedef {Object} HandleWalletVerificationChallengeOptions
+ * @template {AbstractSetupSchema} Setup - The GraphQL schema setup type
+ * @property {ReturnType<typeof createPortalClient>["client"]} portalClient - The portal client instance
+ * @property {initGraphQLTada<Setup>} portalGraphql - The GraphQL query builder
+ * @property {string} verificationId - The ID of the verification challenge
+ * @property {Address} userWalletAddress - The wallet address to verify
+ * @property {string | number} code - The verification code provided by the user
+ * @property {"otp" | "secret-code" | "pincode"} verificationType - The type of verification being performed
+ */
+interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSchema> {
+    portalClient: ReturnType<typeof createPortalClient>["client"];
+    portalGraphql: initGraphQLTada<Setup>;
+    verificationId: string;
+    userWalletAddress: Address;
+    code: string | number;
+    verificationType: "otp" | "secret-code" | "pincode";
+}
+/**
+ * Handles a wallet verification challenge by generating an appropriate response
+ *
+ * @param options - The options for handling the wallet verification challenge
+ * @returns Promise resolving to an object containing the challenge response and optionally the verification ID
+ * @throws {ChallengeError} If the challenge cannot be created or is invalid
+ * @example
+ * import { createPortalClient } from "@settlemint/sdk-portal";
+ * import { handleWalletVerificationChallenge } from "@settlemint/sdk-portal";
+ *
+ * const { client, graphql } = createPortalClient({
+ *   instance: "https://portal.example.com/graphql",
+ *   accessToken: "your-access-token"
+ * });
+ *
+ * const result = await handleWalletVerificationChallenge({
+ *   portalClient: client,
+ *   portalGraphql: graphql,
+ *   verificationId: "verification-123",
+ *   userWalletAddress: "0x123...",
+ *   code: "123456",
+ *   verificationType: "otp"
+ * });
+ */
+declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({ portalClient, portalGraphql, verificationId, userWalletAddress, code, verificationType, }: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
+    challengeResponse: string;
+    verificationId?: string;
+}>;
+
+/**
+ * Represents the structure of a blockchain transaction with its receipt
+ *
+ * @typedef {Object} Transaction
+ * @property {Object} receipt - The transaction receipt details
+ * @property {string} receipt.transactionHash - The hash of the transaction
+ * @property {string} receipt.to - The recipient address of the transaction
+ * @property {string} receipt.status - The status of the transaction (success/failure)
+ * @property {string} receipt.from - The sender address of the transaction
+ * @property {string} receipt.type - The type of the transaction
+ * @property {string} receipt.revertReason - The reason for transaction reversion, if applicable
+ * @property {string} receipt.revertReasonDecoded - Human-readable version of the revert reason
+ * @property {string} receipt.contractAddress - The address of the contract deployed in the transaction
+ * @property {string[]} receipt.logs - Array of log entries generated by the transaction
+ * @property {string[]} receipt.events - Array of events emitted during the transaction
+ * @property {string} transactionHash - The hash of the transaction (duplicate of receipt.transactionHash)
+ * @property {string} from - The sender address (duplicate of receipt.from)
+ * @property {string} createdAt - Timestamp when the transaction was created
+ * @property {string} address - The contract address involved in the transaction
+ * @property {string} functionName - The name of the function called in the transaction
+ * @property {boolean} isContract - Whether the transaction is a contract deployment
+ */
+interface Transaction {
+    receipt: {
+        transactionHash: string;
+        to: string;
+        status: string;
+        from: string;
+        type: string;
+        revertReason: string;
+        revertReasonDecoded: string;
+        logs: string[];
+        events: string[];
+        contractAddress: string;
+    };
+    transactionHash: string;
+    from: string;
+    createdAt: string;
+    address: string;
+    functionName: string;
+    isContract: boolean;
+}
+/**
+ * Options for waiting for a transaction receipt
+ *
+ * @typedef {Object} WaitForTransactionReceiptOptions
+ * @property {string} portalGraphqlEndpoint - The GraphQL endpoint URL for the Portal API
+ * @property {string} accessToken - The access token for authentication with the Portal API
+ * @property {number} [timeout] - Optional timeout in milliseconds before the operation fails
+ */
+interface WaitForTransactionReceiptOptions {
+    portalGraphqlEndpoint: string;
+    accessToken: string;
+    timeout?: number;
+}
+/**
+ * Wait for the transaction receipt
+ * @param transactionHash transaction hash
+ * @param options options
+ * @returns receipt
+ */
+declare function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions): Promise<Transaction | undefined>;
 
 /**
  * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
@@ -36,28 +149,33 @@ type ClientOptions = z.infer<typeof ClientOptionsSchema>;
  * @throws If the provided options fail validation
  *
  * @example
- * import { createPortalClient } from '@settlemint/sdk-portal';
+ * import { createPortalClient } from "@settlemint/sdk-portal";
+ * import { loadEnv } from "@settlemint/sdk-utils/environment";
+ * import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
  * import type { introspection } from "@schemas/portal-env";
- * import { createLogger, requestLogger } from '@settlemint/sdk-utils/logging';
  *
+ * const env = await loadEnv(false, false);
  * const logger = createLogger();
  *
- * export const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
+ * const { client: portalClient, graphql: portalGraphql } = createPortalClient<{
  *   introspection: introspection;
  *   disableMasking: true;
  *   scalars: {
  *     // Change unknown to the type you are using to store metadata
  *     JSON: unknown;
  *   };
- * }>({
- *   instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,
- *   accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
- * }, {
- *   fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
- * });
+ * }>(
+ *   {
+ *     instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,
+ *     accessToken: env.SETTLEMINT_ACCESS_TOKEN!,
+ *   },
+ *   {
+ *     fetch: requestLogger(logger, "portal", fetch) as typeof fetch,
+ *   },
+ * );
  *
  * // Making GraphQL queries
- * const query = graphql(`
+ * const query = portalGraphql(`
  *   query GetPendingTransactions {
  *     getPendingTransactions {
  *       count
@@ -65,11 +183,11 @@ type ClientOptions = z.infer<typeof ClientOptionsSchema>;
  *   }
  * `);
  *
- * const result = await client.request(query);
+ * const result = await portalClient.request(query);
  */
 declare function createPortalClient<const Setup extends AbstractSetupSchema>(options: ClientOptions, clientOptions?: RequestConfig): {
     client: GraphQLClient;
     graphql: initGraphQLTada<Setup>;
 };
 
-export { type ClientOptions, ClientOptionsSchema, type RequestConfig, createPortalClient };
+export { type ClientOptions, ClientOptionsSchema, type HandleWalletVerificationChallengeOptions, type RequestConfig, type Transaction, createPortalClient, handleWalletVerificationChallenge, waitForTransactionReceipt };

package/dist/portal.mjs

@@ -4,6 +4,135 @@ import { ApplicationAccessTokenSchema, UrlOrPathSchema, validate } from "@settle
 import { initGraphQLTada } from "gql.tada";
 import { GraphQLClient } from "graphql-request";
 import { z } from "zod";
+
+// src/utils/wallet-verification-challenge.ts
+import { createHash } from "node:crypto";
+var ChallengeError = class extends Error {
+  code;
+  constructor(message, code) {
+    super(message);
+    this.name = "ChallengeError";
+    this.code = code;
+  }
+};
+function hashPincode(pincode, salt) {
+  return createHash("sha256").update(`${salt}${pincode}`).digest("hex");
+}
+function generateResponse(pincode, salt, challenge) {
+  const hashedPincode = hashPincode(pincode, salt);
+  return createHash("sha256").update(`${hashedPincode}_${challenge}`).digest("hex");
+}
+async function handleWalletVerificationChallenge({
+  portalClient,
+  portalGraphql,
+  verificationId,
+  userWalletAddress,
+  code,
+  verificationType
+}) {
+  try {
+    if (verificationType === "otp") {
+      return {
+        challengeResponse: code.toString(),
+        verificationId
+      };
+    }
+    if (verificationType === "secret-code") {
+      const formattedCode = code.toString().replace(/(.{5})(?=.)/, "$1-");
+      return {
+        challengeResponse: formattedCode,
+        verificationId
+      };
+    }
+    const verificationChallenges = await portalClient.request(
+      portalGraphql(`
+        mutation CreateWalletVerificationChallenges($userWalletAddress: String!, $verificationId: String!) {
+          createWalletVerificationChallenges(userWalletAddress: $userWalletAddress, verificationId: $verificationId) {
+            challenge
+            id
+            name
+            verificationType
+          }
+        }
+      `),
+      {
+        userWalletAddress,
+        verificationId
+      }
+    );
+    if (!verificationChallenges.createWalletVerificationChallenges?.length) {
+      throw new ChallengeError("No verification challenges received", "NO_CHALLENGES");
+    }
+    const walletVerificationChallenge = verificationChallenges.createWalletVerificationChallenges.find(
+      (challenge) => challenge.id === verificationId
+    );
+    if (!walletVerificationChallenge?.challenge?.secret || !walletVerificationChallenge?.challenge?.salt) {
+      throw new ChallengeError("Invalid challenge format", "INVALID_CHALLENGE");
+    }
+    const { secret, salt } = walletVerificationChallenge.challenge;
+    const challengeResponse = generateResponse(code.toString(), salt, secret);
+    return {
+      challengeResponse,
+      verificationId
+    };
+  } catch (error) {
+    if (error instanceof ChallengeError) {
+      throw error;
+    }
+    throw new ChallengeError("Failed to process wallet verification challenge", "CHALLENGE_PROCESSING_ERROR");
+  }
+}
+
+// src/utils/wait-for-transaction-receipt.ts
+import { createClient } from "graphql-ws";
+async function waitForTransactionReceipt(transactionHash, options) {
+  const wsClient = createClient({
+    url: options.portalGraphqlEndpoint.toLowerCase().replace("/graphql", `/${options.accessToken}/graphql`)
+  });
+  const subscription = wsClient.iterate({
+    query: `subscription getTransaction($transactionHash: String!) {
+        getTransaction(transactionHash: $transactionHash) {
+          receipt {
+            transactionHash
+            to
+            status
+            from
+            type
+            revertReason
+            revertReasonDecoded
+            logs
+            events
+            contractAddress
+          }
+          transactionHash
+          from
+          createdAt
+          address
+          functionName
+          isContract
+        }
+      }`,
+    variables: { transactionHash }
+  });
+  return Promise.race([
+    new Promise((_resolve, reject) => {
+      if (options.timeout) {
+        setTimeout(() => {
+          reject(new Error("Transaction receipt not found"));
+        }, options.timeout);
+      }
+    }),
+    (async () => {
+      for await (const result of subscription) {
+        if (result?.data?.getTransaction?.receipt) {
+          return result.data.getTransaction;
+        }
+      }
+    })()
+  ]);
+}
+
+// src/portal.ts
 import { readFragment } from "gql.tada";
 var ClientOptionsSchema = z.object({
   instance: UrlOrPathSchema,
@@ -26,6 +155,8 @@ function createPortalClient(options, clientOptions) {
 export {
   ClientOptionsSchema,
   createPortalClient,
-  readFragment
+  handleWalletVerificationChallenge,
+  readFragment,
+  waitForTransactionReceipt
 };
 //# sourceMappingURL=portal.mjs.map

package/dist/portal.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/portal.ts"],"sourcesContent":["import { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { ApplicationAccessTokenSchema, UrlOrPathSchema, validate } from \"@settlemint/sdk-utils/validation\";\nimport { type AbstractSetupSchema, initGraphQLTada } from \"gql.tada\";\nimport { GraphQLClient } from \"graphql-request\";\nimport { z } from \"zod\";\n\n/**\n * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.\n */\nexport type RequestConfig = ConstructorParameters<typeof GraphQLClient>[1];\n\n/**\n * Schema for validating Portal client configuration options.\n */\nexport const ClientOptionsSchema = z.object({\n  instance: UrlOrPathSchema,\n  accessToken: ApplicationAccessTokenSchema,\n  cache: z.enum([\"default\", \"force-cache\", \"no-cache\", \"no-store\", \"only-if-cached\", \"reload\"]).optional(),\n});\n\n/**\n * Type representing the validated client options.\n */\nexport type ClientOptions = z.infer<typeof ClientOptionsSchema>;\n\n/**\n * Creates a Portal GraphQL client with the provided configuration.\n *\n * @param options - Configuration options for the Portal client\n * @param clientOptions - Additional GraphQL client configuration options\n * @returns An object containing the configured GraphQL client and graphql helper function\n * @throws If the provided options fail validation\n *\n * @example\n * import { createPortalClient } from '@settlemint/sdk-portal';\n * import type { introspection } from \"@schemas/portal-env\";\n * import { createLogger, requestLogger } from '@settlemint/sdk-utils/logging';\n *\n * const logger = createLogger();\n *\n * export const { client: portalClient, graphql: portalGraphql } = createPortalClient<{\n *   introspection: introspection;\n *   disableMasking: true;\n *   scalars: {\n *     // Change unknown to the type you are using to store metadata\n *     JSON: unknown;\n *   };\n * }>({\n *   instance: process.env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT,\n *   accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,\n * }, {\n *   fetch: requestLogger(logger, \"portal\", fetch) as typeof fetch,\n * });\n *\n * // Making GraphQL queries\n * const query = graphql(`\n *   query GetPendingTransactions {\n *     getPendingTransactions {\n *       count\n *     }\n *   }\n * `);\n *\n * const result = await client.request(query);\n */\nexport function createPortalClient<const Setup extends AbstractSetupSchema>(\n  options: ClientOptions,\n  clientOptions?: RequestConfig,\n): {\n  client: GraphQLClient;\n  graphql: initGraphQLTada<Setup>;\n} {\n  ensureServer();\n  const validatedOptions = validate(ClientOptionsSchema, options);\n  const graphql = initGraphQLTada<Setup>();\n  const fullUrl = new URL(validatedOptions.instance).toString();\n\n  return {\n    client: new GraphQLClient(fullUrl, {\n      ...clientOptions,\n      headers: { ...(clientOptions?.headers ?? {}), \"x-auth-token\": validatedOptions.accessToken },\n    }),\n    graphql,\n  };\n}\n\nexport { readFragment } from \"gql.tada\";\nexport type { FragmentOf, ResultOf, VariablesOf } from \"gql.tada\";\n"],"mappings":";AAAA,SAAS,oBAAoB;AAC7B,SAAS,8BAA8B,iBAAiB,gBAAgB;AACxE,SAAmC,uBAAuB;AAC1D,SAAS,qBAAqB;AAC9B,SAAS,SAAS;AAkFlB,SAAS,oBAAoB;AAxEtB,IAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,UAAU;AAAA,EACV,aAAa;AAAA,EACb,OAAO,EAAE,KAAK,CAAC,WAAW,eAAe,YAAY,YAAY,kBAAkB,QAAQ,CAAC,EAAE,SAAS;AACzG,CAAC;AA+CM,SAAS,mBACd,SACA,eAIA;AACA,eAAa;AACb,QAAM,mBAAmB,SAAS,qBAAqB,OAAO;AAC9D,QAAM,UAAU,gBAAuB;AACvC,QAAM,UAAU,IAAI,IAAI,iBAAiB,QAAQ,EAAE,SAAS;AAE5D,SAAO;AAAA,IACL,QAAQ,IAAI,cAAc,SAAS;AAAA,MACjC,GAAG;AAAA,MACH,SAAS,EAAE,GAAI,eAAe,WAAW,CAAC,GAAI,gBAAgB,iBAAiB,YAAY;AAAA,IAC7F,CAAC;AAAA,IACD;AAAA,EACF;AACF;","names":[]}
+{"version":3,"sources":["../src/portal.ts","../src/utils/wallet-verification-challenge.ts","../src/utils/wait-for-transaction-receipt.ts"],"sourcesContent":["import {} from \"@settlemint/sdk-utils/logging\";\nimport { ensureServer } from \"@settlemint/sdk-utils/runtime\";\nimport { ApplicationAccessTokenSchema, UrlOrPathSchema, validate } from \"@settlemint/sdk-utils/validation\";\nimport { type AbstractSetupSchema, initGraphQLTada } from \"gql.tada\";\nimport { GraphQLClient } from \"graphql-request\";\nimport { z } from \"zod\";\n\n/**\n * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.\n */\nexport type RequestConfig = ConstructorParameters<typeof GraphQLClient>[1];\n\n/**\n * Schema for validating Portal client configuration options.\n */\nexport const ClientOptionsSchema = z.object({\n  instance: UrlOrPathSchema,\n  accessToken: ApplicationAccessTokenSchema,\n  cache: z.enum([\"default\", \"force-cache\", \"no-cache\", \"no-store\", \"only-if-cached\", \"reload\"]).optional(),\n});\n\n/**\n * Type representing the validated client options.\n */\nexport type ClientOptions = z.infer<typeof ClientOptionsSchema>;\n\n/**\n * Creates a Portal GraphQL client with the provided configuration.\n *\n * @param options - Configuration options for the Portal client\n * @param clientOptions - Additional GraphQL client configuration options\n * @returns An object containing the configured GraphQL client and graphql helper function\n * @throws If the provided options fail validation\n *\n * @example\n * import { createPortalClient } from \"@settlemint/sdk-portal\";\n * import { loadEnv } from \"@settlemint/sdk-utils/environment\";\n * import { createLogger, requestLogger } from \"@settlemint/sdk-utils/logging\";\n * import type { introspection } from \"@schemas/portal-env\";\n *\n * const env = await loadEnv(false, false);\n * const logger = createLogger();\n *\n * const { client: portalClient, graphql: portalGraphql } = createPortalClient<{\n *   introspection: introspection;\n *   disableMasking: true;\n *   scalars: {\n *     // Change unknown to the type you are using to store metadata\n *     JSON: unknown;\n *   };\n * }>(\n *   {\n *     instance: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,\n *     accessToken: env.SETTLEMINT_ACCESS_TOKEN!,\n *   },\n *   {\n *     fetch: requestLogger(logger, \"portal\", fetch) as typeof fetch,\n *   },\n * );\n *\n * // Making GraphQL queries\n * const query = portalGraphql(`\n *   query GetPendingTransactions {\n *     getPendingTransactions {\n *       count\n *     }\n *   }\n * `);\n *\n * const result = await portalClient.request(query);\n */\nexport function createPortalClient<const Setup extends AbstractSetupSchema>(\n  options: ClientOptions,\n  clientOptions?: RequestConfig,\n): {\n  client: GraphQLClient;\n  graphql: initGraphQLTada<Setup>;\n} {\n  ensureServer();\n  const validatedOptions = validate(ClientOptionsSchema, options);\n  const graphql = initGraphQLTada<Setup>();\n  const fullUrl = new URL(validatedOptions.instance).toString();\n\n  return {\n    client: new GraphQLClient(fullUrl, {\n      ...clientOptions,\n      headers: { ...(clientOptions?.headers ?? {}), \"x-auth-token\": validatedOptions.accessToken },\n    }),\n    graphql,\n  };\n}\n\nexport {\n  handleWalletVerificationChallenge,\n  type HandleWalletVerificationChallengeOptions,\n} from \"./utils/wallet-verification-challenge.js\";\nexport { waitForTransactionReceipt, type Transaction } from \"./utils/wait-for-transaction-receipt.js\";\nexport { readFragment } from \"gql.tada\";\nexport type { FragmentOf, ResultOf, VariablesOf } from \"gql.tada\";\n","import { createHash } from \"node:crypto\";\nimport type { AbstractSetupSchema, initGraphQLTada } from \"gql.tada\";\nimport type { Address } from \"viem\";\nimport type { createPortalClient } from \"../portal.js\";\n\n/**\n * Custom error class for challenge-related errors\n */\nexport class ChallengeError extends Error {\n  readonly code: string;\n\n  constructor(message: string, code: string) {\n    super(message);\n    this.name = \"ChallengeError\";\n    this.code = code;\n  }\n}\n\n/**\n * Represents the structure of a wallet verification challenge\n */\ninterface WalletVerificationChallenge {\n  challenge: {\n    secret: string;\n    salt: string;\n  };\n  id: string;\n  name: string;\n  verificationType: string;\n}\n\n/**\n * Response type for the CreateWalletVerificationChallenges mutation\n */\ninterface CreateWalletVerificationChallengesResponse {\n  createWalletVerificationChallenges: WalletVerificationChallenge[];\n}\n\n/**\n * Hashes a pincode with a salt using SHA-256\n * @param pincode - The pincode to hash\n * @param salt - The salt to use in hashing\n * @returns The hashed pincode as a hex string\n */\nfunction hashPincode(pincode: string, salt: string): string {\n  return createHash(\"sha256\").update(`${salt}${pincode}`).digest(\"hex\");\n}\n\n/**\n * Generates a challenge response by combining a hashed pincode with a challenge\n * @param pincode - The user's pincode\n * @param salt - The salt provided in the challenge\n * @param challenge - The challenge secret\n * @returns The challenge response as a hex string\n */\nfunction generateResponse(pincode: string, salt: string, challenge: string): string {\n  const hashedPincode = hashPincode(pincode, salt);\n  return createHash(\"sha256\").update(`${hashedPincode}_${challenge}`).digest(\"hex\");\n}\n\n/**\n * Options for handling a wallet verification challenge\n *\n * @typedef {Object} HandleWalletVerificationChallengeOptions\n * @template {AbstractSetupSchema} Setup - The GraphQL schema setup type\n * @property {ReturnType<typeof createPortalClient>[\"client\"]} portalClient - The portal client instance\n * @property {initGraphQLTada<Setup>} portalGraphql - The GraphQL query builder\n * @property {string} verificationId - The ID of the verification challenge\n * @property {Address} userWalletAddress - The wallet address to verify\n * @property {string | number} code - The verification code provided by the user\n * @property {\"otp\" | \"secret-code\" | \"pincode\"} verificationType - The type of verification being performed\n */\nexport interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSchema> {\n  portalClient: ReturnType<typeof createPortalClient>[\"client\"];\n  portalGraphql: initGraphQLTada<Setup>;\n  verificationId: string;\n  userWalletAddress: Address;\n  code: string | number;\n  verificationType: \"otp\" | \"secret-code\" | \"pincode\";\n}\n\n/**\n * Handles a wallet verification challenge by generating an appropriate response\n *\n * @param options - The options for handling the wallet verification challenge\n * @returns Promise resolving to an object containing the challenge response and optionally the verification ID\n * @throws {ChallengeError} If the challenge cannot be created or is invalid\n * @example\n * import { createPortalClient } from \"@settlemint/sdk-portal\";\n * import { handleWalletVerificationChallenge } from \"@settlemint/sdk-portal\";\n *\n * const { client, graphql } = createPortalClient({\n *   instance: \"https://portal.example.com/graphql\",\n *   accessToken: \"your-access-token\"\n * });\n *\n * const result = await handleWalletVerificationChallenge({\n *   portalClient: client,\n *   portalGraphql: graphql,\n *   verificationId: \"verification-123\",\n *   userWalletAddress: \"0x123...\",\n *   code: \"123456\",\n *   verificationType: \"otp\"\n * });\n */\nexport async function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({\n  portalClient,\n  portalGraphql,\n  verificationId,\n  userWalletAddress,\n  code,\n  verificationType,\n}: HandleWalletVerificationChallengeOptions<Setup>): Promise<{\n  challengeResponse: string;\n  verificationId?: string;\n}> {\n  try {\n    if (verificationType === \"otp\") {\n      return {\n        challengeResponse: code.toString(),\n        verificationId,\n      };\n    }\n\n    if (verificationType === \"secret-code\") {\n      // Add - separator to the code\n      const formattedCode = code.toString().replace(/(.{5})(?=.)/, \"$1-\");\n      return {\n        challengeResponse: formattedCode,\n        verificationId,\n      };\n    }\n\n    const verificationChallenges = await portalClient.request<CreateWalletVerificationChallengesResponse>(\n      portalGraphql(`\n        mutation CreateWalletVerificationChallenges($userWalletAddress: String!, $verificationId: String!) {\n          createWalletVerificationChallenges(userWalletAddress: $userWalletAddress, verificationId: $verificationId) {\n            challenge\n            id\n            name\n            verificationType\n          }\n        }\n      `),\n      {\n        userWalletAddress,\n        verificationId,\n      },\n    );\n\n    if (!verificationChallenges.createWalletVerificationChallenges?.length) {\n      throw new ChallengeError(\"No verification challenges received\", \"NO_CHALLENGES\");\n    }\n\n    const walletVerificationChallenge = verificationChallenges.createWalletVerificationChallenges.find(\n      (challenge) => challenge.id === verificationId,\n    );\n\n    if (!walletVerificationChallenge?.challenge?.secret || !walletVerificationChallenge?.challenge?.salt) {\n      throw new ChallengeError(\"Invalid challenge format\", \"INVALID_CHALLENGE\");\n    }\n\n    const { secret, salt } = walletVerificationChallenge.challenge;\n    const challengeResponse = generateResponse(code.toString(), salt, secret);\n    return {\n      challengeResponse,\n      verificationId,\n    };\n  } catch (error) {\n    if (error instanceof ChallengeError) {\n      throw error;\n    }\n    throw new ChallengeError(\"Failed to process wallet verification challenge\", \"CHALLENGE_PROCESSING_ERROR\");\n  }\n}\n","import { createClient } from \"graphql-ws\";\n\n/**\n * Represents the structure of a blockchain transaction with its receipt\n *\n * @typedef {Object} Transaction\n * @property {Object} receipt - The transaction receipt details\n * @property {string} receipt.transactionHash - The hash of the transaction\n * @property {string} receipt.to - The recipient address of the transaction\n * @property {string} receipt.status - The status of the transaction (success/failure)\n * @property {string} receipt.from - The sender address of the transaction\n * @property {string} receipt.type - The type of the transaction\n * @property {string} receipt.revertReason - The reason for transaction reversion, if applicable\n * @property {string} receipt.revertReasonDecoded - Human-readable version of the revert reason\n * @property {string} receipt.contractAddress - The address of the contract deployed in the transaction\n * @property {string[]} receipt.logs - Array of log entries generated by the transaction\n * @property {string[]} receipt.events - Array of events emitted during the transaction\n * @property {string} transactionHash - The hash of the transaction (duplicate of receipt.transactionHash)\n * @property {string} from - The sender address (duplicate of receipt.from)\n * @property {string} createdAt - Timestamp when the transaction was created\n * @property {string} address - The contract address involved in the transaction\n * @property {string} functionName - The name of the function called in the transaction\n * @property {boolean} isContract - Whether the transaction is a contract deployment\n */\nexport interface Transaction {\n  receipt: {\n    transactionHash: string;\n    to: string;\n    status: string;\n    from: string;\n    type: string;\n    revertReason: string;\n    revertReasonDecoded: string;\n    logs: string[];\n    events: string[];\n    contractAddress: string;\n  };\n  transactionHash: string;\n  from: string;\n  createdAt: string;\n  address: string;\n  functionName: string;\n  isContract: boolean;\n}\n\ninterface GetTransactionResponse {\n  getTransaction: Transaction;\n}\n\n/**\n * Options for waiting for a transaction receipt\n *\n * @typedef {Object} WaitForTransactionReceiptOptions\n * @property {string} portalGraphqlEndpoint - The GraphQL endpoint URL for the Portal API\n * @property {string} accessToken - The access token for authentication with the Portal API\n * @property {number} [timeout] - Optional timeout in milliseconds before the operation fails\n */\ninterface WaitForTransactionReceiptOptions {\n  portalGraphqlEndpoint: string;\n  accessToken: string;\n  timeout?: number;\n}\n\n/**\n * Wait for the transaction receipt\n * @param transactionHash transaction hash\n * @param options options\n * @returns receipt\n */\nexport async function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions) {\n  const wsClient = createClient({\n    url: options.portalGraphqlEndpoint.toLowerCase().replace(\"/graphql\", `/${options.accessToken}/graphql`),\n  });\n  const subscription = wsClient.iterate<GetTransactionResponse>({\n    query: `subscription getTransaction($transactionHash: String!) {\n        getTransaction(transactionHash: $transactionHash) {\n          receipt {\n            transactionHash\n            to\n            status\n            from\n            type\n            revertReason\n            revertReasonDecoded\n            logs\n            events\n            contractAddress\n          }\n          transactionHash\n          from\n          createdAt\n          address\n          functionName\n          isContract\n        }\n      }`,\n    variables: { transactionHash },\n  });\n  return Promise.race([\n    new Promise<undefined>((_resolve, reject) => {\n      if (options.timeout) {\n        setTimeout(() => {\n          reject(new Error(\"Transaction receipt not found\"));\n        }, options.timeout);\n      }\n    }),\n    (async () => {\n      for await (const result of subscription) {\n        if (result?.data?.getTransaction?.receipt) {\n          return result.data.getTransaction;\n        }\n      }\n    })(),\n  ]);\n}\n"],"mappings":";AACA,SAAS,oBAAoB;AAC7B,SAAS,8BAA8B,iBAAiB,gBAAgB;AACxE,SAAmC,uBAAuB;AAC1D,SAAS,qBAAqB;AAC9B,SAAS,SAAS;;;ACLlB,SAAS,kBAAkB;AAQpB,IAAM,iBAAN,cAA6B,MAAM;AAAA,EAC/B;AAAA,EAET,YAAY,SAAiB,MAAc;AACzC,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,EACd;AACF;AA4BA,SAAS,YAAY,SAAiB,MAAsB;AAC1D,SAAO,WAAW,QAAQ,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,EAAE,EAAE,OAAO,KAAK;AACtE;AASA,SAAS,iBAAiB,SAAiB,MAAc,WAA2B;AAClF,QAAM,gBAAgB,YAAY,SAAS,IAAI;AAC/C,SAAO,WAAW,QAAQ,EAAE,OAAO,GAAG,aAAa,IAAI,SAAS,EAAE,EAAE,OAAO,KAAK;AAClF;AA+CA,eAAsB,kCAA2E;AAAA,EAC/F;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAGG;AACD,MAAI;AACF,QAAI,qBAAqB,OAAO;AAC9B,aAAO;AAAA,QACL,mBAAmB,KAAK,SAAS;AAAA,QACjC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,qBAAqB,eAAe;AAEtC,YAAM,gBAAgB,KAAK,SAAS,EAAE,QAAQ,eAAe,KAAK;AAClE,aAAO;AAAA,QACL,mBAAmB;AAAA,QACnB;AAAA,MACF;AAAA,IACF;AAEA,UAAM,yBAAyB,MAAM,aAAa;AAAA,MAChD,cAAc;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,OASb;AAAA,MACD;AAAA,QACE;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,QAAI,CAAC,uBAAuB,oCAAoC,QAAQ;AACtE,YAAM,IAAI,eAAe,uCAAuC,eAAe;AAAA,IACjF;AAEA,UAAM,8BAA8B,uBAAuB,mCAAmC;AAAA,MAC5F,CAAC,cAAc,UAAU,OAAO;AAAA,IAClC;AAEA,QAAI,CAAC,6BAA6B,WAAW,UAAU,CAAC,6BAA6B,WAAW,MAAM;AACpG,YAAM,IAAI,eAAe,4BAA4B,mBAAmB;AAAA,IAC1E;AAEA,UAAM,EAAE,QAAQ,KAAK,IAAI,4BAA4B;AACrD,UAAM,oBAAoB,iBAAiB,KAAK,SAAS,GAAG,MAAM,MAAM;AACxE,WAAO;AAAA,MACL;AAAA,MACA;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,QAAI,iBAAiB,gBAAgB;AACnC,YAAM;AAAA,IACR;AACA,UAAM,IAAI,eAAe,mDAAmD,4BAA4B;AAAA,EAC1G;AACF;;;AC9KA,SAAS,oBAAoB;AAqE7B,eAAsB,0BAA0B,iBAAyB,SAA2C;AAClH,QAAM,WAAW,aAAa;AAAA,IAC5B,KAAK,QAAQ,sBAAsB,YAAY,EAAE,QAAQ,YAAY,IAAI,QAAQ,WAAW,UAAU;AAAA,EACxG,CAAC;AACD,QAAM,eAAe,SAAS,QAAgC;AAAA,IAC5D,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAsBP,WAAW,EAAE,gBAAgB;AAAA,EAC/B,CAAC;AACD,SAAO,QAAQ,KAAK;AAAA,IAClB,IAAI,QAAmB,CAAC,UAAU,WAAW;AAC3C,UAAI,QAAQ,SAAS;AACnB,mBAAW,MAAM;AACf,iBAAO,IAAI,MAAM,+BAA+B,CAAC;AAAA,QACnD,GAAG,QAAQ,OAAO;AAAA,MACpB;AAAA,IACF,CAAC;AAAA,KACA,YAAY;AACX,uBAAiB,UAAU,cAAc;AACvC,YAAI,QAAQ,MAAM,gBAAgB,SAAS;AACzC,iBAAO,OAAO,KAAK;AAAA,QACrB;AAAA,MACF;AAAA,IACF,GAAG;AAAA,EACL,CAAC;AACH;;;AFjBA,SAAS,oBAAoB;AAlFtB,IAAM,sBAAsB,EAAE,OAAO;AAAA,EAC1C,UAAU;AAAA,EACV,aAAa;AAAA,EACb,OAAO,EAAE,KAAK,CAAC,WAAW,eAAe,YAAY,YAAY,kBAAkB,QAAQ,CAAC,EAAE,SAAS;AACzG,CAAC;AAoDM,SAAS,mBACd,SACA,eAIA;AACA,eAAa;AACb,QAAM,mBAAmB,SAAS,qBAAqB,OAAO;AAC9D,QAAM,UAAU,gBAAuB;AACvC,QAAM,UAAU,IAAI,IAAI,iBAAiB,QAAQ,EAAE,SAAS;AAE5D,SAAO;AAAA,IACL,QAAQ,IAAI,cAAc,SAAS;AAAA,MACjC,GAAG;AAAA,MACH,SAAS,EAAE,GAAI,eAAe,WAAW,CAAC,GAAI,gBAAgB,iBAAiB,YAAY;AAAA,IAC7F,CAAC;AAAA,IACD;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@settlemint/sdk-portal",
   "description": "Portal API client module for SettleMint SDK, providing access to smart contract portal services and APIs",
-  "version": "2.2.0-prc00b96af",
+  "version": "2.2.0-prd03e197f",
   "type": "module",
   "private": false,
   "license": "FSL-1.1-MIT",
@@ -47,12 +47,16 @@
     "typecheck": "tsc --noEmit",
     "publish-npm": "bun publish --tag ${TAG} --access public || exit 0",
     "prepack": "cp ../../LICENSE .",
+    "codegen": "gql-tada generate-output",
     "docs": "typedoc --options '../../typedoc.config.mjs' --entryPoints src/portal.ts --out ./docs"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "viem": "^2"
+  },
   "dependencies": {
     "gql.tada": "^1",
-    "@settlemint/sdk-utils": "2.2.0-prc00b96af",
+    "graphql-ws": "^6",
+    "@settlemint/sdk-utils": "2.2.0-prd03e197f",
     "graphql-request": "^7",
     "zod": "^3"
   },