@ordanetwork/sdk 1.0.1 → 1.0.2

package/README.md

@@ -11,24 +11,23 @@ TypeScript SDK for cross-chain cryptocurrency payments with smart wallet support
 ```bash
 npm install @ordanetwork/sdk
 # or
-yarn add @ordaordanetwork/sdk
+yarn add @ordanetwork/sdk
 # or
-pnpm add @ordaordanetwork/sdk
+pnpm add @ordanetwork/sdk
 ```
 
 ### Requirements
 
+- **Node.js**: Version 18.0.0 or higher
 - **TypeScript**: Version 5.0.0 or higher (if using TypeScript)
-- **viem**: Required peer dependency for blockchain interactions
 
 ## Features
 
-- 🔐 **HMAC Authentication**: Secure API authentication
-- 🚀 **Zero Dependencies**: Pure TypeScript implementation, no runtime dependencies
-- 📦 **Tree-shakeable**: Optimized for minimal bundle size
-- 🔄 **Async/Await**: Modern promise-based API
-- 💱 **Multi-chain Support**: Cross-chain transfers, off-ramp, and on-ramp operations
-- 🔑 **Smart Wallets**: Integrated Alchemy Account Kit support for UserOperations
+- **HMAC Authentication**: Secure API authentication
+- **Multi-chain Support**: Cross-chain transfers, off-ramp, and on-ramp operations
+- **Smart Wallets**: Integrated Alchemy Account Kit support for UserOperations
+- **Module Formats**: ESM and CommonJS
+- **TypeScript**: Full type definitions included
 
 
 ## Quick Start
@@ -41,25 +40,37 @@ const orda = new OrdaSDK({
   clientSecret: 'your-client-secret'
 });
 
-// Create a recipient
-const recipient = await orda.recipients.create({
+// Create a recipient with smart wallet (no toAddress)
+const recipientWithSmartWallet = await orda.recipients.create({
   name: 'Test Recipient',
   cryptoSettlementDetails: {
-    toChain: '8453'
-    toToken: '0x4200000000000000000000000000000000000006'
+    toChain: '8453',
+    toToken: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913'
+    // No toAddress - will generate smart wallet
+  }
+});
+console.log('Smart wallet:', recipientWithSmartWallet.smartWallet?.address);
+
+// Create a recipient with specific address
+const recipientWithAddress = await orda.recipients.create({
+  name: 'Test Recipient',
+  cryptoSettlementDetails: {
+    toChain: '8453',
+    toToken: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
+    toAddress: '0xYourRecipientAddress'
   }
 });
 
 // Request a quote
 const quote = await orda.quote.request({
-  fromChain: '1', // Ethereum
-  fromToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+  fromChain: '1', // Ethereum mainnet
+  fromToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC
   fromAddress: '0xYourAddress',
   intent: {
     method: 'usd',
     value: '100'
   },
-  recipientId: recipient.recipientId
+  recipientId: recipientWithSmartWallet.recipientId
 });
 ```
 
@@ -79,7 +90,7 @@ import { OrdaSDK } from '@ordanetwork/sdk';
 
 ## Security Considerations
 
-⚠️ **CRITICAL SECURITY WARNING** ⚠️
+**CRITICAL SECURITY WARNING**
 
 **Never expose your API credentials in frontend code!** Your `clientId` and `clientSecret` should always be kept secure on your backend server.
 
@@ -91,7 +102,6 @@ const orda = new OrdaSDK({
   clientSecret: process.env.ORDA_CLIENT_SECRET
 });
 
-// Use the SDK to make API calls
 const quote = await orda.quote.request({
   fromChain: '1',
   fromToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
@@ -112,7 +122,6 @@ const quote = await orda.quote.request({
 const orda = new OrdaSDK({
   clientId: 'your-client-id',
   clientSecret: 'your-client-secret',
-  debug: true
 });
 ```
 
@@ -245,6 +254,127 @@ try {
 }
 ```
 
+## Smart Wallet Support
+
+The SDK includes integrated support for Alchemy Account Kit smart wallets:
+
+```typescript
+// Generate a new private key
+const { privateKey, address } = await orda.smartWallets.generatePrivateKey();
+
+// Validate private key
+const isValid = orda.smartWallets.validatePrivateKey(privateKey);
+
+// Get address from private key
+const address = await orda.smartWallets.getAddressFromPrivateKey(privateKey);
+
+// Create project wallet
+const wallet = await orda.smartWallets.createProjectWallet(
+  projectId,
+  privateKey,
+  chainId
+);
+
+// Create recipient wallet
+const recipientWallet = await orda.smartWallets.createRecipientWallet(
+  recipientId,
+  privateKey,
+  chainId
+);
+```
+
+## Complete Example
+
+```javascript
+const { OrdaSDK } = require('@ordanetwork/sdk');
+
+async function main() {
+  const orda = new OrdaSDK({
+    clientId: process.env.ORDA_CLIENT_ID,
+    clientSecret: process.env.ORDA_CLIENT_SECRET,
+    debug: true,
+  });
+
+  // Create recipient with smart wallet
+  const recipient = await orda.recipients.create({
+    name: 'Test Recipient',
+    cryptoSettlementDetails: {
+      toChain: '8453', // Base
+      toToken: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913', // USDC
+    },
+  });
+  console.log('Smart wallet:', recipient.smartWallet?.address);
+
+  // Request cross-chain quote
+  const quote = await orda.quote.request({
+    fromChain: '1', // Ethereum
+    fromToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC
+    fromAddress: '0xYourAddress',
+    intent: {
+      method: 'usd',
+      value: '100',
+    },
+    recipientId: recipient.recipientId,
+  });
+
+  // Monitor transaction
+  await orda.transactions.waitForCompletion(quote.transactionId, {
+    intervalMs: 10000,
+    timeoutMs: 600000,
+    onStatusUpdate: (status) => console.log('Status:', status),
+  });
+
+  // Off-ramp example (Crypto to Fiat)
+  const offRampRecipient = await orda.recipients.create({
+    name: 'Fiat Recipient',
+    fiatSettlementDetails: {
+      toCurrency: 'BRL',
+      pixKey: 'user@example.com',
+    },
+    kycInformation: {
+      taxId: '12345678901',
+      taxIdCountry: 'BRA',
+      email: 'user@example.com',
+      name: 'User Name',
+    },
+  });
+
+  const offRampQuote = await orda.offRamp.requestQuote({
+    fromChain: '8453',
+    fromToken: '0xE9185Ee218cae427aF7B9764A011bb89FeA761B4', // BRZ
+    fromAddress: '0xYourAddress',
+    intent: {
+      method: 'fromAmount',
+      value: '10000000000000000000', // 10 BRZ
+    },
+    recipientId: offRampRecipient.recipientId,
+  });
+
+  // On-ramp example (Fiat to Crypto)
+  const onRampQuote = await orda.onRamp.requestQuote({
+    fromCurrency: 'BRL',
+    intent: {
+      method: 'fromAmount',
+      value: '100.00',
+    },
+    recipientId: recipient.recipientId,
+  });
+  console.log('PIX payment key:', onRampQuote.depositInstructions.pixKey);
+}
+
+main().catch(console.error);
+```
+
+## Dependencies
+
+The SDK uses the following runtime dependencies:
+
+- `@aa-sdk/core` - Alchemy Account Abstraction SDK core
+- `@account-kit/core` - Account Kit core functionality
+- `@account-kit/infra` - Account Kit infrastructure
+- `@account-kit/smart-contracts` - Smart contract implementations
+- `viem` - TypeScript interface for Ethereum
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ordanetwork/sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "TypeScript SDK for orda API",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",