@megaflow-labs/sdk 0.1.0 → 0.1.1

package/CHANGELOG.md

@@ -6,6 +6,39 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ---
 
+## [0.1.1] – 2026-02-26
+
+### Improvements — Developer Experience
+
+#### Zero external imports (single SDK import pattern)
+- Added `MegaFlowClient.fromPrivateKey(privateKey)` static factory — no need to import `privateKeyToAccount` from viem
+- Added `MegaFlowClient.fromMnemonic(mnemonic)` static factory — create a client from a BIP-39 phrase in one line
+- Added `client.address` getter — access the connected account's address without reaching into viem internals
+
+#### viem re-exports
+The most commonly needed viem utilities are now re-exported from `@megaflow-labs/sdk` directly:
+- **Account factories**: `privateKeyToAccount`, `mnemonicToAccount`, `hdKeyToAccount`
+- **Unit helpers**: `parseUnits`, `parseEther`, `formatUnits`, `formatEther`
+- **Address utilities**: `isAddress`, `getAddress`, `zeroAddress`
+- **Encoding**: `encodeFunctionData`, `decodeFunctionData`, `encodeAbiParameters`, `decodeAbiParameters`
+- **Types**: `Address`, `Hash`, `Hex`, `PublicClient`, `WalletClient`, `Account`, `TransactionReceipt`
+
+Before (v0.1.0):
+```typescript
+import { MegaFlowClient } from '@megaflow-labs/sdk';
+import { privateKeyToAccount } from 'viem/accounts';
+import { parseUnits } from 'viem';
+const client = new MegaFlowClient().connectWithAccount(privateKeyToAccount('0x...'));
+```
+
+After (v0.1.1):
+```typescript
+import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
+const client = MegaFlowClient.fromPrivateKey('0x...');
+```
+
+---
+
 ## [0.1.0] – 2026-02-26
 
 ### Initial release

package/dist/index.d.mts

@@ -1,4 +1,6 @@
 import { Chain, Address, Hex, Hash, TransactionReceipt, PublicClient, WalletClient, Account } from 'viem';
+export { Account, Address, Hash, Hex, PublicClient, TransactionReceipt, WalletClient, decodeAbiParameters, decodeFunctionData, encodeAbiParameters, encodeFunctionData, formatEther, formatUnits, getAddress, hexToBigInt, isAddress, numberToHex, parseEther, parseUnits, zeroAddress } from 'viem';
+export { hdKeyToAccount, mnemonicToAccount, privateKeyToAccount } from 'viem/accounts';
 
 /**
  * MegaETH Chain Definitions
@@ -1472,26 +1474,26 @@ declare class MegaFlowBuilder {
  * - ERC20 balance/allowance reads
  * - Multicall token state fetching
  *
- * @example
+ * @example Zero-config (recommended)
  * ```typescript
- * import { MegaFlowClient } from '@megaflow-labs/sdk';
- * import { privateKeyToAccount } from 'viem/accounts';
+ * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
  *
- * const account = privateKeyToAccount('0x...');
+ * // One import, no viem required
+ * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
  *
- * // Zero-config: uses MegaETH Mainnet by default
- * const client = new MegaFlowClient().connectWithAccount(account);
- *
- * // Read state
- * const balance = await client.getTokenBalance(USDC, account.address);
- * const allowance = await client.getAllowance(USDC, account.address, DEX_ROUTER);
- *
- * // Build + execute in one call
  * const result = await client.batch()
- *   .safeApprove(USDC, DEX_ROUTER, amountIn, allowance)
+ *   .safeApprove(USDC, DEX_ROUTER, parseUnits('100', 6), 0n)
  *   .swapExactTokensForTokens({ ... })
  *   .executeSync(); // instant receipt on MegaETH
  * ```
+ *
+ * @example With existing viem account
+ * ```typescript
+ * import { MegaFlowClient } from '@megaflow-labs/sdk';
+ * import { privateKeyToAccount } from 'viem/accounts';
+ *
+ * const client = new MegaFlowClient().connectWithAccount(privateKeyToAccount('0x...'));
+ * ```
  */
 
 declare class MegaFlowClient {
@@ -1501,6 +1503,30 @@ declare class MegaFlowClient {
     private wsClient?;
     private nonceCache;
     constructor(config?: MegaFlowClientConfig);
+    /**
+     * Create a client from a raw private key.
+     * Eliminates the need to import `privateKeyToAccount` from viem/accounts.
+     *
+     * @example
+     * ```typescript
+     * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
+     * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
+     * ```
+     */
+    static fromPrivateKey(privateKey: Hex, config?: MegaFlowClientConfig): MegaFlowClient;
+    /**
+     * Create a client from a BIP-39 mnemonic phrase.
+     *
+     * @example
+     * ```typescript
+     * const client = MegaFlowClient.fromMnemonic('word1 word2 ... word12');
+     * ```
+     */
+    static fromMnemonic(mnemonic: string, config?: MegaFlowClientConfig): MegaFlowClient;
+    /**
+     * The connected account's address, or undefined if not yet connected.
+     */
+    get address(): Address | undefined;
     connectWithAccount(account: Account, rpcUrl?: string): this;
     connect(walletClient: WalletClient): this;
     /**
@@ -1588,26 +1614,23 @@ declare class MegaFlowClient {
  * atomic transaction through the MegaRouter contract. All operations
  * either succeed together or revert together.
  *
- * @example Quick start
+ * @example Quick start — single import
  * ```typescript
- * import { MegaFlowClient } from '@megaflow-labs/sdk';
- * import { privateKeyToAccount } from 'viem/accounts';
- *
- * const account = privateKeyToAccount('0x...');
+ * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
  *
- * // Zero-config: uses MegaETH Mainnet by default
- * const client = new MegaFlowClient().connectWithAccount(account);
+ * // No viem import needed — fromPrivateKey handles it internally
+ * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
  *
- * const allowance = await client.getAllowance(USDC, account.address, DEX_ROUTER);
+ * const allowance = await client.getAllowance(USDC, client.address!, DEX_ROUTER);
  *
  * const result = await client.batch()
  *   .safeApprove(USDC, DEX_ROUTER, parseUnits('100', 6), allowance)
  *   .swapExactTokensForTokens({
  *     router: DEX_ROUTER,
  *     amountIn: parseUnits('100', 6),
- *     amountOutMin: parseEther('0.03'),
+ *     amountOutMin: parseUnits('0.03', 18),
  *     path: [USDC, WETH],
- *     to: account.address,
+ *     to: client.address!,
  *   })
  *   .executeSync(); // instant receipt on MegaETH
  * ```

package/dist/index.d.ts

@@ -1,4 +1,6 @@
 import { Chain, Address, Hex, Hash, TransactionReceipt, PublicClient, WalletClient, Account } from 'viem';
+export { Account, Address, Hash, Hex, PublicClient, TransactionReceipt, WalletClient, decodeAbiParameters, decodeFunctionData, encodeAbiParameters, encodeFunctionData, formatEther, formatUnits, getAddress, hexToBigInt, isAddress, numberToHex, parseEther, parseUnits, zeroAddress } from 'viem';
+export { hdKeyToAccount, mnemonicToAccount, privateKeyToAccount } from 'viem/accounts';
 
 /**
  * MegaETH Chain Definitions
@@ -1472,26 +1474,26 @@ declare class MegaFlowBuilder {
  * - ERC20 balance/allowance reads
  * - Multicall token state fetching
  *
- * @example
+ * @example Zero-config (recommended)
  * ```typescript
- * import { MegaFlowClient } from '@megaflow-labs/sdk';
- * import { privateKeyToAccount } from 'viem/accounts';
+ * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
  *
- * const account = privateKeyToAccount('0x...');
+ * // One import, no viem required
+ * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
  *
- * // Zero-config: uses MegaETH Mainnet by default
- * const client = new MegaFlowClient().connectWithAccount(account);
- *
- * // Read state
- * const balance = await client.getTokenBalance(USDC, account.address);
- * const allowance = await client.getAllowance(USDC, account.address, DEX_ROUTER);
- *
- * // Build + execute in one call
  * const result = await client.batch()
- *   .safeApprove(USDC, DEX_ROUTER, amountIn, allowance)
+ *   .safeApprove(USDC, DEX_ROUTER, parseUnits('100', 6), 0n)
  *   .swapExactTokensForTokens({ ... })
  *   .executeSync(); // instant receipt on MegaETH
  * ```
+ *
+ * @example With existing viem account
+ * ```typescript
+ * import { MegaFlowClient } from '@megaflow-labs/sdk';
+ * import { privateKeyToAccount } from 'viem/accounts';
+ *
+ * const client = new MegaFlowClient().connectWithAccount(privateKeyToAccount('0x...'));
+ * ```
  */
 
 declare class MegaFlowClient {
@@ -1501,6 +1503,30 @@ declare class MegaFlowClient {
     private wsClient?;
     private nonceCache;
     constructor(config?: MegaFlowClientConfig);
+    /**
+     * Create a client from a raw private key.
+     * Eliminates the need to import `privateKeyToAccount` from viem/accounts.
+     *
+     * @example
+     * ```typescript
+     * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
+     * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
+     * ```
+     */
+    static fromPrivateKey(privateKey: Hex, config?: MegaFlowClientConfig): MegaFlowClient;
+    /**
+     * Create a client from a BIP-39 mnemonic phrase.
+     *
+     * @example
+     * ```typescript
+     * const client = MegaFlowClient.fromMnemonic('word1 word2 ... word12');
+     * ```
+     */
+    static fromMnemonic(mnemonic: string, config?: MegaFlowClientConfig): MegaFlowClient;
+    /**
+     * The connected account's address, or undefined if not yet connected.
+     */
+    get address(): Address | undefined;
     connectWithAccount(account: Account, rpcUrl?: string): this;
     connect(walletClient: WalletClient): this;
     /**
@@ -1588,26 +1614,23 @@ declare class MegaFlowClient {
  * atomic transaction through the MegaRouter contract. All operations
  * either succeed together or revert together.
  *
- * @example Quick start
+ * @example Quick start — single import
  * ```typescript
- * import { MegaFlowClient } from '@megaflow-labs/sdk';
- * import { privateKeyToAccount } from 'viem/accounts';
- *
- * const account = privateKeyToAccount('0x...');
+ * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
  *
- * // Zero-config: uses MegaETH Mainnet by default
- * const client = new MegaFlowClient().connectWithAccount(account);
+ * // No viem import needed — fromPrivateKey handles it internally
+ * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
  *
- * const allowance = await client.getAllowance(USDC, account.address, DEX_ROUTER);
+ * const allowance = await client.getAllowance(USDC, client.address!, DEX_ROUTER);
  *
  * const result = await client.batch()
  *   .safeApprove(USDC, DEX_ROUTER, parseUnits('100', 6), allowance)
  *   .swapExactTokensForTokens({
  *     router: DEX_ROUTER,
  *     amountIn: parseUnits('100', 6),
- *     amountOutMin: parseEther('0.03'),
+ *     amountOutMin: parseUnits('0.03', 18),
  *     path: [USDC, WETH],
- *     to: account.address,
+ *     to: client.address!,
  *   })
  *   .executeSync(); // instant receipt on MegaETH
  * ```

package/dist/index.js

@@ -46,16 +46,32 @@ __export(index_exports, {
   createMegaFlowMainnet: () => createMegaFlowMainnet,
   createMegaFlowTestnet: () => createMegaFlowTestnet,
   deadlineInMinutes: () => deadlineInMinutes,
+  decodeAbiParameters: () => import_viem7.decodeAbiParameters,
+  decodeFunctionData: () => import_viem7.decodeFunctionData,
+  encodeAbiParameters: () => import_viem7.encodeAbiParameters,
+  encodeFunctionData: () => import_viem7.encodeFunctionData,
+  formatEther: () => import_viem5.formatEther,
+  formatUnits: () => import_viem5.formatUnits,
+  getAddress: () => import_viem6.getAddress,
   getKyberQuote: () => getKyberQuote,
+  hdKeyToAccount: () => import_accounts2.hdKeyToAccount,
+  hexToBigInt: () => import_viem5.hexToBigInt,
+  isAddress: () => import_viem6.isAddress,
   isUserRejection: () => isUserRejection,
   isValidAddress: () => isValidAddress,
   isValidHex: () => isValidHex,
   megaethChains: () => megaethChains,
   megaethMainnet: () => megaethMainnet,
   megaethTestnet: () => megaethTestnet,
+  mnemonicToAccount: () => import_accounts2.mnemonicToAccount,
+  numberToHex: () => import_viem5.numberToHex,
   parseBatchExecutedEvent: () => parseBatchExecutedEvent,
   parseCallExecutedEvents: () => parseCallExecutedEvents,
-  parseCallResults: () => parseCallResults
+  parseCallResults: () => parseCallResults,
+  parseEther: () => import_viem5.parseEther,
+  parseUnits: () => import_viem5.parseUnits,
+  privateKeyToAccount: () => import_accounts2.privateKeyToAccount,
+  zeroAddress: () => import_viem6.zeroAddress
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1078,7 +1094,8 @@ var MegaFlowBuilder = class {
 // src/client.ts
 var import_viem4 = require("viem");
 var import_actions = require("viem/actions");
-var MegaFlowClient = class {
+var import_accounts = require("viem/accounts");
+var MegaFlowClient = class _MegaFlowClient {
   constructor(config = {}) {
     // Local nonce cache: address → last used nonce
     this.nonceCache = /* @__PURE__ */ new Map();
@@ -1100,8 +1117,43 @@ var MegaFlowClient = class {
     }
   }
   // ==========================================================================
+  // Static factories — zero external imports needed
+  // ==========================================================================
+  /**
+   * Create a client from a raw private key.
+   * Eliminates the need to import `privateKeyToAccount` from viem/accounts.
+   *
+   * @example
+   * ```typescript
+   * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
+   * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
+   * ```
+   */
+  static fromPrivateKey(privateKey, config = {}) {
+    const account = (0, import_accounts.privateKeyToAccount)(privateKey);
+    return new _MegaFlowClient(config).connectWithAccount(account);
+  }
+  /**
+   * Create a client from a BIP-39 mnemonic phrase.
+   *
+   * @example
+   * ```typescript
+   * const client = MegaFlowClient.fromMnemonic('word1 word2 ... word12');
+   * ```
+   */
+  static fromMnemonic(mnemonic, config = {}) {
+    const account = (0, import_accounts.mnemonicToAccount)(mnemonic);
+    return new _MegaFlowClient(config).connectWithAccount(account);
+  }
+  // ==========================================================================
   // Connection
   // ==========================================================================
+  /**
+   * The connected account's address, or undefined if not yet connected.
+   */
+  get address() {
+    return this.walletClient?.account?.address;
+  }
   connectWithAccount(account, rpcUrl) {
     const chain = this.config.chain ?? megaethMainnet;
     this.walletClient = (0, import_viem4.createWalletClient)({
@@ -1316,6 +1368,10 @@ var MegaFlowClient = class {
 };
 
 // src/index.ts
+var import_accounts2 = require("viem/accounts");
+var import_viem5 = require("viem");
+var import_viem6 = require("viem");
+var import_viem7 = require("viem");
 function createMegaFlow(config) {
   return new MegaFlowBuilder(config);
 }
@@ -1362,14 +1418,30 @@ function createMegaFlowClientTestnet(routerAddress, rpcUrl) {
   createMegaFlowMainnet,
   createMegaFlowTestnet,
   deadlineInMinutes,
+  decodeAbiParameters,
+  decodeFunctionData,
+  encodeAbiParameters,
+  encodeFunctionData,
+  formatEther,
+  formatUnits,
+  getAddress,
   getKyberQuote,
+  hdKeyToAccount,
+  hexToBigInt,
+  isAddress,
   isUserRejection,
   isValidAddress,
   isValidHex,
   megaethChains,
   megaethMainnet,
   megaethTestnet,
+  mnemonicToAccount,
+  numberToHex,
   parseBatchExecutedEvent,
   parseCallExecutedEvents,
-  parseCallResults
+  parseCallResults,
+  parseEther,
+  parseUnits,
+  privateKeyToAccount,
+  zeroAddress
 });

package/dist/index.mjs

@@ -1030,7 +1030,8 @@ import {
   webSocket as webSocket2
 } from "viem";
 import { multicall } from "viem/actions";
-var MegaFlowClient = class {
+import { privateKeyToAccount, mnemonicToAccount } from "viem/accounts";
+var MegaFlowClient = class _MegaFlowClient {
   constructor(config = {}) {
     // Local nonce cache: address → last used nonce
     this.nonceCache = /* @__PURE__ */ new Map();
@@ -1052,8 +1053,43 @@ var MegaFlowClient = class {
     }
   }
   // ==========================================================================
+  // Static factories — zero external imports needed
+  // ==========================================================================
+  /**
+   * Create a client from a raw private key.
+   * Eliminates the need to import `privateKeyToAccount` from viem/accounts.
+   *
+   * @example
+   * ```typescript
+   * import { MegaFlowClient, parseUnits } from '@megaflow-labs/sdk';
+   * const client = MegaFlowClient.fromPrivateKey('0xYOUR_PRIVATE_KEY');
+   * ```
+   */
+  static fromPrivateKey(privateKey, config = {}) {
+    const account = privateKeyToAccount(privateKey);
+    return new _MegaFlowClient(config).connectWithAccount(account);
+  }
+  /**
+   * Create a client from a BIP-39 mnemonic phrase.
+   *
+   * @example
+   * ```typescript
+   * const client = MegaFlowClient.fromMnemonic('word1 word2 ... word12');
+   * ```
+   */
+  static fromMnemonic(mnemonic, config = {}) {
+    const account = mnemonicToAccount(mnemonic);
+    return new _MegaFlowClient(config).connectWithAccount(account);
+  }
+  // ==========================================================================
   // Connection
   // ==========================================================================
+  /**
+   * The connected account's address, or undefined if not yet connected.
+   */
+  get address() {
+    return this.walletClient?.account?.address;
+  }
   connectWithAccount(account, rpcUrl) {
     const chain = this.config.chain ?? megaethMainnet;
     this.walletClient = createWalletClient2({
@@ -1268,6 +1304,10 @@ var MegaFlowClient = class {
 };
 
 // src/index.ts
+import { privateKeyToAccount as privateKeyToAccount2, mnemonicToAccount as mnemonicToAccount2, hdKeyToAccount } from "viem/accounts";
+import { parseUnits, parseEther as parseEther2, formatUnits, formatEther, hexToBigInt, numberToHex } from "viem";
+import { isAddress, getAddress, zeroAddress } from "viem";
+import { encodeFunctionData as encodeFunctionData2, decodeFunctionData, encodeAbiParameters, decodeAbiParameters as decodeAbiParameters2 } from "viem";
 function createMegaFlow(config) {
   return new MegaFlowBuilder(config);
 }
@@ -1313,14 +1353,30 @@ export {
   createMegaFlowMainnet,
   createMegaFlowTestnet,
   deadlineInMinutes,
+  decodeAbiParameters2 as decodeAbiParameters,
+  decodeFunctionData,
+  encodeAbiParameters,
+  encodeFunctionData2 as encodeFunctionData,
+  formatEther,
+  formatUnits,
+  getAddress,
   getKyberQuote,
+  hdKeyToAccount,
+  hexToBigInt,
+  isAddress,
   isUserRejection,
   isValidAddress,
   isValidHex,
   megaethChains,
   megaethMainnet,
   megaethTestnet,
+  mnemonicToAccount2 as mnemonicToAccount,
+  numberToHex,
   parseBatchExecutedEvent,
   parseCallExecutedEvents,
-  parseCallResults
+  parseCallResults,
+  parseEther2 as parseEther,
+  parseUnits,
+  privateKeyToAccount2 as privateKeyToAccount,
+  zeroAddress
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@megaflow-labs/sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Batch transaction SDK for MegaETH — compose, simulate and execute multiple on-chain operations in a single atomic transaction.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",