npm package: @pyxisjs/sdk
Description: A comprehensive DeFi vault management platform built on the Aptos blockchain
Author: Pyxis Team
Latest version: 0.1.19

# Pyxis SDK

[![npm version](https://badge.fury.io/js/@pyxisjs%2Fsdk.svg)](https://badge.fury.io/js/pyxisjs%2Fsdk)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)

A comprehensive DeFi vault management platform built on the Aptos blockchain. Pyxis SDK provides developers with powerful tools to integrate yield-generating vaults into their applications.

## ✨ Features

- 🏦 **Multi-Vault Support** - Access conservative, balanced, and aggressive yield strategies
- 📈 **Portfolio Tracking** - Monitor positions, P&L, and performance
- 🛠️ **TypeScript First** - Full type safety and excellent developer experience
- 🚀 **Production Ready** - Optimized for performance and reliability

## 🚀 Quick Start

### Installation

```bash
# Using pnpm (recommended)
pnpm add @pyxisjs/sdk

# Using npm
npm install @pyxisjs/sdk

# Using yarn
yarn add @pyxisjs/sdk
```

### Basic Usage

```typescript
import { PyxisClient } from '@pyxisjs/sdk';

// Initialize SDK
const sdk = new PyxisClient({
  network: 'testnet',
  timeout: 5000,
});

// Get available vaults
const vaults = await sdk.vault.getAll();

// Deposit into a vault
const depositTx = await sdk.position.deposit('vault-id', '100.0', 'USDC');
console.log('Deposit successful:', depositTx.txHash);
```

## 📚 Documentation

- **[Installation Guide](./docs/installation.md)** - Complete setup instructions
- **[Quick Start](./docs/quick-start.md)** - Get up and running quickly
- **[API Reference](./docs/api-reference.md)** - Complete API documentation
- **[Examples](./docs/examples.md)** - Code examples and use cases
- **[Configuration](./docs/configuration.md)** - SDK configuration options

## 🏗️ Architecture

Pyxis SDK is organized into modular APIs:

```
PyxisClient
├── vault     - Vault creation, discovery, and management
└── position  - Deposits, withdrawals, and portfolio tracking
```

## 🔧 Requirements

- **Node.js**: >= 16.0.0
- **TypeScript**: >= 5.0.0
- **pnpm**: >= 8.0.0 (recommended)

### Peer Dependencies

```bash
pnpm add @aptos-labs/ts-sdk@^3.1.3
```

## 🧪 Development

```bash
# Clone the repository
git clone https://github.com/pyxis/pyxis-sdk.git
cd pyxis-sdk

# Install dependencies
pnpm install

# Run tests
pnpm run test

# Build the project
pnpm run build

# Run linting
pnpm run lint
```

## 📊 Available Scripts

- `pnpm run build` - Compile TypeScript to JavaScript
- `pnpm run dev` - Watch mode compilation
- `pnpm run test` - Run test suite
- `pnpm run test:watch` - Run tests in watch mode
- `pnpm run test:coverage` - Generate coverage report
- `pnpm run lint` - Run ESLint
- `pnpm run lint:fix` - Auto-fix linting issues
- `pnpm run format` - Format code with Prettier
- `pnpm run typecheck` - Run TypeScript type checking

## 🌐 Networks Supported

- **Mainnet** - Production environment
- **Testnet** - Testing and staging
- **Devnet** - Development and experimentation

## 💡 Use Cases

- **DeFi Applications** - Build yield farming interfaces
- **Portfolio Managers** - Create vault management dashboards
- **Analytics Tools** - Develop yield tracking applications
- **Trading Bots** - Automate vault strategies

## 🤝 Contributing

We welcome contributions! Please see our [Contributing Guide](./CONTRIBUTING.md) for details.

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Ensure all tests pass
6. Submit a pull request

## 📝 License

This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.