@chipi-stack/types 11.21.0 → 12.0.0

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { TypedData, Call } from 'starknet';
+export { Call } from 'starknet';
 
 /**
  * Core configuration and environment types
@@ -38,21 +39,39 @@ declare const STARKNET_CONTRACTS: Record<ChainToken, {
 /**
  * Wallet-related types
  */
+/**
+ * Supported wallet types
+ * - CHIPI: OpenZeppelin account with SNIP-9 session keys support (default)
+ * - READY: Argent X Account v0.4.0
+ */
+type WalletType = "CHIPI" | "READY";
 interface WalletData {
     publicKey: string;
     encryptedPrivateKey: string;
+    walletType?: WalletType;
+    normalizedPublicKey?: string;
+}
+interface DeploymentData {
+    class_hash: string;
+    salt: string;
+    unique: string;
+    calldata: string[];
 }
 interface CreateWalletParams {
     encryptKey: string;
     externalUserId: string;
     userId?: string;
+    /**
+     * The type of wallet to create.
+     * - "CHIPI" (default): OpenZeppelin account with SNIP-9 session keys support
+     * - "ARGENT": Argent X Account v0.4.0
+     */
+    walletType?: WalletType;
 }
 interface CreateWalletResponse {
     txHash: string;
     walletPublicKey: string;
-    wallet: WalletData & {
-        normalizedPublicKey: string;
-    };
+    wallet: WalletData;
 }
 interface GetWalletParams {
     externalUserId: string;
@@ -74,9 +93,7 @@ interface GetWalletResponse {
     id: string;
     userId?: string;
     orgId?: string;
-    publicKey: string;
-    encryptedPrivateKey: string;
-    normalizedPublicKey: string;
+    wallet: WalletData;
     externalUserId?: string;
     createdAt?: string;
     updatedAt?: string;
@@ -374,4 +391,143 @@ interface GetUserParams {
     includeStarknetWallet?: boolean;
 }
 
-export { type ApiError, type ApiKey, type ApiResponse, type ApproveHookInput, type ApproveParams, type AsyncReturnType, type AuthContext, type CallAnyContractParams, type Chain, type ChainToken, type ChipiBrowserSDKConfig, type ChipiSDKConfig, type ChipiServerSDKConfig, type Country, type CreateCustodialWalletParams, type CreateSkuTransactionParams, type CreateUserParams, type CreateWalletParams, type CreateWalletResponse, type DeepPartial, type ErrorWithCode, type ExecuteSponsoredTransactionParams, type ExecuteSponsoredTransactionResponse, type ExecuteTransactionParams, type GetMerchantWalletParams, type GetSkuListQuery, type GetTokenBalanceParams, type GetTokenBalanceResponse, type GetTransactionListQuery, type GetTransactionsParams, type GetUserParams, type GetWalletParams, type GetWalletResponse, type JwtPayload, type MaybePromise, type NonEmptyArray, type Optional, type PaginatedResponse, type PaginationQuery, type PrepareTypedDataParams, type PrepareWalletCreationParams, type PrepareWalletCreationResponse, type Prettify, type RecordSendTransactionParams, type RequireAtLeastOne, STARKNET_CONTRACTS, type Sku, type SkuCategory, type SkuTransaction, type StakeVesuUsdcHookInputParams, type StakeVesuUsdcParams, type Transaction, type TransferHookInput, type TransferParams, type User, type ValueOrFunction, type WalletData, type WithdrawVesuUsdcHookInputParams, type WithdrawVesuUsdcParams, type alphaUrl };
+/**
+ * Session key types for CHIPI wallets (SNIP-9 compatible)
+ *
+ * Session keys enable temporary, delegated access to execute transactions
+ * without requiring the owner's private key for each operation.
+ *
+ * @see https://github.com/chipi-pay/sessions-smart-contract
+ */
+/**
+ * Session key data returned to developer for self-custodial storage.
+ * The SDK generates this data but does NOT store it - developers must
+ * persist it externally (e.g., in Clerk metadata, database, etc.)
+ */
+interface SessionKeyData {
+    /** Stark public key (hex format, e.g., "0x...") */
+    publicKey: string;
+    /** AES encrypted private key - encrypt with user's encryptKey */
+    encryptedPrivateKey: string;
+    /** Unix timestamp (seconds) when this session expires */
+    validUntil: number;
+}
+/**
+ * Full session configuration for on-chain registration.
+ * Used when calling add_or_update_session_key on the contract.
+ */
+interface SessionConfig {
+    /** Stark public key of the session (hex format) */
+    sessionPublicKey: string;
+    /** Unix timestamp (seconds) - u64 on-chain */
+    validUntil: number;
+    /** Maximum number of transactions allowed - u32 on-chain */
+    maxCalls: number;
+    /**
+     * Whitelisted function selectors (hex format).
+     * Empty array = all entrypoints allowed.
+     * Non-empty = only these selectors can be called with this session.
+     */
+    allowedEntrypoints: string[];
+}
+/**
+ * Parameters for creating a session keypair locally.
+ * This only generates keys - does NOT register on-chain.
+ */
+interface CreateSessionKeyParams {
+    /** Encryption key to encrypt the session private key */
+    encryptKey: string;
+    /**
+     * Session duration in seconds.
+     * @default 21600 (6 hours)
+     */
+    durationSeconds?: number;
+}
+/**
+ * Parameters for registering a session key on the smart contract.
+ * Requires owner signature (uses owner's encrypted private key).
+ *
+ * NOTE: walletType is intentionally optional for backward compatibility.
+ * Legacy wallets from getWallet() may not have walletType set (defaults to ARGENT).
+ * Runtime validation in ChipiSessions ensures only CHIPI wallets are used.
+ * Making walletType required here would be a breaking change for existing users.
+ * @see ChipiSessions.validateChipiWallet() for runtime validation.
+ */
+interface AddSessionKeyParams {
+    /** Encryption key to decrypt the owner's private key for signing */
+    encryptKey: string;
+    /** Wallet data including encrypted owner private key */
+    wallet: WalletData & {
+        walletType?: WalletType;
+    };
+    /** Session configuration to register on-chain */
+    sessionConfig: SessionConfig;
+}
+/**
+ * Parameters for executing a transaction using a session key.
+ * Uses session signature (4-element format) instead of owner signature.
+ *
+ * NOTE: walletType is intentionally optional for backward compatibility.
+ * @see AddSessionKeyParams for detailed reasoning.
+ */
+interface ExecuteWithSessionParams {
+    /** Encryption key to decrypt the session private key */
+    encryptKey: string;
+    /** Wallet data (session executes on behalf of this wallet) */
+    wallet: WalletData & {
+        walletType?: WalletType;
+    };
+    /** Session key data (must be registered on-chain first) */
+    session: SessionKeyData;
+    /** Calls to execute */
+    calls: Call[];
+}
+/**
+ * Parameters for revoking a session key from the smart contract.
+ * Requires owner signature.
+ *
+ * NOTE: walletType is intentionally optional for backward compatibility.
+ * @see AddSessionKeyParams for detailed reasoning.
+ */
+interface RevokeSessionKeyParams {
+    /** Encryption key to decrypt the owner's private key for signing */
+    encryptKey: string;
+    /** Wallet data including encrypted owner private key */
+    wallet: WalletData & {
+        walletType?: WalletType;
+    };
+    /** Public key of the session to revoke */
+    sessionPublicKey: string;
+}
+/**
+ * Parameters for querying session data from the contract.
+ */
+interface GetSessionDataParams {
+    /** Wallet address to query */
+    walletAddress: string;
+    /** Session public key to query */
+    sessionPublicKey: string;
+}
+/**
+ * Response from get_session_data contract call.
+ * Represents the on-chain state of a session key.
+ */
+interface SessionDataResponse {
+    /** Whether the session is currently active (not revoked, not expired) */
+    isActive: boolean;
+    /** Unix timestamp when the session expires */
+    validUntil: number;
+    /** Number of calls remaining (decrements with each use) */
+    remainingCalls: number;
+    /** Whitelisted selectors (empty = all allowed) */
+    allowedEntrypoints: string[];
+}
+/**
+ * Extended wallet data with required walletType for session operations.
+ * Session keys only work with CHIPI wallets.
+ */
+interface SessionWalletData extends WalletData {
+    walletType: WalletType;
+}
+
+export { type AddSessionKeyParams, type ApiError, type ApiKey, type ApiResponse, type ApproveHookInput, type ApproveParams, type AsyncReturnType, type AuthContext, type CallAnyContractParams, type Chain, type ChainToken, type ChipiBrowserSDKConfig, type ChipiSDKConfig, type ChipiServerSDKConfig, type Country, type CreateCustodialWalletParams, type CreateSessionKeyParams, type CreateSkuTransactionParams, type CreateUserParams, type CreateWalletParams, type CreateWalletResponse, type DeepPartial, type DeploymentData, type ErrorWithCode, type ExecuteSponsoredTransactionParams, type ExecuteSponsoredTransactionResponse, type ExecuteTransactionParams, type ExecuteWithSessionParams, type GetMerchantWalletParams, type GetSessionDataParams, type GetSkuListQuery, type GetTokenBalanceParams, type GetTokenBalanceResponse, type GetTransactionListQuery, type GetTransactionsParams, type GetUserParams, type GetWalletParams, type GetWalletResponse, type JwtPayload, type MaybePromise, type NonEmptyArray, type Optional, type PaginatedResponse, type PaginationQuery, type PrepareTypedDataParams, type PrepareWalletCreationParams, type PrepareWalletCreationResponse, type Prettify, type RecordSendTransactionParams, type RequireAtLeastOne, type RevokeSessionKeyParams, STARKNET_CONTRACTS, type SessionConfig, type SessionDataResponse, type SessionKeyData, type SessionWalletData, type Sku, type SkuCategory, type SkuTransaction, type StakeVesuUsdcHookInputParams, type StakeVesuUsdcParams, type Transaction, type TransferHookInput, type TransferParams, type User, type ValueOrFunction, type WalletData, type WalletType, type WithdrawVesuUsdcHookInputParams, type WithdrawVesuUsdcParams, type alphaUrl };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { TypedData, Call } from 'starknet';
+export { Call } from 'starknet';
 
 /**
  * Core configuration and environment types
@@ -38,21 +39,39 @@ declare const STARKNET_CONTRACTS: Record<ChainToken, {
 /**
  * Wallet-related types
  */
+/**
+ * Supported wallet types
+ * - CHIPI: OpenZeppelin account with SNIP-9 session keys support (default)
+ * - READY: Argent X Account v0.4.0
+ */
+type WalletType = "CHIPI" | "READY";
 interface WalletData {
     publicKey: string;
     encryptedPrivateKey: string;
+    walletType?: WalletType;
+    normalizedPublicKey?: string;
+}
+interface DeploymentData {
+    class_hash: string;
+    salt: string;
+    unique: string;
+    calldata: string[];
 }
 interface CreateWalletParams {
     encryptKey: string;
     externalUserId: string;
     userId?: string;
+    /**
+     * The type of wallet to create.
+     * - "CHIPI" (default): OpenZeppelin account with SNIP-9 session keys support
+     * - "ARGENT": Argent X Account v0.4.0
+     */
+    walletType?: WalletType;
 }
 interface CreateWalletResponse {
     txHash: string;
     walletPublicKey: string;
-    wallet: WalletData & {
-        normalizedPublicKey: string;
-    };
+    wallet: WalletData;
 }
 interface GetWalletParams {
     externalUserId: string;
@@ -74,9 +93,7 @@ interface GetWalletResponse {
     id: string;
     userId?: string;
     orgId?: string;
-    publicKey: string;
-    encryptedPrivateKey: string;
-    normalizedPublicKey: string;
+    wallet: WalletData;
     externalUserId?: string;
     createdAt?: string;
     updatedAt?: string;
@@ -374,4 +391,143 @@ interface GetUserParams {
     includeStarknetWallet?: boolean;
 }
 
-export { type ApiError, type ApiKey, type ApiResponse, type ApproveHookInput, type ApproveParams, type AsyncReturnType, type AuthContext, type CallAnyContractParams, type Chain, type ChainToken, type ChipiBrowserSDKConfig, type ChipiSDKConfig, type ChipiServerSDKConfig, type Country, type CreateCustodialWalletParams, type CreateSkuTransactionParams, type CreateUserParams, type CreateWalletParams, type CreateWalletResponse, type DeepPartial, type ErrorWithCode, type ExecuteSponsoredTransactionParams, type ExecuteSponsoredTransactionResponse, type ExecuteTransactionParams, type GetMerchantWalletParams, type GetSkuListQuery, type GetTokenBalanceParams, type GetTokenBalanceResponse, type GetTransactionListQuery, type GetTransactionsParams, type GetUserParams, type GetWalletParams, type GetWalletResponse, type JwtPayload, type MaybePromise, type NonEmptyArray, type Optional, type PaginatedResponse, type PaginationQuery, type PrepareTypedDataParams, type PrepareWalletCreationParams, type PrepareWalletCreationResponse, type Prettify, type RecordSendTransactionParams, type RequireAtLeastOne, STARKNET_CONTRACTS, type Sku, type SkuCategory, type SkuTransaction, type StakeVesuUsdcHookInputParams, type StakeVesuUsdcParams, type Transaction, type TransferHookInput, type TransferParams, type User, type ValueOrFunction, type WalletData, type WithdrawVesuUsdcHookInputParams, type WithdrawVesuUsdcParams, type alphaUrl };
+/**
+ * Session key types for CHIPI wallets (SNIP-9 compatible)
+ *
+ * Session keys enable temporary, delegated access to execute transactions
+ * without requiring the owner's private key for each operation.
+ *
+ * @see https://github.com/chipi-pay/sessions-smart-contract
+ */
+/**
+ * Session key data returned to developer for self-custodial storage.
+ * The SDK generates this data but does NOT store it - developers must
+ * persist it externally (e.g., in Clerk metadata, database, etc.)
+ */
+interface SessionKeyData {
+    /** Stark public key (hex format, e.g., "0x...") */
+    publicKey: string;
+    /** AES encrypted private key - encrypt with user's encryptKey */
+    encryptedPrivateKey: string;
+    /** Unix timestamp (seconds) when this session expires */
+    validUntil: number;
+}
+/**
+ * Full session configuration for on-chain registration.
+ * Used when calling add_or_update_session_key on the contract.
+ */
+interface SessionConfig {
+    /** Stark public key of the session (hex format) */
+    sessionPublicKey: string;
+    /** Unix timestamp (seconds) - u64 on-chain */
+    validUntil: number;
+    /** Maximum number of transactions allowed - u32 on-chain */
+    maxCalls: number;
+    /**
+     * Whitelisted function selectors (hex format).
+     * Empty array = all entrypoints allowed.
+     * Non-empty = only these selectors can be called with this session.
+     */
+    allowedEntrypoints: string[];
+}
+/**
+ * Parameters for creating a session keypair locally.
+ * This only generates keys - does NOT register on-chain.
+ */
+interface CreateSessionKeyParams {
+    /** Encryption key to encrypt the session private key */
+    encryptKey: string;
+    /**
+     * Session duration in seconds.
+     * @default 21600 (6 hours)
+     */
+    durationSeconds?: number;
+}
+/**
+ * Parameters for registering a session key on the smart contract.
+ * Requires owner signature (uses owner's encrypted private key).
+ *
+ * NOTE: walletType is intentionally optional for backward compatibility.
+ * Legacy wallets from getWallet() may not have walletType set (defaults to ARGENT).
+ * Runtime validation in ChipiSessions ensures only CHIPI wallets are used.
+ * Making walletType required here would be a breaking change for existing users.
+ * @see ChipiSessions.validateChipiWallet() for runtime validation.
+ */
+interface AddSessionKeyParams {
+    /** Encryption key to decrypt the owner's private key for signing */
+    encryptKey: string;
+    /** Wallet data including encrypted owner private key */
+    wallet: WalletData & {
+        walletType?: WalletType;
+    };
+    /** Session configuration to register on-chain */
+    sessionConfig: SessionConfig;
+}
+/**
+ * Parameters for executing a transaction using a session key.
+ * Uses session signature (4-element format) instead of owner signature.
+ *
+ * NOTE: walletType is intentionally optional for backward compatibility.
+ * @see AddSessionKeyParams for detailed reasoning.
+ */
+interface ExecuteWithSessionParams {
+    /** Encryption key to decrypt the session private key */
+    encryptKey: string;
+    /** Wallet data (session executes on behalf of this wallet) */
+    wallet: WalletData & {
+        walletType?: WalletType;
+    };
+    /** Session key data (must be registered on-chain first) */
+    session: SessionKeyData;
+    /** Calls to execute */
+    calls: Call[];
+}
+/**
+ * Parameters for revoking a session key from the smart contract.
+ * Requires owner signature.
+ *
+ * NOTE: walletType is intentionally optional for backward compatibility.
+ * @see AddSessionKeyParams for detailed reasoning.
+ */
+interface RevokeSessionKeyParams {
+    /** Encryption key to decrypt the owner's private key for signing */
+    encryptKey: string;
+    /** Wallet data including encrypted owner private key */
+    wallet: WalletData & {
+        walletType?: WalletType;
+    };
+    /** Public key of the session to revoke */
+    sessionPublicKey: string;
+}
+/**
+ * Parameters for querying session data from the contract.
+ */
+interface GetSessionDataParams {
+    /** Wallet address to query */
+    walletAddress: string;
+    /** Session public key to query */
+    sessionPublicKey: string;
+}
+/**
+ * Response from get_session_data contract call.
+ * Represents the on-chain state of a session key.
+ */
+interface SessionDataResponse {
+    /** Whether the session is currently active (not revoked, not expired) */
+    isActive: boolean;
+    /** Unix timestamp when the session expires */
+    validUntil: number;
+    /** Number of calls remaining (decrements with each use) */
+    remainingCalls: number;
+    /** Whitelisted selectors (empty = all allowed) */
+    allowedEntrypoints: string[];
+}
+/**
+ * Extended wallet data with required walletType for session operations.
+ * Session keys only work with CHIPI wallets.
+ */
+interface SessionWalletData extends WalletData {
+    walletType: WalletType;
+}
+
+export { type AddSessionKeyParams, type ApiError, type ApiKey, type ApiResponse, type ApproveHookInput, type ApproveParams, type AsyncReturnType, type AuthContext, type CallAnyContractParams, type Chain, type ChainToken, type ChipiBrowserSDKConfig, type ChipiSDKConfig, type ChipiServerSDKConfig, type Country, type CreateCustodialWalletParams, type CreateSessionKeyParams, type CreateSkuTransactionParams, type CreateUserParams, type CreateWalletParams, type CreateWalletResponse, type DeepPartial, type DeploymentData, type ErrorWithCode, type ExecuteSponsoredTransactionParams, type ExecuteSponsoredTransactionResponse, type ExecuteTransactionParams, type ExecuteWithSessionParams, type GetMerchantWalletParams, type GetSessionDataParams, type GetSkuListQuery, type GetTokenBalanceParams, type GetTokenBalanceResponse, type GetTransactionListQuery, type GetTransactionsParams, type GetUserParams, type GetWalletParams, type GetWalletResponse, type JwtPayload, type MaybePromise, type NonEmptyArray, type Optional, type PaginatedResponse, type PaginationQuery, type PrepareTypedDataParams, type PrepareWalletCreationParams, type PrepareWalletCreationResponse, type Prettify, type RecordSendTransactionParams, type RequireAtLeastOne, type RevokeSessionKeyParams, STARKNET_CONTRACTS, type SessionConfig, type SessionDataResponse, type SessionKeyData, type SessionWalletData, type Sku, type SkuCategory, type SkuTransaction, type StakeVesuUsdcHookInputParams, type StakeVesuUsdcParams, type Transaction, type TransferHookInput, type TransferParams, type User, type ValueOrFunction, type WalletData, type WalletType, type WithdrawVesuUsdcHookInputParams, type WithdrawVesuUsdcParams, type alphaUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chipi-stack/types",
-  "version": "11.21.0",
+  "version": "12.0.0",
   "description": "Type definitions for Chipi SDK packages",
   "keywords": [
     "chipi",