@settlemint/sdk-portal 2.5.14 → 2.6.0

package/README.md

@@ -38,6 +38,8 @@
     - [getWebsocketClient()](#getwebsocketclient)
     - [handleWalletVerificationChallenge()](#handlewalletverificationchallenge)
     - [waitForTransactionReceipt()](#waitfortransactionreceipt)
+  - [Classes](#classes)
+    - [WalletVerificationChallengeError](#walletverificationchallengeerror)
   - [Interfaces](#interfaces)
     - [HandleWalletVerificationChallengeOptions\<Setup\>](#handlewalletverificationchallengeoptionssetup)
     - [Transaction](#transaction)
@@ -48,6 +50,7 @@
   - [Type Aliases](#type-aliases)
     - [ClientOptions](#clientoptions)
     - [RequestConfig](#requestconfig)
+    - [WalletVerificationType](#walletverificationtype)
   - [Variables](#variables)
     - [ClientOptionsSchema](#clientoptionsschema)
 - [Contributing](#contributing)
@@ -112,7 +115,7 @@ const FROM = getAddress("0x4B03331cF2db1497ec58CAa4AFD8b93611906960");
 const deployForwarder = await portalClient.request(
   portalGraphql(`
     mutation DeployContractForwarder($from: String!) {
-      DeployContractForwarder(from: $from, gasLimit: "0x3d0900") {
+      DeployContractATKForwarder(from: $from, gasLimit: "0x3d0900") {
         transactionHash
       }
     }
@@ -125,18 +128,18 @@ const deployForwarder = await portalClient.request(
 /**
  * Wait for the forwarder contract deployment to be finalized
  */
-const transaction = await waitForTransactionReceipt(deployForwarder.DeployContractForwarder?.transactionHash!, {
+const transaction = await waitForTransactionReceipt(deployForwarder.DeployContractATKForwarder?.transactionHash!, {
   portalGraphqlEndpoint: env.SETTLEMINT_PORTAL_GRAPHQL_ENDPOINT!,
   accessToken: env.SETTLEMINT_ACCESS_TOKEN!,
 });
 
 /**
- * Deploy a stablecoin factory contract
+ * Deploy a stablecoin implementation contract
  */
-const deployStableCoinFactory = await portalClient.request(
+const deployStableCoinImplementation = await portalClient.request(
   portalGraphql(`
-    mutation DeployContractStableCoinFactory($from: String!, $constructorArguments: DeployContractStableCoinFactoryInput!) {
-      DeployContractStableCoinFactory(from: $from, constructorArguments: $constructorArguments, gasLimit: "0x3d0900") {
+    mutation DeployContractStableCoinFactory($from: String!, $constructorArguments: DeployContractATKStableCoinImplementationInput!) {
+      DeployContractATKStableCoinImplementation(from: $from, constructorArguments: $constructorArguments, gasLimit: "0x3d0900") {
         transactionHash
       }
     }
@@ -144,12 +147,12 @@ const deployStableCoinFactory = await portalClient.request(
   {
     from: FROM,
     constructorArguments: {
-      forwarder: getAddress(transaction?.receipt.contractAddress!),
+      forwarder_: getAddress(transaction?.receipt.contractAddress!),
     },
   },
 );
 
-console.log(deployStableCoinFactory?.DeployContractStableCoinFactory?.transactionHash);
+console.log(deployStableCoinImplementation?.DeployContractATKStableCoinImplementation?.transactionHash);
 
 const contractAddresses = await portalClient.request(
   portalGraphql(`
@@ -471,7 +474,7 @@ runMonitoringExample();
  */
 import { loadEnv } from "@settlemint/sdk-utils/environment";
 import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
-import type { Address } from "viem";
+import { getAddress } from "viem";
 import { createPortalClient } from "../portal.js"; // Replace this path with "@settlemint/sdk-portal"
 import { handleWalletVerificationChallenge } from "../utils/wallet-verification-challenge.js"; // Replace this path with "@settlemint/sdk-portal"
 import type { introspection } from "./schemas/portal-env.js"; // Replace this path with the generated introspection type
@@ -543,9 +546,9 @@ const challengeResponse = await handleWalletVerificationChallenge({
   portalClient,
   portalGraphql,
   verificationId: pincodeVerification.createWalletVerification?.id!,
-  userWalletAddress: wallet.createWallet?.address! as Address,
+  userWalletAddress: getAddress(wallet.createWallet?.address!),
   code: "123456",
-  verificationType: "pincode",
+  verificationType: "PINCODE",
 });
 
 /**
@@ -556,40 +559,49 @@ const challengeResponse = await handleWalletVerificationChallenge({
  */
 const result = await portalClient.request(
   portalGraphql(`
-    mutation StableCoinFactoryCreate(
-      $challengeResponse: String!
-      $verificationId: String
+    mutation CreateStableCoinMutation(
       $address: String!
       $from: String!
-      $input: StableCoinFactoryCreateInput!
+      $symbol: String!
+      $name: String!
+      $decimals: Int!
+      $initialModulePairs: [ATKStableCoinFactoryImplementationATKStableCoinFactoryImplementationCreateStableCoinInitialModulePairsInput!]!
+      $challengeId: String
+      $challengeResponse: String
+      $countryCode: Int!
     ) {
-      StableCoinFactoryCreate(
-        challengeResponse: $challengeResponse
-        verificationId: $verificationId
+      CreateStableCoin: ATKStableCoinFactoryImplementationCreateStableCoin(
         address: $address
         from: $from
-        input: $input
+        input: {
+          symbol_: $symbol
+          name_: $name
+          decimals_: $decimals
+          initialModulePairs_: $initialModulePairs
+          countryCode_: $countryCode
+        }
+        challengeId: $challengeId
+        challengeResponse: $challengeResponse
       ) {
         transactionHash
       }
     }
   `),
   {
-    challengeResponse: challengeResponse.challengeResponse,
-    verificationId: pincodeVerification.createWalletVerification?.id!,
     address: "0x5e771e1417100000000000000000000000000004",
     from: wallet.createWallet?.address!,
-    input: {
-      name: "Test Coin",
-      symbol: "TEST",
-      decimals: 18,
-      collateralLivenessSeconds: 3_600,
-    },
+    symbol: "TEST",
+    name: "Test Coin",
+    decimals: 18,
+    initialModulePairs: [],
+    challengeResponse: challengeResponse.challengeResponse,
+    challengeId: challengeResponse.challengeId,
+    countryCode: 56, // Example country code for BE
   },
 );
 
 // Log the transaction hash
-console.log("Transaction hash:", result.StableCoinFactoryCreate?.transactionHash);
+console.log("Transaction hash:", result.CreateStableCoin?.transactionHash);
 
 ```
 
@@ -601,7 +613,7 @@ console.log("Transaction hash:", result.StableCoinFactoryCreate?.transactionHash
 
 > **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
 
-Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L72)
+Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L72)
 
 Creates a Portal GraphQL client with the provided configuration.
 
@@ -629,8 +641,8 @@ An object containing the configured GraphQL client and graphql helper function
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L76) |
-| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L77) |
+| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L76) |
+| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L77) |
 
 ##### Throws
 
@@ -682,7 +694,7 @@ const result = await portalClient.request(query);
 
 > **getWebsocketClient**(`options`): `Client`
 
-Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/websocket-client.ts#L30)
+Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/websocket-client.ts#L30)
 
 Creates a GraphQL WebSocket client for the Portal API
 
@@ -713,9 +725,9 @@ const client = getWebsocketClient({
 
 #### handleWalletVerificationChallenge()
 
-> **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
+> **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeId`: `string`; `challengeResponse`: `string`; \}\>
 
-Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:103](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L103)
+Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:111](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L111)
 
 Handles a wallet verification challenge by generating an appropriate response
 
@@ -733,7 +745,7 @@ Handles a wallet verification challenge by generating an appropriate response
 
 ##### Returns
 
-`Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
+`Promise`\<\{ `challengeId`: `string`; `challengeResponse`: `string`; \}\>
 
 Promise resolving to an object containing the challenge response and optionally the verification ID
 
@@ -758,7 +770,7 @@ const result = await handleWalletVerificationChallenge({
   verificationId: "verification-123",
   userWalletAddress: "0x123...",
   code: "123456",
-  verificationType: "otp"
+  verificationType: "OTP"
 });
 ```
 
@@ -768,7 +780,7 @@ const result = await handleWalletVerificationChallenge({
 
 > **waitForTransactionReceipt**(`transactionHash`, `options`): `Promise`\<[`Transaction`](#transaction)\>
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L80)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L80)
 
 Waits for a blockchain transaction receipt by subscribing to transaction updates via GraphQL.
 This function polls until the transaction is confirmed or the timeout is reached.
@@ -802,11 +814,23 @@ const transaction = await waitForTransactionReceipt("0x123...", {
 });
 ```
 
+### Classes
+
+#### WalletVerificationChallengeError
+
+Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:14](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L14)
+
+Custom error class for challenge-related errors
+
+##### Extends
+
+- `Error`
+
 ### Interfaces
 
 #### HandleWalletVerificationChallengeOptions\<Setup\>
 
-Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:64](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L64)
+Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:70](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L70)
 
 Options for handling a wallet verification challenge
 
@@ -820,18 +844,19 @@ Options for handling a wallet verification challenge
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="code"></a> `code` | `string` \| `number` | The verification code provided by the user | [sdk/portal/src/utils/wallet-verification-challenge.ts:74](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L74) |
-| <a id="portalclient"></a> `portalClient` | `GraphQLClient` | The portal client instance | [sdk/portal/src/utils/wallet-verification-challenge.ts:66](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L66) |
-| <a id="portalgraphql"></a> `portalGraphql` | `initGraphQLTada`\<`Setup`\> | The GraphQL query builder | [sdk/portal/src/utils/wallet-verification-challenge.ts:68](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L68) |
-| <a id="userwalletaddress"></a> `userWalletAddress` | `` `0x${string}` `` | The wallet address to verify | [sdk/portal/src/utils/wallet-verification-challenge.ts:72](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L72) |
-| <a id="verificationid"></a> `verificationId` | `string` | The ID of the verification challenge | [sdk/portal/src/utils/wallet-verification-challenge.ts:70](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L70) |
-| <a id="verificationtype"></a> `verificationType` | `"otp"` \| `"secret-code"` \| `"pincode"` | The type of verification being performed | [sdk/portal/src/utils/wallet-verification-challenge.ts:76](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wallet-verification-challenge.ts#L76) |
+| <a id="code"></a> `code` | `string` \| `number` | The verification code provided by the user | [sdk/portal/src/utils/wallet-verification-challenge.ts:80](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L80) |
+| <a id="portalclient"></a> `portalClient` | `GraphQLClient` | The portal client instance | [sdk/portal/src/utils/wallet-verification-challenge.ts:72](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L72) |
+| <a id="portalgraphql"></a> `portalGraphql` | `initGraphQLTada`\<`Setup`\> | The GraphQL query builder | [sdk/portal/src/utils/wallet-verification-challenge.ts:74](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L74) |
+| <a id="requestid"></a> `requestId?` | `string` | Request id which can be added for tracing purposes | [sdk/portal/src/utils/wallet-verification-challenge.ts:84](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L84) |
+| <a id="userwalletaddress"></a> `userWalletAddress` | `` `0x${string}` `` | The wallet address to verify | [sdk/portal/src/utils/wallet-verification-challenge.ts:78](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L78) |
+| <a id="verificationid"></a> `verificationId` | `string` | The ID of the verification challenge | [sdk/portal/src/utils/wallet-verification-challenge.ts:76](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L76) |
+| <a id="verificationtype"></a> `verificationType` | [`WalletVerificationType`](#walletverificationtype) | The type of verification being performed | [sdk/portal/src/utils/wallet-verification-challenge.ts:82](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L82) |
 
 ***
 
 #### Transaction
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L34)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L34)
 
 Represents the structure of a blockchain transaction with its receipt
 
@@ -839,18 +864,18 @@ Represents the structure of a blockchain transaction with its receipt
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="address"></a> `address` | `string` | The contract address involved in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:43](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L43) |
-| <a id="createdat"></a> `createdAt` | `string` | Timestamp when the transaction was created | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:41](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L41) |
-| <a id="from"></a> `from` | `string` | The sender address (duplicate of receipt.from) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:39](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L39) |
-| <a id="functionname"></a> `functionName` | `string` | The name of the function called in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:45](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L45) |
-| <a id="iscontract"></a> `isContract` | `boolean` | Whether the transaction is a contract deployment | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:47](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L47) |
-| <a id="transactionhash"></a> `transactionHash` | `string` | The hash of the transaction (duplicate of receipt.transactionHash) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:37](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L37) |
+| <a id="address"></a> `address` | `string` | The contract address involved in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:43](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L43) |
+| <a id="createdat"></a> `createdAt` | `string` | Timestamp when the transaction was created | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:41](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L41) |
+| <a id="from"></a> `from` | `string` | The sender address (duplicate of receipt.from) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:39](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L39) |
+| <a id="functionname"></a> `functionName` | `string` | The name of the function called in the transaction | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:45](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L45) |
+| <a id="iscontract"></a> `isContract` | `boolean` | Whether the transaction is a contract deployment | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:47](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L47) |
+| <a id="transactionhash"></a> `transactionHash` | `string` | The hash of the transaction (duplicate of receipt.transactionHash) | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:37](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L37) |
 
 ***
 
 #### TransactionEvent
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:8](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L8)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:8](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L8)
 
 Represents an event emitted during a transaction execution
 
@@ -858,15 +883,15 @@ Represents an event emitted during a transaction execution
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="args"></a> `args` | `Record`\<`string`, `unknown`\> | The arguments emitted by the event | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:12](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L12) |
-| <a id="eventname"></a> `eventName` | `string` | The name of the event that was emitted | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:10](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L10) |
-| <a id="topics"></a> `topics` | `` `0x${string}` ``[] | Indexed event parameters used for filtering and searching | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:14](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L14) |
+| <a id="args"></a> `args` | `Record`\<`string`, `unknown`\> | The arguments emitted by the event | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:12](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L12) |
+| <a id="eventname"></a> `eventName` | `string` | The name of the event that was emitted | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:10](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L10) |
+| <a id="topics"></a> `topics` | `` `0x${string}` ``[] | Indexed event parameters used for filtering and searching | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:14](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L14) |
 
 ***
 
 #### TransactionReceipt
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:20](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L20)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:20](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L20)
 
 Represents the structure of a blockchain transaction receipt
 
@@ -878,16 +903,16 @@ Represents the structure of a blockchain transaction receipt
 
 | Property | Type | Description | Overrides | Defined in |
 | ------ | ------ | ------ | ------ | ------ |
-| <a id="contractaddress"></a> `contractAddress` | `` `0x${string}` `` | The address of the contract deployed in the transaction | `TransactionReceiptViem.contractAddress` | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:28](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L28) |
-| <a id="events"></a> `events` | [`TransactionEvent`](#transactionevent)[] | Array of events emitted during the transaction | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L26) |
-| <a id="revertreason"></a> `revertReason` | `string` | The raw reason for transaction reversion, if applicable | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:22](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L22) |
-| <a id="revertreasondecoded"></a> `revertReasonDecoded` | `string` | Human-readable version of the revert reason | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:24](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L24) |
+| <a id="contractaddress"></a> `contractAddress` | `` `0x${string}` `` | The address of the contract deployed in the transaction | `TransactionReceiptViem.contractAddress` | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:28](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L28) |
+| <a id="events"></a> `events` | [`TransactionEvent`](#transactionevent)[] | Array of events emitted during the transaction | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L26) |
+| <a id="revertreason"></a> `revertReason` | `string` | The raw reason for transaction reversion, if applicable | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:22](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L22) |
+| <a id="revertreasondecoded"></a> `revertReasonDecoded` | `string` | Human-readable version of the revert reason | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:24](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L24) |
 
 ***
 
 #### WaitForTransactionReceiptOptions
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L57)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:57](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L57)
 
 Options for waiting for a transaction receipt
 
@@ -899,15 +924,15 @@ Options for waiting for a transaction receipt
 
 | Property | Type | Description | Inherited from | Defined in |
 | ------ | ------ | ------ | ------ | ------ |
-| <a id="accesstoken"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`accessToken`](#accesstoken-1) | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/websocket-client.ts#L14) |
-| <a id="portalgraphqlendpoint"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`portalGraphqlEndpoint`](#portalgraphqlendpoint-1) | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/websocket-client.ts#L10) |
-| <a id="timeout"></a> `timeout?` | `number` | Optional timeout in milliseconds before the operation fails | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:59](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L59) |
+| <a id="accesstoken"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`accessToken`](#accesstoken-1) | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/websocket-client.ts#L14) |
+| <a id="portalgraphqlendpoint"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [`WebsocketClientOptions`](#websocketclientoptions).[`portalGraphqlEndpoint`](#portalgraphqlendpoint-1) | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/websocket-client.ts#L10) |
+| <a id="timeout"></a> `timeout?` | `number` | Optional timeout in milliseconds before the operation fails | - | [sdk/portal/src/utils/wait-for-transaction-receipt.ts:59](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L59) |
 
 ***
 
 #### WebsocketClientOptions
 
-Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/websocket-client.ts#L6)
+Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/websocket-client.ts#L6)
 
 Options for the GraphQL WebSocket client
 
@@ -919,8 +944,8 @@ Options for the GraphQL WebSocket client
 
 | Property | Type | Description | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="accesstoken-1"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/websocket-client.ts#L14) |
-| <a id="portalgraphqlendpoint-1"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/utils/websocket-client.ts#L10) |
+| <a id="accesstoken-1"></a> `accessToken?` | `string` | The access token for authentication with the Portal API | [sdk/portal/src/utils/websocket-client.ts:14](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/websocket-client.ts#L14) |
+| <a id="portalgraphqlendpoint-1"></a> `portalGraphqlEndpoint` | `string` | The GraphQL endpoint URL for the Portal API | [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/websocket-client.ts#L10) |
 
 ### Type Aliases
 
@@ -928,7 +953,7 @@ Options for the GraphQL WebSocket client
 
 > **ClientOptions** = `object`
 
-Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L25)
+Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L25)
 
 Type representing the validated client options.
 
@@ -936,9 +961,9 @@ Type representing the validated client options.
 
 | Name | Type | Default value | Defined in |
 | ------ | ------ | ------ | ------ |
-| <a id="accesstoken-2"></a> `accessToken?` | `string` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L18) |
-| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:19](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L19) |
-| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L17) |
+| <a id="accesstoken-2"></a> `accessToken?` | `string` | - | [sdk/portal/src/portal.ts:18](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L18) |
+| <a id="cache"></a> `cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - | [sdk/portal/src/portal.ts:19](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L19) |
+| <a id="instance"></a> `instance` | `string` | `UrlOrPathSchema` | [sdk/portal/src/portal.ts:17](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L17) |
 
 ***
 
@@ -946,17 +971,27 @@ Type representing the validated client options.
 
 > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
 
-Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L11)
+Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L11)
 
 Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
 
+***
+
+#### WalletVerificationType
+
+> **WalletVerificationType** = `"PINCODE"` \| `"OTP"` \| `"SECRET_CODES"`
+
+Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:9](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/utils/wallet-verification-challenge.ts#L9)
+
+Type representing the different types of wallet verification methods
+
 ### Variables
 
 #### ClientOptionsSchema
 
 > `const` **ClientOptionsSchema**: `ZodObject`\<[`ClientOptions`](#clientoptions)\>
 
-Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.5.14/sdk/portal/src/portal.ts#L16)
+Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.6.0/sdk/portal/src/portal.ts#L16)
 
 Schema for validating Portal client configuration options.
 

package/dist/browser/portal.d.ts

@@ -108,10 +108,14 @@ interface WaitForTransactionReceiptOptions extends WebsocketClientOptions {
 declare function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions): Promise<Transaction>;
 //#endregion
 //#region src/utils/wallet-verification-challenge.d.ts
+/**
+ * Type representing the different types of wallet verification methods
+ */
+type WalletVerificationType = "PINCODE" | "OTP" | "SECRET_CODES";
 /**
  * Custom error class for challenge-related errors
  */
-declare class ChallengeError extends Error {
+declare class WalletVerificationChallengeError extends Error {
   readonly code: string;
   constructor(message: string, code: string);
 }
@@ -130,14 +134,16 @@ interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSc
   /** The verification code provided by the user */
   code: string | number;
   /** The type of verification being performed */
-  verificationType: "otp" | "secret-code" | "pincode";
+  verificationType: WalletVerificationType;
+  /** Request id which can be added for tracing purposes */
+  requestId?: string;
 }
 /**
  * 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
+ * @throws {WalletVerificationChallengeError} If the challenge cannot be created or is invalid
  * @example
  * import { createPortalClient } from "@settlemint/sdk-portal";
  * import { handleWalletVerificationChallenge } from "@settlemint/sdk-portal";
@@ -153,7 +159,7 @@ interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSc
  *   verificationId: "verification-123",
  *   userWalletAddress: "0x123...",
  *   code: "123456",
- *   verificationType: "otp"
+ *   verificationType: "OTP"
  * });
  */
 declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({
@@ -162,10 +168,11 @@ declare function handleWalletVerificationChallenge<const Setup extends AbstractS
   verificationId,
   userWalletAddress,
   code,
-  verificationType
+  verificationType,
+  requestId
 }: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
   challengeResponse: string;
-  verificationId?: string;
+  challengeId: string;
 }>;
 //#endregion
 //#region src/portal.d.ts
@@ -242,5 +249,5 @@ declare function createPortalClient<const Setup extends AbstractSetupSchema>(opt
   graphql: initGraphQLTada<Setup>;
 };
 //#endregion
-export { ClientOptions, ClientOptionsSchema, type FragmentOf, type HandleWalletVerificationChallengeOptions, RequestConfig, type ResultOf, type Transaction, type TransactionEvent, type TransactionReceipt, type VariablesOf, type WaitForTransactionReceiptOptions, type WebsocketClientOptions, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, readFragment, waitForTransactionReceipt };
+export { ClientOptions, ClientOptionsSchema, type FragmentOf, type HandleWalletVerificationChallengeOptions, RequestConfig, type ResultOf, type Transaction, type TransactionEvent, type TransactionReceipt, type VariablesOf, type WaitForTransactionReceiptOptions, WalletVerificationChallengeError, type WalletVerificationType, type WebsocketClientOptions, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, readFragment, waitForTransactionReceipt };
 //# sourceMappingURL=portal.d.ts.map

package/dist/browser/portal.js

@@ -113,7 +113,7 @@ async function getTransactionFromSubscription(subscription) {
 /**
 * Custom error class for challenge-related errors
 */
-var ChallengeError = class extends Error {
+var WalletVerificationChallengeError = class extends Error {
 	code;
 	constructor(message, code) {
 		super(message);
@@ -146,7 +146,7 @@ function generateResponse(pincode, salt, challenge) {
 *
 * @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
+* @throws {WalletVerificationChallengeError} If the challenge cannot be created or is invalid
 * @example
 * import { createPortalClient } from "@settlemint/sdk-portal";
 * import { handleWalletVerificationChallenge } from "@settlemint/sdk-portal";
@@ -162,55 +162,65 @@ function generateResponse(pincode, salt, challenge) {
 *   verificationId: "verification-123",
 *   userWalletAddress: "0x123...",
 *   code: "123456",
-*   verificationType: "otp"
+*   verificationType: "OTP"
 * });
 */
-async function handleWalletVerificationChallenge({ portalClient, portalGraphql, verificationId, userWalletAddress, code, verificationType }) {
+async function handleWalletVerificationChallenge({ portalClient, portalGraphql, verificationId, userWalletAddress, code, verificationType, requestId }) {
 	try {
-		if (verificationType === "otp") {
-			return {
-				challengeResponse: code.toString(),
-				verificationId
-			};
+		const requestHeaders = new Headers();
+		if (requestId) {
+			requestHeaders.append("x-request-id", requestId);
 		}
-		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
+		const verificationChallenge = await portalClient.request(portalGraphql(`
+        mutation CreateWalletVerificationChallenge($userWalletAddress: String!, $verificationId: String!) {
+          createWalletVerificationChallenge(
+            userWalletAddress: $userWalletAddress
+            verificationId: $verificationId
+          ) {
             id
             name
+            verificationId
             verificationType
+            challenge {
+              salt
+              secret
+            }
           }
         }
       `), {
 			userWalletAddress,
 			verificationId
-		});
-		if (!verificationChallenges.createWalletVerificationChallenges?.length) {
-			throw new ChallengeError("No verification challenges received", "NO_CHALLENGES");
+		}, requestHeaders);
+		if (!verificationChallenge.createWalletVerificationChallenge) {
+			throw new WalletVerificationChallengeError("No verification challenge received", "NO_CHALLENGES");
+		}
+		if (verificationType === "OTP") {
+			return {
+				challengeResponse: code.toString(),
+				challengeId: verificationChallenge.createWalletVerificationChallenge.id
+			};
 		}
-		const walletVerificationChallenge = verificationChallenges.createWalletVerificationChallenges.find((challenge) => challenge.id === verificationId);
-		if (!walletVerificationChallenge?.challenge?.secret || !walletVerificationChallenge?.challenge?.salt) {
-			throw new ChallengeError("Invalid challenge format", "INVALID_CHALLENGE");
+		if (verificationType === "SECRET_CODES") {
+			const formattedCode = code.toString().replace(/(.{5})(?=.)/, "$1-");
+			return {
+				challengeResponse: formattedCode,
+				challengeId: verificationChallenge.createWalletVerificationChallenge.id
+			};
+		}
+		const { secret, salt } = verificationChallenge.createWalletVerificationChallenge.challenge ?? {};
+		if (!secret || !salt) {
+			throw new WalletVerificationChallengeError("Invalid challenge format", "INVALID_CHALLENGE");
 		}
-		const { secret, salt } = walletVerificationChallenge.challenge;
 		const challengeResponse = generateResponse(code.toString(), salt, secret);
 		return {
 			challengeResponse,
-			verificationId
+			challengeId: verificationChallenge.createWalletVerificationChallenge.id
 		};
 	} catch (error) {
-		if (error instanceof ChallengeError) {
+		if (error instanceof WalletVerificationChallengeError) {
 			throw error;
 		}
-		throw new ChallengeError("Failed to process wallet verification challenge", "CHALLENGE_PROCESSING_ERROR");
+		throw new WalletVerificationChallengeError("Failed to process wallet verification challenge", "CHALLENGE_PROCESSING_ERROR");
 	}
 }
 
@@ -291,5 +301,5 @@ function createPortalClient(options, clientOptions) {
 }
 
 //#endregion
-export { ClientOptionsSchema, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, readFragment, waitForTransactionReceipt };
+export { ClientOptionsSchema, WalletVerificationChallengeError, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, readFragment, waitForTransactionReceipt };
 //# sourceMappingURL=portal.js.map