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

package/LICENSE

@@ -0,0 +1,55 @@
+# Mycelium SDK license
+
+## Overview
+
+This project is dual-licensed under the **Apache License 2.0 (Non-Commercial use only)** and a separate **Commercial License**
+
+- The **Apache License 2.0 (Non-Commercial)** applies to all **non-commercial** use
+- A **Commercial License** is required for any **for-profit**, **enterprise**, or **SaaS** use
+
+## 1. Apache License 2.0 (Non-Commercial)
+
+Copyright © 2025 MyceliumSDK
+All rights reserved
+
+Licensed under the Apache License, Version 2.0 (the "License");  
+you may not use this file except in compliance with the License and the **Non-Commercial Use Restriction** below
+
+You may obtain a copy of the License at:
+
+> https://www.apache.org/licenses/LICENSE-2.0
+
+### Additional non-commercial use restriction
+
+Notwithstanding the terms of the Apache License 2.0,  
+**you may use, copy, modify, and distribute this software only for non-commercial purposes**
+
+“Non-commercial” means use that:
+
+- Does **not** generate revenue or commercial advantage (directly or indirectly)
+- Is **not** used in a product or service offered for sale, rent, or subscription
+- Is **not** used in a business or enterprise setting, except for internal research or testing
+
+If you wish to use this software commercially, you must obtain a separate **Commercial License**
+
+## 2. Commercial License
+
+For commercial use of Mycelium SDK, including but not limited to:
+
+- Use in a commercial or for-profit product or service
+- Integration into closed-source or proprietary software
+- SaaS or hosted offerings built upon Mycelium SDK
+- Use by a company, organization, or enterprise for business purposes
+
+you must obtain a valid **Commercial License** from the copyright holder.
+
+To inquire about a commercial license, please contact:
+
+Email: license@mycelium.sh
+Website: [https://mycelium.sh](https://mycelium.sh)
+
+## 3. No Warranty
+
+This software is provided "as is", without warranty of any kind, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, or noninfringement
+
+In no event shall the authors or copyright holders be liable for any claim, damages, or other liability arising from, out of, or in connection with the software or its use

package/README.md

@@ -142,4 +142,4 @@ Check the [CONTRIBUTION.md](https://github.com/0xdeval/mycelium-sdk/blob/main/CO
 
 ## License
 
-This project is licensed under the dual license - Apache 2.0 + Commercial - see the [LICENSE](https://github.com/0xdeval/mycelium-sdk/blob/main/LICENSE.md)
+This project is licensed under the dual license - Apache 2.0 + Commercial - see the [LICENSE](https://github.com/0xdeval/mycelium-sdk/blob/main/LICENSE)

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   DefaultSmartWallet: () => DefaultSmartWallet,
+  FundingNamespace: () => FundingNamespace,
   MyceliumSDK: () => MyceliumSDK
 });
 module.exports = __toCommonJS(index_exports);
@@ -494,7 +495,7 @@ var DefaultSmartWallet = class extends SmartWallet {
    * Funds the smart wallet with the specified amount of the specified token via Coinbase CDP on-ramp service
    *
    * @public
-   * @category Ramp
+   * @category Funding
    *
    * @remarks
    * If Coinbase CDP is not initialized, the method will throw an error. For more details, visit @see {@link https://docs.cdp.coinbase.com/api-reference/v2/rest-api/onramp/create-an-onramp-session}
@@ -532,7 +533,7 @@ var DefaultSmartWallet = class extends SmartWallet {
    * Cashout token from smart wallet to fiat currency via Coinbase CDP off-ramp service
    *
    * @public
-   * @category Ramp
+   * @category Funding
    *
    * @remarks
    * If Coinbase CDP is not initialized, the method will throw an error. For more details, visit @see {@link https://docs.cdp.coinbase.com/api-reference/rest-api/onramp-offramp/create-sell-quote}
@@ -608,6 +609,42 @@ var DefaultSmartWallet = class extends SmartWallet {
   }
 };
 
+// src/ramp/FundingNamespace.ts
+var FundingNamespace = class {
+  constructor(coinbaseCDP) {
+    this.coinbaseCDP = null;
+    if (!coinbaseCDP) {
+      throw new Error(
+        "Coinbase CDP is not initialized. Please, provide the configuration in the SDK initialization"
+      );
+    }
+    this.coinbaseCDP = coinbaseCDP;
+  }
+  /**
+   * Return all supported countries and payment methods for on-ramp by Coinbase CDP
+   * @public
+   * @category Funding
+   *
+   * @returns @see {@link RampConfigResponse} with supported countries and payment methods for top-up
+   * @throws If API returned an error
+   */
+  async getTopUpConfig() {
+    return await this.coinbaseCDP.getOnRampConfig();
+  }
+  /**
+   * Return all supported countries and payment methods for off-ramp by Coinbase CDP
+   * @public
+   * @category Funding
+   *
+   *
+   * @returns @see {@link RampConfigResponse} with supported countries and payment methods for cash out
+   * @throws If API returned an error
+   */
+  async getCashOutConfig() {
+    return await this.coinbaseCDP.getOffRampConfig();
+  }
+};
+
 // src/tools/ChainManager.ts
 var import_viem5 = require("viem");
 var import_account_abstraction2 = require("viem/account-abstraction");
@@ -913,32 +950,6 @@ var WalletNamespace = class {
   constructor(provider) {
     this.provider = provider;
   }
-  /**
-   * Direct access to the underlying embedded wallet provider
-   *
-   * @public
-   * @category Providers
-   * @remarks
-   * Useful when you need advanced functionality beyond the unified namespace. By default, you should use the unified namespace
-   *
-   * @returns The configured embedded wallet provider instance
-   */
-  get embeddedWalletProvider() {
-    return this.provider.embeddedWalletProvider;
-  }
-  /**
-   * Direct access to the underlying smart wallet provider
-   *
-   * @public
-   * @category Providers
-   * @remarks
-   * Useful when you need advanced functionality beyond the unified namespace. By default, you should use the unified namespace
-   *
-   * @returns The configured smart wallet provider instance
-   */
-  get smartWalletProvider() {
-    return this.provider.smartWalletProvider;
-  }
   /**
    * Creates an embedded wallet
    *
@@ -971,7 +982,7 @@ var WalletNamespace = class {
     return this.provider.createSmartWallet(params);
   }
   /**
-   * Creates a smart wallet with an embedded wallet as signer
+   * A unified a web3 account: creates a smart wallet with an embedded wallet as signer
    *
    * @public
    * @category Creation
@@ -985,11 +996,11 @@ var WalletNamespace = class {
    * @param params.nonce Optional nonce/salt for deterministic address generation (defaults to 0)
    * @returns Promise that resolves to the created {@link SmartWallet}
    */
-  async createWalletWithEmbeddedSigner(params) {
-    return this.provider.createWalletWithEmbeddedSigner(params);
+  async createAccount(params) {
+    return this.provider.createAccount(params);
   }
   /**
-   * Gets a smart wallet using an embedded wallet as the signer
+   * Gets a unified web3 account: a smart wallet using an embedded wallet as the signer
    *
    * @public
    * @category Retrieval
@@ -1007,8 +1018,8 @@ var WalletNamespace = class {
    * @returns Promise that resolves to the {@link SmartWallet}
    * @throws Error if the embedded wallet cannot be found
    */
-  async getSmartWalletWithEmbeddedSigner(params) {
-    return this.provider.getSmartWalletWithEmbeddedSigner(params);
+  async getAccount(params) {
+    return this.provider.getAccount(params);
   }
   /**
    * Gets an existing embedded wallet by ID
@@ -1164,18 +1175,6 @@ var DefaultSmartWalletProvider = class extends SmartWalletProvider {
       ownerIndex
     );
   }
-  /**
-   * Funds a wallet via a faucet if supported by the selected chain
-   *
-   * @internal
-   * @category Funding
-   * @remarks
-   * Placeholder for testnet faucet integration
-   *
-   * @returns Future transaction hash or provider response
-   */
-  fundViaFaucet() {
-  }
 };
 
 // src/wallet/WalletProvider.ts
@@ -1239,9 +1238,12 @@ var WalletProvider = class {
    * @param params.nonce Optional salt/nonce for deterministic address calculation (defaults to 0)
    * @returns Promise that resolves to the created {@link SmartWallet}
    */
-  async createWalletWithEmbeddedSigner(params) {
+  async createAccount(params) {
     const { owners: ownersParam, embeddedWalletIndex, nonce } = params || {};
     const embeddedWallet = await this.embeddedWalletProvider.createWallet();
+    if (!embeddedWallet.walletId) {
+      throw new Error("Failed to create embedded wallet. No wallet ID returned");
+    }
     const account = await embeddedWallet.account();
     let owners;
     if (ownersParam) {
@@ -1251,14 +1253,18 @@ var WalletProvider = class {
     } else {
       owners = [embeddedWallet.address];
     }
-    return this.smartWalletProvider.createWallet({
+    const smartWallet = await this.smartWalletProvider.createWallet({
       owners,
       signer: account,
       nonce
     });
+    return {
+      embeddedWalletId: embeddedWallet.walletId,
+      smartWallet
+    };
   }
   /**
-   * Gets a smart wallet using an embedded wallet as the signer
+   * Gets a unified web3 account: a smart wallet using an embedded wallet as the signer
    *
    * @internal
    * @remarks
@@ -1275,7 +1281,7 @@ var WalletProvider = class {
    * @returns Promise that resolves to the {@link SmartWallet}
    * @throws Error if the embedded wallet cannot be found
    */
-  async getSmartWalletWithEmbeddedSigner(params) {
+  async getAccount(params) {
     const { walletId, deploymentOwners, walletAddress } = params;
     const embeddedWallet = await this.embeddedWalletProvider.getWallet({
       walletId
@@ -2342,6 +2348,15 @@ var MyceliumSDK = class {
    * @see MyceliumSDKConfig
    */
   constructor(config) {
+    /**
+     * Ramp namespace to manage ramp operations. Methods are available on {@link RampNamespace}
+     * @internal
+     * @remarks
+     * If the Coinbase CDP configuration is not provided, the ramp functionality will be disabled.
+     * Calling the respective method will throw an error
+     * @category Tools
+     */
+    this.fundingNamespace = null;
     /**
      * Coinbase CDP instance to Coinbase related and onchain operations using Coinbase CDP API
      * @remarks
@@ -2350,46 +2365,6 @@ var MyceliumSDK = class {
      * @internal
      */
     this.coinbaseCDP = null;
-    /**
-     * Coinbase CDP configuration methods for ramp operations
-     * @public
-     * @category Tools
-     */
-    this.rampConfig = {
-      /**
-       * Return all supported countries and payment methods for on-ramp by Coinbase CDP
-       * @public
-       * @category Ramp
-       *
-       * @returns @see {@link RampConfigResponse} with supported countries and payment methods for top-up
-       * @throws If API returned an error
-       */
-      getTopUpConfig: async () => {
-        if (!this.coinbaseCDP) {
-          throw new Error(
-            "Coinbase CDP is not initialized. Please, provide the configuration in the SDK initialization"
-          );
-        }
-        return await this.coinbaseCDP.getOnRampConfig();
-      },
-      /**
-       * Return all supported countries and payment methods for off-ramp by Coinbase CDP
-       * @public
-       * @category Ramp
-       *
-       *
-       * @returns @see {@link RampConfigResponse} with supported countries and payment methods for cash out
-       * @throws If API returned an error
-       */
-      getCashOutConfig: async () => {
-        if (!this.coinbaseCDP) {
-          throw new Error(
-            "Coinbase CDP is not initialized. Please, provide the configuration in the SDK initialization"
-          );
-        }
-        return await this.coinbaseCDP.getOffRampConfig();
-      }
-    };
     this._chainManager = new ChainManager(
       config.chain || {
         chainId: import_chains7.base.id,
@@ -2410,6 +2385,7 @@ var MyceliumSDK = class {
         config.integratorId,
         this.chainManager
       );
+      this.fundingNamespace = new FundingNamespace(this.coinbaseCDP);
     }
     const protocolsRouterConfig = config.protocolsRouterConfig || {
       riskLevel: "low"
@@ -2420,6 +2396,8 @@ var MyceliumSDK = class {
   /**
    * Returns the chain manager instance for multi-chain operations
    * @public
+   * @remarks
+   * More about methods in {@link ChainManager}
    * @category Tools
    *
    * @returns ChainManager instance of the type {@link ChainManager}
@@ -2427,6 +2405,23 @@ var MyceliumSDK = class {
   get chainManager() {
     return this._chainManager;
   }
+  /**
+   * Returns a funding namespace to manage top ups & cash outs configurations
+   * @public
+   * @remarks
+   * More about methods in {@link FundingNamespace}
+   * @category Tools
+   *
+   * @returns Funding namespace of the type {@link FundingNamespace}
+   */
+  get funding() {
+    if (!this.fundingNamespace) {
+      throw new Error(
+        "Ramp namespace is not initialized. Please, provide the configuration in the SDK initialization"
+      );
+    }
+    return this.fundingNamespace;
+  }
   /**
    * Recommends and initializes a protocol based on router settings
    *
@@ -2495,6 +2490,7 @@ var MyceliumSDK = class {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   DefaultSmartWallet,
+  FundingNamespace,
   MyceliumSDK
 });
 //# sourceMappingURL=index.cjs.map