@sega-so/sega-sdk/README.md

An SDK for building applications on top of SEGA.

# Sega SDK

Sega SDK is a comprehensive toolkit for interacting with the Sonic blockchain, providing easy-to-use functions for swapping tokens, managing liquidity pools, and more.

## Installation

```bash
npm install sega-sdk
```

## Documentation

For more detailed documentation, please refer to the source code and examples in the repository.


## Features

- Token swapping
- Liquidity pool management
- Transaction building and execution
- Support for Sonic Mainnet and Testnet

## Swap Example

Here's a basic example of how to use the Sega SDK to swap tokens:

```typescript
import { Keypair, PublicKey } from "@solana/web3.js";
import { Sega, Network, getConnection, CurveCalculator } from "./src/index";
import BN from "bn.js";

// Initialize connection and SDK
const network = Network.SonicTestnetV1;
const connection = getConnection(network);

// Create or import a wallet
const wallet = Keypair.generate(); // Or import from private key

// Initialize Sega SDK
const sega = await Sega.load({
  cluster: 'testnet',
  connection,
  owner: wallet,
  apiRequestInterval: 5 * 60 * 1000,
  apiRequestTimeout: 10 * 1000,
  apiCacheTime: 5 * 60 * 1000,
  blockhashCommitment: 'confirmed',
});

// Define token mint and pool
const usdcMint = new PublicKey("8EdufEDLupX62qQaAMez9nFCXr5vKZ4w8tFgrJXAjTyk");
const poolId = "BmaLNG7n6Aj4pfpUqaaGwyujEkhcoXBcuaPGwN71Wo2R";

// Set input amount and mint
const inputAmount = new BN(100);
const inputMint = usdcMint.toBase58();

// Get pool information
const data = await sega.cpmm.getPoolInfoFromRpc(poolId);
const poolInfo = data.poolInfo;
const poolKeys = data.poolKeys;
const rpcData = data.rpcData;

// Verify input mint matches pool
if (inputMint !== poolInfo.mintA.address && inputMint !== poolInfo.mintB.address) {
  throw new Error('Input mint does not match pool');
}

// Calculate swap parameters
const baseIn = inputMint === poolInfo.mintA.address;
const swapResult = CurveCalculator.swap(
  inputAmount,
  baseIn ? rpcData.baseReserve : rpcData.quoteReserve,
  baseIn ? rpcData.quoteReserve : rpcData.baseReserve,
  rpcData.configInfo!.tradeFeeRate
);

// Create and execute swap transaction
const { execute } = await sega.cpmm.swap({
  poolInfo,
  poolKeys,
  inputAmount,
  swapResult,
  slippage: 0.001, // range: 1 ~ 0.0001, means 100% ~ 0.01%
  baseIn,
});

// Send and confirm transaction
const { txId } = await execute({ sendAndConfirm: true });

console.log(`Swap transaction: https://explorer.sonic.game/${txId}?cluster=testnet.v1`);
```

## Testing

For a complete example of token swapping with tests, see the [swap.test.ts](./test/swap.test.ts) file.

The test demonstrates:
- Connecting to the Sonic Testnet
- Fetching pool information
- Calculating swap parameters
- Creating and executing a swap transaction