@scallop-io/scallop-deepbook-kit 0.1.3

package/README.md

@@ -0,0 +1,360 @@
+# Scallop DeepBook Kit
+
+A comprehensive toolkit for interacting with DeepBook V3 Margin Pools on the Sui blockchain.
+一個在 Sui 區塊鏈上與 DeepBook V3 Margin Pools 互動的完整工具套件。
+
+## Features | 功能特色
+
+- **DeepBook V3 Integration** | **DeepBook V3 整合**
+  Complete integration with DeepBook V3 Margin Pool system
+  完整整合 DeepBook V3 Margin Pool 系統
+
+- **Simplified API** | **簡化的 API**
+  Clean and intuitive API for complex margin operations
+  簡潔直觀的 API，處理複雜的 margin 操作
+
+- **Supplier Cap Management** | **Supplier Cap 管理**
+  Automatic creation and management of Supplier Credentials
+  自動創建和管理供應者憑證
+
+- **Referral System** | **推薦系統**
+  Built-in referral creation and fee withdrawal support
+  內建推薦系統創建和費用提取支援
+
+- **Balance Tracking** | **餘額追蹤**
+  Query wallet and margin pool balances in real-time
+  即時查詢錢包和 margin pool 餘額
+
+- **TypeScript Support** | **TypeScript 支援**
+  Full TypeScript support with comprehensive type definitions
+  完整的 TypeScript 支援與詳盡的型別定義
+
+- **Environment Management** | **環境管理**
+  Easy-to-use environment variable management utilities
+  易於使用的環境變數管理工具
+
+## Prerequisites | 環境需求
+
+- **Node.js** >= 18.0.0
+- **pnpm** >= 9.0.0
+- **Sui Testnet Account** with SUI and DBUSDC balance
+  **Sui 測試網帳戶**，需包含 SUI 和 DBUSDC 餘額
+
+## Installation | 安裝
+
+```bash
+# Clone the repository | 克隆儲存庫
+git clone https://github.com/your-username/scallop-deepbook-kit.git
+cd scallop-deepbook-kit
+
+# Install dependencies | 安裝依賴
+pnpm install
+
+# Setup environment variables | 設定環境變數
+cp .env.example .env
+# Edit .env and add your PRIVATE_KEY | 編輯 .env 並新增您的 PRIVATE_KEY
+```
+
+## Quick Start | 快速開始
+
+### 1. Configure Environment | 配置環境
+
+Create a `.env` file in the project root:
+在專案根目錄建立 `.env` 檔案：
+
+```env
+# Required: Your wallet private key (hex format, without 0x prefix)
+# 必需：您的錢包私鑰（hex 格式，不含 0x 前綴）
+PRIVATE_KEY=your_private_key_here
+
+# Optional: These will be auto-generated and saved
+# 可選：這些會自動產生並儲存
+# SUPPLIER_CAP_ID=
+# SUI_REFERRAL_ID=
+# DBUSDC_REFERRAL_ID=
+```
+
+### 2. Run the Demo | 執行示範
+
+```bash
+# Run the complete toolkit demo | 執行完整的 toolkit 示範
+pnpm example:toolkit
+```
+
+The demo will:
+示範程式將會：
+
+- Create or load Supplier Cap | 創建或載入 Supplier Cap
+- Create referrals for SUI and DBUSDC | 為 SUI 和 DBUSDC 創建 referrals
+- Withdraw all existing supplies | 提取所有現有的供應
+- Supply 0.1 SUI and 10 DBUSDC to margin pools | 供應 0.1 SUI 和 10 DBUSDC 到 margin pools
+- Track and display balance changes | 追蹤並顯示餘額變化
+
+### 3. Use the Toolkit in Your Code | 在程式碼中使用 Toolkit
+
+```typescript
+import { DeepBookMarginToolkit } from './toolkit';
+
+// Initialize the toolkit | 初始化 toolkit
+const toolkit = new DeepBookMarginToolkit({
+  network: 'testnet',
+  privateKey: process.env.PRIVATE_KEY!,
+  supplierCapId: process.env.SUPPLIER_CAP_ID, // Optional | 可選
+});
+
+// Initialize (creates Supplier Cap if needed) | 初始化（需要時創建 Supplier Cap）
+await toolkit.initialize();
+
+// Create a referral | 創建 referral
+const referralId = await toolkit.createSupplyReferral('SUI');
+
+// Supply to margin pool | 供應到 margin pool
+await toolkit.supplyToMarginPool('SUI', 0.1, referralId);
+
+// Get balance | 查詢餘額
+const balance = await toolkit.getBalance('SUI');
+console.log(`Supply amount: ${balance.userSupplyAmount}`);
+console.log(`Wallet balance: ${balance.walletBalance}`);
+
+// Withdraw from margin pool | 從 margin pool 提取
+await toolkit.withdrawFromMarginPool('SUI'); // Withdraws all | 提取全部
+
+// Withdraw referral fees | 提取 referral 費用
+await toolkit.withdrawReferralFees('SUI', referralId);
+```
+
+## API Reference | API 參考
+
+### DeepBookMarginToolkit
+
+#### Constructor | 建構函式
+
+```typescript
+new DeepBookMarginToolkit(config: ToolkitConfig)
+```
+
+**Parameters | 參數:**
+
+- `config.network`: `'testnet' | 'mainnet'` - Network type | 網路類型
+- `config.privateKey`: `string` - Private key (hex, no 0x prefix) | 私鑰（hex 格式，無 0x 前綴）
+- `config.supplierCapId?`: `string` - Optional existing Supplier Cap ID | 可選的現有 Supplier Cap ID
+
+#### Methods | 方法
+
+##### `initialize(): Promise<string>`
+
+Initialize the toolkit and create Supplier Cap if needed.
+初始化 toolkit 並在需要時創建 Supplier Cap。
+
+**Returns | 返回:** Supplier Cap ID
+
+##### `createSupplyReferral(coin: MarginCoinType): Promise<string | null>`
+
+Create a supply referral for the specified coin.
+為指定的幣種創建供應 referral。
+
+**Parameters | 參數:**
+
+- `coin`: `'SUI' | 'DBUSDC'` - Coin type | 幣種
+
+**Returns | 返回:** Referral ID or null
+
+##### `supplyToMarginPool(coin: MarginCoinType, amount: number, referralId?: string): Promise<boolean>`
+
+Supply funds to the margin pool.
+供應資金到 margin pool。
+
+**Parameters | 參數:**
+
+- `coin`: `'SUI' | 'DBUSDC'` - Coin type | 幣種
+- `amount`: `number` - Amount in human-readable units | 人類可讀單位的金額
+- `referralId?`: `string` - Optional referral ID | 可選的 referral ID
+
+**Returns | 返回:** Success status
+
+##### `withdrawFromMarginPool(coin: MarginCoinType, amount?: number): Promise<boolean>`
+
+Withdraw funds from the margin pool.
+從 margin pool 提取資金。
+
+**Parameters | 參數:**
+
+- `coin`: `'SUI' | 'DBUSDC'` - Coin type | 幣種
+- `amount?`: `number` - Optional amount, omit to withdraw all | 可選的金額，省略則提取全部
+
+**Returns | 返回:** Success status
+
+##### `withdrawReferralFees(coin: MarginCoinType, referralId: string): Promise<boolean>`
+
+Withdraw accumulated referral fees.
+提取累積的 referral 費用。
+
+**Parameters | 參數:**
+
+- `coin`: `'SUI' | 'DBUSDC'` - Coin type | 幣種
+- `referralId`: `string` - Referral Object ID | Referral 物件 ID
+
+**Returns | 返回:** Success status
+
+##### `getBalance(coin: MarginCoinType): Promise<MarginBalance>`
+
+Query margin balance for a coin.
+查詢幣種的 margin 餘額。
+
+**Parameters | 參數:**
+
+- `coin`: `'SUI' | 'DBUSDC'` - Coin type | 幣種
+
+**Returns | 返回:** Balance information with `userSupplyAmount` and `walletBalance`
+
+##### `getAddress(): string`
+
+Get the wallet address.
+獲取錢包地址。
+
+**Returns | 返回:** Wallet address
+
+##### `getSupplierCapId(): string | undefined`
+
+Get the Supplier Cap ID.
+獲取 Supplier Cap ID。
+
+**Returns | 返回:** Supplier Cap ID or undefined
+
+## Development Commands | 開發指令
+
+### Build | 建置
+
+```bash
+pnpm build          # Compile TypeScript | 編譯 TypeScript
+pnpm build:watch    # Watch mode compilation | 監聽模式編譯
+pnpm clean          # Remove build artifacts | 清除建置檔案
+```
+
+### Code Quality | 程式碼品質
+
+```bash
+pnpm lint           # Check code style with ESLint | 使用 ESLint 檢查程式碼風格
+pnpm lint:fix       # Auto-fix ESLint issues | 自動修正 ESLint 問題
+pnpm format         # Format code with Prettier | 使用 Prettier 格式化程式碼
+pnpm format:check   # Check code formatting | 檢查程式碼格式
+```
+
+### Testing | 測試
+
+```bash
+pnpm test           # Run tests | 執行測試
+pnpm test:watch     # Run tests in watch mode | 監聽模式執行測試
+pnpm test:coverage  # Generate coverage report | 產生覆蓋率報告
+```
+
+### Examples | 範例
+
+```bash
+pnpm example:toolkit  # Run the DeepBook Margin Toolkit demo | 執行 DeepBook Margin Toolkit 示範
+```
+
+## Project Structure | 專案結構
+
+```
+.
+├── src/
+│   ├── toolkit/                    # Core toolkit implementation | 核心 toolkit 實作
+│   │   ├── DeepBookMarginToolkit.ts  # Main toolkit class | 主要 toolkit 類別
+│   │   ├── types.ts                  # Type definitions | 型別定義
+│   │   └── index.ts                  # Exports | 匯出
+│   ├── examples/                   # Example scripts | 範例程式
+│   │   └── toolkit-demo.ts          # Complete demo | 完整示範
+│   ├── utils/                      # Utility functions | 工具函式
+│   │   └── env-manager.ts           # Environment variable management | 環境變數管理
+│   ├── config.ts                   # Configuration loader | 配置載入器
+│   └── testnet-config.ts           # Testnet constants | 測試網常數
+├── tests/                          # Test files | 測試檔案
+├── dist/                           # Build output (git-ignored) | 建置輸出（git 忽略）
+└── .env                            # Environment variables (git-ignored) | 環境變數（git 忽略）
+```
+
+## Tech Stack | 技術堆疊
+
+### Core Dependencies | 核心依賴
+
+- **[@mysten/sui](https://www.npmjs.com/package/@mysten/sui)** ^1.44.0 - Sui blockchain SDK | Sui 區塊鏈 SDK
+- **[@mysten/deepbook-v3](https://www.npmjs.com/package/@mysten/deepbook-v3)** ^0.20.2 - DeepBook V3 SDK
+- **[dotenv](https://www.npmjs.com/package/dotenv)** ^17.2.3 - Environment variable management | 環境變數管理
+
+### Development Tools | 開發工具
+
+- **[TypeScript](https://www.typescriptlang.org/)** ^5.9.3 - Type-safe JavaScript | 型別安全的 JavaScript
+- **[Jest](https://jestjs.io/)** ^30.2.0 - Testing framework | 測試框架
+- **[ESLint](https://eslint.org/)** ^9.39.1 - Code linting | 程式碼檢查
+- **[Prettier](https://prettier.io/)** ^3.6.2 - Code formatting | 程式碼格式化
+- **[tsx](https://www.npmjs.com/package/tsx)** ^4.19.2 - TypeScript execution | TypeScript 執行工具
+
+### Package Manager | 套件管理器
+
+- **[pnpm](https://pnpm.io/)** ^10.21.0 - Fast, disk space efficient package manager | 快速、節省磁碟空間的套件管理器
+
+## Configuration | 配置
+
+### Testnet Configuration | 測試網配置
+
+The toolkit uses predefined testnet configurations for:
+toolkit 使用預定義的測試網配置：
+
+- **Coins | 幣種**: SUI, DBUSDC, DEEP
+- **Pools | 池子**: SUI/DBUSDC trading pool
+- **Margin Pools | Margin 池子**: SUI and DBUSDC margin pools
+
+These configurations are defined in `src/testnet-config.ts`.
+這些配置定義於 `src/testnet-config.ts`。
+
+## Environment Variables | 環境變數
+
+| Variable             | Description                     | Required | Auto-generated |
+| -------------------- | ------------------------------- | -------- | -------------- |
+| `PRIVATE_KEY`        | Wallet private key (hex, no 0x) | ✅ Yes   | ❌ No          |
+| `SUPPLIER_CAP_ID`    | Supplier Cap Object ID          | ❌ No    | ✅ Yes         |
+| `SUI_REFERRAL_ID`    | SUI Supply Referral ID          | ❌ No    | ✅ Yes         |
+| `DBUSDC_REFERRAL_ID` | DBUSDC Supply Referral ID       | ❌ No    | ✅ Yes         |
+
+| 變數                 | 說明                    | 必需  | 自動產生 |
+| -------------------- | ----------------------- | ----- | -------- |
+| `PRIVATE_KEY`        | 錢包私鑰（hex，無 0x）  | ✅ 是 | ❌ 否    |
+| `SUPPLIER_CAP_ID`    | Supplier Cap 物件 ID    | ❌ 否 | ✅ 是    |
+| `SUI_REFERRAL_ID`    | SUI 供應 Referral ID    | ❌ 否 | ✅ 是    |
+| `DBUSDC_REFERRAL_ID` | DBUSDC 供應 Referral ID | ❌ 否 | ✅ 是    |
+
+## Troubleshooting | 疑難排解
+
+### Common Issues | 常見問題
+
+**Issue | 問題:** "Supplier Cap not initialized"
+**Solution | 解決方法:** Call `await toolkit.initialize()` before using other methods | 在使用其他方法前呼叫 `await toolkit.initialize()`
+
+**Issue | 問題:** Transaction fails due to insufficient balance
+**Solution | 解決方法:** Ensure you have enough SUI and DBUSDC in your wallet | 確保錢包中有足夠的 SUI 和 DBUSDC
+
+**Issue | 問題:** "Failed to create Supplier Cap"
+**Solution | 解決方法:** Check network connectivity and wallet balance | 檢查網路連線和錢包餘額
+
+## Contributing | 貢獻
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+歡迎貢獻！請隨時提交 Pull Request。
+
+## License | 授權
+
+MIT License - see [LICENSE](LICENSE) file for details.
+MIT 授權 - 詳情請見 [LICENSE](LICENSE) 檔案。
+
+## Links | 連結
+
+- [DeepBook Documentation](https://docs.sui.io/standards/deepbookv3-sdk)
+- [Sui Documentation](https://docs.sui.io/)
+- [DeepBook V3 SDK](https://www.npmjs.com/package/@mysten/deepbook-v3)
+- [Sui TypeScript SDK](https://www.npmjs.com/package/@mysten/sui)
+
+---
+
+**Made with ❤️ for the Sui and DeepBook community**
+**用 ❤️ 為 Sui 和 DeepBook 社群打造**

package/dist/index.d.mts

@@ -0,0 +1,80 @@
+import * as _mysten_deepbook_v3 from '@mysten/deepbook-v3';
+import { MarginPoolContract, DeepBookConfig } from '@mysten/deepbook-v3';
+import { SuiClient } from '@mysten/sui/client';
+import { Transaction } from '@mysten/sui/transactions';
+
+type NetworkType = 'testnet' | 'mainnet';
+type MarginCoinType = 'SUI' | 'DBUSDC';
+interface ToolkitConfig {
+    network: NetworkType;
+    privateKey: string;
+    supplierCapId?: string;
+    fullnodeUrl?: string;
+}
+interface TransactionResult {
+    digest: string;
+    status: string;
+    objectId?: string;
+}
+interface MarginBalance {
+    userSupplyAmount: number;
+    walletBalance: number;
+}
+interface ReferralInfo {
+    referralId: string;
+    coin: MarginCoinType;
+    owner: string;
+}
+
+declare class DeepBookMarginToolkit {
+    #private;
+    private suiClient;
+    private keypair;
+    private address;
+    private marginPoolContract;
+    private supplierCapId?;
+    constructor(config: ToolkitConfig);
+    initialize(): Promise<string>;
+    createSupplierCap(): Promise<string | null>;
+    createSupplyReferral(coin: MarginCoinType): Promise<string | null>;
+    supplyToMarginPool(coin: MarginCoinType, amount: number, referralId?: string): Promise<boolean>;
+    withdrawFromMarginPool(coin: MarginCoinType, amount?: number): Promise<boolean>;
+    withdrawReferralFees(coin: MarginCoinType, referralId: string): Promise<boolean>;
+    getBalance(coin: MarginCoinType): Promise<MarginBalance>;
+    getSupplierCapId(): string | undefined;
+    getAddress(): string;
+}
+
+declare const MARGIN_POOL_PARAM_KEYS: readonly ["supplyCap", "maxUtilizationRate", "protocolSpread", "minBorrow", "interestRate", "totalSupply", "supplyShares", "totalBorrow", "borrowShares", "lastUpdateTimestamp"];
+declare const MARGIN_POOL_W_SUPPLIER_CAP_PARAM_KEYS: readonly ["userSupplyShares", "userSupplyAmount"];
+
+type MarginPoolParamKey = (typeof MARGIN_POOL_PARAM_KEYS)[number];
+type MarginPoolWithSupplierCapParamKey = (typeof MARGIN_POOL_W_SUPPLIER_CAP_PARAM_KEYS)[number];
+type InterestConfig = {
+    midKink: number;
+    highKink: number;
+    baseBorrowApr: number;
+    midBorrowApr: number;
+    highBorrowApr: number;
+    maxBorrowApr: number;
+    borrowApr: number;
+};
+type MarginPoolParams = Record<MarginPoolParamKey | MarginPoolWithSupplierCapParamKey, number> & InterestConfig & {
+    address: string;
+    type: string;
+    scalar: number;
+    decimals: number;
+};
+declare class DeepBookMarginPool {
+    #private;
+    readonly suiClient: SuiClient;
+    marginPoolContract: MarginPoolContract;
+    dbConfig: DeepBookConfig;
+    constructor(env?: NetworkType, address?: string, suiClient?: SuiClient, dbConfig?: DeepBookConfig);
+    get env(): _mysten_deepbook_v3.Environment;
+    getPoolParameters(coinKey: string, supplierCapId?: string, tx?: Transaction): Promise<MarginPoolParams>;
+    getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: true): Promise<MarginPoolParams>;
+    getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: false): Promise<Transaction>;
+}
+
+export { DeepBookMarginPool, DeepBookMarginToolkit, type MarginBalance, type MarginCoinType, type MarginPoolParams, type NetworkType, type ReferralInfo, type ToolkitConfig, type TransactionResult };

package/dist/index.d.ts

@@ -0,0 +1,80 @@
+import * as _mysten_deepbook_v3 from '@mysten/deepbook-v3';
+import { MarginPoolContract, DeepBookConfig } from '@mysten/deepbook-v3';
+import { SuiClient } from '@mysten/sui/client';
+import { Transaction } from '@mysten/sui/transactions';
+
+type NetworkType = 'testnet' | 'mainnet';
+type MarginCoinType = 'SUI' | 'DBUSDC';
+interface ToolkitConfig {
+    network: NetworkType;
+    privateKey: string;
+    supplierCapId?: string;
+    fullnodeUrl?: string;
+}
+interface TransactionResult {
+    digest: string;
+    status: string;
+    objectId?: string;
+}
+interface MarginBalance {
+    userSupplyAmount: number;
+    walletBalance: number;
+}
+interface ReferralInfo {
+    referralId: string;
+    coin: MarginCoinType;
+    owner: string;
+}
+
+declare class DeepBookMarginToolkit {
+    #private;
+    private suiClient;
+    private keypair;
+    private address;
+    private marginPoolContract;
+    private supplierCapId?;
+    constructor(config: ToolkitConfig);
+    initialize(): Promise<string>;
+    createSupplierCap(): Promise<string | null>;
+    createSupplyReferral(coin: MarginCoinType): Promise<string | null>;
+    supplyToMarginPool(coin: MarginCoinType, amount: number, referralId?: string): Promise<boolean>;
+    withdrawFromMarginPool(coin: MarginCoinType, amount?: number): Promise<boolean>;
+    withdrawReferralFees(coin: MarginCoinType, referralId: string): Promise<boolean>;
+    getBalance(coin: MarginCoinType): Promise<MarginBalance>;
+    getSupplierCapId(): string | undefined;
+    getAddress(): string;
+}
+
+declare const MARGIN_POOL_PARAM_KEYS: readonly ["supplyCap", "maxUtilizationRate", "protocolSpread", "minBorrow", "interestRate", "totalSupply", "supplyShares", "totalBorrow", "borrowShares", "lastUpdateTimestamp"];
+declare const MARGIN_POOL_W_SUPPLIER_CAP_PARAM_KEYS: readonly ["userSupplyShares", "userSupplyAmount"];
+
+type MarginPoolParamKey = (typeof MARGIN_POOL_PARAM_KEYS)[number];
+type MarginPoolWithSupplierCapParamKey = (typeof MARGIN_POOL_W_SUPPLIER_CAP_PARAM_KEYS)[number];
+type InterestConfig = {
+    midKink: number;
+    highKink: number;
+    baseBorrowApr: number;
+    midBorrowApr: number;
+    highBorrowApr: number;
+    maxBorrowApr: number;
+    borrowApr: number;
+};
+type MarginPoolParams = Record<MarginPoolParamKey | MarginPoolWithSupplierCapParamKey, number> & InterestConfig & {
+    address: string;
+    type: string;
+    scalar: number;
+    decimals: number;
+};
+declare class DeepBookMarginPool {
+    #private;
+    readonly suiClient: SuiClient;
+    marginPoolContract: MarginPoolContract;
+    dbConfig: DeepBookConfig;
+    constructor(env?: NetworkType, address?: string, suiClient?: SuiClient, dbConfig?: DeepBookConfig);
+    get env(): _mysten_deepbook_v3.Environment;
+    getPoolParameters(coinKey: string, supplierCapId?: string, tx?: Transaction): Promise<MarginPoolParams>;
+    getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: true): Promise<MarginPoolParams>;
+    getPoolParameters(coinKey: string, supplierCapId: string | undefined, tx: Transaction, inspect: false): Promise<Transaction>;
+}
+
+export { DeepBookMarginPool, DeepBookMarginToolkit, type MarginBalance, type MarginCoinType, type MarginPoolParams, type NetworkType, type ReferralInfo, type ToolkitConfig, type TransactionResult };

package/dist/index.js

@@ -0,0 +1 @@
+'use strict';var client=require('@mysten/sui/client'),ed25519=require('@mysten/sui/keypairs/ed25519'),transactions=require('@mysten/sui/transactions'),deepbookV3=require('@mysten/deepbook-v3'),cryptography=require('@mysten/sui/cryptography'),bcs$1=require('@mysten/bcs'),bcs=require('@mysten/sui/bcs'),bignumber_js=require('bignumber.js');var D={MARGIN_INITIAL_PACKAGE_ID:"0x7f2d8f15343f210e813595a8798d6197d152061d0a35be938372f4b1cd66f209"},c={DEEP:{address:"0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8",type:"0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP",scalar:1e6,decimals:6},SUI:{address:"0x0000000000000000000000000000000000000000000000000000000000000002",type:"0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",scalar:1e9,decimals:9},DBUSDC:{address:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7",type:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC",scalar:1e6,decimals:6},DBUSDT:{address:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7",type:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDT::DBUSDT",scalar:1e6,decimals:6},WAL:{address:"0x9ef7676a9f81937a52ae4b2af8d511a28a0b080477c0c2db40b0ab8882240d76",type:"0x9ef7676a9f81937a52ae4b2af8d511a28a0b080477c0c2db40b0ab8882240d76::wal::WAL",scalar:1e9,decimals:9}},f={DEEP_SUI:{address:"0x48c95963e9eac37a316b7ae04a0deb761bcdcc2b67912374d6036e7f0e9bae9f",baseCoin:"DEEP",quoteCoin:"SUI",lotSize:1e6,tickSize:1e6},SUI_DBUSDC:{address:"0x1c19362ca52b8ffd7a33cee805a67d40f31e6ba303753fd3a4cfdfacea7163a5",baseCoin:"SUI",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},DEEP_DBUSDC:{address:"0xe86b991f8632217505fd859445f9803967ac84a9d4a1219065bf191fcb74b622",baseCoin:"DEEP",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},DBUSDT_DBUSDC:{address:"0x83970bb02e3636efdff8c141ab06af5e3c9a22e2f74d7f02a9c3430d0d10c1ca",baseCoin:"DBUSDT",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},WAL_DBUSDC:{address:"0xeb524b6aea0ec4b494878582e0b78924208339d360b62aec4a8ecd4031520dbb",baseCoin:"WAL",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},WAL_SUI:{address:"0x8c1c1b186c4fddab1ebd53e0895a36c1d1b3b9a77cd34e607bef49a38af0150a",baseCoin:"WAL",quoteCoin:"SUI",lotSize:1e6,tickSize:1e6}},d={SUI:{address:"0xe620d6a5390e57e88baff18af89383130d4210eb496a024edcd62f270a655af7",coinType:"0x2::sui::SUI"},DBUSDC:{address:"0xfd0dc290a120ad6c534507614d4dc0b2e78baab649c35bfacbaec2ce18140b69",coinType:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC"}};var P=["supplyCap","maxUtilizationRate","protocolSpread","minBorrow","interestRate","totalSupply","supplyShares","totalBorrow","borrowShares","lastUpdateTimestamp"],b=["userSupplyShares","userSupplyAmount"],B={supplyCap:"U64",maxUtilizationRate:"U64",protocolSpread:"U64",minBorrow:"U64",interestRate:"U64",totalSupply:"U64",supplyShares:"U64",totalBorrow:"U64",borrowShares:"U64",lastUpdateTimestamp:"U64",userSupplyShares:"U64",userSupplyAmount:"U64"};var k=n=>/^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(n),L=n=>/^[a-zA-Z0-9+/]+={0,2}$/g.test(n),x=n=>{if(k(n))return bcs$1.fromHex(n);if(L(n))return bcs$1.fromBase64(n);throw new Error("The string is not a valid hex or base64 string.")},_=n=>{if(n.length===cryptography.LEGACY_PRIVATE_KEY_SIZE)return n.slice(0,cryptography.PRIVATE_KEY_SIZE);if(n.length===cryptography.PRIVATE_KEY_SIZE+1&&n[0]===0)return n.slice(1);if(n.length===cryptography.PRIVATE_KEY_SIZE)return n;throw new Error("invalid secret key")};var w=class{suiClient;keypair;address;marginPoolContract;supplierCapId;constructor(r){let a=r.fullnodeUrl??client.getFullnodeUrl(r.network);this.suiClient=new client.SuiClient({url:a}),this.keypair=this.#r(r.privateKey),this.address=this.keypair.getPublicKey().toSuiAddress(),this.supplierCapId=r.supplierCapId;let e={DEEP:{address:c.DEEP.address,type:c.DEEP.type,scalar:c.DEEP.scalar},SUI:{address:c.SUI.address,type:c.SUI.type,scalar:c.SUI.scalar},DBUSDC:{address:c.DBUSDC.address,type:c.DBUSDC.type,scalar:c.DBUSDC.scalar}},t={SUI_DBUSDC:{address:f.SUI_DBUSDC.address,baseCoin:f.SUI_DBUSDC.baseCoin,quoteCoin:f.SUI_DBUSDC.quoteCoin}},i={SUI:{address:d.SUI.address,type:d.SUI.coinType},DBUSDC:{address:d.DBUSDC.address,type:d.DBUSDC.coinType}},o=new deepbookV3.DeepBookConfig({address:this.address,env:r.network,coins:e,pools:t,marginPools:i});this.marginPoolContract=new deepbookV3.MarginPoolContract(o);}#r(r){if(r.startsWith(cryptography.SUI_PRIVATE_KEY_PREFIX)){let{secretKey:a}=cryptography.decodeSuiPrivateKey(r);return ed25519.Ed25519Keypair.fromSecretKey(_(a))}return ed25519.Ed25519Keypair.fromSecretKey(_(x(r)))}async#e(){let r=`${D.MARGIN_INITIAL_PACKAGE_ID}::margin_pool::SupplierCap`;return (await this.suiClient.getOwnedObjects({owner:this.address,filter:{StructType:r},options:{showType:true}})).data?.[0]?.data?.objectId}async initialize(){if(this.supplierCapId)return this.supplierCapId;let r=await this.#e();if(r)return this.supplierCapId=r,r;let a=await this.createSupplierCap();if(!a)throw new Error("Failed to create Supplier Cap");return this.supplierCapId=a,a}async createSupplierCap(){try{let r=new transactions.Transaction,a=this.marginPoolContract.mintSupplierCap()(r);r.transferObjects([a],this.address);let e=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:r,options:{showEffects:!0,showObjectChanges:!0}});if(e.errors&&e.errors.length>0)throw new Error(`Transaction failed with errors: ${e.errors.map(t=>t.toString()).join(", ")}`);if(e.objectChanges){for(let t of e.objectChanges)if(t.type==="created"&&t.objectType.includes("SupplierCap"))return t.objectId}return null}catch(r){throw new Error(`Failed to create Supplier Cap: ${r.message||r}`)}}async createSupplyReferral(r){try{let a=new transactions.Transaction;this.marginPoolContract.mintSupplyReferral(r)(a);let e=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:a,options:{showEffects:!0,showObjectChanges:!0}});if(e.errors&&e.errors.length>0)throw new Error(`Transaction failed with errors: ${e.errors.map(t=>t.toString()).join(", ")}`);if(e.objectChanges){for(let t of e.objectChanges)if(t.type==="created"&&t.objectType.includes("SupplyReferral"))return t.objectId}return null}catch(a){throw new Error(`Failed to create Supply Referral: ${a.message||a}`)}}async supplyToMarginPool(r,a,e){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let t=new transactions.Transaction;t.setSender(this.address);let i=t.object(this.supplierCapId);t.add(this.marginPoolContract.supplyToMarginPool(r,i,a,e));let{errors:o}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0}});if(o&&o.length>0)throw new Error(`Transaction failed with errors: ${o.map(s=>s.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to supply to margin pool: ${t.message||t}`)}}async withdrawFromMarginPool(r,a){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let e=new transactions.Transaction,t=e.object(this.supplierCapId),o=this.marginPoolContract.withdrawFromMarginPool(r,t,a)(e);e.transferObjects([o],this.address);let{errors:s}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0}});if(s&&s.length>0)throw new Error(`Transaction failed with errors: ${s.map(l=>l.toString()).join(", ")}`);return !0}catch(e){throw new Error(`Failed to withdraw from margin pool: ${e.message||e}`)}}async withdrawReferralFees(r,a){try{let e=new transactions.Transaction;e.add(this.marginPoolContract.withdrawReferralFees(r,a));let{errors:t}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0,showBalanceChanges:!0}});if(t&&t.length>0)throw new Error(`Transaction failed with errors: ${t.map(i=>i.toString()).join(", ")}`);return !0}catch(e){throw new Error(`Failed to withdraw referral fees: ${e.message||e}`)}}async getBalance(r){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let a=new transactions.Transaction;a.add(this.marginPoolContract.userSupplyAmount(r,this.supplierCapId));let e=await this.suiClient.devInspectTransactionBlock({sender:this.address,transactionBlock:a}),t=0;if(e&&e.results&&e.results[0]&&e.results[0].returnValues){let p=e.results[0].returnValues[0];if(p&&p[0]){let m=Buffer.from(p[0]).readBigUInt64LE(),C=r==="SUI"?c.SUI.scalar:c.DBUSDC.scalar;t=Number(m)/C;}}let i=r==="SUI"?c.SUI.type:c.DBUSDC.type,o=await this.suiClient.getBalance({owner:this.address,coinType:i}),s=r==="SUI"?c.SUI.scalar:c.DBUSDC.scalar,l=Number(o.totalBalance)/s;return {userSupplyAmount:t,walletBalance:l}}catch(a){throw new Error(`Failed to get balance: ${a.message||a}`)}}getSupplierCapId(){return this.supplierCapId}getAddress(){return this.address}};var X=new Set(b),J=n=>X.has(n),I=class{constructor(r="testnet",a="",e=new client.SuiClient({url:client.getFullnodeUrl(r)}),t){this.suiClient=e;this.dbConfig=t??new deepbookV3.DeepBookConfig({env:r,address:a,coins:c,pools:f,marginPools:{SUI:{address:d.SUI.address,type:d.SUI.coinType},DBUSDC:{address:d.DBUSDC.address,type:d.DBUSDC.coinType}}}),this.marginPoolContract=new deepbookV3.MarginPoolContract(this.dbConfig);}marginPoolContract;dbConfig;get env(){return this.dbConfig.env}#r(r,a,e,t){if(J(a)){let i=this.marginPoolContract[a];if(t==null)throw new Error(`supplierCap is required for '${a}'.`);r.add(i(e,t));}else {let i=this.marginPoolContract[a];r.add(i(e));}}#e(r,a){let e=r.results;return e?a.reduce((t,i,o)=>{let s=e[o]?.returnValues?.[0]?.[0];if(!s)return t;let l=bcs.bcs[B[i]];return t[i]=l.parse(new Uint8Array(s)),t},{}):{}}#t(r,a){let e=this.dbConfig.getCoin(a),t={supplyCap:0,maxUtilizationRate:0,protocolSpread:0,minBorrow:0,interestRate:0,totalSupply:0,supplyShares:0,totalBorrow:0,borrowShares:0,lastUpdateTimestamp:0,userSupplyShares:0,userSupplyAmount:0,decimals:0,midKink:0,highKink:0,baseBorrowApr:0,midBorrowApr:0,highBorrowApr:0,maxBorrowApr:0,borrowApr:0,...e};if(!e)return t;let i=new Set(["interestRate","maxUtilizationRate","protocolSpread"]);for(let[o,s]of Object.entries(r))o==="lastUpdateTimestamp"?t[o]=Number(s):i.has(o)?t[o]=new bignumber_js.BigNumber(s).dividedBy(deepbookV3.FLOAT_SCALAR).toNumber():t[o]=new bignumber_js.BigNumber(s).dividedBy(e.scalar).toNumber();return t}#a(r,a){let e=BigInt(a.base_rate),t=BigInt(a.base_slope),i=BigInt(a.excess_slope),o=BigInt(a.optimal_utilization),s=r<0n?0n:r>BigInt(deepbookV3.FLOAT_SCALAR)?BigInt(deepbookV3.FLOAT_SCALAR):BigInt(r);return s<=o?e+t*s/o:e+t+i*(s-o)/(BigInt(deepbookV3.FLOAT_SCALAR)-o)}#o(r,a,e){let t=BigInt(r.base_rate),i=BigInt(r.base_slope),o=BigInt(r.excess_slope),s=BigInt(r.optimal_utilization),l=BigInt(a.max_utilization_rate),p=s,m=l,C=t,E=t+i,T=t+i+o*(l-s)/(1000000000n-s),A=t+i+o,U=this.#a(BigInt(bignumber_js.BigNumber(e.total_borrow).dividedBy(e.total_supply).shiftedBy(9).decimalPlaces(0).toString()),r),u=M=>bignumber_js.BigNumber(M).dividedBy(deepbookV3.FLOAT_SCALAR).toNumber();return {raw:{midKink:p,highKink:m,baseBorrowApr:C,midBorrowApr:E,highBorrowApr:T,maxBorrowApr:A,borrowApr:U},normalized:{midKink:u(p),highKink:u(m),baseBorrowApr:u(C),midBorrowApr:u(E),highBorrowApr:u(T),maxBorrowApr:u(A),borrowApr:u(U)}}}async#i(r){let{address:a}=this.dbConfig.getMarginPool(r),t=((await this.suiClient.getObject({id:a,options:{showContent:true}})).data?.content).fields,i=t.config.fields,o=i.interest_config.fields,s=i.margin_pool_config.fields,l=t.state.fields,{normalized:p}=this.#o(o,s,l);return p}async getPoolParameters(r,a,e=new transactions.Transaction,t=true){if(P.forEach(p=>this.#r(e,p,r)),a&&b.forEach(p=>this.#r(e,p,r,a)),!t)return e;let i=[...P,...b],o=await this.suiClient.devInspectTransactionBlock({transactionBlock:e,sender:this.dbConfig.address}),s=await this.#i(r);return {...this.#t(this.#e(o,i),r),...s}}};exports.DeepBookMarginPool=I;exports.DeepBookMarginToolkit=w;

package/dist/index.mjs

@@ -0,0 +1 @@
+import {getFullnodeUrl,SuiClient}from'@mysten/sui/client';import {Ed25519Keypair}from'@mysten/sui/keypairs/ed25519';import {Transaction}from'@mysten/sui/transactions';import {DeepBookConfig,MarginPoolContract,FLOAT_SCALAR}from'@mysten/deepbook-v3';import {SUI_PRIVATE_KEY_PREFIX,decodeSuiPrivateKey,LEGACY_PRIVATE_KEY_SIZE,PRIVATE_KEY_SIZE}from'@mysten/sui/cryptography';import {fromHex,fromBase64}from'@mysten/bcs';import {bcs}from'@mysten/sui/bcs';import {BigNumber}from'bignumber.js';var D={MARGIN_INITIAL_PACKAGE_ID:"0x7f2d8f15343f210e813595a8798d6197d152061d0a35be938372f4b1cd66f209"},c={DEEP:{address:"0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8",type:"0x36dbef866a1d62bf7328989a10fb2f07d769f4ee587c0de4a0a256e57e0a58a8::deep::DEEP",scalar:1e6,decimals:6},SUI:{address:"0x0000000000000000000000000000000000000000000000000000000000000002",type:"0x0000000000000000000000000000000000000000000000000000000000000002::sui::SUI",scalar:1e9,decimals:9},DBUSDC:{address:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7",type:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC",scalar:1e6,decimals:6},DBUSDT:{address:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7",type:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDT::DBUSDT",scalar:1e6,decimals:6},WAL:{address:"0x9ef7676a9f81937a52ae4b2af8d511a28a0b080477c0c2db40b0ab8882240d76",type:"0x9ef7676a9f81937a52ae4b2af8d511a28a0b080477c0c2db40b0ab8882240d76::wal::WAL",scalar:1e9,decimals:9}},f={DEEP_SUI:{address:"0x48c95963e9eac37a316b7ae04a0deb761bcdcc2b67912374d6036e7f0e9bae9f",baseCoin:"DEEP",quoteCoin:"SUI",lotSize:1e6,tickSize:1e6},SUI_DBUSDC:{address:"0x1c19362ca52b8ffd7a33cee805a67d40f31e6ba303753fd3a4cfdfacea7163a5",baseCoin:"SUI",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},DEEP_DBUSDC:{address:"0xe86b991f8632217505fd859445f9803967ac84a9d4a1219065bf191fcb74b622",baseCoin:"DEEP",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},DBUSDT_DBUSDC:{address:"0x83970bb02e3636efdff8c141ab06af5e3c9a22e2f74d7f02a9c3430d0d10c1ca",baseCoin:"DBUSDT",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},WAL_DBUSDC:{address:"0xeb524b6aea0ec4b494878582e0b78924208339d360b62aec4a8ecd4031520dbb",baseCoin:"WAL",quoteCoin:"DBUSDC",lotSize:1e6,tickSize:1e3},WAL_SUI:{address:"0x8c1c1b186c4fddab1ebd53e0895a36c1d1b3b9a77cd34e607bef49a38af0150a",baseCoin:"WAL",quoteCoin:"SUI",lotSize:1e6,tickSize:1e6}},d={SUI:{address:"0xe620d6a5390e57e88baff18af89383130d4210eb496a024edcd62f270a655af7",coinType:"0x2::sui::SUI"},DBUSDC:{address:"0xfd0dc290a120ad6c534507614d4dc0b2e78baab649c35bfacbaec2ce18140b69",coinType:"0xf7152c05930480cd740d7311b5b8b45c6f488e3a53a11c3f74a6fac36a52e0d7::DBUSDC::DBUSDC"}};var P=["supplyCap","maxUtilizationRate","protocolSpread","minBorrow","interestRate","totalSupply","supplyShares","totalBorrow","borrowShares","lastUpdateTimestamp"],b=["userSupplyShares","userSupplyAmount"],B={supplyCap:"U64",maxUtilizationRate:"U64",protocolSpread:"U64",minBorrow:"U64",interestRate:"U64",totalSupply:"U64",supplyShares:"U64",totalBorrow:"U64",borrowShares:"U64",lastUpdateTimestamp:"U64",userSupplyShares:"U64",userSupplyAmount:"U64"};var k=n=>/^0x[0-9a-fA-F]+$|^[0-9a-fA-F]+$/.test(n),L=n=>/^[a-zA-Z0-9+/]+={0,2}$/g.test(n),x=n=>{if(k(n))return fromHex(n);if(L(n))return fromBase64(n);throw new Error("The string is not a valid hex or base64 string.")},_=n=>{if(n.length===LEGACY_PRIVATE_KEY_SIZE)return n.slice(0,PRIVATE_KEY_SIZE);if(n.length===PRIVATE_KEY_SIZE+1&&n[0]===0)return n.slice(1);if(n.length===PRIVATE_KEY_SIZE)return n;throw new Error("invalid secret key")};var w=class{suiClient;keypair;address;marginPoolContract;supplierCapId;constructor(r){let a=r.fullnodeUrl??getFullnodeUrl(r.network);this.suiClient=new SuiClient({url:a}),this.keypair=this.#r(r.privateKey),this.address=this.keypair.getPublicKey().toSuiAddress(),this.supplierCapId=r.supplierCapId;let e={DEEP:{address:c.DEEP.address,type:c.DEEP.type,scalar:c.DEEP.scalar},SUI:{address:c.SUI.address,type:c.SUI.type,scalar:c.SUI.scalar},DBUSDC:{address:c.DBUSDC.address,type:c.DBUSDC.type,scalar:c.DBUSDC.scalar}},t={SUI_DBUSDC:{address:f.SUI_DBUSDC.address,baseCoin:f.SUI_DBUSDC.baseCoin,quoteCoin:f.SUI_DBUSDC.quoteCoin}},i={SUI:{address:d.SUI.address,type:d.SUI.coinType},DBUSDC:{address:d.DBUSDC.address,type:d.DBUSDC.coinType}},o=new DeepBookConfig({address:this.address,env:r.network,coins:e,pools:t,marginPools:i});this.marginPoolContract=new MarginPoolContract(o);}#r(r){if(r.startsWith(SUI_PRIVATE_KEY_PREFIX)){let{secretKey:a}=decodeSuiPrivateKey(r);return Ed25519Keypair.fromSecretKey(_(a))}return Ed25519Keypair.fromSecretKey(_(x(r)))}async#e(){let r=`${D.MARGIN_INITIAL_PACKAGE_ID}::margin_pool::SupplierCap`;return (await this.suiClient.getOwnedObjects({owner:this.address,filter:{StructType:r},options:{showType:true}})).data?.[0]?.data?.objectId}async initialize(){if(this.supplierCapId)return this.supplierCapId;let r=await this.#e();if(r)return this.supplierCapId=r,r;let a=await this.createSupplierCap();if(!a)throw new Error("Failed to create Supplier Cap");return this.supplierCapId=a,a}async createSupplierCap(){try{let r=new Transaction,a=this.marginPoolContract.mintSupplierCap()(r);r.transferObjects([a],this.address);let e=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:r,options:{showEffects:!0,showObjectChanges:!0}});if(e.errors&&e.errors.length>0)throw new Error(`Transaction failed with errors: ${e.errors.map(t=>t.toString()).join(", ")}`);if(e.objectChanges){for(let t of e.objectChanges)if(t.type==="created"&&t.objectType.includes("SupplierCap"))return t.objectId}return null}catch(r){throw new Error(`Failed to create Supplier Cap: ${r.message||r}`)}}async createSupplyReferral(r){try{let a=new Transaction;this.marginPoolContract.mintSupplyReferral(r)(a);let e=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:a,options:{showEffects:!0,showObjectChanges:!0}});if(e.errors&&e.errors.length>0)throw new Error(`Transaction failed with errors: ${e.errors.map(t=>t.toString()).join(", ")}`);if(e.objectChanges){for(let t of e.objectChanges)if(t.type==="created"&&t.objectType.includes("SupplyReferral"))return t.objectId}return null}catch(a){throw new Error(`Failed to create Supply Referral: ${a.message||a}`)}}async supplyToMarginPool(r,a,e){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let t=new Transaction;t.setSender(this.address);let i=t.object(this.supplierCapId);t.add(this.marginPoolContract.supplyToMarginPool(r,i,a,e));let{errors:o}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:t,options:{showEffects:!0,showObjectChanges:!0}});if(o&&o.length>0)throw new Error(`Transaction failed with errors: ${o.map(s=>s.toString()).join(", ")}`);return !0}catch(t){throw new Error(`Failed to supply to margin pool: ${t.message||t}`)}}async withdrawFromMarginPool(r,a){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let e=new Transaction,t=e.object(this.supplierCapId),o=this.marginPoolContract.withdrawFromMarginPool(r,t,a)(e);e.transferObjects([o],this.address);let{errors:s}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0}});if(s&&s.length>0)throw new Error(`Transaction failed with errors: ${s.map(l=>l.toString()).join(", ")}`);return !0}catch(e){throw new Error(`Failed to withdraw from margin pool: ${e.message||e}`)}}async withdrawReferralFees(r,a){try{let e=new Transaction;e.add(this.marginPoolContract.withdrawReferralFees(r,a));let{errors:t}=await this.suiClient.signAndExecuteTransaction({signer:this.keypair,transaction:e,options:{showEffects:!0,showObjectChanges:!0,showBalanceChanges:!0}});if(t&&t.length>0)throw new Error(`Transaction failed with errors: ${t.map(i=>i.toString()).join(", ")}`);return !0}catch(e){throw new Error(`Failed to withdraw referral fees: ${e.message||e}`)}}async getBalance(r){try{if(!this.supplierCapId)throw new Error("Supplier Cap not initialized. Call initialize() first.");let a=new Transaction;a.add(this.marginPoolContract.userSupplyAmount(r,this.supplierCapId));let e=await this.suiClient.devInspectTransactionBlock({sender:this.address,transactionBlock:a}),t=0;if(e&&e.results&&e.results[0]&&e.results[0].returnValues){let p=e.results[0].returnValues[0];if(p&&p[0]){let m=Buffer.from(p[0]).readBigUInt64LE(),C=r==="SUI"?c.SUI.scalar:c.DBUSDC.scalar;t=Number(m)/C;}}let i=r==="SUI"?c.SUI.type:c.DBUSDC.type,o=await this.suiClient.getBalance({owner:this.address,coinType:i}),s=r==="SUI"?c.SUI.scalar:c.DBUSDC.scalar,l=Number(o.totalBalance)/s;return {userSupplyAmount:t,walletBalance:l}}catch(a){throw new Error(`Failed to get balance: ${a.message||a}`)}}getSupplierCapId(){return this.supplierCapId}getAddress(){return this.address}};var X=new Set(b),J=n=>X.has(n),I=class{constructor(r="testnet",a="",e=new SuiClient({url:getFullnodeUrl(r)}),t){this.suiClient=e;this.dbConfig=t??new DeepBookConfig({env:r,address:a,coins:c,pools:f,marginPools:{SUI:{address:d.SUI.address,type:d.SUI.coinType},DBUSDC:{address:d.DBUSDC.address,type:d.DBUSDC.coinType}}}),this.marginPoolContract=new MarginPoolContract(this.dbConfig);}marginPoolContract;dbConfig;get env(){return this.dbConfig.env}#r(r,a,e,t){if(J(a)){let i=this.marginPoolContract[a];if(t==null)throw new Error(`supplierCap is required for '${a}'.`);r.add(i(e,t));}else {let i=this.marginPoolContract[a];r.add(i(e));}}#e(r,a){let e=r.results;return e?a.reduce((t,i,o)=>{let s=e[o]?.returnValues?.[0]?.[0];if(!s)return t;let l=bcs[B[i]];return t[i]=l.parse(new Uint8Array(s)),t},{}):{}}#t(r,a){let e=this.dbConfig.getCoin(a),t={supplyCap:0,maxUtilizationRate:0,protocolSpread:0,minBorrow:0,interestRate:0,totalSupply:0,supplyShares:0,totalBorrow:0,borrowShares:0,lastUpdateTimestamp:0,userSupplyShares:0,userSupplyAmount:0,decimals:0,midKink:0,highKink:0,baseBorrowApr:0,midBorrowApr:0,highBorrowApr:0,maxBorrowApr:0,borrowApr:0,...e};if(!e)return t;let i=new Set(["interestRate","maxUtilizationRate","protocolSpread"]);for(let[o,s]of Object.entries(r))o==="lastUpdateTimestamp"?t[o]=Number(s):i.has(o)?t[o]=new BigNumber(s).dividedBy(FLOAT_SCALAR).toNumber():t[o]=new BigNumber(s).dividedBy(e.scalar).toNumber();return t}#a(r,a){let e=BigInt(a.base_rate),t=BigInt(a.base_slope),i=BigInt(a.excess_slope),o=BigInt(a.optimal_utilization),s=r<0n?0n:r>BigInt(FLOAT_SCALAR)?BigInt(FLOAT_SCALAR):BigInt(r);return s<=o?e+t*s/o:e+t+i*(s-o)/(BigInt(FLOAT_SCALAR)-o)}#o(r,a,e){let t=BigInt(r.base_rate),i=BigInt(r.base_slope),o=BigInt(r.excess_slope),s=BigInt(r.optimal_utilization),l=BigInt(a.max_utilization_rate),p=s,m=l,C=t,E=t+i,T=t+i+o*(l-s)/(1000000000n-s),A=t+i+o,U=this.#a(BigInt(BigNumber(e.total_borrow).dividedBy(e.total_supply).shiftedBy(9).decimalPlaces(0).toString()),r),u=M=>BigNumber(M).dividedBy(FLOAT_SCALAR).toNumber();return {raw:{midKink:p,highKink:m,baseBorrowApr:C,midBorrowApr:E,highBorrowApr:T,maxBorrowApr:A,borrowApr:U},normalized:{midKink:u(p),highKink:u(m),baseBorrowApr:u(C),midBorrowApr:u(E),highBorrowApr:u(T),maxBorrowApr:u(A),borrowApr:u(U)}}}async#i(r){let{address:a}=this.dbConfig.getMarginPool(r),t=((await this.suiClient.getObject({id:a,options:{showContent:true}})).data?.content).fields,i=t.config.fields,o=i.interest_config.fields,s=i.margin_pool_config.fields,l=t.state.fields,{normalized:p}=this.#o(o,s,l);return p}async getPoolParameters(r,a,e=new Transaction,t=true){if(P.forEach(p=>this.#r(e,p,r)),a&&b.forEach(p=>this.#r(e,p,r,a)),!t)return e;let i=[...P,...b],o=await this.suiClient.devInspectTransactionBlock({transactionBlock:e,sender:this.dbConfig.address}),s=await this.#i(r);return {...this.#t(this.#e(o,i),r),...s}}};export{I as DeepBookMarginPool,w as DeepBookMarginToolkit};

package/package.json

@@ -0,0 +1,95 @@
+{
+  "name": "@scallop-io/scallop-deepbook-kit",
+  "version": "0.1.3",
+  "description": "A toolkit for integrating Scallop with DeepBook functionality",
+  "keywords": [
+    "scallop",
+    "deepbook",
+    "sui",
+    "defi",
+    "blockchain",
+    "dex"
+  ],
+  "author": "team@scallop.io",
+  "homepage": "https://github.com/scallop-io/scallop-deepbook-kit#readme",
+  "bugs": "https://github.com/scallop-io/scallop-deepbook-kit/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scallop-io/scallop-deepbook-kit.git"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.10.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.4",
+    "@typescript-eslint/parser": "^8.46.4",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "husky": "^8.0.3",
+    "jest": "^30.2.0",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.5",
+    "tsup": "^8.5.1",
+    "tsx": "^4.19.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@mysten/bcs": "^1.9.2",
+    "@mysten/deepbook-v3": "^0.21.0",
+    "@mysten/sui": "^1.45.0",
+    "bignumber.js": "^9.3.1",
+    "dotenv": "^17.2.3"
+  },
+  "lint-staged": {
+    "**/*.ts": [
+      "pnpm run format:fix"
+    ],
+    "**/*.json|md": [
+      "pnpm run format:fix"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=9.0.0"
+  },
+  "scripts": {
+    "build": "npm run build:tsup",
+    "build:prod": "tsup --env.NODE_ENV production",
+    "build:tsup": "tsup",
+    "build:watch": "tsc --watch",
+    "example:toolkit": "tsx src/examples/toolkit-demo.ts",
+    "clean": "rm -rf dist",
+    "lint": "eslint src --ext .ts",
+    "format:fix": "prettier --ignore-path 'dist/* docs/*' --write '**/*.{ts,json,md}'",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
+  }
+}