@settlemint/sdk-portal 2.3.2 → 2.3.3

package/README.md

@@ -30,6 +30,7 @@
 - [Examples](#examples)
   - [Deploy contract](#deploy-contract)
   - [Get pending transactions](#get-pending-transactions)
+  - [Monitoring alerting](#monitoring-alerting)
   - [Send transaction using hd wallet](#send-transaction-using-hd-wallet)
 - [API Reference](#api-reference)
   - [Functions](#functions)
@@ -40,6 +41,8 @@
   - [Interfaces](#interfaces)
     - [HandleWalletVerificationChallengeOptions\<Setup\>](#handlewalletverificationchallengeoptionssetup)
     - [Transaction](#transaction)
+    - [TransactionEvent](#transactionevent)
+    - [TransactionReceipt](#transactionreceipt)
     - [WaitForTransactionReceiptOptions](#waitfortransactionreceiptoptions)
     - [WebsocketClientOptions](#websocketclientoptions)
   - [Type Aliases](#type-aliases)
@@ -219,6 +222,236 @@ const query = portalGraphql(`
 const result = await portalClient.request(query);
 console.log(`There are ${result.getPendingTransactions?.count} pending transactions`);
 
+```
+### Monitoring alerting
+
+```ts
+/**
+ * This example demonstrates how to implement real-time transaction monitoring and alerting.
+ *
+ * The process involves:
+ * 1. Creating a WebSocket subscription to monitor all blockchain transactions
+ * 2. Setting up custom handlers for different monitoring scenarios
+ * 3. Processing transactions in real-time as they are confirmed
+ * 4. Implementing specific monitoring functions for addresses, events, and failures
+ * 5. Triggering alerts based on predefined conditions
+ *
+ * This pattern is useful for applications that need to:
+ * - Detect suspicious activities for security purposes
+ * - Track high-value transfers or specific contract interactions
+ * - Monitor for failed transactions that require attention
+ * - Implement compliance reporting and audit trails
+ * - Build automated workflows that respond to on-chain events
+ * - Provide real-time notifications to stakeholders
+ */
+
+import type { FormattedExecutionResult } from "graphql";
+import { type Transaction, type WebsocketClientOptions, getWebsocketClient } from "../portal.js"; // Replace this path with "@settlemint/sdk-portal"
+
+/**
+ * Handlers for different monitoring scenarios
+ * You can implement your own handlers
+ */
+export type AlertHandlers = {
+  onAddressActivity: (transaction: Transaction, addresses: string[]) => void;
+  onEvent: (transaction: Transaction, eventNames: string[]) => void;
+  onFailure: (transaction: Transaction) => void;
+};
+
+/**
+ * Monitors all blockchain transactions by subscribing to transaction updates via GraphQL.
+ * This function continuously logs all transaction receipts as they are received.
+ *
+ * @param options - Configuration options for connecting to the Portal API
+ * @param handlers - Optional handlers for different monitoring scenarios
+ * @throws Error if the subscription fails
+ *
+ * @example
+ * import { monitorAllTransactions } from "@settlemint/sdk-portal";
+ *
+ * monitorAllTransactions({
+ *   portalGraphqlEndpoint: "https://example.settlemint.com/graphql",
+ *   accessToken: "your-access-token"
+ * }, {
+ *   onAddressActivity: (tx, address) => {
+ *     console.log(`Address ${address} was involved in transaction ${tx.transactionHash}`);
+ *   },
+ *   onEvent: (tx, eventName) => {
+ *     console.log(`Event ${eventName} detected in transaction ${tx.transactionHash}`);
+ *   },
+ *   onFailure: (tx, reason) => {
+ *     console.log(`Transaction ${tx.transactionHash} failed: ${reason}`);
+ *   }
+ * });
+ */
+export function monitorAllTransactions(options: WebsocketClientOptions, handlers: AlertHandlers) {
+  const wsClient = getWebsocketClient(options);
+
+  const subscription = wsClient.iterate<{
+    getProcessedTransactions: {
+      records: Transaction[];
+    };
+  }>({
+    query: `subscription getProcessedTransactions {
+      getProcessedTransactions(pageSize: 1) {
+        records {
+          receipt {
+            transactionHash
+            to
+            status
+            from
+            type
+            revertReason
+            revertReasonDecoded
+            logs
+            events
+            contractAddress
+          }
+          transactionHash
+          from
+          createdAt
+          address
+          functionName
+          isContract
+        }
+      }
+    }`,
+  });
+
+  // Start the monitoring process
+  processSubscription(subscription, handlers);
+
+  return subscription;
+}
+
+/**
+ * Internal helper to process the subscription stream
+ */
+async function processSubscription(
+  subscription: AsyncIterable<
+    FormattedExecutionResult<
+      {
+        getProcessedTransactions: {
+          records: Transaction[];
+        };
+      },
+      unknown
+    >
+  >,
+  handlers: AlertHandlers,
+) {
+  (async () => {
+    for await (const result of subscription) {
+      if (result?.data?.getProcessedTransactions?.records) {
+        const records = result.data.getProcessedTransactions.records;
+        const transaction = records.at(-1);
+
+        if (transaction) {
+          processTransaction(transaction, handlers);
+        }
+      }
+    }
+  })();
+}
+
+/**
+ * Process a single transaction with the configured handlers
+ */
+function processTransaction(transaction: Transaction, handlers: AlertHandlers) {
+  // Monitor specific addresses (example addresses)
+  handlers.onAddressActivity(transaction, ["0x742d35Cc6634C0532925a3b844Bc454e4438f44e"]);
+
+  // Monitor for specific events
+  handlers.onEvent(transaction, ["Transfer", "Approval"]);
+
+  // Monitor for failed transactions
+  handlers.onFailure(transaction);
+}
+
+/**
+ * Monitors transactions from or to specific addresses.
+ *
+ * @param transaction - The transaction to check
+ * @param addresses - The addresses to monitor
+ *
+ * @example
+ * import { monitorSpecificAddresses } from "@settlemint/sdk-portal";
+ *
+ * monitorSpecificAddresses(transaction, ["0x742d35Cc6634C0532925a3b844Bc454e4438f44e"]);
+ */
+export function monitorSpecificAddresses(transaction: Transaction, addresses: string[]) {
+  const { from, address } = transaction;
+  const { to } = transaction.receipt;
+  const isInvolved = addresses.some((address) => [from, to].includes(address));
+
+  if (isInvolved) {
+    notify(`[ADDRESS] Address ${address} was involved in transaction ${transaction.transactionHash}`);
+  }
+}
+
+/**
+ * Monitors transactions for specific contract events.
+ *
+ * @param transaction - The transaction to check
+ * @param eventNames - The event names to monitor
+ *
+ * @example
+ * import { monitorContractEvents } from "@settlemint/sdk-portal";
+ *
+ * monitorContractEvents(transaction, ["Transfer", "Approval"]);
+ */
+export function monitorContractEvents(transaction: Transaction, eventNames: string[]) {
+  const events = transaction.receipt.events;
+
+  const eventDetected = events.find((event) => eventNames.includes(event.eventName));
+  if (eventDetected) {
+    notify(`[EVENT] Event ${eventDetected.eventName} detected in transaction ${transaction.transactionHash}`);
+  }
+}
+
+/**
+ * Monitors for failed transactions that require attention.
+ *
+ * @param transaction - The transaction to check
+ *
+ * @example
+ * import { monitorFailedTransactions } from "@settlemint/sdk-portal";
+ *
+ * monitorFailedTransactions(transaction, "Unknown reason");
+ */
+export function monitorFailedTransactions(transaction: Transaction) {
+  const status = transaction.receipt?.status;
+
+  if (status === "Reverted") {
+    const reason = transaction.receipt.revertReasonDecoded;
+    notify(`[FAILED] Transaction ${transaction.transactionHash} failed: ${reason}`);
+  }
+}
+
+const notify = (message: string) => {
+  console.log(message);
+};
+
+/**
+ * Example usage - monitoring specific on-chain activity
+ */
+export function runMonitoringExample() {
+  // Basic usage
+  monitorAllTransactions(
+    {
+      portalGraphqlEndpoint: "https://example.settlemint.com/graphql",
+      accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!,
+    },
+    {
+      onAddressActivity: monitorSpecificAddresses,
+      onEvent: monitorContractEvents,
+      onFailure: monitorFailedTransactions,
+    },
+  );
+}
+
+runMonitoringExample();
+
 ```
 ### Send transaction using hd wallet
 
@@ -368,7 +601,7 @@ console.log("Transaction hash:", result.StableCoinFactoryCreate?.transactionHash
 
 > **createPortalClient**\<`Setup`\>(`options`, `clientOptions?`): `object`
 
-Defined in: [sdk/portal/src/portal.ts:71](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/portal.ts#L71)
+Defined in: [sdk/portal/src/portal.ts:72](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/portal.ts#L72)
 
 Creates a Portal GraphQL client with the provided configuration.
 
@@ -382,8 +615,8 @@ Creates a Portal GraphQL client with the provided configuration.
 
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
-| `options` | \{ `accessToken`: `string`; `cache?`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `instance`: `string`; \} | Configuration options for the Portal client |
-| `options.accessToken` | `string` | - |
+| `options` | \{ `accessToken?`: `string`; `cache?`: `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"`; `instance`: `string`; \} | Configuration options for the Portal client |
+| `options.accessToken?` | `string` | - |
 | `options.cache?` | `"default"` \| `"force-cache"` \| `"no-cache"` \| `"no-store"` \| `"only-if-cached"` \| `"reload"` | - |
 | `options.instance?` | `string` | - |
 | `clientOptions?` | `RequestConfig` | Additional GraphQL client configuration options |
@@ -396,8 +629,8 @@ An object containing the configured GraphQL client and graphql helper function
 
 | Name | Type | Defined in |
 | ------ | ------ | ------ |
-| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:75](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/portal.ts#L75) |
-| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/portal.ts#L76) |
+| `client` | `GraphQLClient` | [sdk/portal/src/portal.ts:76](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/portal.ts#L76) |
+| `graphql` | `initGraphQLTada`\<`Setup`\> | [sdk/portal/src/portal.ts:77](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/portal.ts#L77) |
 
 ##### Throws
 
@@ -449,7 +682,7 @@ const result = await portalClient.request(query);
 
 > **getWebsocketClient**(`options`): `Client`
 
-Defined in: [sdk/portal/src/utils/websocket-client.ts:23](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/utils/websocket-client.ts#L23)
+Defined in: [sdk/portal/src/utils/websocket-client.ts:30](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/utils/websocket-client.ts#L30)
 
 Creates a GraphQL WebSocket client for the Portal API
 
@@ -465,13 +698,24 @@ Creates a GraphQL WebSocket client for the Portal API
 
 The GraphQL WebSocket client
 
+##### Example
+
+```ts
+import { getWebsocketClient } from "@settlemint/sdk-portal";
+
+const client = getWebsocketClient({
+  portalGraphqlEndpoint: "https://portal.settlemint.com/graphql",
+  accessToken: "your-access-token",
+});
+```
+
 ***
 
 #### handleWalletVerificationChallenge()
 
 > **handleWalletVerificationChallenge**\<`Setup`\>(`options`): `Promise`\<\{ `challengeResponse`: `string`; `verificationId?`: `string`; \}\>
 
-Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:106](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/utils/wallet-verification-challenge.ts#L106)
+Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:103](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L103)
 
 Handles a wallet verification challenge by generating an appropriate response
 
@@ -524,7 +768,7 @@ const result = await handleWalletVerificationChallenge({
 
 > **waitForTransactionReceipt**(`transactionHash`, `options`): `Promise`\<[`Transaction`](#transaction)\>
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:79](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L79)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:80](https://github.com/settlemint/sdk/blob/v2.3.3/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.
@@ -562,29 +806,88 @@ const transaction = await waitForTransactionReceipt("0x123...", {
 
 #### HandleWalletVerificationChallengeOptions\<Setup\>
 
-Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:73](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/utils/wallet-verification-challenge.ts#L73)
+Defined in: [sdk/portal/src/utils/wallet-verification-challenge.ts:64](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L64)
 
 Options for handling a wallet verification challenge
 
 ##### Type Parameters
 
-| Type Parameter | Description |
-| ------ | ------ |
-| `Setup` *extends* `AbstractSetupSchema` | The GraphQL schema setup type |
+| Type Parameter |
+| ------ |
+| `Setup` *extends* `AbstractSetupSchema` |
+
+##### Properties
+
+| 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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/sdk/portal/src/utils/wallet-verification-challenge.ts#L76) |
 
 ***
 
 #### Transaction
 
-Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:26](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L26)
+Defined in: [sdk/portal/src/utils/wait-for-transaction-receipt.ts:34](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L34)
 
 Represents the structure of a blockchain transaction with its receipt
 
+##### Properties
+
+| 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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/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.3.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L8)
+
+Represents an event emitted during a transaction execution
+
+##### Properties
+
+| 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.3.3/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.3.3/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.3.3/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.3.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L20)
+
+Represents the structure of a blockchain transaction receipt
+
+##### Extends
+
+- `TransactionReceipt`\<`string`, `number`, `"Success"` \| `"Reverted"`\>
+
+##### Properties
+
+| 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.3.3/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.3.3/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.3.3/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.3.3/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.3.2/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.3.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L57)
 
 Options for waiting for a transaction receipt
 
@@ -592,11 +895,19 @@ Options for waiting for a transaction receipt
 
 - [`WebsocketClientOptions`](#websocketclientoptions)
 
+##### Properties
+
+| 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.3.3/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.3.3/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.3.3/sdk/portal/src/utils/wait-for-transaction-receipt.ts#L59) |
+
 ***
 
 #### WebsocketClientOptions
 
-Defined in: [sdk/portal/src/utils/websocket-client.ts:10](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/utils/websocket-client.ts#L10)
+Defined in: [sdk/portal/src/utils/websocket-client.ts:6](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/utils/websocket-client.ts#L6)
 
 Options for the GraphQL WebSocket client
 
@@ -604,13 +915,20 @@ Options for the GraphQL WebSocket client
 
 - [`WaitForTransactionReceiptOptions`](#waitfortransactionreceiptoptions)
 
+##### Properties
+
+| 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.3.3/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.3.3/sdk/portal/src/utils/websocket-client.ts#L10) |
+
 ### Type Aliases
 
 #### ClientOptions
 
 > **ClientOptions** = `z.infer`\<*typeof* [`ClientOptionsSchema`](#clientoptionsschema)\>
 
-Defined in: [sdk/portal/src/portal.ts:24](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/portal.ts#L24)
+Defined in: [sdk/portal/src/portal.ts:25](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/portal.ts#L25)
 
 Type representing the validated client options.
 
@@ -620,7 +938,7 @@ Type representing the validated client options.
 
 > **RequestConfig** = `ConstructorParameters`\<*typeof* `GraphQLClient`\>\[`1`\]
 
-Defined in: [sdk/portal/src/portal.ts:10](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/portal.ts#L10)
+Defined in: [sdk/portal/src/portal.ts:11](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/portal.ts#L11)
 
 Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
 
@@ -628,9 +946,9 @@ Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
 
 #### ClientOptionsSchema
 
-> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodString`; `cache`: `ZodOptional`\<`ZodEnum`\<\{ `default`: `"default"`; `force-cache`: `"force-cache"`; `no-cache`: `"no-cache"`; `no-store`: `"no-store"`; `only-if-cached`: `"only-if-cached"`; `reload`: `"reload"`; \}\>\>; `instance`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
+> `const` **ClientOptionsSchema**: `ZodObject`\<\{ `accessToken`: `ZodOptional`\<`ZodString`\>; `cache`: `ZodOptional`\<`ZodEnum`\<\{ `default`: `"default"`; `force-cache`: `"force-cache"`; `no-cache`: `"no-cache"`; `no-store`: `"no-store"`; `only-if-cached`: `"only-if-cached"`; `reload`: `"reload"`; \}\>\>; `instance`: `ZodUnion`\<readonly \[`ZodString`, `ZodString`\]\>; \}, `$strip`\>
 
-Defined in: [sdk/portal/src/portal.ts:15](https://github.com/settlemint/sdk/blob/v2.3.2/sdk/portal/src/portal.ts#L15)
+Defined in: [sdk/portal/src/portal.ts:16](https://github.com/settlemint/sdk/blob/v2.3.3/sdk/portal/src/portal.ts#L16)
 
 Schema for validating Portal client configuration options.