@diviswap/sdk 1.7.27 → 1.8.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 LiberEx
+Copyright (c) 2024 Diviswap
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -17,12 +17,14 @@ pnpm add @diviswap/sdk
 ### Basic Usage
 
 ```typescript
-import Diviswap from '@diviswap/sdk';
+import { Diviswap } from '@diviswap/sdk';
 
 // Initialize the SDK
 const diviswap = Diviswap.init({
-  apiKey: 'your-api-key',
-  clientId: 'your-client-id',
+  mode: 'partner',
+  keyId: process.env.DIVISWAP_PARTNER_KEY_ID,
+  secretKey: process.env.DIVISWAP_PARTNER_SECRET_KEY,
+  authMethod: 'hmac',
   environment: 'sandbox' // or 'production'
 });
 
@@ -35,10 +37,8 @@ const { user } = await diviswap.auth.register({
 // Check KYC status
 const compliance = await diviswap.kyc.getComplianceStatus();
 if (!compliance.canTransact) {
-  // Start KYC verification
-  const session = await diviswap.kyc.startKycSession();
-  // Redirect user to complete KYC
-  window.location.href = session.sessionUrl;
+  // KYC verification required - redirect to your KYC flow
+  console.log('KYC required:', compliance.nextStep);
   return;
 }
 
@@ -50,12 +50,15 @@ const payee = await diviswap.payees.create({
   accountType: 'checking'
 });
 
-// Create an onramp transaction (buy crypto)
-const transaction = await diviswap.transactions.onramp({
-  amount: 100,
-  currency: 'USD',
+// Create an offramp transaction (sell crypto for fiat)
+// First send crypto, then record the transaction
+const transaction = await diviswap.transactions.offramp({
+  amount: 0.5,
+  currency: 'ETH',
+  fromAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123',
   payeeId: payee.id,
-  toAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123'
+  chain: 'ethereum',
+  txHash: '0x...' // Your crypto transaction hash
 });
 ```
 
@@ -89,8 +92,8 @@ await diviswap.auth.login({
   password: 'password'
 });
 
-// Get user profile
-const user = await diviswap.auth.getProfile();
+// Check if authenticated
+const isLoggedIn = diviswap.auth.isAuthenticated();
 
 // Logout
 await diviswap.auth.logout();
@@ -105,10 +108,6 @@ if (!status.canTransact) {
   console.log('KYC required:', status.nextStep);
 }
 
-// Start KYC verification
-const session = await diviswap.kyc.startKycSession();
-// Redirect to: session.sessionUrl
-
 // Check if KYC approved
 const isApproved = await diviswap.kyc.isKycApproved();
 
@@ -145,35 +144,27 @@ const payees = await diviswap.payees.list();
 // Set default payee
 await diviswap.payees.setDefault(payee.id);
 
-// Verify with micro-deposits
-await diviswap.payees.verify(payee.id, {
-  amount1: 0.32,
-  amount2: 0.45
-});
+// Delete a payee
+await diviswap.payees.delete(payee.id);
 ```
 
 ### Transactions
+**IMPORTANT: If no transaction hash is supplied, the offramp will fail.**
 
 ```typescript
-// Onramp (buy crypto with fiat)
-const onramp = await diviswap.transactions.onramp({
-  amount: 100,
-  currency: 'USD',
-  payeeId: 'payee-id',
-  toAddress: '0x...'
-});
-
 // Offramp (sell crypto for fiat)
+// IMPORTANT: Send crypto first, then call offramp with the tx hash
 const offramp = await diviswap.transactions.offramp({
   amount: 0.5,
   currency: 'ETH',
   fromAddress: '0x...',
-  payeeId: 'payee-id'
+  payeeId: 'payee-id',
+  chain: 'ethereum',
+  txHash: '0x...' // Required: hash from your crypto transaction.
 });
 
 // List transactions
 const transactions = await diviswap.transactions.list({
-  type: 'onramp',
   status: 'completed'
 });
 
@@ -181,8 +172,11 @@ const transactions = await diviswap.transactions.list({
 const estimate = await diviswap.transactions.estimateFees({
   amount: 100,
   currency: 'USD',
-  type: 'onramp'
+  type: 'offramp'
 });
+
+// Get recent transactions
+const recent = await diviswap.transactions.getRecent(10);
 ```
 
 ### Address Management
@@ -306,18 +300,15 @@ CHAIN_IDS.arbitrumSepolia // 421614
 // Set your custom fee (default is 0.5%)
 await diviswap.fees.setFee({ percentage: 0.75 });
 
-// Calculate fees for transparency
+// Get current fee settings
+const fees = await diviswap.fees.getFees();
+console.log(`Total fee: ${fees.totalFeePercentage}%`);
+
+// Calculate fees for a specific amount
 const calc = await diviswap.fees.calculateFees({ amount: 100 });
 console.log(`Diviswap fee: $${calc.baseFee} (1.5%)`);
 console.log(`Your earnings: $${calc.integratorFee} (0.75%)`);
 console.log(`Total fee: $${calc.totalFee}`);
-
-// Track your earnings
-const earnings = await diviswap.fees.getEarnings({
-  startDate: '2024-01-01',
-  endDate: '2024-01-31'
-});
-console.log(`Monthly revenue: $${earnings.totalEarned}`);
 ```
 
 ## Monetization
@@ -328,7 +319,6 @@ Earn revenue from every transaction with customizable integrator fees:
 - **Fully customizable** - Set any fee percentage
 - **Per-user pricing** - Different fees for different user tiers
 - **Transparent** - Users see exact fee breakdowns
-- **Real-time tracking** - Monitor your earnings
 
 See the [Integrator Fees Guide](docs/guides/integrator-fees.md) for details.
 
@@ -338,43 +328,45 @@ See the [Integrator Fees Guide](docs/guides/integrator-fees.md) for details.
 
 ```typescript
 Diviswap.init({
-  apiKey: 'your-api-key',        // Required
-  clientId: 'your-client-id',    // Required
-  environment: 'production',     // Optional: 'production' | 'sandbox' | 'development'
-  apiUrl: 'https://custom.api',  // Optional: Override default API URL
-  debug: false,                  // Optional: Enable debug logging
-  timeout: 30000,                // Optional: Request timeout in ms
-  defaultFee: 0.5                // Optional: Your default fee % (default: 0.5)
+  mode: 'partner',                        // Required: 'partner' for partner authentication
+  keyId: 'pk_...',                        // Required: Your Partner Key ID
+  secretKey: 'sk_...',                    // Required: Your Partner Secret Key
+  authMethod: 'hmac',                     // Optional: 'hmac' (default) or 'jwt'
+  environment: 'production',              // Optional: 'production' | 'sandbox' | 'development'
+  debug: false,                           // Optional: Enable debug logging
+  timeout: 30000                          // Optional: Request timeout in ms
 });
 ```
 
 ### Environments
 
-- **Production**: `https://api.diviswap.io`
-- **Sandbox**: `https://sandbox.api.diviswap.io`
+- **Production**: `https://api.diviswap.com`
+- **Sandbox**: `https://api.diviswap.com` (uses sandbox partner credentials)
 - **Development**: `http://localhost:5000`
 
 ## Security
 
-- API keys and Client IDs are required for all requests
-- Requests are signed with HMAC-SHA256
-- Tokens are automatically refreshed when expired
+- Partner authentication with HMAC-SHA256 request signing (recommended) or JWT
+- Partner credentials (keyId/secretKey) are required for all requests
+- User sessions managed via JWT tokens after login
 - Sensitive data is never logged in debug mode
 - KYC verification required before transactions
 - All user data encrypted and stored securely
 
 ## Examples
 
-### Complete Onramp Flow
+### Complete Offramp Flow
 
 ```typescript
-import Diviswap from '@diviswap/sdk';
+import { Diviswap } from '@diviswap/sdk';
 
-async function buyBitcoin() {
+async function sellCrypto() {
   // Initialize SDK
   const diviswap = Diviswap.init({
-    apiKey: process.env.DIVISWAP_API_KEY,
-    clientId: process.env.DIVISWAP_CLIENT_ID,
+    mode: 'partner',
+    keyId: process.env.DIVISWAP_PARTNER_KEY_ID,
+    secretKey: process.env.DIVISWAP_PARTNER_SECRET_KEY,
+    authMethod: 'hmac',
     environment: 'sandbox'
   });
 
@@ -388,9 +380,7 @@ async function buyBitcoin() {
     // Check KYC status
     const compliance = await diviswap.kyc.getComplianceStatus();
     if (!compliance.canTransact) {
-      console.log('KYC verification required');
-      const session = await diviswap.kyc.startKycSession();
-      console.log('Complete KYC at:', session.sessionUrl);
+      console.log('KYC verification required:', compliance.nextStep);
       return;
     }
 
@@ -406,31 +396,30 @@ async function buyBitcoin() {
       });
     }
 
-    // Check fee estimate
-    const estimate = await diviswap.transactions.estimateFees({
-      amount: 100,
-      currency: 'USD',
-      type: 'onramp'
-    });
+    // Get deposit address for the chain
+    const depositAddress = diviswap.transactions.getDepositAddressForChain('ethereum');
 
-    console.log(`You'll pay $${estimate.fee} in fees`);
+    // 1. First, send crypto to the deposit address (using your wallet library)
+    // const txHash = await sendTransaction({ to: depositAddress, value: amount });
 
-    // Create transaction
-    const tx = await diviswap.transactions.onramp({
-      amount: 100,
-      currency: 'USD',
+    // 2. Then record the offramp transaction with the tx hash
+    const tx = await diviswap.transactions.offramp({
+      amount: 0.5,
+      currency: 'ETH',
+      fromAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123',
       payeeId: payee.id,
-      toAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123'
+      chain: 'ethereum',
+      txHash: '0x...' // Transaction hash from step 1
     });
 
-    console.log(`Transaction ${tx.id} created!`);
+    console.log(`Offramp ${tx.id} created!`);
 
   } catch (error) {
     console.error('Error:', error);
   }
 }
 
-buyBitcoin();
+sellCrypto();
 ```
 
 ### Complete Wallet Integration Flow
@@ -440,8 +429,10 @@ import { Diviswap, connectWallet, useWalletAddresses } from '@diviswap/sdk';
 
 async function integrateWallet() {
   const diviswap = Diviswap.init({
-    apiKey: process.env.DIVISWAP_API_KEY,
-    clientId: process.env.DIVISWAP_CLIENT_ID,
+    mode: 'partner',
+    keyId: process.env.DIVISWAP_PARTNER_KEY_ID,
+    secretKey: process.env.DIVISWAP_PARTNER_SECRET_KEY,
+    authMethod: 'hmac',
     environment: 'sandbox'
   });
 
@@ -501,9 +492,9 @@ try {
 
 ## Support
 
-- Email: support@diviswap.io
-- Documentation: https://docs.diviswap.io
-- Issues: https://github.com/diviswap/sdk/issues
+- Email: support@diviswap.com
+- Documentation: https://docs.diviswap.com
+- Issues: https://github.com/liberex-sv/diviswap-sdk/issues
 
 ## License
 

package/bin/create-diviswap-app.js

@@ -11,15 +11,15 @@ const cliPath = join(__dirname, '..', 'dist', 'cli', 'index.js');
 // Forward all arguments to the main CLI, defaulting to create-app if no command specified
 const args = process.argv.slice(2);
 if (args.length === 0 || !args[0].startsWith('-')) {
-  // If no args or first arg is not a flag, assume create-app
-  args.unshift('create-app');
+    // If no args or first arg is not a flag, assume create-app
+    args.unshift('create-app');
 }
 
 const child = spawn('node', [cliPath, ...args], {
-  stdio: 'inherit',
-  env: process.env
+    stdio: 'inherit',
+    env: process.env,
 });
 
 child.on('exit', (code) => {
-  process.exit(code || 0);
+    process.exit(code || 0);
 });