@naviprotocol/wallet-client 1.4.9 → 2.0.0-beta.0

package/README.md

@@ -9,7 +9,6 @@ NAVI Wallet Client is a comprehensive wallet client SDK designed for the Sui blo
 
 For SDK documentation visit http://sdk.naviprotocol.io/wallet-client
 
-
 ## Core Features
 
 - 🔐 **Transaction Signing**: Complete transaction signing and execution functionality
@@ -23,27 +22,33 @@ For SDK documentation visit http://sdk.naviprotocol.io/wallet-client
 ## Supported Modules
 
 ### [Balance Module](./wallet-client/balance)
+
 Provides comprehensive wallet balance management functionality, including token tracking, portfolio management, token transfers, and automatic balance updates.
 
 **Key Features:**
+
 - Real-time balance tracking
 - Token transfers
 - Object transfers
 - Automatic balance updates
 
 ### [Swap Module](./wallet-client/swap)
+
 Provides DEX token swapping functionality, integrated with Astros aggregator to find optimal swap paths and execute trades across multiple decentralized exchanges.
 
 **Key Features:**
+
 - Token swapping
 - Aggregator integration
 - Slippage protection
 - Multi-DEX support
 
 ### [Lending Module](./wallet-client/lending)
+
 Provides comprehensive lending protocol functionality, including deposits, withdrawals, borrowing, repayments, liquidations, reward claiming, and oracle price updates.
 
 **Key Features:**
+
 - Deposits and withdrawals
 - Borrowing and repayments
 - Liquidation functionality
@@ -51,17 +56,21 @@ Provides comprehensive lending protocol functionality, including deposits, withd
 - Oracle updates
 
 ### [Haedal Module](./wallet-client/haedal)
+
 Provides Haedal protocol staking and unstaking functionality, allowing users to stake SUI to receive haSUI and obtain APY statistics.
 
 **Key Features:**
+
 - SUI staking
 - haSUI unstaking
 - APY queries
 
 ### [Volo Module](./wallet-client/volo)
+
 Provides Volo staking protocol functionality, allowing users to stake SUI tokens and receive vSUI (volo SUI) tokens for liquid staking.
 
 **Key Features:**
+
 - SUI staking
 - vSUI unstaking
 - Statistics queries
@@ -73,13 +82,57 @@ Provides Volo staking protocol functionality, allowing users to stake SUI tokens
 npm install @naviprotocol/wallet-client
 ```
 
-## Quick Start
+## Sui SDK v2 Notes
+
+`@naviprotocol/wallet-client@2` defaults to the Sui SDK v2 main path. The
+Suilend adapter is an optional peer dependency and is loaded lazily when the
+lending protocol registry is initialized. This preserves the previous
+cross-protocol migration behavior without adding the Suilend stack to the root
+SDK import path. Install the optional peers only when you use Suilend migration
+paths:
+
+```bash
+npm install @suilend/sdk@^3.0.4 @suilend/sui-fe@^3.0.7 @mysten/bcs@2.0.1 @pythnetwork/pyth-sui-js@2.2.0
+```
 
 ```ts
-import { WalletClient } from '@naviprotocol/wallet-client'
+const walletClient = new WalletClient({
+  signer,
+  client: { url: getJsonRpcFullnodeUrl('mainnet') }
+})
+```
+
+If an app does not use Suilend, it can explicitly opt out:
+
+```ts
+const walletClient = new WalletClient({
+  signer,
+  client: { url: getJsonRpcFullnodeUrl('mainnet') },
+  configs: {
+    lending: {
+      enableSuilend: false
+    }
+  }
+})
+```
+
+For custom Sui environments, pass `configs.lending.suilendGrpcUrl` or
+`configs.lending.suilendGrpcClient` when Suilend needs a dedicated gRPC
+endpoint.
 
-// Create wallet client
-const walletClient = new WalletClient()
+## Quick Start
+
+```ts
+import { getJsonRpcFullnodeUrl } from '@mysten/sui/jsonRpc'
+import { WalletClient, WatchSigner } from '@naviprotocol/wallet-client'
+
+const address = '0x0000000000000000000000000000000000000000000000000000000000000001'
+const walletClient = new WalletClient({
+  signer: new WatchSigner(address),
+  client: {
+    url: getJsonRpcFullnodeUrl('mainnet')
+  }
+})
 
 // Use balance module
 const portfolio = walletClient.balance.portfolio
@@ -90,7 +143,8 @@ const result = await walletClient.swap.swap(
   '0x2::sui::SUI',
   '0x5d4b302506645c37ff133b98c4b50a5ae14841659738d6d733d59d0d217a93bf::coin::COIN',
   1000000000,
-  0.01
+  0.01,
+  { dryRun: true }
 )
 
 // Use lending module
@@ -99,11 +153,11 @@ const pools = await walletClient.lending.getPools()
 
 // Use Haedal module
 const apy = await walletClient.haedal.getApy()
-const stakeResult = await walletClient.haedal.stake(1000000000)
+const stakeResult = await walletClient.haedal.stake(1000000000, { dryRun: true })
 
 // Use Volo module
 const stats = await walletClient.volo.getStats()
-const voloStakeResult = await walletClient.volo.stake(1000000000)
+const voloStakeResult = await walletClient.volo.stake(1000000000, { dryRun: true })
 ```
 
 ## Event Listening
@@ -137,4 +191,3 @@ walletClient.events.on('volo:stake-success', (data) => {
 ## Support
 
 - Issue reporting: [GitHub Issues](https://github.com/naviprotocol/naviprotocol-monorepo/issues)
-

package/dist/client.d.ts

@@ -1,10 +1,10 @@
-import { SuiClient, SuiClientOptions, ExecuteTransactionBlockParams } from '@mysten/sui/client';
+import { SuiJsonRpcClient, SuiJsonRpcClientOptions } from '@mysten/sui/jsonRpc';
 import { Signer } from '@mysten/sui/cryptography';
 import { Emitter } from 'mitt';
 import { Module, ModuleConfig } from './modules/module';
 import { modules, ModuleName, ModuleEvents } from './modules';
 import { Transaction } from '@mysten/sui/transactions';
-import { DryRunOptions } from './types';
+import { DryRunOptions, NaviTransactionExecutionOptions, NaviWalletTransactionResult } from './types';
 
 /**
  * Extracts the configuration type from a module
@@ -25,7 +25,9 @@ export type WalletClientOptions = {
     /** Optional module-specific configurations */
     configs?: Partial<UserConfigs>;
     /** Optional Sui client configuration */
-    client?: SuiClientOptions;
+    client?: Partial<SuiJsonRpcClientOptions> & {
+        url?: string;
+    };
 };
 /**
  * Main wallet client class that provides unified access to blockchain operations
@@ -44,7 +46,9 @@ export declare class WalletClient {
     /** Event emitter for module events */
     readonly events: Emitter<ModuleEvents>;
     /** The Sui client instance */
-    readonly client: SuiClient;
+    readonly client: SuiJsonRpcClient;
+    /** URL used by the default JSON-RPC client, when available. */
+    readonly clientUrl?: string;
     get lending(): import('./modules/lendingModule').LendingModule;
     get balance(): import('./modules/balanceModule').BalanceModule;
     get volo(): import('./modules/voloModule').VoloModule;
@@ -62,7 +66,7 @@ export declare class WalletClient {
      */
     signExecuteTransaction(options: {
         transaction: Uint8Array | Transaction;
-    } & Omit<ExecuteTransactionBlockParams, 'transactionBlock' | 'signature'> & Partial<DryRunOptions>): Promise<import('@mysten/sui/dist/cjs/client').DryRunTransactionBlockResponse | import('@mysten/sui/dist/cjs/client').SuiTransactionBlockResponse>;
+    } & NaviTransactionExecutionOptions & Partial<DryRunOptions>): Promise<NaviWalletTransactionResult<boolean>>;
     /**
      * Gets the wallet address from the signer's public key
      * @returns The wallet address as a string

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,KAAK,6BAA6B,EAAE,MAAM,oBAAoB,CAAA;AACpG,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAa,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEpC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAGvC;;GAEG;AACH,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,EAAE,GAAG,CAAC,GAAG,OAAO,GAAG,KAAK,CAAA;AAEpF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;KACvB,CAAC,IAAI,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrE,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,8CAA8C;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC9B,wCAAwC;IACxC,MAAM,CAAC,EAAE,gBAAgB,CAAA;CAC1B,CAAA;AASD;;;;;;GAMG;AACH,qBAAa,YAAY;IACvB,kDAAkD;IAClD,SAAgB,MAAM,EAAE,MAAM,CAAA;IAE9B,sDAAsD;IACtD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAElC,0CAA0C;IAC1C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD,sCAAsC;IACtC,SAAgB,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,CAAS;IAEtD,8BAA8B;IAC9B,SAAgB,MAAM,EAAE,SAAS,CAAA;IAEjC,IAAW,OAAO,oDAEjB;IAED,IAAW,OAAO,oDAEjB;IAED,IAAW,IAAI,8CAEd;IAED,IAAW,IAAI,8CAEd;IAED,IAAW,MAAM,kDAEhB;IAED;;;OAGG;gBACS,OAAO,EAAE,mBAAmB;IAqBxC;;;;OAIG;IACG,sBAAsB,CAC1B,OAAO,EAAE;QACP,WAAW,EAAE,UAAU,GAAG,WAAW,CAAA;KACtC,GAAG,IAAI,CAAC,6BAA6B,EAAE,kBAAkB,GAAG,WAAW,CAAC,GACvE,OAAO,CAAC,aAAa,CAAC;IA2B1B;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,KAAK,CAAC;IAItE;;;;OAIG;IACH,MAAM,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,GAAG,mBAAmB,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC;IAQ3F;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO;CAGrC;AAED,YAAY,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EACL,gBAAgB,EAEhB,KAAK,uBAAuB,EAC7B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAa,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAEpC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AACtD,OAAO,EACL,aAAa,EACb,+BAA+B,EAC/B,2BAA2B,EAC5B,MAAM,SAAS,CAAA;AAGhB;;GAEG;AACH,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,OAAO,EAAE,GAAG,CAAC,GAAG,OAAO,GAAG,KAAK,CAAA;AAEpF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;KACvB,CAAC,IAAI,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACrE,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,8CAA8C;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC9B,wCAAwC;IACxC,MAAM,CAAC,EAAE,OAAO,CAAC,uBAAuB,CAAC,GAAG;QAC1C,GAAG,CAAC,EAAE,MAAM,CAAA;KACb,CAAA;CACF,CAAA;AAUD;;;;;;GAMG;AACH,qBAAa,YAAY;IACvB,kDAAkD;IAClD,SAAgB,MAAM,EAAE,MAAM,CAAA;IAE9B,sDAAsD;IACtD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAElC,0CAA0C;IAC1C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD,sCAAsC;IACtC,SAAgB,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,CAAS;IAEtD,8BAA8B;IAC9B,SAAgB,MAAM,EAAE,gBAAgB,CAAA;IAExC,+DAA+D;IAC/D,SAAgB,SAAS,CAAC,EAAE,MAAM,CAAA;IAElC,IAAW,OAAO,oDAEjB;IAED,IAAW,OAAO,oDAEjB;IAED,IAAW,IAAI,8CAEd;IAED,IAAW,IAAI,8CAEd;IAED,IAAW,MAAM,kDAEhB;IAED;;;OAGG;gBACS,OAAO,EAAE,mBAAmB;IAwBxC;;;;OAIG;IACG,sBAAsB,CAC1B,OAAO,EAAE;QACP,WAAW,EAAE,UAAU,GAAG,WAAW,CAAA;KACtC,GAAG,+BAA+B,GACjC,OAAO,CAAC,aAAa,CAAC,GACvB,OAAO,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC;IA6BhD;;;OAGG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,KAAK,CAAC;IAItE;;;;OAIG;IACH,MAAM,CAAC,KAAK,SAAS,UAAU,EAAE,IAAI,EAAE,KAAK,GAAG,mBAAmB,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC;IAQ3F;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO;CAGrC;AAED,YAAY,EAAE,YAAY,EAAE,CAAA"}