API Reference

send(options)

Send a private transaction

Parameters

• to - Recipient address

• amount - Amount to send

• token - Token symbol (default: 'SOL')

Example

await obscura.send({
  to: '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM',
  amount: 1.5,
  token: 'SOL'
});

getBalance()

Get your private balance across all supported tokens

Returns

Object with token symbols as keys and balances as values

Example

const balance = await obscura.getBalance();
console.log(balance); 
// { SOL: 10.5, USDC: 100, USDT: 50 }

deposit(amount, token)

Deposit funds into your private account

Parameters

• amount - Amount to deposit

• token - Token symbol (default: 'SOL')

Example

const deposit = await obscura.deposit({
  amount: 5.0,
  token: 'SOL'
});

console.log('Deposit confirmed:', deposit.hash);

withdraw(amount, token)

Withdraw funds from your private account to a public address

Parameters

• amount - Amount to withdraw

• token - Token symbol

• to - (optional) Recipient address, defaults to connected wallet

Example

const withdrawal = await obscura.withdraw({
  amount: 2.0,
  token: 'SOL',
  to: 'your-public-address'
});

getTransactionHistory()

Get your private transaction history

Options

• limit - Number of transactions (default: 50)

• offset - Pagination offset

Example

const history = await obscura.getTransactionHistory({
  limit: 20,
  offset: 0
});

history.transactions.forEach(tx => {
  console.log(tx.type, tx.amount, tx.token);
});

connectWallet()

Connect a Solana wallet to your Obscura instance

Example

// Automatically opens wallet selection modal
await obscura.connectWallet();

// Or connect programmatically
await obscura.connectWallet('phantom'); // 'phantom', 'solflare', etc.

---

Usage Examples

Complete Example: Send Private Payment

import { Obscura } from '@obscura/sdk';

async function sendPrivatePayment() {
  // Initialize
  const obscura = new Obscura({
    apiKey: process.env.OBSCURA_API_KEY
  });

  // Connect wallet
  await obscura.connectWallet();

  // Check balance
  const balance = await obscura.getBalance();
  console.log('Current balance:', balance);

  // Send private transaction
  try {
    const tx = await obscura.send({
      to: '9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM',
      amount: 1.5,
      token: 'SOL'
    });
    
    console.log('Transaction successful!', tx.hash);
  } catch (error) {
    console.error('Transaction failed:', error);
  }
}

Example: Batch Transactions

async function sendBatchPayments(recipients) {
  const results = await Promise.all(
    recipients.map(recipient => 
      obscura.send({
        to: recipient.address,
        amount: recipient.amount,
        token: recipient.token || 'SOL'
      })
    )
  );
  
  return results;
}

// Usage
const recipients = [
  { address: 'addr1...', amount: 1.0 },
  { address: 'addr2...', amount: 2.5 },
  { address: 'addr3...', amount: 0.5, token: 'USDC' }
];

const results = await sendBatchPayments(recipients);