@cryptforge/blockchain-evm 0.1.0 → 0.2.0

package/README.md

@@ -225,6 +225,194 @@ interface EVMAdapterConfig {
 - Fantom (FTM)
 - Any other EVM-compatible chain
 
+## Transaction Examples
+
+### Send Native Token (ETH/S)
+
+```typescript
+import { createAuthClient } from '@cryptforge/auth';
+import { EthereumAdapter } from '@cryptforge/blockchain-evm';
+
+const auth = createAuthClient();
+auth.registerAdapter('ethereum', EthereumAdapter);
+
+// Unlock wallet
+await auth.unlock({ password: 'password', chainId: 'ethereum' });
+
+// Sign and send transaction
+const { signedTransaction, signature } = await auth.signTransaction({
+  transaction: {
+    to: '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+    value: ethers.parseEther('0.1'), // 0.1 ETH
+    gasLimit: 21000,
+  },
+});
+
+console.log('Signed Transaction:', signedTransaction);
+console.log('Transaction Hash:', signature);
+```
+
+### Sign Message
+
+```typescript
+// Unlock wallet first
+await auth.unlock({ password: 'password', chainId: 'ethereum' });
+
+// Sign a message
+const { signature, address, publicKey } = await auth.signMessage({
+  message: 'Hello Ethereum!',
+});
+
+console.log('Signature:', signature);
+console.log('Signed by:', address);
+
+// Verify signature
+const isValid = await auth.verifySignature(
+  'Hello Ethereum!',
+  signature,
+  publicKey
+);
+console.log('Valid:', isValid);
+```
+
+### Get Balance
+
+```typescript
+const adapter = EthereumAdapter;
+
+// Get native balance
+const balance = await adapter.getNativeBalance(
+  '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
+);
+console.log('ETH Balance:', ethers.formatEther(balance));
+
+// Get all token balances
+const tokens = await adapter.getTokenBalances(
+  '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb'
+);
+tokens.forEach(token => {
+  console.log(`${token.symbol}: ${token.balance}`);
+});
+```
+
+### Get Transactions
+
+```typescript
+const adapter = EthereumAdapter;
+
+// Get recent transactions
+const transactions = await adapter.getTransactions(
+  '0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb',
+  { limit: 10 }
+);
+
+transactions.forEach(tx => {
+  console.log('Hash:', tx.hash);
+  console.log('From:', tx.from);
+  console.log('To:', tx.to);
+  console.log('Value:', ethers.formatEther(tx.value));
+});
+```
+
+### Generate Multiple Addresses
+
+```typescript
+// Get addresses at different indices
+const addresses = await auth.getAddresses('ethereum', 0, 5);
+
+addresses.forEach(addr => {
+  console.log(`Index ${addr.index}: ${addr.address}`);
+  console.log(`Path: ${addr.path}`);
+});
+
+// Output:
+// Index 0: 0xabc... Path: m/44'/60'/0'/0/0
+// Index 1: 0xdef... Path: m/44'/60'/0'/0/1
+// ...
+```
+
+## Data Providers
+
+The EVM adapter supports pluggable data providers for fetching blockchain data.
+
+### Using Alchemy Provider
+
+```typescript
+import { EVMAdapter, AlchemyProvider } from '@cryptforge/blockchain-evm';
+
+const adapter = new EVMAdapter({
+  chainData: {
+    name: 'Ethereum',
+    symbol: 'ETH',
+    cmc_id: 1027,
+  },
+  coinType: 60,
+  networks: {
+    mainnet: {
+      name: 'Ethereum Mainnet',
+      rpcUrl: 'https://eth-mainnet.g.alchemy.com/v2/YOUR_API_KEY',
+      chainId: 1,
+    },
+  },
+});
+
+// Alchemy provider automatically detects Alchemy RPC URLs
+// and provides enhanced data fetching capabilities
+```
+
+### Using Etherscan Provider
+
+```typescript
+import { EVMAdapter, EtherscanProvider } from '@cryptforge/blockchain-evm';
+
+const adapter = new EVMAdapter({
+  chainData: {
+    name: 'Ethereum',
+    symbol: 'ETH',
+    cmc_id: 1027,
+  },
+  coinType: 60,
+  networks: {
+    mainnet: {
+      name: 'Ethereum Mainnet',
+      rpcUrl: 'https://mainnet.infura.io/v3/YOUR_KEY',
+      explorerUrl: 'https://etherscan.io',
+      chainId: 1,
+    },
+  },
+});
+
+// Configure Etherscan provider
+const etherscanProvider = new EtherscanProvider({
+  apiKey: 'YOUR_ETHERSCAN_API_KEY',
+  network: 'mainnet',
+});
+```
+
+## Browser Compatibility
+
+This package is **100% browser-compatible**:
+
+- ✅ Chrome, Firefox, Safari, Edge
+- ✅ Node.js (v16+)
+- ✅ Electron (main and renderer)
+- ✅ React Native (with polyfills)
+- ✅ Web Workers
+
+Uses ethers.js which is fully browser-safe.
+
+## Examples
+
+See working examples in:
+- `examples/vue-electron-example/` - Complete wallet application
+- `examples/vue-web-example/` - Web-based wallet
+
+## Related Packages
+
+- **[@cryptforge/auth](../auth)** - Authentication and key management
+- **[@cryptforge/core](../core)** - Core types and interfaces
+- **[@cryptforge/blockchain-btc](../blockchain-btc)** - Bitcoin blockchain adapter
+
 ## License
 
 ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cryptforge/blockchain-evm",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "EVM-compatible blockchain adapter for CryptForge SDK (Ethereum, Sonic, Polygon, etc.)",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -41,7 +41,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@cryptforge/core": "^0.1.0",
+    "@cryptforge/core": "workspace:*",
     "alchemy-sdk": "^3.4.2",
     "ethers": "^6.13.4"
   },
@@ -51,6 +51,6 @@
     "typescript": "^5.7.2"
   },
   "peerDependencies": {
-    "@cryptforge/core": "^0.1.0"
+    "@cryptforge/core": "workspace:*"
   }
 }