@naviprotocol/wallet-client 1.0.0

package/dist/modules/lendingModule/index.d.ts

@@ -0,0 +1,218 @@
+import { DryRunTransactionBlockResponse, SuiTransactionBlockResponse } from '@mysten/sui/client';
+import { Module } from '../module';
+import { AssetIdentifier, CacheOption, LendingReward, AccountCapOption, Pool } from '@naviprotocol/lending';
+
+/**
+ * Configuration options for the lending module
+ */
+export interface LendingModuleConfig {
+    /** Environment setting for protocol interaction */
+    env: 'dev' | 'prod';
+}
+/**
+ * Events emitted by the lending module
+ */
+export type Events = {
+    /** Emitted when a deposit is successfully completed */
+    'lending:deposit-success': {
+        /** Asset identifier for the deposited asset */
+        identifier: AssetIdentifier;
+        /** Amount deposited */
+        amount: number;
+    };
+    /** Emitted when a withdrawal is successfully completed */
+    'lending:withdraw-success': {
+        /** Asset identifier for the withdrawn asset */
+        identifier: AssetIdentifier;
+        /** Amount withdrawn */
+        amount: number;
+    };
+    /** Emitted when a borrow is successfully completed */
+    'lending:borrow-success': {
+        /** Asset identifier for the borrowed asset */
+        identifier: AssetIdentifier;
+        /** Amount borrowed */
+        amount: number;
+    };
+    /** Emitted when a repayment is successfully completed */
+    'lending:repay-success': {
+        /** Asset identifier for the repaid asset */
+        identifier: AssetIdentifier;
+        /** Amount repaid */
+        amount: number;
+    };
+    /** Emitted when a liquidation is successfully completed */
+    'lending:liquidate-success': {
+        /** Asset identifier for the debt being paid */
+        payIdentifier: AssetIdentifier;
+        /** Amount of debt paid */
+        payAmount: number;
+        /** Asset identifier for the collateral being liquidated */
+        collateralIdentifier: AssetIdentifier;
+        /** Address of the account being liquidated */
+        liquidationAddress: string;
+    };
+    /** Emitted when rewards are successfully claimed */
+    'lending:claim-rewards-success': {
+        /** Array of claimed rewards */
+        rewards: LendingReward[];
+    };
+};
+/**
+ * Lending protocol module for wallet operations
+ *
+ * This module provides comprehensive lending functionality including:
+ * - Deposit and withdraw operations
+ * - Borrow and repay operations
+ * - Liquidation functionality
+ * - Reward claiming
+ * - Oracle price updates
+ * - Health factor monitoring
+ * - Pool information retrieval
+ */
+export declare class LendingModule extends Module<LendingModuleConfig, Events> {
+    /** Module name identifier */
+    readonly name = "lending";
+    /** Default configuration values */
+    readonly defaultConfig: LendingModuleConfig;
+    /**
+     * Gets all available lending pools
+     *
+     * @param options - Optional caching options
+     * @returns Array of pool information
+     */
+    getPools(options?: Partial<CacheOption>): Promise<Pool[]>;
+    /**
+     * Gets information for a specific lending pool
+     *
+     * @param identifier - Asset identifier (string, Pool object, or number)
+     * @param options - Optional caching options
+     * @returns Pool information
+     */
+    getPool(identifier: AssetIdentifier, options?: Partial<CacheOption>): Promise<Pool>;
+    /**
+     * Deposits coins into a lending pool
+     *
+     * @param identifier - Asset identifier for the pool
+     * @param amount - Amount to deposit
+     * @param options - Optional parameters including dry run mode and account capability
+     * @returns Transaction response or dry run response
+     */
+    deposit<T extends boolean = false>(identifier: AssetIdentifier, amount: number, options?: {
+        dryRun: T;
+    } & Partial<AccountCapOption>): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Withdraws coins from a lending pool
+     *
+     * @param identifier - Asset identifier for the pool
+     * @param amount - Amount to withdraw
+     * @param options - Optional parameters including dry run mode and account capability
+     * @returns Transaction response or dry run response
+     */
+    withdraw<T extends boolean = false>(identifier: AssetIdentifier, amount: number, options?: {
+        dryRun: T;
+        disableUpdateOracle?: boolean;
+    } & Partial<AccountCapOption>): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Borrows coins from a lending pool
+     *
+     * @param identifier - Asset identifier for the pool
+     * @param amount - Amount to borrow
+     * @param options - Optional parameters including dry run mode and account capability
+     * @returns Transaction response or dry run response
+     */
+    borrow<T extends boolean = false>(identifier: AssetIdentifier, amount: number, options?: {
+        dryRun: T;
+        disableUpdateOracle?: boolean;
+    } & Partial<AccountCapOption>): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Repays borrowed coins to a lending pool
+     *
+     * @param identifier - Asset identifier for the pool
+     * @param amount - Amount to repay
+     * @param options - Optional parameters including dry run mode and account capability
+     * @returns Transaction response or dry run response
+     */
+    repay<T extends boolean = false>(identifier: AssetIdentifier, amount: number, options?: {
+        dryRun: T;
+    } & Partial<AccountCapOption>): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Gets the current health factor for the user
+     *
+     * @returns Current health factor value
+     */
+    getHealthFactor(): Promise<number>;
+    /**
+     * Initiates a liquidation process
+     *
+     * @param payIdentifier - Asset identifier for the debt being paid
+     * @param payAmount - Amount of debt to pay
+     * @param collateralIdentifier - Asset identifier for the collateral being liquidated
+     * @param liquidationAddress - Address of the account being liquidated
+     * @param options - Optional parameters including dry run mode
+     * @returns Transaction response or dry run response
+     */
+    liquidate<T extends boolean = false>(payIdentifier: AssetIdentifier, payAmount: number, collateralIdentifier: AssetIdentifier, liquidationAddress: string, options?: {
+        dryRun: T;
+    }): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Gets the available lending rewards for the current user.
+     *
+     * @param options - Optional cache options.
+     * @returns The available lending rewards for the user.
+     * @throws If the wallet client is not found.
+     */
+    getAvailableRewards(options?: Partial<CacheOption>): Promise<LendingReward[]>;
+    /**
+     * Gets the claimed reward history for the current user.
+     *
+     * @param options - Optional cache options.
+     * @returns The claimed reward history for the user.
+     * @throws If the wallet client is not found.
+     */
+    getClaimedRewardHistory(options?: Partial<CacheOption> & {
+        page?: number;
+        size?: number;
+    }): Promise<{
+        data: import('@naviprotocol/lending').HistoryClaimedReward[];
+        cursor?: string;
+    }>;
+    /**
+     * Claims all available lending rewards for the user
+     *
+     * @param options - Optional parameters including dry run mode and account capability
+     * @returns Transaction response or dry run response
+     */
+    claimAllRewards<T extends boolean = false>(options?: {
+        dryRun: T;
+    } & Partial<AccountCapOption>): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    private updateOraclePTB;
+    /**
+     * Updates the oracle prices for the lending protocol
+     *
+     * @param options - Optional parameters including dry run mode and pools
+     * @param options.dryRun - Whether to perform a dry run
+     * @returns Transaction response or dry run response
+     */
+    updateOracle<T extends boolean = false>(options?: {
+        dryRun: T;
+        pools?: Pool[];
+    }): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Gets all active lending positions for the user
+     *
+     * @param options - Optional caching options
+     * @returns User's lending state information
+     */
+    getLendingState(options?: Partial<CacheOption>): Promise<import('@naviprotocol/lending').UserLendingInfo[]>;
+    /**
+     * Creates an account capability for the lending protocol
+     *
+     * @param options - Optional parameters including dry run mode
+     * @returns Transaction response or dry run response
+     */
+    createAccountCap<T extends boolean = false>(options?: {
+        dryRun: T;
+    }): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/lendingModule/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/lendingModule/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,8BAA8B,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAA;AAChG,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAKL,eAAe,EAYf,WAAW,EACX,aAAa,EACb,gBAAgB,EAChB,IAAI,EAGL,MAAM,uBAAuB,CAAA;AAG9B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,mDAAmD;IACnD,GAAG,EAAE,KAAK,GAAG,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,uDAAuD;IACvD,yBAAyB,EAAE;QACzB,+CAA+C;QAC/C,UAAU,EAAE,eAAe,CAAA;QAC3B,uBAAuB;QACvB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,0DAA0D;IAC1D,0BAA0B,EAAE;QAC1B,+CAA+C;QAC/C,UAAU,EAAE,eAAe,CAAA;QAC3B,uBAAuB;QACvB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,sDAAsD;IACtD,wBAAwB,EAAE;QACxB,8CAA8C;QAC9C,UAAU,EAAE,eAAe,CAAA;QAC3B,sBAAsB;QACtB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,yDAAyD;IACzD,uBAAuB,EAAE;QACvB,4CAA4C;QAC5C,UAAU,EAAE,eAAe,CAAA;QAC3B,oBAAoB;QACpB,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,2DAA2D;IAC3D,2BAA2B,EAAE;QAC3B,+CAA+C;QAC/C,aAAa,EAAE,eAAe,CAAA;QAC9B,0BAA0B;QAC1B,SAAS,EAAE,MAAM,CAAA;QACjB,2DAA2D;QAC3D,oBAAoB,EAAE,eAAe,CAAA;QACrC,8CAA8C;QAC9C,kBAAkB,EAAE,MAAM,CAAA;KAC3B,CAAA;IACD,oDAAoD;IACpD,+BAA+B,EAAE;QAC/B,+BAA+B;QAC/B,OAAO,EAAE,aAAa,EAAE,CAAA;KACzB,CAAA;CACF,CAAA;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,aAAc,SAAQ,MAAM,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACpE,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,aAAY;IAEzB,mCAAmC;IACnC,QAAQ,CAAC,aAAa,EAAE,mBAAmB,CAE1C;IAED;;;;;OAKG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAO7C;;;;;;OAMG;IACG,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAOzE;;;;;;;OAOG;IACG,OAAO,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACrC,UAAU,EAAE,eAAe,EAC3B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAClD,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IAmDzF;;;;;;;OAOG;IACG,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACtC,UAAU,EAAE,eAAe,EAC3B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAC;QAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,GACjF,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IA4CzF;;;;;;;OAOG;IACG,MAAM,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACpC,UAAU,EAAE,eAAe,EAC3B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAC;QAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,GACjF,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IA4CzF;;;;;;;OAOG;IACG,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACnC,UAAU,EAAE,eAAe,EAC3B,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAClD,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IAmDzF;;;;OAIG;IACG,eAAe;IAerB;;;;;;;;;OASG;IACG,SAAS,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACvC,aAAa,EAAE,eAAe,EAC9B,SAAS,EAAE,MAAM,EACjB,oBAAoB,EAAE,eAAe,EACrC,kBAAkB,EAAE,MAAM,EAC1B,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GACtB,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IAkEzF;;;;;;OAMG;IACG,mBAAmB,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAUxD;;;;;;OAMG;IACG,uBAAuB,CAC3B,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG;QAC/B,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd;;;;IAUH;;;;;OAKG;IACG,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EAC7C,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,GAClD,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;YA+B3E,eAAe;IAoB7B;;;;;;OAMG;IACG,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EAAE,OAAO,CAAC,EAAE;QACtD,MAAM,EAAE,CAAC,CAAA;QACT,KAAK,CAAC,EAAE,IAAI,EAAE,CAAA;KACf,GAAG,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IAiB1F;;;;;OAKG;IACG,eAAe,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC;IAWpD;;;;;OAKG;IACG,gBAAgB,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EAAE,OAAO,CAAC,EAAE;QAC1D,MAAM,EAAE,CAAC,CAAA;KACV,GAAG,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;CAkB3F"}

package/dist/modules/module.d.ts

@@ -0,0 +1,69 @@
+import { WalletClient } from '../client';
+
+/**
+ * Base interface for module configuration
+ *
+ * All modules must implement this interface to define their configuration structure.
+ */
+export interface ModuleConfig {
+    [key: string]: any;
+}
+/**
+ * Base interface for module events
+ *
+ * All modules must implement this interface to define their event structure.
+ */
+export type ModuleEvents = {
+    [key: string]: any;
+};
+/**
+ * Abstract base class for all wallet client modules
+ *
+ * This class provides the foundation for modular functionality in the wallet client.
+ * Each module (swap, lending, balance, etc.) extends this class to provide
+ * specific functionality while maintaining a consistent interface.
+ *
+ * @template TConfig - The configuration type for this module
+ * @template TEvents - The events type for this module
+ */
+export declare abstract class Module<TConfig extends ModuleConfig, TEvents extends ModuleEvents> {
+    /** The unique name identifier for this module */
+    abstract readonly name: string;
+    /** Default configuration values for this module */
+    abstract readonly defaultConfig: TConfig;
+    /** Reference to the wallet client instance that owns this module */
+    protected walletClient?: WalletClient;
+    /**
+     * Gets the current configuration for this module
+     *
+     * This combines the default configuration with any user-provided overrides
+     * from the wallet client configuration.
+     *
+     * @returns The merged configuration for this module
+     */
+    get config(): TConfig;
+    /**
+     * Emits an event through the wallet client's event system
+     *
+     * @param event - The event name to emit
+     * @param data - The event data to emit
+     */
+    emit(event: keyof TEvents, data: TEvents[keyof TEvents]): void;
+    /**
+     * Installs this module into a wallet client
+     *
+     * This method is called by the wallet client during initialization
+     * to establish the connection between the module and the client.
+     *
+     * @param walletClient - The wallet client instance to install into
+     */
+    install(walletClient: WalletClient): void;
+    /**
+     * Uninstalls this module from the wallet client
+     *
+     * This method removes the reference to the wallet client,
+     * effectively disconnecting the module.
+     */
+    uninstall(): void;
+}
+//# sourceMappingURL=module.d.ts.map

package/dist/modules/module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../src/modules/module.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAGxC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB,CAAA;AAED;;;;;;;;;GASG;AACH,8BAAsB,MAAM,CAAC,OAAO,SAAS,YAAY,EAAE,OAAO,SAAS,YAAY;IACrF,iDAAiD;IACjD,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IAE9B,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,CAAC,aAAa,EAAE,OAAO,CAAA;IAExC,oEAAoE;IACpE,SAAS,CAAC,YAAY,CAAC,EAAE,YAAY,CAAA;IAErC;;;;;;;OAOG;IACH,IAAI,MAAM,IAAI,OAAO,CAIpB;IAED;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,OAAO,CAAC;IAIvD;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI;IAIzC;;;;;OAKG;IACH,SAAS;CAGV"}

package/dist/modules/swapModule/index.d.ts

@@ -0,0 +1,81 @@
+import { Dex, FeeOption } from '@naviprotocol/astros-aggregator-sdk';
+import { Module } from '../module';
+import { SuiTransactionBlockResponse, DryRunTransactionBlockResponse } from '@mysten/sui/client';
+
+/**
+ * Configuration options for the swap module
+ */
+export interface SwapModuleConfig {
+    /** API key for aggregator access */
+    apiKey: string;
+    /** Base URL for the aggregator API */
+    baseUrl: string;
+    /** List of DEXes to use for routing */
+    dexList: Dex[];
+    /** Maximum routing depth for finding optimal paths */
+    depth: number;
+    /** Service fee configuration */
+    serviceFee: FeeOption | undefined;
+    /** Environment setting */
+    env: 'dev' | 'prod';
+}
+/**
+ * Events emitted by the swap module
+ */
+export type Events = {
+    /** Emitted when a swap is successfully completed */
+    'swap:swap-success': {
+        /** Source coin type */
+        fromCoinType: string;
+        /** Target coin type */
+        toCoinType: string;
+        /** Input amount */
+        fromAmount: number;
+        /** Applied slippage tolerance */
+        slippage: number;
+        /** Output amount received */
+        toAmount: number;
+    };
+};
+/**
+ * DEX swapping module for wallet operations
+ *
+ * This module provides functionality for:
+ * - Getting swap quotes from multiple DEXes
+ * - Executing swaps with slippage protection
+ * - Managing swap transactions and events
+ * - Integrating with the balance module for coin management
+ */
+export declare class SwapModule extends Module<SwapModuleConfig, Events> {
+    /** Module name identifier */
+    readonly name = "swap";
+    /** Default configuration values */
+    readonly defaultConfig: SwapModuleConfig;
+    /**
+     * Gets the referral ID for this swap module
+     *
+     * @returns Referral ID if API key is configured, otherwise 0
+     */
+    get referral(): number;
+    /**
+     * Executes a swap between two coin types
+     *
+     * This method performs a complete swap operation including:
+     * - Balance validation
+     * - Quote retrieval from aggregator
+     * - Transaction building with slippage protection
+     * - Transaction execution
+     * - Event emission on success
+     *
+     * @param fromCoinType - Source coin type
+     * @param toCoinType - Target coin type
+     * @param fromAmount - Amount to swap
+     * @param slippage - Slippage tolerance (0-1)
+     * @param options - Optional parameters including dry run mode
+     * @returns Transaction response or dry run response
+     */
+    swap<T extends boolean = false>(fromCoinType: string, toCoinType: string, fromAmount: number, slippage: number, options?: {
+        dryRun: T;
+    }): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/swapModule/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/swapModule/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAGL,GAAG,EACH,SAAS,EAEV,MAAM,qCAAqC,CAAA;AAE5C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAA;AAIhG;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,sCAAsC;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,uCAAuC;IACvC,OAAO,EAAE,GAAG,EAAE,CAAA;IACd,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAA;IACb,gCAAgC;IAChC,UAAU,EAAE,SAAS,GAAG,SAAS,CAAA;IACjC,0BAA0B;IAC1B,GAAG,EAAE,KAAK,GAAG,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,oDAAoD;IACpD,mBAAmB,EAAE;QACnB,uBAAuB;QACvB,YAAY,EAAE,MAAM,CAAA;QACpB,uBAAuB;QACvB,UAAU,EAAE,MAAM,CAAA;QAClB,mBAAmB;QACnB,UAAU,EAAE,MAAM,CAAA;QAClB,iCAAiC;QACjC,QAAQ,EAAE,MAAM,CAAA;QAChB,6BAA6B;QAC7B,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;CACF,CAAA;AAED;;;;;;;;GAQG;AACH,qBAAa,UAAW,SAAQ,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC9D,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,UAAS;IAEtB,mCAAmC;IACnC,QAAQ,CAAC,aAAa,EAAE,gBAAgB,CAOvC;IAED;;;;OAIG;IACH,IAAI,QAAQ,WAEX;IAED;;;;;;;;;;;;;;;;OAgBG;IACG,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EAClC,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GACtB,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;CAsF1F"}

package/dist/modules/voloModule/index.d.ts

@@ -0,0 +1,148 @@
+import { CoinObject } from '@naviprotocol/lending';
+import { Transaction } from '@mysten/sui/transactions';
+import { Module } from '../module';
+import { SuiTransactionBlockResponse, DryRunTransactionBlockResponse } from '@mysten/sui/client';
+
+/**
+ * Configuration interface for the Volo staking module
+ */
+export interface VoloModuleConfig {
+    /** The package ID of the Volo staking contract */
+    packageId: string;
+    /** The pool ID for the staking pool */
+    poolId: string;
+    /** The coin type for vSUI tokens */
+    coinType: string;
+    /** The metadata ID for the staking pool */
+    metadataId: string;
+}
+/**
+ * Event types emitted by the Volo module
+ */
+export type Events = {
+    /** Emitted when staking is successful */
+    'volo:stake-success': {
+        /** Amount of SUI staked */
+        suiAmount: number;
+    };
+    /** Emitted when unstaking is successful */
+    'volo:unstake-success': {
+        /** Amount of vSUI unstaked */
+        vSuiAmount: number;
+    };
+};
+/**
+ * Statistics and information about the Volo staking pool
+ */
+export type VoloStats = {
+    /** Current operator balance */
+    operatorBalance: string;
+    /** Collectable fees in the pool */
+    collectableFee: string;
+    /** Pending stakes waiting to be processed */
+    pendingStakes: string;
+    /** Total amount staked in the pool */
+    totalStaked: string;
+    /** Total rewards distributed to stakers */
+    totalRewardsInStakes: string;
+    /** Currently active stake amount */
+    activeStake: string;
+    /** Current epoch number */
+    currentEpoch: string;
+    /** List of validators in the pool */
+    validators: {
+        /** Validator address */
+        address: string;
+        /** Total amount staked with this validator */
+        totalStaked: string;
+        /** Assigned weight for this validator */
+        assigned_weight: string;
+        /** Annual percentage yield for this validator */
+        apy: string;
+        /** Validator name */
+        name: string;
+    }[];
+    /** Current exchange rate between SUI and vSUI */
+    exchangeRate: number;
+    /** Total supply of vSUI tokens */
+    totalSupply: string;
+    /** Overall APY for the staking pool */
+    apy: number;
+    /** Maximum amount that can be instantly unstaked */
+    maxInstantUnstake: string;
+    /** Maximum amount that can be unstaked without fees */
+    maxNoFeeUnstake: string;
+    /** Total number of stakers in the pool */
+    totalStakers: number;
+    /** Timestamp of last update */
+    lastUpdated: number;
+};
+/**
+ * Volo Module for Sui Staking Protocol
+ *
+ * Provides functionality to stake SUI tokens and receive vSUI tokens,
+ * enabling liquid staking with potential rewards and instant unstaking.
+ */
+export declare class VoloModule extends Module<VoloModuleConfig, Events> {
+    /** Module name identifier */
+    readonly name = "volo";
+    /** Default configuration for the Volo staking protocol */
+    readonly defaultConfig: {
+        packageId: string;
+        poolId: string;
+        metadataId: string;
+        coinType: string;
+    };
+    /**
+     * Get current statistics and information about the Volo staking pool
+     * Uses caching to avoid repeated API calls
+     *
+     * @returns Volo staking pool information
+     */
+    getStats: () => Promise<VoloStats>;
+    /**
+     * Adds staking operation to a transaction black
+     *
+     * @param tx - The transaction block to add the staking operation to
+     * @param suiCoin - The SUI coin object to stake
+     * @returns The vSUI coin object received from staking
+     */
+    stakePTB(tx: Transaction, suiCoin: CoinObject): Promise<{
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }>;
+    /**
+     * Adds unstaking operation to a transaction black
+     *
+     * @param tx - The transaction block to add the unstaking operation to
+     * @param vSuiCoin - The vSUI coin object to unstake
+     * @returns The SUI coin object received from unstaking
+     */
+    unstakePTB(tx: Transaction, vSuiCoin: CoinObject): Promise<{
+        $kind: "NestedResult";
+        NestedResult: [number, number];
+    }>;
+    /**
+     * Stake SUI tokens to receive vSUI tokens
+     *
+     * @param suiAmount - Amount of SUI to stake (in MIST units)
+     * @param options - Optional parameters including dryRun flag
+     * @returns Transaction response or dry run response
+     * @throws Error if wallet client not found or stake amount is too low
+     */
+    stake<T extends boolean = false>(suiAmount: number, options?: {
+        dryRun: T;
+    }): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+    /**
+     * Unstake vSUI tokens to receive SUI tokens
+     *
+     * @param vSuiAmount - Amount of vSUI to unstake (in MIST units)
+     * @param options - Optional parameters including dryRun flag
+     * @returns Transaction response or dry run response
+     * @throws Error if wallet client not found or unstake amount is too low
+     */
+    unstake<T extends boolean = false>(vSuiAmount: number, options?: {
+        dryRun: T;
+    }): Promise<T extends true ? DryRunTransactionBlockResponse : SuiTransactionBlockResponse>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/voloModule/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/modules/voloModule/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACL,UAAU,EAKX,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAA;AAEhG;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kDAAkD;IAClD,SAAS,EAAE,MAAM,CAAA;IACjB,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,yCAAyC;IACzC,oBAAoB,EAAE;QACpB,2BAA2B;QAC3B,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,2CAA2C;IAC3C,sBAAsB,EAAE;QACtB,8BAA8B;QAC9B,UAAU,EAAE,MAAM,CAAA;KACnB,CAAA;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,+BAA+B;IAC/B,eAAe,EAAE,MAAM,CAAA;IACvB,mCAAmC;IACnC,cAAc,EAAE,MAAM,CAAA;IACtB,6CAA6C;IAC7C,aAAa,EAAE,MAAM,CAAA;IACrB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAA;IACnB,2CAA2C;IAC3C,oBAAoB,EAAE,MAAM,CAAA;IAC5B,oCAAoC;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,2BAA2B;IAC3B,YAAY,EAAE,MAAM,CAAA;IACpB,qCAAqC;IACrC,UAAU,EAAE;QACV,wBAAwB;QACxB,OAAO,EAAE,MAAM,CAAA;QACf,8CAA8C;QAC9C,WAAW,EAAE,MAAM,CAAA;QACnB,yCAAyC;QACzC,eAAe,EAAE,MAAM,CAAA;QACvB,iDAAiD;QACjD,GAAG,EAAE,MAAM,CAAA;QACX,qBAAqB;QACrB,IAAI,EAAE,MAAM,CAAA;KACb,EAAE,CAAA;IACH,iDAAiD;IACjD,YAAY,EAAE,MAAM,CAAA;IACpB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAA;IACX,oDAAoD;IACpD,iBAAiB,EAAE,MAAM,CAAA;IACzB,uDAAuD;IACvD,eAAe,EAAE,MAAM,CAAA;IACvB,0CAA0C;IAC1C,YAAY,EAAE,MAAM,CAAA;IACpB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC9D,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,UAAS;IAEtB,0DAA0D;IAC1D,QAAQ,CAAC,aAAa;;;;;MAKrB;IAED;;;;;OAKG;IACH,QAAQ,2BAQP;IAED;;;;;;OAMG;IACG,QAAQ,CAAC,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU;;;;IAcnD;;;;;;OAMG;IACG,UAAU,CAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU;;;;IActD;;;;;;;OAOG;IACG,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACnC,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GACtB,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;IAwCzF;;;;;;;OAOG;IACG,OAAO,CAAC,CAAC,SAAS,OAAO,GAAG,KAAK,EACrC,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,CAAC,CAAA;KAAE,GACtB,OAAO,CAAC,CAAC,SAAS,IAAI,GAAG,8BAA8B,GAAG,2BAA2B,CAAC;CAwC1F"}

package/dist/signer.d.ts

@@ -0,0 +1,113 @@
+import { Signer, SignatureWithBytes } from '@mysten/sui/cryptography';
+import { Transaction } from '@mysten/sui/transactions';
+import { SuiClient } from '@mysten/sui/client';
+import { Experimental_SuiClientTypes } from '@mysten/sui/experimental';
+
+/**
+ * Options for signing and executing transactions
+ */
+interface SignAndExecuteOptions {
+    /** Transaction to sign and execute */
+    transaction: Transaction;
+    /** Sui client instance */
+    client: SuiClient;
+}
+/**
+ * Watch-only signer implementation
+ *
+ * This signer provides read-only access to wallet information without
+ * the ability to sign transactions. It's useful for viewing wallet
+ * balances, transaction history, and other non-signing operations.
+ *
+ * Note: This signer cannot actually sign transactions and will return
+ * empty signatures or throw errors when signing is attempted.
+ */
+export declare class WatchSigner extends Signer {
+    /** The wallet address this signer represents */
+    private address;
+    /**
+     * Creates a new watch-only signer
+     *
+     * @param address - The wallet address to watch
+     */
+    constructor(address: string);
+    /**
+     * Signs transaction bytes (not implemented for watch-only mode)
+     *
+     * This method is required by the Signer interface but cannot
+     * actually sign transactions in watch-only mode.
+     *
+     * @param bytes - Transaction bytes to sign
+     * @returns Promise<Uint8Array> - Empty signature (not valid)
+     */
+    sign(bytes: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Gets the public key information for this signer
+     *
+     * Returns a mock public key object that provides the wallet address
+     * but cannot be used for actual cryptographic operations.
+     *
+     * @returns Mock public key object
+     */
+    getPublicKey(): any;
+    /**
+     * Gets the key scheme for this signer
+     *
+     * @returns Key scheme string (ed25519 for compatibility)
+     */
+    getKeyScheme(): any;
+    /**
+     * Signs and executes a transaction (not implemented for watch-only mode)
+     *
+     * This method is required by the Signer interface but cannot
+     * actually sign and execute transactions in watch-only mode.
+     *
+     * @param options - Sign and execute options
+     * @returns Promise<any> - Empty result (not a real transaction result)
+     */
+    signAndExecuteTransaction({ transaction, client }: SignAndExecuteOptions): Promise<any>;
+}
+/**
+ * Web signer implementation
+ *
+ * For use in browser environments
+ */
+export declare abstract class WebSigner extends Signer {
+    private address;
+    /**
+     * Creates a new watch-only signer
+     *
+     * @param address - The wallet address to watch
+     */
+    constructor(address: string);
+    /**
+     * Signs transaction bytes (not implemented for watch-only mode)
+     *
+     * This method is required by the Signer interface but cannot
+     * actually sign transactions in watch-only mode.
+     *
+     * @param bytes - Transaction bytes to sign
+     * @returns Promise<Uint8Array> - Empty signature (not valid)
+     */
+    sign(bytes: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Gets the public key information for this signer
+     *
+     * Returns a mock public key object that provides the wallet address
+     * but cannot be used for actual cryptographic operations.
+     *
+     * @returns Mock public key object
+     */
+    getPublicKey(): any;
+    /**
+     * Gets the key scheme for this signer
+     *
+     * @returns Key scheme string (ed25519 for compatibility)
+     */
+    getKeyScheme(): any;
+    abstract signPersonalMessage(bytes: Uint8Array): Promise<SignatureWithBytes>;
+    abstract signTransaction(bytes: Uint8Array): Promise<SignatureWithBytes>;
+    abstract signAndExecuteTransaction({ transaction, client }: SignAndExecuteOptions): Promise<Experimental_SuiClientTypes.TransactionResponse>;
+}
+export {};
+//# sourceMappingURL=signer.d.ts.map

package/dist/signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAA;AACtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAE7D;;GAEG;AACH,UAAU,qBAAqB;IAC7B,sCAAsC;IACtC,WAAW,EAAE,WAAW,CAAA;IACxB,0BAA0B;IAC1B,MAAM,EAAE,SAAS,CAAA;CAClB;AAED;;;;;;;;;GASG;AACH,qBAAa,WAAY,SAAQ,MAAM;IACrC,gDAAgD;IAChD,OAAO,CAAC,OAAO,CAAQ;IAEvB;;;;OAIG;gBACS,OAAO,EAAE,MAAM;IAK3B;;;;;;;;OAQG;IACG,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlD;;;;;;;OAOG;IACH,YAAY,IAAI,GAAG;IAenB;;;;OAIG;IACH,YAAY,IAAI,GAAG;IAInB;;;;;;;;OAQG;IACG,yBAAyB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,qBAAqB,GAAG,OAAO,CAAC,GAAG,CAAC;CAG9F;AAED;;;;GAIG;AACH,8BAAsB,SAAU,SAAQ,MAAM;IAC5C,OAAO,CAAC,OAAO,CAAQ;IAEvB;;;;OAIG;gBACS,OAAO,EAAE,MAAM;IAK3B;;;;;;;;OAQG;IACG,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAIlD;;;;;;;OAOG;IACH,YAAY,IAAI,GAAG;IAenB;;;;OAIG;IACH,YAAY,IAAI,GAAG;IAInB,QAAQ,CAAC,mBAAmB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAE5E,QAAQ,CAAC,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAExE,QAAQ,CAAC,yBAAyB,CAAC,EACjC,WAAW,EACX,MAAM,EACP,EAAE,qBAAqB,GAAG,OAAO,CAAC,2BAA2B,CAAC,mBAAmB,CAAC;CACpF"}