@scallop-io/sui-scallop-sdk 0.42.8 → 0.44.1

package/src/models/scallopClient.ts

@@ -6,8 +6,8 @@ import { ScallopUtils } from './scallopUtils';
 import { ScallopBuilder } from './scallopBuilder';
 import { ScallopQuery } from './scallopQuery';
 import type { SuiTransactionBlockResponse } from '@mysten/sui.js/client';
-import type { TransactionArgument } from '@mysten/sui.js/transactions';
-import type { SuiTxArg } from '@scallop-io/sui-kit';
+import type { TransactionObjectArgument } from '@mysten/sui.js/transactions';
+import type { SuiObjectArg } from '@scallop-io/sui-kit';
 import type {
   ScallopClientFnReturnType,
   ScallopInstanceParams,
@@ -237,14 +237,14 @@ export class ScallopClient {
     collateralCoinName: SupportCollateralCoins,
     amount: number,
     sign?: S,
-    obligationId?: SuiTxArg,
+    obligationId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
   public async depositCollateral<S extends boolean>(
     collateralCoinName: SupportCollateralCoins,
     amount: number,
     sign: S = true as S,
-    obligationId?: SuiTxArg,
+    obligationId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
@@ -374,14 +374,14 @@ export class ScallopClient {
     stakeCoinName: SupportStakeCoins,
     amount: number,
     sign?: S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
   public async depositAndStake<S extends boolean>(
     stakeCoinName: SupportStakeCoins,
     amount: number,
     sign: S = true as S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
@@ -543,16 +543,16 @@ export class ScallopClient {
     amount: number,
     callback: (
       txBlock: ScallopTxBlock,
-      coin: TransactionArgument
-    ) => TransactionArgument
+      coin: TransactionObjectArgument | string
+    ) => SuiObjectArg
   ): Promise<SuiTransactionBlockResponse>;
   public async flashLoan<S extends boolean>(
     poolCoinName: SupportPoolCoins,
     amount: number,
     callback: (
       txBlock: ScallopTxBlock,
-      coin: TransactionArgument
-    ) => TransactionArgument,
+      coin: TransactionObjectArgument | string
+    ) => SuiObjectArg,
     sign?: S,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
@@ -561,8 +561,8 @@ export class ScallopClient {
     amount: number,
     callback: (
       txBlock: ScallopTxBlock,
-      coin: TransactionArgument
-    ) => TransactionArgument,
+      coin: TransactionObjectArgument | string
+    ) => SuiObjectArg,
     sign: S = true as S,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
@@ -637,14 +637,14 @@ export class ScallopClient {
     stakeMarketCoinName: SupportStakeMarketCoins,
     amount: number,
     sign?: S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
   public async stake<S extends boolean>(
     stakeMarketCoinName: SupportStakeMarketCoins,
     amount: number,
     sign: S = true as S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
@@ -689,14 +689,14 @@ export class ScallopClient {
     stakeMarketCoinName: SupportStakeMarketCoins,
     amount: number,
     sign?: S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
   public async unstake<S extends boolean>(
     stakeMarketCoinName: SupportStakeMarketCoins,
     amount: number,
     sign: S = true as S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
@@ -737,14 +737,14 @@ export class ScallopClient {
     stakeMarketCoinName: SupportStakeMarketCoins,
     amount: number,
     sign?: S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
   public async unstakeAndWithdraw<S extends boolean>(
     stakeMarketCoinName: SupportStakeMarketCoins,
     amount: number,
     sign: S = true as S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();
@@ -791,13 +791,13 @@ export class ScallopClient {
   public async claim<S extends boolean>(
     stakeMarketCoinName: SupportStakeMarketCoins,
     sign?: S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>>;
   public async claim<S extends boolean>(
     stakeMarketCoinName: SupportStakeMarketCoins,
     sign: S = true as S,
-    stakeAccountId?: SuiTxArg,
+    stakeAccountId?: string,
     walletAddress?: string
   ): Promise<ScallopClientFnReturnType<S>> {
     const txBlock = this.builder.createTxBlock();

package/src/models/scallopUtils.ts

@@ -1,5 +1,5 @@
 import { SUI_TYPE_ARG, normalizeStructTag } from '@mysten/sui.js/utils';
-import { SuiKit } from '@scallop-io/sui-kit';
+import { SuiAddressArg, SuiKit } from '@scallop-io/sui-kit';
 import { SuiPriceServiceConnection } from '@pythnetwork/pyth-sui-js';
 import { ScallopAddress } from './scallopAddress';
 import { ScallopQuery } from './scallopQuery';
@@ -294,7 +294,7 @@ export class ScallopUtils {
    * @param obligationId - The obligation id.
    * @return Asset coin Names.
    */
-  public async getObligationCoinNames(obligationId: string) {
+  public async getObligationCoinNames(obligationId: SuiAddressArg) {
     const obligation = await queryObligation(this._query, obligationId);
     const collateralCoinTypes = obligation.collaterals.map((collateral) => {
       return `0x${collateral.type.name}`;

package/src/queries/coreQuery.ts

@@ -12,6 +12,7 @@ import {
   calculateMarketCollateralData,
 } from '../utils';
 import type { SuiObjectResponse, SuiObjectData } from '@mysten/sui.js/client';
+import type { SuiAddressArg } from '@scallop-io/sui-kit';
 import type { ScallopQuery } from '../models';
 import {
   Market,
@@ -603,7 +604,7 @@ export const getObligations = async (
  */
 export const queryObligation = async (
   query: ScallopQuery,
-  obligationId: string
+  obligationId: SuiAddressArg
 ) => {
   const packageId = query.address.get('core.packages.query.id');
   const queryTarget = `${packageId}::obligation_query::obligation_data`;

package/src/types/builder/core.ts

@@ -1,14 +1,16 @@
 import type {
   SuiTxBlock as SuiKitTxBlock,
+  SuiAddressArg,
+  SuiObjectArg,
   SuiTxArg,
 } from '@scallop-io/sui-kit';
+import type { TransactionResult } from '@mysten/sui.js/transactions';
 import type { ScallopBuilder } from '../../models';
 import type {
   SupportCollateralCoins,
   SupportPoolCoins,
   SupportAssetCoins,
 } from '../constant';
-import type { TransactionResult } from './index';
 
 export type CoreIds = {
   protocolPkg: string;
@@ -21,55 +23,58 @@ export type CoreIds = {
 export type CoreNormalMethods = {
   openObligation: () => TransactionResult;
   returnObligation: (
-    obligation: SuiTxArg,
-    obligationHotPotato: SuiTxArg
+    obligation: SuiAddressArg,
+    obligationHotPotato: SuiObjectArg
   ) => void;
   openObligationEntry: () => void;
   addCollateral: (
-    obligation: SuiTxArg,
-    coin: SuiTxArg,
+    obligation: SuiAddressArg,
+    coin: SuiObjectArg,
     collateralCoinName: SupportCollateralCoins
   ) => void;
   takeCollateral: (
-    obligation: SuiTxArg,
-    obligationKey: SuiTxArg,
-    amount: number,
+    obligation: SuiAddressArg,
+    obligationKey: SuiAddressArg,
+    amount: SuiTxArg,
     collateralCoinName: SupportCollateralCoins
   ) => TransactionResult;
   deposit: (
-    coin: SuiTxArg,
+    coin: SuiObjectArg,
     poolCoinName: SupportPoolCoins
   ) => TransactionResult;
-  depositEntry: (coin: SuiTxArg, poolCoinName: SupportPoolCoins) => void;
+  depositEntry: (coin: SuiObjectArg, poolCoinName: SupportPoolCoins) => void;
   withdraw: (
-    marketCoin: SuiTxArg,
+    marketCoin: SuiObjectArg,
     poolCoinName: SupportPoolCoins
   ) => TransactionResult;
-  withdrawEntry: (marketCoin: SuiTxArg, poolCoinName: SupportPoolCoins) => void;
+  withdrawEntry: (
+    marketCoin: SuiObjectArg,
+    poolCoinName: SupportPoolCoins
+  ) => void;
   borrow: (
-    obligation: SuiTxArg,
-    obligationKey: SuiTxArg,
-    amount: number,
+    obligation: SuiAddressArg,
+    obligationKey: SuiAddressArg,
+    amount: SuiTxArg,
     poolCoinName: SupportPoolCoins
   ) => TransactionResult;
   borrowEntry: (
-    obligation: SuiTxArg,
-    obligationKey: SuiTxArg,
-    amount: number,
+    obligation: SuiAddressArg,
+    obligationKey: SuiAddressArg,
+    amount: SuiTxArg,
     poolCoinName: SupportPoolCoins
   ) => void;
   repay: (
-    obligation: SuiTxArg,
-    coin: SuiTxArg,
+    obligation: SuiAddressArg,
+    coin: SuiObjectArg,
     poolCoinName: SupportPoolCoins
   ) => void;
   borrowFlashLoan: (
-    amount: number,
+    amount: SuiTxArg,
     poolCoinName: SupportPoolCoins
   ) => TransactionResult;
   repayFlashLoan: (
-    coin: SuiTxArg,
-    loan: SuiTxArg,
+    coin: SuiObjectArg,
+    loan: SuiAddressArg,
     poolCoinName: SupportPoolCoins
   ) => void;
 };
@@ -78,19 +83,19 @@ export type CoreQuickMethods = {
   addCollateralQuick: (
     amount: number,
     collateralCoinName: SupportCollateralCoins,
-    obligationId?: SuiTxArg
+    obligationId?: SuiAddressArg
   ) => Promise<void>;
   takeCollateralQuick: (
     amount: number,
     collateralCoinName: SupportCollateralCoins,
-    obligationId?: string,
-    obligationKey?: string
+    obligationId?: SuiAddressArg,
+    obligationKey?: SuiAddressArg
   ) => Promise<TransactionResult>;
   borrowQuick: (
     amount: number,
     poolCoinName: SupportPoolCoins,
-    obligationId?: string,
-    obligationKey?: string
+    obligationId?: SuiAddressArg,
+    obligationKey?: SuiAddressArg
   ) => Promise<TransactionResult>;
   depositQuick: (
     amount: number,
@@ -103,7 +108,7 @@ export type CoreQuickMethods = {
   repayQuick: (
     amount: number,
     poolCoinName: SupportPoolCoins,
-    obligationId?: string
+    obligationId?: SuiAddressArg
   ) => Promise<void>;
   updateAssetPricesQuick: (
     assetCoinNames?: SupportAssetCoins[]

package/src/types/builder/index.ts

@@ -1,4 +1,3 @@
-import type { TransactionArgument } from '@mysten/sui.js/transactions';
 import type { CoreTxBlock } from './core';
 import type { SpoolTxBlock } from './spool';
 
@@ -6,4 +5,3 @@ export type * from './core';
 export type * from './spool';
 
 export type ScallopTxBlock = CoreTxBlock & SpoolTxBlock;
-export type TransactionResult = TransactionArgument & TransactionArgument[];

package/src/types/builder/spool.ts

@@ -1,10 +1,12 @@
 import type {
   SuiTxBlock as SuiKitTxBlock,
+  SuiAddressArg,
+  SuiObjectArg,
   SuiTxArg,
 } from '@scallop-io/sui-kit';
+import type { TransactionResult } from '@mysten/sui.js/transactions';
 import type { ScallopBuilder } from '../../models';
 import type { SupportStakeMarketCoins } from '../constant';
-import type { TransactionResult } from './index';
 
 export type SpoolIds = {
   spoolPkg: string;
@@ -15,41 +17,37 @@ export type SpoolNormalMethods = {
     stakeMarketCoinName: SupportStakeMarketCoins
   ) => TransactionResult;
   stake: (
-    stakeAccount: SuiTxArg,
-    coin: SuiTxArg,
+    stakeAccount: SuiAddressArg,
+    coin: SuiObjectArg,
     stakeMarketCoinName: SupportStakeMarketCoins
   ) => void;
   unstake: (
-    stakeAccount: SuiTxArg,
-    amount: number,
+    stakeAccount: SuiAddressArg,
+    amount: SuiTxArg,
     stakeMarketCoinName: SupportStakeMarketCoins
   ) => TransactionResult;
   claim: (
-    stakeAccount: SuiTxArg,
+    stakeAccount: SuiAddressArg,
     stakeMarketCoinName: SupportStakeMarketCoins
   ) => TransactionResult;
 };
 
 export type SpoolQuickMethods = {
   stakeQuick(
-    amountOrMarketCoin: number,
+    amountOrMarketCoin: SuiObjectArg | number,
     stakeMarketCoinName: SupportStakeMarketCoins,
-    stakeAccountId?: SuiTxArg
-  ): Promise<void>;
-  stakeQuick(
-    amountOrMarketCoin: TransactionResult,
-    stakeMarketCoinName: SupportStakeMarketCoins,
-    stakeAccountId?: SuiTxArg
+    stakeAccountId?: SuiAddressArg
   ): Promise<void>;
+
   unstakeQuick(
     amount: number,
     stakeMarketCoinName: SupportStakeMarketCoins,
-    stakeAccountId?: SuiTxArg
-  ): Promise<TransactionResult>;
+    stakeAccountId?: SuiAddressArg
+  ): Promise<TransactionResult[]>;
   claimQuick(
     stakeMarketCoinName: SupportStakeMarketCoins,
-    stakeAccountId?: SuiTxArg
-  ): Promise<TransactionResult>;
+    stakeAccountId?: SuiAddressArg
+  ): Promise<TransactionResult[]>;
 };
 
 export type SuiTxBlockWithSpoolNormalMethods = SuiKitTxBlock &