@crossmint/wallets-sdk 1.0.0 → 1.0.2

package/dist/types-DfT-EHk3.d.cts

@@ -0,0 +1,428 @@
+import { TypedDataDefinition, TypedData, Address } from 'viem';
+import { CreateWalletV2025Dto, WalletV2025ResponseDto, WalletV1Alpha2ErrorDto, CreateTransactionV2025Dto, WalletsTransactionV2025ResponseDto, WalletV1Alpha2TransactionErrorDto, SubmitApprovalV2025Dto, WalletsV2025ControllerSubmitApprovals2Error, WalletsV2025ControllerGetTransaction2Error, CreateSignatureV2025Dto, WalletsSignatureV2025ResponseDto, WalletsV2025ControllerCreateSignatureRequest2Error, WalletsV2025ControllerSubmitSignatureApprovals2Error, WalletsV2025ControllerGetSignature2Error, WalletsMultipleTransactionV2025ResponseDto, WalletsV2025ControllerGetTransactionsWithoutChain2Error, WalletsActivityResponseUnstableDto, WalletBalanceV20250609ResponseDto, BalanceControllerGetBalanceForLocator2Error, FundWalletAmountDto, BalanceControllerFundWallet2Responses, BalanceControllerFundWallet2Error, CreateSignerV2025InputDto, DelegatedSignerV2025Dto, WalletsV2025ControllerCreateDelegatedSigner2Error, WalletsV2025ControllerGetDelegatedSigner2Error, SendTokenDto, WalletsSendTokenControllerSendToken2Response } from './api/gen/types.gen.cjs';
+import { WebAuthnP256 } from 'ox';
+import { HandshakeParent } from '@crossmint/client-sdk-window';
+import { signerOutboundEvents, signerInboundEvents, exportSignerOutboundEvents, exportSignerInboundEvents } from '@crossmint/client-signers';
+import { SolanaExternalWalletSignerConfig, StellarExternalWalletSignerConfig, EvmExternalWalletSignerConfig, Crossmint } from '@crossmint/common-sdk-base';
+import { Chain, StellarChain, EVMSmartWalletChain, SolanaChain } from './chains/chains.cjs';
+import { VersionedTransaction, Keypair } from '@solana/web3.js';
+import { Abi } from 'abitype';
+import { DeviceSignerKeyStorage } from './utils/device-signers/DeviceSignerKeyStorage.cjs';
+
+type PrepareOnly<T extends boolean = boolean> = {
+    prepareOnly: T;
+};
+type SendTokenTransactionType = "onramp" | "regulated-transfer" | "direct";
+type TransactionInputOptions = PrepareOnly & {
+    signer?: string | ServerSignerConfig;
+};
+type SendTokenTransactionOptions = TransactionInputOptions & {
+    transactionType?: SendTokenTransactionType;
+};
+type SignatureInputOptions = PrepareOnly;
+type AddSignerOptions = PrepareOnly;
+type AddSignerReturnType<C extends Chain> = C extends "solana" | "stellar" ? Signer$1 & {
+    transactionId: string;
+} : Signer$1 & {
+    signatureId?: string;
+};
+type SignMessageInput = {
+    message: string;
+    options?: SignatureInputOptions;
+};
+type SignTypedDataInput = TypedDataDefinition<TypedData, string> & {
+    chain: EVMSmartWalletChain;
+    options?: SignatureInputOptions;
+};
+type ApproveResult<T extends ApproveParams> = T extends {
+    transactionId: string;
+} ? Transaction<false> : T extends {
+    signatureId: string;
+} ? Signature<false> : Error;
+type EVMTransactionInputBase = {
+    options?: TransactionInputOptions;
+};
+type EVMTransactionInput = EVMTransactionInputBase & ({
+    to: string;
+    functionName?: string;
+    args?: unknown[];
+    value?: bigint;
+    abi?: Abi;
+    data?: `0x${string}`;
+} | {
+    transaction: string;
+});
+type StellarTransactionInput = ({
+    contractId: string;
+    method: string;
+    memo?: string;
+    args: Record<string, unknown>;
+} | {
+    transaction: string;
+    contractId: string;
+}) & {
+    options?: TransactionInputOptions;
+};
+type SolanaTransactionInput = ({
+    transaction: VersionedTransaction;
+} | {
+    serializedTransaction: string;
+}) & {
+    additionalSigners?: Keypair[];
+    options?: TransactionInputOptions;
+};
+type FormattedEVMTransaction = {
+    to: string;
+    value: string;
+    data: string;
+} | {
+    transaction: string;
+};
+type SignerStatus = "success" | "pending" | "awaiting-approval" | "failed";
+type SignerInput = {
+    signer: string | ServerSignerConfig;
+};
+type Signer$1 = {
+    type: "passkey";
+    id: string;
+    name: string;
+    publicKey: {
+        x: string;
+        y: string;
+    };
+    validatorContractVersion: string;
+    locator: string;
+    status: SignerStatus;
+} | {
+    type: "api-key";
+    address: string;
+    locator: string;
+    status: SignerStatus;
+} | {
+    type: "external-wallet";
+    address: string;
+    locator: string;
+    status: SignerStatus;
+} | {
+    type: "email";
+    email: string;
+    address: string;
+    locator: string;
+    status: SignerStatus;
+} | {
+    type: "phone";
+    phone: string;
+    address: string;
+    locator: string;
+    status: SignerStatus;
+} | {
+    type: "device";
+    publicKey: {
+        x: string;
+        y: string;
+    };
+    locator: string;
+    status: SignerStatus;
+} | {
+    type: "server";
+    address: string;
+    locator: string;
+    status: SignerStatus;
+};
+type PendingApproval = NonNullable<NonNullable<CreateTransactionSuccessResponse["approvals"]>["pending"]>[number];
+type Callbacks = {
+    onWalletCreationStart?: () => Promise<void>;
+    onTransactionStart?: () => Promise<void>;
+    onAuthRequired?: (signerType: "email" | "phone", signerLocator: string, needsAuth: boolean, sendOtp: () => Promise<void>, verifyOtp: (otp: string) => Promise<void>, reject: () => void) => Promise<void>;
+};
+type StellarWalletPlugin = string;
+type WalletPlugin<C extends Chain> = C extends StellarChain ? StellarWalletPlugin : never;
+type WalletOptions = {
+    callbacks?: Callbacks;
+    clientTEEConnection?: HandshakeParent<typeof signerOutboundEvents, typeof signerInboundEvents>;
+    deviceSignerKeyStorage?: DeviceSignerKeyStorage;
+};
+type WalletArgsFor<C extends Chain> = {
+    /** The blockchain to create the wallet on (e.g. "base-sepolia"). */
+    chain: C;
+    /** Optional owner identifier. */
+    owner?: string;
+    /** Optional array of wallet plugins. */
+    plugins?: WalletPlugin<C>[];
+    options?: WalletOptions;
+    /** Optional wallet alias. */
+    alias?: string;
+};
+type WalletCreateArgs<C extends Chain> = WalletArgsFor<C> & {
+    /** Recovery signer for wallet creation. Device signers cannot be recovery signers. */
+    recovery: Exclude<SignerConfigForChain<C>, DeviceSignerConfig>;
+    /** Signers to register on the wallet during creation. */
+    signers?: Array<SignerConfigForChain<C> | ExternalWalletRegistrationConfig>;
+    alias?: string;
+};
+/**
+ * A device signer descriptor containing the public key and locator.
+ * Returned by `createDeviceSigner`.
+ */
+type DeviceSignerDescriptor = {
+    type: "device";
+    publicKey: {
+        x: string;
+        y: string;
+    };
+    locator: DeviceSignerLocator;
+    name?: string;
+};
+type ClientSideWalletArgsFor<C extends Chain> = Omit<WalletArgsFor<C>, "owner">;
+type ClientSideWalletCreateArgs<C extends Chain> = Omit<WalletCreateArgs<C>, "owner">;
+type ChainExtras = {
+    solana: {
+        mintHash?: string;
+    };
+    stellar: {
+        contractId?: string;
+    };
+    evm: {
+        contractAddress?: string;
+    };
+};
+type ChainToExtrasKey<C extends Chain> = C extends "solana" ? "solana" : C extends "stellar" ? "stellar" : "evm";
+type TokenBalance<C extends Chain = Chain> = {
+    symbol: "sol" | "eth" | "usdc" | string;
+    name: string;
+    amount: string;
+    decimals?: number;
+    rawAmount?: string;
+} & ChainExtras[ChainToExtrasKey<C>];
+type Balances<C extends Chain = Chain> = {
+    nativeToken: TokenBalance<C>;
+    usdc: TokenBalance<C>;
+    tokens: TokenBalance<C>[];
+};
+type UserLocator = {
+    email: string;
+} | {
+    x: string;
+} | {
+    twitter: string;
+} | {
+    phone: string;
+} | {
+    userId: string;
+};
+type Transaction<TPrepareOnly extends boolean = false> = TPrepareOnly extends true ? {
+    hash?: string;
+    explorerLink?: string;
+    transactionId: string;
+} : {
+    hash: string;
+    explorerLink: string;
+    transactionId: string;
+};
+type Signature<TPrepareOnly extends boolean = false> = TPrepareOnly extends true ? {
+    signature?: string;
+    signatureId: string;
+} : {
+    signature: string;
+    signatureId: string;
+};
+type ApproveOptions = {
+    approval?: Approval;
+    additionalSigners?: SignerAdapter[];
+};
+type ApproveParams = {
+    transactionId?: string;
+    signatureId?: string;
+    options?: ApproveOptions;
+};
+type Approval = (BaseSignResult | PasskeySignResult | DeviceSignResult) & {
+    signer: string;
+};
+
+type ExternalWalletRegistrationConfig = {
+    type: "external-wallet";
+    address: string;
+};
+declare class AuthRejectedError extends Error {
+    constructor();
+}
+type EmailSignerConfig = {
+    type: "email";
+    email?: string;
+    locator?: string;
+};
+type PhoneSignerConfig = {
+    type: "phone";
+    phone?: string;
+    locator?: string;
+};
+type NonCustodialSignerType = PhoneSignerConfig["type"] | EmailSignerConfig["type"];
+type ExternalWalletSignerConfigForChain<C extends Chain> = C extends SolanaChain ? SolanaExternalWalletSignerConfig : C extends StellarChain ? StellarExternalWalletSignerConfig : EvmExternalWalletSignerConfig;
+type ApiKeySignerConfig = {
+    type: "api-key";
+};
+type ServerSignerConfig = {
+    type: "server";
+    secret: string;
+};
+type BaseSignerConfig<C extends Chain> = ExternalWalletSignerConfigForChain<C> | ApiKeySignerConfig | ServerSignerConfig;
+type PasskeySignerConfig = {
+    type: "passkey";
+    name?: string;
+    id?: string;
+    locator?: string;
+    onCreatePasskey?: (name: string) => Promise<{
+        id: string;
+        publicKey: {
+            x: string;
+            y: string;
+        };
+    }>;
+    onSignWithPasskey?: (message: string) => Promise<PasskeySignResult>;
+};
+type BaseInternalSignerConfig = {
+    locator: SignerLocator;
+    address: string;
+    crossmint: Crossmint;
+    clientTEEConnection?: HandshakeParent<typeof signerOutboundEvents, typeof signerInboundEvents>;
+};
+type EmailInternalSignerConfig = EmailSignerConfig & Omit<BaseInternalSignerConfig, "locator"> & {
+    locator: EmailSignerLocator;
+    onAuthRequired?: Callbacks["onAuthRequired"];
+};
+type PhoneInternalSignerConfig = PhoneSignerConfig & Omit<BaseInternalSignerConfig, "locator"> & {
+    locator: PhoneSignerLocator;
+    onAuthRequired?: Callbacks["onAuthRequired"];
+};
+type DeviceInternalSignerConfig = {
+    type: "device";
+    locator?: DeviceSignerLocator;
+    address: string;
+};
+type PasskeyInternalSignerConfig = PasskeySignerConfig & {
+    locator: PasskeySignerLocator;
+    id: string;
+};
+type ApiKeyInternalSignerConfig = ApiKeySignerConfig & {
+    locator: ApiKeySignerLocator;
+    address: string;
+};
+type ExternalWalletInternalSignerConfig<C extends Chain> = ExternalWalletSignerConfigForChain<C> & {
+    locator: ExternalWalletSignerLocator;
+};
+type ServerInternalSignerConfig = {
+    type: "server";
+    /** The derived chain-specific private key bytes */
+    derivedKeyBytes: Uint8Array;
+    locator: ServerSignerLocator;
+    address: string;
+};
+type InternalSignerConfig<C extends Chain> = EmailInternalSignerConfig | PhoneInternalSignerConfig | PasskeyInternalSignerConfig | ApiKeyInternalSignerConfig | ExternalWalletInternalSignerConfig<C> | DeviceInternalSignerConfig | ServerInternalSignerConfig;
+type BaseSignResult = {
+    signature: string;
+};
+type DeviceSignResult = {
+    signature: {
+        r: string;
+        s: string;
+    };
+};
+type PasskeySignResult = {
+    signature: {
+        r: string;
+        s: string;
+    };
+    metadata: WebAuthnP256.SignMetadata;
+};
+type DeviceSignerConfig = {
+    type: "device";
+    publicKey?: {
+        x: string;
+        y: string;
+    };
+    locator?: string;
+    name?: string;
+};
+type SignerConfigForChain<C extends Chain> = C extends SolanaChain ? EmailSignerConfig | PhoneSignerConfig | BaseSignerConfig<C> | DeviceSignerConfig : C extends StellarChain ? EmailSignerConfig | PhoneSignerConfig | BaseSignerConfig<C> | DeviceSignerConfig : EmailSignerConfig | PhoneSignerConfig | PasskeySignerConfig | BaseSignerConfig<C> | DeviceSignerConfig;
+type EmailSignerLocator = `email:${string}`;
+type PhoneSignerLocator = `phone:${string}`;
+type PasskeySignerLocator = `passkey:${string}`;
+type DeviceSignerLocator = `device:${string}`;
+type ExternalWalletSignerLocator = `external-wallet:${string}`;
+type ApiKeySignerLocator = "api-key" | `api-key:${string}`;
+type ServerSignerLocator = `server:${string}`;
+type SignerLocator = EmailSignerLocator | PhoneSignerLocator | PasskeySignerLocator | DeviceSignerLocator | ExternalWalletSignerLocator | ApiKeySignerLocator | ServerSignerLocator;
+type SignResultMap = {
+    email: BaseSignResult;
+    phone: BaseSignResult;
+    "api-key": BaseSignResult;
+    "external-wallet": BaseSignResult;
+    server: BaseSignResult;
+    passkey: PasskeySignResult;
+    device: DeviceSignResult;
+};
+interface SignerAdapter<T extends keyof SignResultMap = keyof SignResultMap> {
+    type: T;
+    status?: SignerStatus;
+    locator(): SignerLocator;
+    address?(): string;
+    signMessage(message: string): Promise<SignResultMap[T]>;
+    signTransaction(transaction: string): Promise<SignResultMap[T]>;
+}
+interface ExportableSignerAdapter extends SignerAdapter {
+    _exportPrivateKey: (exportTEEConnection: ExportSignerTEEConnection) => Promise<void>;
+}
+declare function isExportableSignerAdapter(signer: SignerAdapter): signer is ExportableSignerAdapter;
+type ExportSignerTEEConnection = HandshakeParent<typeof exportSignerOutboundEvents, typeof exportSignerInboundEvents>;
+
+type CreateWalletParams = CreateWalletV2025Dto;
+type GetWalletSuccessResponse = WalletV2025ResponseDto;
+type CreateWalletResponse = GetWalletSuccessResponse | WalletV1Alpha2ErrorDto;
+type GetWalletResponse = GetWalletSuccessResponse | WalletV1Alpha2ErrorDto;
+type RecoverySignerConfig = NonNullable<Extract<CreateWalletV2025Dto, {
+    config: {
+        adminSigner: Record<string, unknown>;
+    };
+}>["config"]>["adminSigner"];
+type CreateTransactionParams = CreateTransactionV2025Dto;
+type CreateTransactionSuccessResponse = WalletsTransactionV2025ResponseDto;
+type CreateTransactionResponse = CreateTransactionSuccessResponse | WalletV1Alpha2TransactionErrorDto;
+type ApproveTransactionParams = SubmitApprovalV2025Dto;
+type ApproveTransactionResponse = WalletsTransactionV2025ResponseDto | WalletsV2025ControllerSubmitApprovals2Error;
+type GetTransactionResponse = WalletsTransactionV2025ResponseDto | WalletsV2025ControllerGetTransaction2Error;
+type GetTransactionSuccessResponse = WalletsTransactionV2025ResponseDto;
+type CreateSignatureParams = CreateSignatureV2025Dto;
+type CreateSignatureResponse = WalletsSignatureV2025ResponseDto | WalletsV2025ControllerCreateSignatureRequest2Error;
+type ApproveSignatureParams = SubmitApprovalV2025Dto;
+type ApproveSignatureResponse = WalletsSignatureV2025ResponseDto | WalletsV2025ControllerSubmitSignatureApprovals2Error;
+type GetSignatureResponse = WalletsSignatureV2025ResponseDto | WalletsV2025ControllerGetSignature2Error;
+type GetTransactionsResponse = WalletsMultipleTransactionV2025ResponseDto | WalletsV2025ControllerGetTransactionsWithoutChain2Error;
+type GetBalanceResponse = WalletBalanceV20250609ResponseDto | BalanceControllerGetBalanceForLocator2Error;
+type GetBalanceSuccessResponse = WalletBalanceV20250609ResponseDto;
+type GetTransfersResponse = WalletsActivityResponseUnstableDto | WalletV1Alpha2ErrorDto;
+type Transfers = WalletsActivityResponseUnstableDto;
+type FundWalletParams = FundWalletAmountDto;
+type FundWalletResponse = BalanceControllerFundWallet2Responses | BalanceControllerFundWallet2Error;
+type RegisterSignerChain = Extract<CreateSignerV2025InputDto, {
+    chain: string;
+}>["chain"];
+type RegisterSignerPasskeyParams = Extract<CreateSignerV2025InputDto["signer"], {
+    type: "passkey";
+}>;
+type RegisterSignerParams = {
+    signer: SignerLocator | RegisterSignerPasskeyParams | SignerConfigForChain<Chain>;
+    chain?: RegisterSignerChain;
+};
+type RegisterSignerResponse = DelegatedSignerV2025Dto | WalletsV2025ControllerCreateDelegatedSigner2Error;
+type GetSignerResponse = DelegatedSignerV2025Dto | WalletsV2025ControllerGetDelegatedSigner2Error;
+type GetSignersResponse = Array<DelegatedSignerV2025Dto> | WalletsV2025ControllerGetDelegatedSigner2Error;
+type Signer = DelegatedSignerV2025Dto;
+type SendParams = SendTokenDto;
+type SendResponse = WalletsSendTokenControllerSendToken2Response;
+type WalletType = "smart" | "mpc";
+type SolanaAddress = string;
+type EvmWalletLocator = `me:evm:${WalletType}` | Address;
+type SolanaWalletLocator = `me:solana:${WalletType}` | SolanaAddress;
+type WalletLocator = EvmWalletLocator | SolanaWalletLocator;
+
+export { type SendTokenTransactionOptions as $, type ApproveParams as A, type Balances as B, type ClientSideWalletArgsFor as C, type DeviceSignerLocator as D, type EVMTransactionInput as E, type ExportSignerTEEConnection as F, type DeviceInternalSignerConfig as G, type DeviceSignResult as H, type ApiKeyInternalSignerConfig as I, type ExternalWalletInternalSignerConfig as J, type InternalSignerConfig as K, type PasskeyInternalSignerConfig as L, type PasskeySignResult as M, type Signer as N, type PrepareOnly as O, type PhoneSignerConfig as P, type SignMessageInput as Q, type RegisterSignerPasskeyParams as R, type Signer$1 as S, type Transfers as T, type SignTypedDataInput as U, type TransactionInputOptions as V, type WalletArgsFor as W, type StellarTransactionInput as X, type FundWalletResponse as Y, type GetTransactionsResponse as Z, type GetTransactionSuccessResponse as _, type ClientSideWalletCreateArgs as a, type UserLocator as a0, type ApproveResult as a1, type AddSignerReturnType as a2, type WalletLocator as a3, type ApproveSignatureResponse as a4, type CreateWalletResponse as a5, type SendResponse as a6, type CreateWalletParams as a7, type GetTransactionResponse as a8, type EmailInternalSignerConfig as a9, type SignatureInputOptions as aA, type FormattedEVMTransaction as aB, type SignerInput as aC, type PendingApproval as aD, type StellarWalletPlugin as aE, type DeviceSignerDescriptor as aF, type TokenBalance as aG, type Approval as aH, AuthRejectedError as aI, type NonCustodialSignerType as aJ, type ApiKeySignerConfig as aK, type BaseSignerConfig as aL, type PasskeySignerConfig as aM, type ServerSignerLocator as aN, type PhoneInternalSignerConfig as aa, type BaseSignResult as ab, type ServerInternalSignerConfig as ac, type GetWalletResponse as ad, type CreateTransactionParams as ae, type CreateTransactionResponse as af, type ApproveTransactionParams as ag, type ApproveTransactionResponse as ah, type CreateSignatureParams as ai, type CreateSignatureResponse as aj, type ApproveSignatureParams as ak, type GetSignatureResponse as al, type GetTransfersResponse as am, type GetBalanceResponse as an, type FundWalletParams as ao, type RegisterSignerParams as ap, type RegisterSignerResponse as aq, type GetSignerResponse as ar, type SendParams as as, type GetWalletSuccessResponse as at, type RecoverySignerConfig as au, type CreateTransactionSuccessResponse as av, type GetBalanceSuccessResponse as aw, type RegisterSignerChain as ax, type GetSignersResponse as ay, type SendTokenTransactionType as az, type SignerStatus as b, type Transaction as c, type WalletCreateArgs as d, type Callbacks as e, type WalletOptions as f, type WalletPlugin as g, type Signature as h, type SolanaTransactionInput as i, type ApproveOptions as j, type AddSignerOptions as k, isExportableSignerAdapter as l, type SignerAdapter as m, type EmailSignerConfig as n, type ExternalWalletRegistrationConfig as o, type ExternalWalletSignerConfigForChain as p, type ServerSignerConfig as q, type SignerConfigForChain as r, type SignerLocator as s, type EmailSignerLocator as t, type PhoneSignerLocator as u, type PasskeySignerLocator as v, type DeviceSignerConfig as w, type ExternalWalletSignerLocator as x, type ApiKeySignerLocator as y, type ExportableSignerAdapter as z };