@diviswap/sdk 1.7.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LiberEx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,510 @@
+# Diviswap SDK
+
+The official TypeScript/JavaScript SDK for Diviswap - crypto rails made simple. Get up and running in under 9 minutes!
+
+## Quick Start
+
+### Installation
+
+```bash
+npm install @diviswap/sdk
+# or
+yarn add @diviswap/sdk
+# or
+pnpm add @diviswap/sdk
+```
+
+### Basic Usage
+
+```typescript
+import Diviswap from '@diviswap/sdk';
+
+// Initialize the SDK
+const diviswap = Diviswap.init({
+  apiKey: 'your-api-key',
+  clientId: 'your-client-id',
+  environment: 'sandbox' // or 'production'
+});
+
+// Register a new user
+const { user } = await diviswap.auth.register({
+  email: 'user@example.com',
+  password: 'secure-password'
+});
+
+// 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;
+  return;
+}
+
+// Create a bank account (payee)
+const payee = await diviswap.payees.create({
+  nickname: 'My Bank',
+  accountNumber: '123456789',
+  routingNumber: '021000021',
+  accountType: 'checking'
+});
+
+// Create an onramp transaction (buy crypto)
+const transaction = await diviswap.transactions.onramp({
+  amount: 100,
+  currency: 'USD',
+  payeeId: payee.id,
+  toAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123'
+});
+```
+
+## Features
+
+- **Simple Authentication** - Register and login with just email/password
+- **Bank Account Management** - Add and verify bank accounts easily
+- **Crypto On/Off Ramps** - Convert between fiat and crypto seamlessly
+- **Address Management** - Automatic wallet tracking and manual address management
+- **Automatic Token Refresh** - Never worry about expired tokens
+- **TypeScript Support** - Full type safety and IntelliSense
+- **Multi-Environment** - Support for production, sandbox, and local development
+- **Lightweight** - Minimal dependencies, uses native fetch
+
+## API Reference
+
+### Authentication
+
+```typescript
+// Register new user
+await diviswap.auth.register({
+  email: 'user@example.com',
+  password: 'password',
+  firstName: 'John',
+  lastName: 'Doe'
+});
+
+// Login existing user
+await diviswap.auth.login({
+  email: 'user@example.com',
+  password: 'password'
+});
+
+// Get user profile
+const user = await diviswap.auth.getProfile();
+
+// Logout
+await diviswap.auth.logout();
+```
+
+### KYC Verification
+
+```typescript
+// Check compliance status
+const status = await diviswap.kyc.getComplianceStatus();
+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();
+
+// Wait for approval (polling)
+try {
+  await diviswap.kyc.waitForApproval({
+    pollInterval: 5000,
+    maxAttempts: 60
+  });
+} catch (error) {
+  console.log('KYC not approved');
+}
+
+// Get rejection reasons
+if (status.kycStatus === 'REJECTED') {
+  const reasons = await diviswap.kyc.getRejectionReasons();
+}
+```
+
+### Payees (Bank Accounts)
+
+```typescript
+// Create payee
+const payee = await diviswap.payees.create({
+  nickname: 'My Checking',
+  accountNumber: '123456789',
+  routingNumber: '021000021',
+  accountType: 'checking'
+});
+
+// List all payees
+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
+});
+```
+
+### Transactions
+
+```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)
+const offramp = await diviswap.transactions.offramp({
+  amount: 0.5,
+  currency: 'ETH',
+  fromAddress: '0x...',
+  payeeId: 'payee-id'
+});
+
+// List transactions
+const transactions = await diviswap.transactions.list({
+  type: 'onramp',
+  status: 'completed'
+});
+
+// Get fee estimate
+const estimate = await diviswap.transactions.estimateFees({
+  amount: 100,
+  currency: 'USD',
+  type: 'onramp'
+});
+```
+
+### Address Management
+
+#### Automatic Wallet Tracking (Recommended)
+
+```typescript
+import { Diviswap, connectWallet, trackCurrentWallet, setupWalletTracking } from '@diviswap/sdk';
+
+const diviswap = Diviswap.init(config);
+
+// Connect and automatically track wallet
+const connections = await connectWallet(diviswap);
+console.log('Tracked addresses:', connections);
+
+// Track current wallet state without requesting permission
+const current = await trackCurrentWallet(diviswap);
+
+// Setup automatic tracking for account/chain changes
+const tracker = setupWalletTracking(diviswap, {
+  trackAccountChanges: true,
+  trackChainChanges: true,
+  setAsDefault: true
+});
+```
+
+#### Manual Address Management
+
+```typescript
+// Create address manually
+const address = await diviswap.addresses.create({
+  chain_id: 1, // Ethereum mainnet
+  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123',
+  is_default: true
+});
+
+// List all addresses
+const addresses = await diviswap.addresses.list();
+
+// Filter by chain
+const ethAddresses = await diviswap.addresses.list({ chain_id: 1 });
+
+// Get default addresses only
+const defaults = await diviswap.addresses.list({ is_default: true });
+
+// Set address as default for its chain
+await diviswap.addresses.setDefault({
+  chain_id: 1,
+  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123'
+});
+
+// Delete address
+await diviswap.addresses.delete({
+  chain_id: 1,
+  address: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123'
+});
+
+// Convenience methods
+const ethAddresses = await diviswap.addresses.getByChain('ethereum');
+const defaultEth = await diviswap.addresses.getDefault('ethereum');
+const chainId = diviswap.addresses.getChainId('base'); // Returns 8453
+```
+
+#### React Hooks for Addresses
+
+```typescript
+import { useAddresses, useWalletConnection, useWalletAddresses } from '@diviswap/sdk/react';
+
+function AddressManager() {
+  const { addresses, loading, createAddress, setDefaultAddress } = useAddresses(diviswap);
+
+  const { connections, connect, isConnecting } = useWalletConnection(diviswap);
+
+  // Combined hook for wallet + address management
+  const {
+    addresses,
+    connections,
+    connectAndTrack,
+    isConnecting
+  } = useWalletAddresses(diviswap);
+
+  return (
+    <div>
+      <button onClick={() => connectAndTrack()} disabled={isConnecting}>
+        {isConnecting ? 'Connecting...' : 'Connect Wallet'}
+      </button>
+
+      {addresses.map(addr => (
+        <div key={`${addr.chain_id}-${addr.address}`}>
+          {addr.address} {addr.is_default && '(Default)'}
+        </div>
+      ))}
+    </div>
+  );
+}
+```
+
+#### Supported Chains
+
+```typescript
+import { CHAIN_IDS } from '@diviswap/sdk';
+
+// Mainnets
+CHAIN_IDS.ethereum  // 1
+CHAIN_IDS.optimism  // 10
+CHAIN_IDS.base      // 8453
+CHAIN_IDS.polygon   // 137
+CHAIN_IDS.arbitrum  // 42161
+
+// Testnets
+CHAIN_IDS.sepolia        // 11155111
+CHAIN_IDS.optimismSepolia // 11155420
+CHAIN_IDS.baseSepolia    // 84532
+CHAIN_IDS.polygonAmoy    // 80002
+CHAIN_IDS.arbitrumSepolia // 421614
+```
+
+### Fee Management (Monetization)
+
+```typescript
+// Set your custom fee (default is 0.5%)
+await diviswap.fees.setFee({ percentage: 0.75 });
+
+// Calculate fees for transparency
+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
+
+Earn revenue from every transaction with customizable integrator fees:
+
+- **Default 0.5% fee** - Start earning immediately
+- **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.
+
+## Configuration
+
+### Initialization Options
+
+```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)
+});
+```
+
+### Environments
+
+- **Production**: `https://api.diviswap.io`
+- **Sandbox**: `https://sandbox.api.diviswap.io`
+- **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
+- Sensitive data is never logged in debug mode
+- KYC verification required before transactions
+- All user data encrypted and stored securely
+
+## Examples
+
+### Complete Onramp Flow
+
+```typescript
+import Diviswap from '@diviswap/sdk';
+
+async function buyBitcoin() {
+  // Initialize SDK
+  const diviswap = Diviswap.init({
+    apiKey: process.env.DIVISWAP_API_KEY,
+    clientId: process.env.DIVISWAP_CLIENT_ID,
+    environment: 'sandbox'
+  });
+
+  try {
+    // Login user
+    await diviswap.auth.login({
+      email: 'user@example.com',
+      password: 'password'
+    });
+
+    // 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);
+      return;
+    }
+
+    // Get or create a payee
+    let payee = await diviswap.payees.getDefault();
+    if (!payee) {
+      payee = await diviswap.payees.create({
+        nickname: 'My Bank',
+        accountNumber: '123456789',
+        routingNumber: '021000021',
+        accountType: 'checking',
+        setAsDefault: true
+      });
+    }
+
+    // Check fee estimate
+    const estimate = await diviswap.transactions.estimateFees({
+      amount: 100,
+      currency: 'USD',
+      type: 'onramp'
+    });
+
+    console.log(`You'll pay $${estimate.fee} in fees`);
+
+    // Create transaction
+    const tx = await diviswap.transactions.onramp({
+      amount: 100,
+      currency: 'USD',
+      payeeId: payee.id,
+      toAddress: '0x742d35Cc6634C0532925a3b844Bc9e7595f6E123'
+    });
+
+    console.log(`Transaction ${tx.id} created!`);
+
+  } catch (error) {
+    console.error('Error:', error);
+  }
+}
+
+buyBitcoin();
+```
+
+### Complete Wallet Integration Flow
+
+```typescript
+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,
+    environment: 'sandbox'
+  });
+
+  try {
+    // Connect user's wallet and automatically track addresses
+    const connections = await connectWallet(diviswap);
+    console.log('Connected wallets:', connections);
+
+    // Get user's tracked addresses
+    const addresses = await diviswap.addresses.list();
+    console.log('User addresses:', addresses);
+
+    // Use default Ethereum address for offramp
+    const defaultEth = await diviswap.addresses.getDefault('ethereum');
+
+    if (defaultEth) {
+      // Create offramp transaction using tracked address
+      const tx = await diviswap.transactions.offramp({
+        amount: 0.1,
+        currency: 'ETH',
+        fromAddress: defaultEth.address,
+        txHash: '0x...', // Transaction hash from user's wallet
+        chain: 'ethereum',
+        payeeId: 'user-bank-account-id'
+      });
+
+      console.log('Offramp created:', tx.id);
+    }
+
+  } catch (error) {
+    console.error('Error:', error);
+  }
+}
+
+integrateWallet();
+```
+
+## Error Handling
+
+The SDK throws typed errors for different scenarios:
+
+```typescript
+import { DiviswapError, AuthenticationError, ValidationError } from '@diviswap/sdk';
+
+try {
+  await diviswap.auth.login(credentials);
+} catch (error) {
+  if (error instanceof AuthenticationError) {
+    console.error('Invalid credentials');
+  } else if (error instanceof ValidationError) {
+    console.error('Invalid input:', error.details);
+  } else if (error instanceof DiviswapError) {
+    console.error('API error:', error.message);
+  }
+}
+```
+
+## Support
+
+- Email: support@diviswap.io
+- Documentation: https://docs.diviswap.io
+- Issues: https://github.com/diviswap/sdk/issues
+
+## License
+
+MIT

package/bin/create-diviswap-app.js

@@ -0,0 +1,25 @@
+#!/usr/bin/env node
+
+// This file enables `npx @diviswap/sdk` to work
+// It simply forwards to the main CLI with the create-app command
+
+const { spawn } = require('child_process');
+const { join } = require('path');
+
+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');
+}
+
+const child = spawn('node', [cliPath, ...args], {
+  stdio: 'inherit',
+  env: process.env
+});
+
+child.on('exit', (code) => {
+  process.exit(code || 0);
+});

package/bin/diviswap-sdk.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+// This file wraps the compiled CLI
+require('../dist/cli/index.js');