@settlemint/sdk-portal 2.3.2-pr3dad35bd → 2.3.2-pr472d8b55

package/dist/portal.d.cts

@@ -1,22 +1,25 @@
-import { AbstractSetupSchema, initGraphQLTada } from 'gql.tada';
-export { FragmentOf, ResultOf, VariablesOf, readFragment } from 'gql.tada';
-import { GraphQLClient } from 'graphql-request';
-import { z } from 'zod/v4';
-import { TransactionReceipt as TransactionReceipt$1, Hex, Address } from 'viem';
-import * as graphql_ws from 'graphql-ws';
+import { AbstractSetupSchema, FragmentOf, ResultOf, VariablesOf, initGraphQLTada, readFragment } from "gql.tada";
+import { GraphQLClient } from "graphql-request";
+import { z } from "zod/v4";
+import { Address, Hex, TransactionReceipt as TransactionReceipt$1 } from "viem";
+import * as graphql_ws0 from "graphql-ws";
 
+//#region src/utils/websocket-client.d.ts
+/**
+* Options for the GraphQL WebSocket client
+*/
 /**
  * Options for the GraphQL WebSocket client
  */
 interface WebsocketClientOptions {
-    /**
-     * The GraphQL endpoint URL for the Portal API
-     */
-    portalGraphqlEndpoint: string;
-    /**
-     * The access token for authentication with the Portal API
-     */
-    accessToken?: string;
+  /**
+   * The GraphQL endpoint URL for the Portal API
+   */
+  portalGraphqlEndpoint: string;
+  /**
+   * The access token for authentication with the Portal API
+   */
+  accessToken?: string;
 }
 /**
  * Creates a GraphQL WebSocket client for the Portal API
@@ -31,56 +34,61 @@ interface WebsocketClientOptions {
  *   accessToken: "your-access-token",
  * });
  */
-declare function getWebsocketClient({ portalGraphqlEndpoint, accessToken }: WebsocketClientOptions): graphql_ws.Client;
+declare function getWebsocketClient({
+  portalGraphqlEndpoint,
+  accessToken
+}: WebsocketClientOptions): graphql_ws0.Client;
 
+//#endregion
+//#region src/utils/wait-for-transaction-receipt.d.ts
 /**
  * Represents an event emitted during a transaction execution
  */
 interface TransactionEvent {
-    /** The name of the event that was emitted */
-    eventName: string;
-    /** The arguments emitted by the event */
-    args: Record<string, unknown>;
-    /** Indexed event parameters used for filtering and searching */
-    topics: Hex[];
+  /** The name of the event that was emitted */
+  eventName: string;
+  /** The arguments emitted by the event */
+  args: Record<string, unknown>;
+  /** Indexed event parameters used for filtering and searching */
+  topics: Hex[];
 }
 /**
  * Represents the structure of a blockchain transaction receipt
  */
 interface TransactionReceipt extends TransactionReceipt$1<string, number, "Success" | "Reverted"> {
-    /** The raw reason for transaction reversion, if applicable */
-    revertReason: string;
-    /** Human-readable version of the revert reason */
-    revertReasonDecoded: string;
-    /** Array of events emitted during the transaction */
-    events: TransactionEvent[];
-    /** The address of the contract deployed in the transaction */
-    contractAddress: Address;
+  /** The raw reason for transaction reversion, if applicable */
+  revertReason: string;
+  /** Human-readable version of the revert reason */
+  revertReasonDecoded: string;
+  /** Array of events emitted during the transaction */
+  events: TransactionEvent[];
+  /** The address of the contract deployed in the transaction */
+  contractAddress: Address;
 }
 /**
  * Represents the structure of a blockchain transaction with its receipt
  */
 interface Transaction {
-    receipt: TransactionReceipt;
-    /** The hash of the transaction (duplicate of receipt.transactionHash) */
-    transactionHash: string;
-    /** The sender address (duplicate of receipt.from) */
-    from: string;
-    /** Timestamp when the transaction was created */
-    createdAt: string;
-    /** The contract address involved in the transaction */
-    address: string;
-    /** The name of the function called in the transaction */
-    functionName: string;
-    /** Whether the transaction is a contract deployment */
-    isContract: boolean;
+  receipt: TransactionReceipt;
+  /** The hash of the transaction (duplicate of receipt.transactionHash) */
+  transactionHash: string;
+  /** The sender address (duplicate of receipt.from) */
+  from: string;
+  /** Timestamp when the transaction was created */
+  createdAt: string;
+  /** The contract address involved in the transaction */
+  address: string;
+  /** The name of the function called in the transaction */
+  functionName: string;
+  /** Whether the transaction is a contract deployment */
+  isContract: boolean;
 }
 /**
  * Options for waiting for a transaction receipt
  */
 interface WaitForTransactionReceiptOptions extends WebsocketClientOptions {
-    /** Optional timeout in milliseconds before the operation fails */
-    timeout?: number;
+  /** Optional timeout in milliseconds before the operation fails */
+  timeout?: number;
 }
 /**
  * Waits for a blockchain transaction receipt by subscribing to transaction updates via GraphQL.
@@ -102,22 +110,31 @@ interface WaitForTransactionReceiptOptions extends WebsocketClientOptions {
  */
 declare function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions): Promise<Transaction>;
 
+//#endregion
+//#region src/utils/wallet-verification-challenge.d.ts
+/**
+ * Custom error class for challenge-related errors
+ */
+declare class ChallengeError extends Error {
+  readonly code: string;
+  constructor(message: string, code: string);
+}
 /**
  * Options for handling a wallet verification challenge
  */
 interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSchema> {
-    /** The portal client instance */
-    portalClient: GraphQLClient;
-    /** The GraphQL query builder */
-    portalGraphql: initGraphQLTada<Setup>;
-    /** The ID of the verification challenge */
-    verificationId: string;
-    /** The wallet address to verify */
-    userWalletAddress: Address;
-    /** The verification code provided by the user */
-    code: string | number;
-    /** The type of verification being performed */
-    verificationType: "otp" | "secret-code" | "pincode";
+  /** The portal client instance */
+  portalClient: GraphQLClient;
+  /** The GraphQL query builder */
+  portalGraphql: initGraphQLTada<Setup>;
+  /** The ID of the verification challenge */
+  verificationId: string;
+  /** The wallet address to verify */
+  userWalletAddress: Address;
+  /** The verification code provided by the user */
+  code: string | number;
+  /** The type of verification being performed */
+  verificationType: "otp" | "secret-code" | "pincode";
 }
 /**
  * Handles a wallet verification challenge by generating an appropriate response
@@ -143,11 +160,20 @@ interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSc
  *   verificationType: "otp"
  * });
  */
-declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({ portalClient, portalGraphql, verificationId, userWalletAddress, code, verificationType, }: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
-    challengeResponse: string;
-    verificationId?: string;
+declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({
+  portalClient,
+  portalGraphql,
+  verificationId,
+  userWalletAddress,
+  code,
+  verificationType
+}: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
+  challengeResponse: string;
+  verificationId?: string;
 }>;
 
+//#endregion
+//#region src/portal.d.ts
 /**
  * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
  */
@@ -156,16 +182,16 @@ type RequestConfig = ConstructorParameters<typeof GraphQLClient>[1];
  * Schema for validating Portal client configuration options.
  */
 declare const ClientOptionsSchema: z.ZodObject<{
-    instance: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
-    accessToken: z.ZodOptional<z.ZodString>;
-    cache: z.ZodOptional<z.ZodEnum<{
-        default: "default";
-        "force-cache": "force-cache";
-        "no-cache": "no-cache";
-        "no-store": "no-store";
-        "only-if-cached": "only-if-cached";
-        reload: "reload";
-    }>>;
+  instance: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+  accessToken: z.ZodOptional<z.ZodString>;
+  cache: z.ZodOptional<z.ZodEnum<{
+    default: "default";
+    "force-cache": "force-cache";
+    "no-cache": "no-cache";
+    "no-store": "no-store";
+    "only-if-cached": "only-if-cached";
+    reload: "reload";
+  }>>;
 }, z.core.$strip>;
 /**
  * Type representing the validated client options.
@@ -217,8 +243,10 @@ type ClientOptions = z.infer<typeof ClientOptionsSchema>;
  * const result = await portalClient.request(query);
  */
 declare function createPortalClient<const Setup extends AbstractSetupSchema>(options: ClientOptions, clientOptions?: RequestConfig): {
-    client: GraphQLClient;
-    graphql: initGraphQLTada<Setup>;
+  client: GraphQLClient;
+  graphql: initGraphQLTada<Setup>;
 };
 
-export { type ClientOptions, ClientOptionsSchema, type HandleWalletVerificationChallengeOptions, type RequestConfig, type Transaction, type TransactionEvent, type TransactionReceipt, type WaitForTransactionReceiptOptions, type WebsocketClientOptions, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, waitForTransactionReceipt };
+//#endregion
+export { ClientOptions, ClientOptionsSchema, FragmentOf, HandleWalletVerificationChallengeOptions, RequestConfig, ResultOf, Transaction, TransactionEvent, TransactionReceipt, VariablesOf, WaitForTransactionReceiptOptions, WebsocketClientOptions, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, readFragment, waitForTransactionReceipt };
+//# sourceMappingURL=portal.d.cts.map

package/dist/portal.d.ts

@@ -1,22 +1,25 @@
-import { AbstractSetupSchema, initGraphQLTada } from 'gql.tada';
-export { FragmentOf, ResultOf, VariablesOf, readFragment } from 'gql.tada';
-import { GraphQLClient } from 'graphql-request';
-import { z } from 'zod/v4';
-import { TransactionReceipt as TransactionReceipt$1, Hex, Address } from 'viem';
-import * as graphql_ws from 'graphql-ws';
+import { AbstractSetupSchema, FragmentOf, ResultOf, VariablesOf, initGraphQLTada, readFragment } from "gql.tada";
+import { GraphQLClient } from "graphql-request";
+import { z } from "zod/v4";
+import * as graphql_ws0 from "graphql-ws";
+import { Address, Hex, TransactionReceipt as TransactionReceipt$1 } from "viem";
 
+//#region src/utils/websocket-client.d.ts
+/**
+* Options for the GraphQL WebSocket client
+*/
 /**
  * Options for the GraphQL WebSocket client
  */
 interface WebsocketClientOptions {
-    /**
-     * The GraphQL endpoint URL for the Portal API
-     */
-    portalGraphqlEndpoint: string;
-    /**
-     * The access token for authentication with the Portal API
-     */
-    accessToken?: string;
+  /**
+   * The GraphQL endpoint URL for the Portal API
+   */
+  portalGraphqlEndpoint: string;
+  /**
+   * The access token for authentication with the Portal API
+   */
+  accessToken?: string;
 }
 /**
  * Creates a GraphQL WebSocket client for the Portal API
@@ -31,56 +34,61 @@ interface WebsocketClientOptions {
  *   accessToken: "your-access-token",
  * });
  */
-declare function getWebsocketClient({ portalGraphqlEndpoint, accessToken }: WebsocketClientOptions): graphql_ws.Client;
+declare function getWebsocketClient({
+  portalGraphqlEndpoint,
+  accessToken
+}: WebsocketClientOptions): graphql_ws0.Client;
 
+//#endregion
+//#region src/utils/wait-for-transaction-receipt.d.ts
 /**
  * Represents an event emitted during a transaction execution
  */
 interface TransactionEvent {
-    /** The name of the event that was emitted */
-    eventName: string;
-    /** The arguments emitted by the event */
-    args: Record<string, unknown>;
-    /** Indexed event parameters used for filtering and searching */
-    topics: Hex[];
+  /** The name of the event that was emitted */
+  eventName: string;
+  /** The arguments emitted by the event */
+  args: Record<string, unknown>;
+  /** Indexed event parameters used for filtering and searching */
+  topics: Hex[];
 }
 /**
  * Represents the structure of a blockchain transaction receipt
  */
 interface TransactionReceipt extends TransactionReceipt$1<string, number, "Success" | "Reverted"> {
-    /** The raw reason for transaction reversion, if applicable */
-    revertReason: string;
-    /** Human-readable version of the revert reason */
-    revertReasonDecoded: string;
-    /** Array of events emitted during the transaction */
-    events: TransactionEvent[];
-    /** The address of the contract deployed in the transaction */
-    contractAddress: Address;
+  /** The raw reason for transaction reversion, if applicable */
+  revertReason: string;
+  /** Human-readable version of the revert reason */
+  revertReasonDecoded: string;
+  /** Array of events emitted during the transaction */
+  events: TransactionEvent[];
+  /** The address of the contract deployed in the transaction */
+  contractAddress: Address;
 }
 /**
  * Represents the structure of a blockchain transaction with its receipt
  */
 interface Transaction {
-    receipt: TransactionReceipt;
-    /** The hash of the transaction (duplicate of receipt.transactionHash) */
-    transactionHash: string;
-    /** The sender address (duplicate of receipt.from) */
-    from: string;
-    /** Timestamp when the transaction was created */
-    createdAt: string;
-    /** The contract address involved in the transaction */
-    address: string;
-    /** The name of the function called in the transaction */
-    functionName: string;
-    /** Whether the transaction is a contract deployment */
-    isContract: boolean;
+  receipt: TransactionReceipt;
+  /** The hash of the transaction (duplicate of receipt.transactionHash) */
+  transactionHash: string;
+  /** The sender address (duplicate of receipt.from) */
+  from: string;
+  /** Timestamp when the transaction was created */
+  createdAt: string;
+  /** The contract address involved in the transaction */
+  address: string;
+  /** The name of the function called in the transaction */
+  functionName: string;
+  /** Whether the transaction is a contract deployment */
+  isContract: boolean;
 }
 /**
  * Options for waiting for a transaction receipt
  */
 interface WaitForTransactionReceiptOptions extends WebsocketClientOptions {
-    /** Optional timeout in milliseconds before the operation fails */
-    timeout?: number;
+  /** Optional timeout in milliseconds before the operation fails */
+  timeout?: number;
 }
 /**
  * Waits for a blockchain transaction receipt by subscribing to transaction updates via GraphQL.
@@ -102,22 +110,31 @@ interface WaitForTransactionReceiptOptions extends WebsocketClientOptions {
  */
 declare function waitForTransactionReceipt(transactionHash: string, options: WaitForTransactionReceiptOptions): Promise<Transaction>;
 
+//#endregion
+//#region src/utils/wallet-verification-challenge.d.ts
+/**
+ * Custom error class for challenge-related errors
+ */
+declare class ChallengeError extends Error {
+  readonly code: string;
+  constructor(message: string, code: string);
+}
 /**
  * Options for handling a wallet verification challenge
  */
 interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSchema> {
-    /** The portal client instance */
-    portalClient: GraphQLClient;
-    /** The GraphQL query builder */
-    portalGraphql: initGraphQLTada<Setup>;
-    /** The ID of the verification challenge */
-    verificationId: string;
-    /** The wallet address to verify */
-    userWalletAddress: Address;
-    /** The verification code provided by the user */
-    code: string | number;
-    /** The type of verification being performed */
-    verificationType: "otp" | "secret-code" | "pincode";
+  /** The portal client instance */
+  portalClient: GraphQLClient;
+  /** The GraphQL query builder */
+  portalGraphql: initGraphQLTada<Setup>;
+  /** The ID of the verification challenge */
+  verificationId: string;
+  /** The wallet address to verify */
+  userWalletAddress: Address;
+  /** The verification code provided by the user */
+  code: string | number;
+  /** The type of verification being performed */
+  verificationType: "otp" | "secret-code" | "pincode";
 }
 /**
  * Handles a wallet verification challenge by generating an appropriate response
@@ -143,11 +160,20 @@ interface HandleWalletVerificationChallengeOptions<Setup extends AbstractSetupSc
  *   verificationType: "otp"
  * });
  */
-declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({ portalClient, portalGraphql, verificationId, userWalletAddress, code, verificationType, }: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
-    challengeResponse: string;
-    verificationId?: string;
+declare function handleWalletVerificationChallenge<const Setup extends AbstractSetupSchema>({
+  portalClient,
+  portalGraphql,
+  verificationId,
+  userWalletAddress,
+  code,
+  verificationType
+}: HandleWalletVerificationChallengeOptions<Setup>): Promise<{
+  challengeResponse: string;
+  verificationId?: string;
 }>;
 
+//#endregion
+//#region src/portal.d.ts
 /**
  * Configuration options for the GraphQL client, excluding 'url' and 'exchanges'.
  */
@@ -156,16 +182,16 @@ type RequestConfig = ConstructorParameters<typeof GraphQLClient>[1];
  * Schema for validating Portal client configuration options.
  */
 declare const ClientOptionsSchema: z.ZodObject<{
-    instance: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
-    accessToken: z.ZodOptional<z.ZodString>;
-    cache: z.ZodOptional<z.ZodEnum<{
-        default: "default";
-        "force-cache": "force-cache";
-        "no-cache": "no-cache";
-        "no-store": "no-store";
-        "only-if-cached": "only-if-cached";
-        reload: "reload";
-    }>>;
+  instance: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
+  accessToken: z.ZodOptional<z.ZodString>;
+  cache: z.ZodOptional<z.ZodEnum<{
+    default: "default";
+    "force-cache": "force-cache";
+    "no-cache": "no-cache";
+    "no-store": "no-store";
+    "only-if-cached": "only-if-cached";
+    reload: "reload";
+  }>>;
 }, z.core.$strip>;
 /**
  * Type representing the validated client options.
@@ -217,8 +243,10 @@ type ClientOptions = z.infer<typeof ClientOptionsSchema>;
  * const result = await portalClient.request(query);
  */
 declare function createPortalClient<const Setup extends AbstractSetupSchema>(options: ClientOptions, clientOptions?: RequestConfig): {
-    client: GraphQLClient;
-    graphql: initGraphQLTada<Setup>;
+  client: GraphQLClient;
+  graphql: initGraphQLTada<Setup>;
 };
 
-export { type ClientOptions, ClientOptionsSchema, type HandleWalletVerificationChallengeOptions, type RequestConfig, type Transaction, type TransactionEvent, type TransactionReceipt, type WaitForTransactionReceiptOptions, type WebsocketClientOptions, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, waitForTransactionReceipt };
+//#endregion
+export { ClientOptions, ClientOptionsSchema, FragmentOf, HandleWalletVerificationChallengeOptions, RequestConfig, ResultOf, Transaction, TransactionEvent, TransactionReceipt, VariablesOf, WaitForTransactionReceiptOptions, WebsocketClientOptions, createPortalClient, getWebsocketClient, handleWalletVerificationChallenge, readFragment, waitForTransactionReceipt };
+//# sourceMappingURL=portal.d.ts.map