@mycelium-sdk/core 1.0.0 → 2.0.0-alpha.0

package/dist/index.d.cts

@@ -1,5 +1,6 @@
 import { PublicClient, Chain, Address, Hex, LocalAccount, Hash, WalletClient } from 'viem';
 import { SmartAccount, BundlerClient, WebAuthnAccount, toCoinbaseSmartAccount } from 'viem/account-abstraction';
+import { PimlicoClient } from 'permissionless/clients/pimlico';
 
 declare const SUPPORTED_CHAIN_IDS: number[];
 type SupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
@@ -15,6 +16,8 @@ interface ChainConfig {
     rpcUrl: string;
     /** Bundler URL for the chain */
     bundlerUrl: string;
+    /** Paymaster URL for the chain */
+    paymasterUrl?: string;
 }
 
 /**
@@ -116,6 +119,26 @@ declare class ChainManager {
      * @returns PublicClient instance
      */
     private createPublicClient;
+    /**
+     * Returns the paymaster URL for the given chain ID
+     *
+     * @internal
+     * @category URLs
+     * @param chainId Target chain ID
+     * @returns Paymaster URL string
+     * @throws Error if chain config is missing or URL is invalid
+     */
+    private getPaymasterUrl;
+    /**
+     * Creates a {@link PimlicoClient} for the given chain ID
+     *
+     * @internal
+     * @category Clients
+     * @param chainId Target chain ID
+     * @returns PimlicoClient instance
+     * @throws Error if no paymaster URL is configured
+     */
+    getPaymasterClient(chainId: (typeof SUPPORTED_CHAIN_IDS)[number]): PimlicoClient;
 }
 
 /**
@@ -258,9 +281,13 @@ declare abstract class SmartWallet {
      *
      * @param transactionData Transaction data to execute
      * @param chainId Target blockchain chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise resolving to the transaction {@link Hash}
      */
-    abstract send(transactionData: TransactionData, chainId: SupportedChainId): Promise<Hash>;
+    abstract send(transactionData: TransactionData, chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Executes a batch of transactions through the smart wallet
      *
@@ -272,9 +299,13 @@ declare abstract class SmartWallet {
      *
      * @param transactionData Array of transaction data objects
      * @param chainId Target blockchain chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise resolving to the transaction {@link Hash}
      */
-    abstract sendBatch(transactionData: TransactionData[], chainId: SupportedChainId): Promise<Hash>;
+    abstract sendBatch(transactionData: TransactionData[], chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Prepares transaction data for sending tokens to another address
      *
@@ -572,11 +603,7 @@ interface ProxyBalance {
 
 /**
  * Options for creating a smart wallet
-<<<<<<< HEAD
  * Parameters for creating a new smart wallet with specified owners and signer
-=======
- *  Parameters for creating a new smart wallet with specified owners and signer
->>>>>>> main
  */
 type CreateSmartWalletOptions = {
     owners: Array<Address | WebAuthnAccount>;
@@ -585,11 +612,7 @@ type CreateSmartWalletOptions = {
 };
 /**
  * Options for creating a wallet with embedded signer
-<<<<<<< HEAD
  * Parameters for creating both embedded and smart wallets, with embedded wallet automatically added as signer
-=======
- *  Parameters for creating both embedded and smart wallets, with embedded wallet automatically added as signer
->>>>>>> main
  */
 type CreateAccountOptions = {
     owners?: Array<Address | WebAuthnAccount>;
@@ -598,11 +621,7 @@ type CreateAccountOptions = {
 };
 /**
  * Options for retrieving a smart wallet with provided signer
-<<<<<<< HEAD
  * Parameters for getting an existing smart wallet using a provided LocalAccount signer
-=======
- *  Parameters for getting an existing smart wallet using a provided LocalAccount signer
->>>>>>> main
  */
 type GetSmartWalletOptions = {
     signer: LocalAccount;
@@ -613,22 +632,14 @@ type GetSmartWalletOptions = {
 };
 /**
  * Options for retrieving an embedded wallet
-<<<<<<< HEAD
  * Parameters for getting an existing embedded wallet
-=======
- *  Parameters for getting an existing embedded wallet
->>>>>>> main
  */
 type GetEmbeddedWalletOptions = {
     walletId: string;
 };
 /**
  * Options for retrieving a smart wallet with embedded wallet signer
-<<<<<<< HEAD
  * Parameters for getting an existing smart wallet using an embedded wallet as signer.
-=======
- *  Parameters for getting an existing smart wallet using an embedded wallet as signer.
->>>>>>> main
  * If neither walletAddress nor deploymentOwners is provided, defaults to using the embedded wallet as single owner.
  */
 type GetAccountOptions = Omit<GetSmartWalletOptions, 'signer'> & GetEmbeddedWalletOptions;
@@ -1089,6 +1100,7 @@ declare class ProtocolsNamespace {
  *     chainId: parseInt(process.env.NEXT_PUBLIC_CHAIN_ID!),
  *     rpcUrl: process.env.NEXT_PUBLIC_RPC_URL!,
  *     bundlerUrl: process.env.NEXT_PUBLIC_BUNDLER_URL!,
+ *     paymasterUrl: process.env.NEXT_PUBLIC_PAYMASTER_URL!,
  *   },
  *   protocolsRouterConfig: {
  *     riskLevel: 'low',
@@ -1321,6 +1333,8 @@ declare class DefaultSmartWallet extends SmartWallet {
     private protocolProvider;
     /** Coinbase CDP instance to interact with Coinbase CDP API */
     private coinbaseCDP;
+    /** Paymaster instance for gas sponsoring */
+    private paymaster;
     /**
      * Creates a smart wallet instance
      *
@@ -1333,8 +1347,7 @@ declare class DefaultSmartWallet extends SmartWallet {
      * @param signerOwnerIndex Optional index of `signer` in owners (default 0)
      * @param nonce Optional salt for deterministic address calc (default 0)
      */
-    constructor(owners: Array<Address | WebAuthnAccount>, signer: LocalAccount, chainManager: ChainManager, protocolProvider: BaseProtocol, // Protocol['instance'],
-    coinbaseCDP: CoinbaseCDP | null, deploymentAddress?: Address, signerOwnerIndex?: number, nonce?: bigint);
+    constructor(owners: Array<Address | WebAuthnAccount>, signer: LocalAccount, chainManager: ChainManager, protocolProvider: BaseProtocol, coinbaseCDP: CoinbaseCDP | null, deploymentAddress?: Address, signerOwnerIndex?: number, nonce?: bigint);
     /**
      * Returns the signer account for this smart wallet
      *
@@ -1358,6 +1371,7 @@ declare class DefaultSmartWallet extends SmartWallet {
      * @throws Error if an owner has an invalid type
      */
     getAddress(): Promise<`0x${string}`>;
+    private bumpGasLimits;
     /**
      * Builds a Coinbase Smart Account for a specific chain
      *
@@ -1413,10 +1427,14 @@ declare class DefaultSmartWallet extends SmartWallet {
      *
      * @param transactionData Transaction details (`to`, `value`, `data`)
      * @param chainId Target chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise that resolves to the UserOperation hash
      * @throws Error with a readable message if submission or inclusion fails
      */
-    send(transactionData: TransactionData, chainId: SupportedChainId): Promise<Hash>;
+    send(transactionData: TransactionData, chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Builds a UserOperation from several onchain transactions and submits via the bundler, then waits for inclusion
      *
@@ -1425,10 +1443,14 @@ declare class DefaultSmartWallet extends SmartWallet {
      *
      * @param transactionData An array of calls to execute
      * @param chainId Target chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise that resolves to the UserOperation hash for the batch
      * @throws Error with a readable message if submission or inclusion fails
      */
-    sendBatch(transactionData: TransactionData[], chainId: SupportedChainId): Promise<Hash>;
+    sendBatch(transactionData: TransactionData[], chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Funds the smart wallet with the specified amount of the specified token via Coinbase CDP on-ramp service
      *
@@ -1557,7 +1579,11 @@ declare class FundingNamespace {
  *
  * // Option 1: Initialize with API key (fetches config from backend)
  * const sdk = await MyceliumSDK.init({
- *   apiKey: 'sk_...'
+ *   apiKey: 'sk_...',
+ *   chainId: 8453,
+ *   protocolsSecurityConfig: {
+ *     riskLevel: "low",
+ *   },
  * });
  *
  * // Option 2: Initialize with full configuration

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { PublicClient, Chain, Address, Hex, LocalAccount, Hash, WalletClient } from 'viem';
 import { SmartAccount, BundlerClient, WebAuthnAccount, toCoinbaseSmartAccount } from 'viem/account-abstraction';
+import { PimlicoClient } from 'permissionless/clients/pimlico';
 
 declare const SUPPORTED_CHAIN_IDS: number[];
 type SupportedChainId = (typeof SUPPORTED_CHAIN_IDS)[number];
@@ -15,6 +16,8 @@ interface ChainConfig {
     rpcUrl: string;
     /** Bundler URL for the chain */
     bundlerUrl: string;
+    /** Paymaster URL for the chain */
+    paymasterUrl?: string;
 }
 
 /**
@@ -116,6 +119,26 @@ declare class ChainManager {
      * @returns PublicClient instance
      */
     private createPublicClient;
+    /**
+     * Returns the paymaster URL for the given chain ID
+     *
+     * @internal
+     * @category URLs
+     * @param chainId Target chain ID
+     * @returns Paymaster URL string
+     * @throws Error if chain config is missing or URL is invalid
+     */
+    private getPaymasterUrl;
+    /**
+     * Creates a {@link PimlicoClient} for the given chain ID
+     *
+     * @internal
+     * @category Clients
+     * @param chainId Target chain ID
+     * @returns PimlicoClient instance
+     * @throws Error if no paymaster URL is configured
+     */
+    getPaymasterClient(chainId: (typeof SUPPORTED_CHAIN_IDS)[number]): PimlicoClient;
 }
 
 /**
@@ -258,9 +281,13 @@ declare abstract class SmartWallet {
      *
      * @param transactionData Transaction data to execute
      * @param chainId Target blockchain chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise resolving to the transaction {@link Hash}
      */
-    abstract send(transactionData: TransactionData, chainId: SupportedChainId): Promise<Hash>;
+    abstract send(transactionData: TransactionData, chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Executes a batch of transactions through the smart wallet
      *
@@ -272,9 +299,13 @@ declare abstract class SmartWallet {
      *
      * @param transactionData Array of transaction data objects
      * @param chainId Target blockchain chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise resolving to the transaction {@link Hash}
      */
-    abstract sendBatch(transactionData: TransactionData[], chainId: SupportedChainId): Promise<Hash>;
+    abstract sendBatch(transactionData: TransactionData[], chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Prepares transaction data for sending tokens to another address
      *
@@ -572,11 +603,7 @@ interface ProxyBalance {
 
 /**
  * Options for creating a smart wallet
-<<<<<<< HEAD
  * Parameters for creating a new smart wallet with specified owners and signer
-=======
- *  Parameters for creating a new smart wallet with specified owners and signer
->>>>>>> main
  */
 type CreateSmartWalletOptions = {
     owners: Array<Address | WebAuthnAccount>;
@@ -585,11 +612,7 @@ type CreateSmartWalletOptions = {
 };
 /**
  * Options for creating a wallet with embedded signer
-<<<<<<< HEAD
  * Parameters for creating both embedded and smart wallets, with embedded wallet automatically added as signer
-=======
- *  Parameters for creating both embedded and smart wallets, with embedded wallet automatically added as signer
->>>>>>> main
  */
 type CreateAccountOptions = {
     owners?: Array<Address | WebAuthnAccount>;
@@ -598,11 +621,7 @@ type CreateAccountOptions = {
 };
 /**
  * Options for retrieving a smart wallet with provided signer
-<<<<<<< HEAD
  * Parameters for getting an existing smart wallet using a provided LocalAccount signer
-=======
- *  Parameters for getting an existing smart wallet using a provided LocalAccount signer
->>>>>>> main
  */
 type GetSmartWalletOptions = {
     signer: LocalAccount;
@@ -613,22 +632,14 @@ type GetSmartWalletOptions = {
 };
 /**
  * Options for retrieving an embedded wallet
-<<<<<<< HEAD
  * Parameters for getting an existing embedded wallet
-=======
- *  Parameters for getting an existing embedded wallet
->>>>>>> main
  */
 type GetEmbeddedWalletOptions = {
     walletId: string;
 };
 /**
  * Options for retrieving a smart wallet with embedded wallet signer
-<<<<<<< HEAD
  * Parameters for getting an existing smart wallet using an embedded wallet as signer.
-=======
- *  Parameters for getting an existing smart wallet using an embedded wallet as signer.
->>>>>>> main
  * If neither walletAddress nor deploymentOwners is provided, defaults to using the embedded wallet as single owner.
  */
 type GetAccountOptions = Omit<GetSmartWalletOptions, 'signer'> & GetEmbeddedWalletOptions;
@@ -1089,6 +1100,7 @@ declare class ProtocolsNamespace {
  *     chainId: parseInt(process.env.NEXT_PUBLIC_CHAIN_ID!),
  *     rpcUrl: process.env.NEXT_PUBLIC_RPC_URL!,
  *     bundlerUrl: process.env.NEXT_PUBLIC_BUNDLER_URL!,
+ *     paymasterUrl: process.env.NEXT_PUBLIC_PAYMASTER_URL!,
  *   },
  *   protocolsRouterConfig: {
  *     riskLevel: 'low',
@@ -1321,6 +1333,8 @@ declare class DefaultSmartWallet extends SmartWallet {
     private protocolProvider;
     /** Coinbase CDP instance to interact with Coinbase CDP API */
     private coinbaseCDP;
+    /** Paymaster instance for gas sponsoring */
+    private paymaster;
     /**
      * Creates a smart wallet instance
      *
@@ -1333,8 +1347,7 @@ declare class DefaultSmartWallet extends SmartWallet {
      * @param signerOwnerIndex Optional index of `signer` in owners (default 0)
      * @param nonce Optional salt for deterministic address calc (default 0)
      */
-    constructor(owners: Array<Address | WebAuthnAccount>, signer: LocalAccount, chainManager: ChainManager, protocolProvider: BaseProtocol, // Protocol['instance'],
-    coinbaseCDP: CoinbaseCDP | null, deploymentAddress?: Address, signerOwnerIndex?: number, nonce?: bigint);
+    constructor(owners: Array<Address | WebAuthnAccount>, signer: LocalAccount, chainManager: ChainManager, protocolProvider: BaseProtocol, coinbaseCDP: CoinbaseCDP | null, deploymentAddress?: Address, signerOwnerIndex?: number, nonce?: bigint);
     /**
      * Returns the signer account for this smart wallet
      *
@@ -1358,6 +1371,7 @@ declare class DefaultSmartWallet extends SmartWallet {
      * @throws Error if an owner has an invalid type
      */
     getAddress(): Promise<`0x${string}`>;
+    private bumpGasLimits;
     /**
      * Builds a Coinbase Smart Account for a specific chain
      *
@@ -1413,10 +1427,14 @@ declare class DefaultSmartWallet extends SmartWallet {
      *
      * @param transactionData Transaction details (`to`, `value`, `data`)
      * @param chainId Target chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise that resolves to the UserOperation hash
      * @throws Error with a readable message if submission or inclusion fails
      */
-    send(transactionData: TransactionData, chainId: SupportedChainId): Promise<Hash>;
+    send(transactionData: TransactionData, chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Builds a UserOperation from several onchain transactions and submits via the bundler, then waits for inclusion
      *
@@ -1425,10 +1443,14 @@ declare class DefaultSmartWallet extends SmartWallet {
      *
      * @param transactionData An array of calls to execute
      * @param chainId Target chain ID
+     * @param options Optional parameters
+     * @param options.paymasterToken ERC-20 token address to use for gas payment (e.g., USDC)
      * @returns Promise that resolves to the UserOperation hash for the batch
      * @throws Error with a readable message if submission or inclusion fails
      */
-    sendBatch(transactionData: TransactionData[], chainId: SupportedChainId): Promise<Hash>;
+    sendBatch(transactionData: TransactionData[], chainId: SupportedChainId, options?: {
+        paymasterToken?: Address;
+    }): Promise<Hash>;
     /**
      * Funds the smart wallet with the specified amount of the specified token via Coinbase CDP on-ramp service
      *
@@ -1557,7 +1579,11 @@ declare class FundingNamespace {
  *
  * // Option 1: Initialize with API key (fetches config from backend)
  * const sdk = await MyceliumSDK.init({
- *   apiKey: 'sk_...'
+ *   apiKey: 'sk_...',
+ *   chainId: 8453,
+ *   protocolsSecurityConfig: {
+ *     riskLevel: "low",
+ *   },
  * });
  *
  * // Option 2: Initialize with full configuration