SubWallet Services SDK Documentation

A comprehensive TypeScript SDK for integrating with SubWallet services, providing seamless access to balance detection, price history, swap operations, XCM transfers, and Cardano functionality.

🚀 Quick Start

import subwalletApiSdk from '@subwallet-monorepos/subwallet-services-sdk';

// Get price history for a token
const priceHistory = await subwalletApiSdk.priceHistoryApi.getPriceHistory('DOT', '1W');

// Detect token balances
const balances = await subwalletApiSdk.balanceDetectionApi.getBalances({
  addresses: ['your-wallet-address'],
  chains: ['polkadot']
});

📚 Documentation Index

🎯 Getting Started

• 📖 Overview - Detailed project overview and capabilities
• ⚡ Installation - Quick setup and installation guide
• 💡 Examples - Basic usage examples and common patterns

🏗️ Architecture

• 🏛️ Architecture Overview - High-level system design
• 🧩 Component Architecture - Service components and relationships
• 🔄 Data Flow - Request/response flow and integration points
• 🎨 Design Patterns - Singleton pattern and API design

👨‍💻 Development

• 🛠️ Development Setup - Environment setup and prerequisites
• 🔨 Build Instructions - Build process and compilation
• 🧪 Testing Guide - Testing strategies and procedures
• 📋 Development Workflow - Contributing and development process

📖 Usage Guide

• ⚙️ Configuration - SDK configuration and customization
• 📚 API Reference - Complete API documentation with examples
• 💻 Code Examples - Integration examples and best practices

🚀 Deployment

• 📦 Version Management - Semantic versioning and release strategy
• 🚢 Release Procedures - Release process and publishing
• 🌍 Environment Setup - Environment configuration

🔧 Troubleshooting

• ❗ Common Issues - Troubleshooting guide and FAQ

🌟 Key Features

📊 Price History API

• Real-time and historical price data
• Multiple timeframe support (1D, 1W, 1M, 3M, YTD, 1Y, ALL)
• Chart-ready data format

💰 Balance Detection API

• Multi-chain balance detection
• Real-time balance updates
• Support for various token standards

🔄 Swap API

• Cross-chain swap operations
• Route optimization
• Slippage protection

🌉 XCM API

• Cross-consensus message passing
• Parachain interoperability
• Asset transfers between chains

🃏 Cardano API

• Cardano-specific operations
• Native token support
• Staking operations

🛠️ Technical Specifications

• Language: TypeScript 5.x
• Runtime: Node.js 18+, Browser (ES2020+)
• Module System: ES Modules
• Package Manager: npm/yarn/pnpm
• Build System: Nx monorepo

🏃‍♂️ Quick Installation

# Using npm
npm install @subwallet-monorepos/subwallet-services-sdk

# Using yarn
yarn add @subwallet-monorepos/subwallet-services-sdk

# Using pnpm
pnpm add @subwallet-monorepos/subwallet-services-sdk

🎯 Basic Usage

import { SubWalletServiceSDK } from '@subwallet-monorepos/subwallet-services-sdk';

// Get singleton instance
const sdk = SubWalletServiceSDK.getInstance();

// Configure for your platform
sdk.updateConfig({
  platform: 'webapp', // 'extension' | 'mobile' | 'webapp'
  baseUrl: 'https://your-custom-endpoint.com' // optional
});

// Use specific services
const prices = await sdk.priceHistoryApi.getPriceHistory('DOT', '1W');
const swapQuote = await sdk.swapApi.getQuote(/* swap params */);

🤝 Contributing

We welcome contributions! Please see our Development Workflow for guidelines on:

• Setting up the development environment
• Code standards and linting
• Testing requirements
• Pull request process

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🆘 Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Community Discord
• 📧 Contact Support

---

🔗 Navigation

• Next: Overview →