@msafe/sui-app-store 0.0.337 → 0.0.340

package/dist/index.d.mts

@@ -1,17 +1,229 @@
-import { TransactionType } from '@msafe/sui3-utils';
+import { PoolName } from '@alphafi/alphafi-sdk';
+import { SuiAddress, TransactionType, CreateStreamIntentionData, SetAutoClaimIntentionData, ClaimStreamIntentionData, ClaimByProxyStreamIntentionData, CancelStreamIntentionData } from '@msafe/sui3-utils';
+import { NumStr } from '@firefly-exchange/library-sui';
+import { Pool, NFT, Trade } from 'turbos-clmm-sdk';
 import { Transaction } from '@mysten/sui/transactions';
-import { SuiSignTransactionBlockInput, WalletAccount, IdentifierString } from '@mysten/wallet-standard';
+import { IdentifierString, WalletAccount, SuiSignTransactionBlockInput } from '@mysten/wallet-standard';
 import { SuiJsonRpcClient } from '@mysten/sui/jsonRpc';
 import { SuiGrpcClient } from '@mysten/sui/grpc';
 import { SuiClient } from '@mysten/sui.js/client';
 import { TransactionBlock } from '@mysten/sui.js/transactions';
 
+type AlphaFiIntentionData = DepositDoubleAssetIntentionData | DepositSingleAssetIntentionData | WithdrawAlphaIntentionData | WithdrawIntentionData$2 | EmptyIntentionData;
+interface EmptyIntentionData {
+}
+interface DepositDoubleAssetIntentionData {
+    poolName: PoolName;
+    amount: string;
+    isAmountA: boolean;
+}
+interface DepositSingleAssetIntentionData {
+    poolName: PoolName;
+    amount: string;
+}
+interface WithdrawIntentionData$2 {
+    xTokensAmount: string;
+    poolName: PoolName;
+}
+interface WithdrawAlphaIntentionData {
+    xTokensAmount: string;
+    withdrawFromLocked: boolean;
+}
+
+interface Token {
+    address: string;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoURI: string;
+    totalSupply: string;
+    circulatingSupply: string;
+    isVerified: boolean;
+    hasBluefinPools: boolean;
+    rfqSupported: boolean;
+}
+type FeeTokens = [string, string];
+type RewardTokens = Array<string>;
+type CollectTokens = {
+    collectFeeTokens: FeeTokens;
+    collectRewardTokens: RewardTokens;
+};
+type OpenPositionIntentionData = {
+    pool: SuiAddress;
+    lowerTick: number;
+    upperTick: number;
+    tokenAmount: string;
+    maxAmountTokenA: string;
+    maxAmountTokenB: string;
+    isTokenAFixed: boolean;
+};
+type ClosePositionIntentionData = {
+    pool: SuiAddress;
+    position: SuiAddress;
+    transferTokensTo?: SuiAddress;
+} & CollectTokens;
+type ProvideLiquidityIntentionData = {
+    pool: SuiAddress;
+    position: SuiAddress;
+    lowerTick: number;
+    upperTick: number;
+    tokenAmount: string;
+    maxAmountTokenA: string;
+    maxAmountTokenB: string;
+    isTokenAFixed: boolean;
+};
+type RemoveLiquidityIntentionData$1 = {
+    pool: SuiAddress;
+    position: SuiAddress;
+    liquidity: string;
+    maxAmountTokenA: string;
+    maxAmountTokenB: string;
+    transferTokensTo?: SuiAddress;
+} & CollectTokens;
+type CollectRewardsAndFeeIntentionData = {
+    pool: SuiAddress;
+    position: SuiAddress;
+} & CollectTokens;
+type CollectRewardsIntentionData = {
+    pool: SuiAddress;
+    position: SuiAddress;
+    collectRewardTokens: RewardTokens;
+};
+type CollectFeeIntentionData$1 = {
+    pool: SuiAddress;
+    position: SuiAddress;
+    collectFeeTokens: FeeTokens;
+};
+type Aggregator7KSwapIntentionData = {
+    tokenIn: Token | undefined;
+    tokenOut: Token | undefined;
+    amountIn: string;
+    maxSlippage: string;
+};
+type BluefinIntentionData = OpenPositionIntentionData | ClosePositionIntentionData | ProvideLiquidityIntentionData | RemoveLiquidityIntentionData$1 | CollectRewardsIntentionData | CollectFeeIntentionData$1 | CollectRewardsAndFeeIntentionData | Aggregator7KSwapIntentionData;
+
 type SuiNetworks = 'sui:devnet' | 'sui:testnet' | 'sui:localnet' | 'sui:mainnet';
 
-interface IAppHelper<T> {
-    deserialize(input: SuiSignTransactionBlockInput & {
+interface CloseIntentionData {
+    collateralType: string;
+    recipient: string;
+    strapId?: string;
+}
+interface BorrowIntentionData$2 {
+    collateralType: string;
+    collateralAmount: string;
+    borrowAmount: string;
+    insertionPlace?: string;
+    strapId?: string;
+}
+interface WithdrawIntentionData$1 {
+    collateralType: string;
+    withdrawAmount: string;
+    insertionPlace?: string;
+    strapId?: string;
+}
+interface RepayIntentionData$2 {
+    collateralType: string;
+    repayAmount: string;
+    withdrawAmount: string;
+    isSurplus: boolean;
+    insertionPlace?: string;
+    strapId?: string;
+}
+interface PsmIntentionData {
+    coinType: string;
+    amount: string;
+    buckToCoin: boolean;
+}
+interface SBUCKDepositIntentionData {
+    coinType: string;
+    amount: string;
+    isStake: boolean;
+}
+interface SBUCKUnstakeIntentionData {
+    stakeProofs: string[];
+    amount: string;
+    isStake: boolean;
+    toBuck: boolean;
+}
+interface SBUCKWithdrawIntentionData {
+    amount: string;
+}
+interface SBUCKClaimIntentionData {
+    stakeProofs: string[];
+}
+interface TankDepositIntentionData {
+    coinType: string;
+    amount: string;
+}
+interface TankWithdrawIntentionData {
+    coinType: string;
+    amount: string;
+}
+interface TankClaimIntentionData {
+    coinType: string;
+}
+
+interface LockClaimIntentionData {
+    coinType: string;
+    proofCount: number;
+}
+
+type BucketIntentionData = PsmIntentionData | BorrowIntentionData$2 | WithdrawIntentionData$1 | RepayIntentionData$2 | CloseIntentionData | TankDepositIntentionData | TankWithdrawIntentionData | TankClaimIntentionData | SBUCKDepositIntentionData | SBUCKWithdrawIntentionData | SBUCKUnstakeIntentionData | SBUCKClaimIntentionData | LockClaimIntentionData;
+
+interface CetusIntentionData {
+    txbParams: any;
+    action: string;
+}
+
+type DepositAssetIntentionData = {
+    vaultID: SuiAddress;
+    amount: NumStr;
+};
+type MintSharesIntentionData = {
+    vaultID: SuiAddress;
+    numShares: NumStr;
+};
+type RedeemSharesIntentionData = {
+    vaultID: SuiAddress;
+    numShares: NumStr;
+};
+type CancelPendingWithdrawalRequestIntentionData = {
+    vaultID: SuiAddress;
+    sequenceNumber: NumStr;
+};
+type EmberIntentionData = DepositAssetIntentionData | MintSharesIntentionData | RedeemSharesIntentionData | CancelPendingWithdrawalRequestIntentionData;
+
+type MMTDEXIntentionData = {
+    action: TransactionSubType;
+    params: any;
+};
+declare enum TransactionSubType {
+    AddLiquidity = "AddLiquidity",
+    AddLiquiditySingleSide = "AddLiquiditySingleSide",
+    ClaimAllRewards = "ClaimAllRewards",
+    ClaimRewards = "ClaimRewards",
+    ClaimRewardsAs = "ClaimRewardsAs",
+    RemoveLiquidity = "RemoveLiquidity",
+    Swap = "Swap",
+    ManageLiquidity = "ManageLiquidity",
+    ManageLiquiditySingleSide = "ManageLiquiditySingleSide",
+    StakeXSui = "StakeXSui",
+    UnstakeXSui = "UnstakeXSui",
+    Bond = "Bond",
+    Extend = "Extend",
+    Merge = "Merge",
+    Unbond = "Unbond"
+}
+
+interface IAppHelperInternalGrpc<T> {
+    application: string;
+    supportSDK: '@mysten/sui-v2';
+    deserialize(input: {
+        transaction: Transaction;
+        chain: IdentifierString;
         network: SuiNetworks;
-        clientUrl: string;
+        suiGrpcClient: SuiGrpcClient;
         account: WalletAccount;
         appContext?: any;
     }): Promise<{
@@ -24,11 +236,27 @@ interface IAppHelper<T> {
         txType: TransactionType;
         txSubType: string;
         intentionData: T;
-        clientUrl: string;
+        suiGrpcClient: SuiGrpcClient;
         account: WalletAccount;
     }): Promise<Transaction>;
 }
 
+type MPayIntentionData = CreateStreamIntentionData | SetAutoClaimIntentionData | ClaimStreamIntentionData | ClaimByProxyStreamIntentionData | CancelStreamIntentionData;
+
+interface CoinTransferIntentionData {
+    recipient: string;
+    coinType: string;
+    amount: string;
+}
+
+interface ObjectTransferIntentionData {
+    receiver: string;
+    objectType: string;
+    objectId: string;
+}
+
+type CoreIntentionData = CoinTransferIntentionData | ObjectTransferIntentionData;
+
 interface IAppHelperInternal<T> {
     application: string;
     supportSDK: '@mysten/sui';
@@ -54,14 +282,365 @@ interface IAppHelperInternal<T> {
     }): Promise<Transaction>;
 }
 
-interface IAppHelperInternalGrpc<T> {
+interface ClaimRewardIntentionData {
+    type: string;
+}
+
+interface ClaimSupplyIntentionData {
+    type: string;
+}
+
+interface EntryBorrowIntentionData {
+    amount: number;
+    assetId: number;
+}
+
+interface EntryDepositIntentionData {
+    amount: number;
+    assetId: number;
+}
+
+interface EntryRepayIntentionData {
+    amount: number;
+    assetId: number;
+}
+
+interface EntryWithdrawIntentionData {
+    amount: number;
+    assetId: number;
+}
+
+interface EntryMultiDepositIntentionData {
+    list: {
+        amount: number;
+        assetId: number;
+    }[];
+}
+
+interface PlainTransactionIntentionData {
+    content: string;
+    scene: string;
+}
+
+type NAVIIntentionData = EntryDepositIntentionData | EntryBorrowIntentionData | EntryRepayIntentionData | EntryWithdrawIntentionData | EntryMultiDepositIntentionData | ClaimRewardIntentionData | ClaimSupplyIntentionData | PlainTransactionIntentionData;
+
+type PlainTransactionData = {
+    content: string;
+};
+
+interface BorrowIntentionData$1 {
+    coinName: string;
+    amount: number | string;
+    obligationId: string;
+    obligationKey: string;
+}
+
+interface BorrowWithBoostIntentionData {
+    coinName: string;
+    amount: number | string;
+    obligationId: string;
+    obligationKey: string;
+    veScaKey: string;
+}
+
+interface BorrowWithReferralIntentionData {
+    coinName: string;
+    amount: number | string;
+    obligationId: string;
+    obligationKey: string;
+    veScaKey: string | undefined;
+}
+
+interface DepositCollateralIntentionData {
+    collateralCoinName: string;
+    amount: number | string;
+    obligationId: string;
+}
+
+interface MigrateAndClaimIntentionData {
+    obligationKey: string;
+    obligationId: string;
+    rewardCoinName: string;
+    veScaKey?: string;
+}
+
+interface MigrateScoinIntentionData {
+}
+
+interface OpenObligationIntentionData {
+}
+
+interface RepayIntentionData$1 {
+    coinName: string;
+    amount: number | string;
+    obligationId: string;
+    obligationKey: string;
+}
+
+interface RepayWithBoostIntentionData {
+    coinName: string;
+    amount: number | string;
+    obligationId: string;
+    veScaKey: string;
+}
+
+interface SupplyLendingIntentionData {
+    amount: number | string;
+    coinName: string;
+}
+
+interface UnstakeSpoolIntentionData {
+    amount: number | string;
+    marketCoinName: string;
+    stakeAccountId: string | null;
+}
+
+interface WithdrawAndUnstakeLendingIntentionData {
+    amount: number | undefined;
+    coinName: string;
+    stakeAccountId: {
+        id: string;
+        coin: number;
+    }[];
+}
+
+interface WithdrawCollateralIntentionData {
+    collateralCoinName: string;
+    amount: number | string;
+    obligationId: string;
+    obligationKey: string;
+}
+
+interface WithdrawLendingIntentionData {
+    amount: string | number;
+    coinName: string;
+}
+
+interface BindReferralIntentionData {
+    veScaKey: string;
+}
+
+interface ClaimRevenueReferralIntentionData {
+    veScaKey: string;
+    coins: string[];
+}
+
+interface CreateReferralLinkIntentionData {
+}
+
+interface ExtendPeriodAndStakeMoreIntentionData {
+    amount: number;
+    veScaKey: string;
+    unlockTime: number;
+    obligationId: string | undefined;
+    obligationKey: string | undefined;
+    isOldBorrowIncentive: boolean;
+    isObligationLocked: boolean;
+}
+
+interface ExtendStakePeriodIntentionData {
+    isObligationLocked: boolean;
+    isOldBorrowIncentive: boolean;
+    obligationId: string | undefined;
+    obligationKey: string | undefined;
+    unlockTime: number | undefined;
+    veScaKey: string | undefined;
+}
+
+interface MergeVeScaIntentionData {
+    targetVeScaKey: string;
+    sourceVeScaKey: string;
+    obligationDatas: {
+        obligationKey: string;
+        obligationId: string;
+    }[];
+}
+
+interface RedeemScaIntentionData {
+    veScaKey: string;
+}
+
+interface RenewExpStakePeriodIntentionData {
+    amount: number;
+    unlockTime: number;
+    veScaKey: string;
+    isHaveRedeem: boolean;
+    obligation?: string;
+    obligationKey?: string;
+    isObligationLocked: boolean;
+    isOldBorrowIncentive: boolean;
+}
+
+interface SplitVeScaIntentionData {
+    targetVeScaKey: string;
+    splitAmount: number;
+}
+
+interface StakeScaIntentionData {
+    amount: number;
+    isObligationLocked: boolean;
+    isOldBorrowIncentive: boolean;
+    obligationId: string | undefined;
+    obligationKey: string | undefined;
+    unlockTime: number | undefined;
+    veScaKey: string | undefined;
+}
+
+interface SupplyAndStakeLendingIntentionData {
+    amount: number | string;
+    coinName: string;
+    stakeAccountId?: string | null;
+}
+
+/**
+ * Represents possible actions in the system
+ */
+type Action = 'stake' | 'unstake' | 'deactivate';
+/**
+ * Type mapping from Action to its required arguments
+ */
+type Args<T extends Action> = T extends 'stake' ? StakeArgs : T extends 'unstake' ? UnstakeArgs : T extends 'deactivate' ? DeactivateArgs : never;
+/**
+ * Arguments required for the 'stake' action
+ */
+interface StakeArgs {
+    veScaKey: string;
+    obligationId: string;
+    obligationKey: string;
+}
+/**
+ * Arguments required for the 'unstake' action
+ */
+interface UnstakeArgs {
+    obligationId: string;
+    obligationKey: string;
+}
+/**
+ * Arguments required for the 'deactivate' action
+ */
+interface DeactivateArgs {
+    veScaKey: string;
+    obligationId: string;
+}
+type BindingDatas = {
+    action: 'deactivate';
+    args: Args<'deactivate'>;
+} | {
+    action: 'stake';
+    args: Args<'stake'>;
+} | {
+    action: 'unstake';
+    args: Args<'unstake'>;
+};
+interface VeScaObligationBindingsIntentData {
+    bindingDatas: BindingDatas[];
+}
+
+interface TransferVeScaKeysIntentionData {
+    veScaKeys: {
+        objectId: string;
+        version: string;
+        digest: string;
+    }[];
+}
+
+interface WithdrawStakedScaIntentionData {
+    vescaKey?: string;
+}
+
+type ScallopIntentionData = SupplyLendingIntentionData | WithdrawLendingIntentionData | BorrowIntentionData$1 | RepayIntentionData$1 | DepositCollateralIntentionData | WithdrawCollateralIntentionData | OpenObligationIntentionData | UnstakeSpoolIntentionData | BorrowWithBoostIntentionData | StakeScaIntentionData | ExtendStakePeriodIntentionData | ExtendPeriodAndStakeMoreIntentionData | RenewExpStakePeriodIntentionData | WithdrawStakedScaIntentionData | SupplyAndStakeLendingIntentionData | WithdrawAndUnstakeLendingIntentionData | RedeemScaIntentionData | MigrateAndClaimIntentionData | BorrowWithReferralIntentionData | CreateReferralLinkIntentionData | ClaimRevenueReferralIntentionData | BindReferralIntentionData | MigrateScoinIntentionData | RepayWithBoostIntentionData | MergeVeScaIntentionData | SplitVeScaIntentionData | VeScaObligationBindingsIntentData | TransferVeScaKeysIntentionData;
+
+interface StakeIntentionData$1 {
+    amount: string;
+    outCoinType: string;
+}
+interface StakeAndDepositIntentionData {
+    amount: string;
+    outCoinType: string;
+}
+interface ConvertIntentionData {
+    amount: string;
+    inCoinType: string;
+    outCoinType: string;
+}
+interface ConvertAndDepositIntentionData {
+    amount: string;
+    inCoinType: string;
+    outCoinType: string;
+}
+interface UnstakeIntentionData {
+    amount: string;
+    inCoinType: string;
+}
+type SpringSuiIntentionData = StakeIntentionData$1 | StakeAndDepositIntentionData | ConvertIntentionData | ConvertAndDepositIntentionData | UnstakeIntentionData;
+
+interface MintIntentionData {
+    amount: string;
+}
+interface RedeemIntentionData {
+    amount: string;
+}
+type StSuiIntentionData = MintIntentionData | RedeemIntentionData;
+
+type SuilendIntentionData = DepositIntentionData | WithdrawIntentionData | BorrowIntentionData | RepayIntentionData | ClaimIntentionData | ClaimAndDepositIntentionData;
+interface WithdrawIntentionData {
+    coinType: string;
+    value: string;
+}
+interface BorrowIntentionData {
+    coinType: string;
+    value: string;
+}
+interface ClaimIntentionData {
+    value: Record<string, string>;
+}
+interface ClaimAndDepositIntentionData {
+    value: Record<string, string>;
+}
+interface DepositIntentionData {
+    coinType: string;
+    value: string;
+}
+interface RepayIntentionData {
+    coinType: string;
+    value: string;
+}
+
+type TURBOSIntentionData = CreatePoolIntentionData | AddLiquidityIntentionData | IncreaseLiquidityIntentionData | DecreaseLiquidityIntentionData | DecreaseLiquidityWithReturnIntentionData | CollectFeeIntentionData | CollectRewardIntentionData | RemoveLiquidityIntentionData | RemoveLiquidityWithReturnIntentionData | BurnIntentionData | SwapIntentionData | PrixJoinIntentionData | PrixClaimIntentionData | SwapExactQuoteForBaseIntentionData | SwapExactBaseForQuoteIntentionData;
+type CreatePoolIntentionData = Pool.CreatePoolOptions;
+type AddLiquidityIntentionData = Pool.AddLiquidityOptions;
+type BurnIntentionData = NFT.BurnOptions;
+type CollectFeeIntentionData = Pool.CollectFeeOptions;
+type CollectRewardIntentionData = Pool.CollectRewardOptions;
+type DecreaseLiquidityIntentionData = Pool.DecreaseLiquidityOptions;
+type DecreaseLiquidityWithReturnIntentionData = Pool.DecreaseLiquidityOptions;
+type IncreaseLiquidityIntentionData = Pool.IncreaseLiquidityOptions;
+interface PrixClaimIntentionData {
+}
+interface PrixJoinIntentionData {
+}
+type RemoveLiquidityIntentionData = Pool.RemoveLiquidityOptions;
+type RemoveLiquidityWithReturnIntentionData = Pool.RemoveLiquidityOptions;
+type SwapIntentionData = Trade.SwapOptions;
+interface SwapExactBaseForQuoteIntentionData {
+    token1: string;
+    token2: string;
+    poolId: string;
+    amountIn: number;
+}
+interface SwapExactQuoteForBaseIntentionData {
+    token1: string;
+    token2: string;
+    poolId: string;
+    amountIn: number;
+}
+
+interface IAppHelperInternalLegacy<T> {
     application: string;
-    supportSDK: '@mysten/sui-v2';
-    deserialize(input: {
-        transaction: Transaction;
-        chain: IdentifierString;
+    supportSDK: '@mysten/sui.js';
+    deserialize(input: SuiSignTransactionBlockInput & {
         network: SuiNetworks;
-        suiGrpcClient: SuiGrpcClient;
+        suiClient: SuiClient;
         account: WalletAccount;
         appContext?: any;
     }): Promise<{
@@ -74,17 +653,54 @@ interface IAppHelperInternalGrpc<T> {
         txType: TransactionType;
         txSubType: string;
         intentionData: T;
-        suiGrpcClient: SuiGrpcClient;
+        suiClient: SuiClient;
         account: WalletAccount;
-    }): Promise<Transaction>;
+    }): Promise<TransactionBlock>;
 }
 
-interface IAppHelperInternalLegacy<T> {
-    application: string;
-    supportSDK: '@mysten/sui.js';
+interface ClaimTicketIntentionData {
+    ticketId: string;
+}
+
+interface StakeIntentionData {
+    amount: number;
+}
+
+interface UnStakeIntentionData {
+    amount: number;
+}
+
+type VoloIntentionData = StakeIntentionData | UnStakeIntentionData | ClaimTicketIntentionData;
+
+/**
+ * Maps each registered application name to its intention data type.
+ * Add new apps here when registering helpers in `src/index.ts`.
+ */
+interface AppRegistry {
+    alphafi: AlphaFiIntentionData;
+    bluefin: BluefinIntentionData;
+    bucket: BucketIntentionData;
+    cetus: CetusIntentionData;
+    ember: EmberIntentionData;
+    'mmt-dex': MMTDEXIntentionData;
+    mpay: MPayIntentionData;
+    'msafe-core': CoreIntentionData;
+    'msafe-plain-tx': PlainTransactionData;
+    navi: NAVIIntentionData;
+    scallop: ScallopIntentionData;
+    SpringSui: SpringSuiIntentionData;
+    stsui: StSuiIntentionData;
+    Suilend: SuilendIntentionData;
+    turbos: TURBOSIntentionData;
+    volo: VoloIntentionData;
+}
+type AppName = keyof AppRegistry;
+type AppIntentionData<K extends AppName> = AppRegistry[K];
+
+interface IAppHelper<T> {
     deserialize(input: SuiSignTransactionBlockInput & {
         network: SuiNetworks;
-        suiClient: SuiClient;
+        clientUrl: string;
         account: WalletAccount;
         appContext?: any;
     }): Promise<{
@@ -97,22 +713,25 @@ interface IAppHelperInternalLegacy<T> {
         txType: TransactionType;
         txSubType: string;
         intentionData: T;
-        suiClient: SuiClient;
+        clientUrl: string;
         account: WalletAccount;
-    }): Promise<TransactionBlock>;
+    }): Promise<Transaction>;
 }
 
 type InternalAppHelper<T> = IAppHelperInternalLegacy<T> | IAppHelperInternal<T> | IAppHelperInternalGrpc<T>;
+type RegisteredAppHelper = IAppHelper<AppRegistry[AppName]>;
 declare class MSafeApps {
-    apps: Map<string, IAppHelper<any>>;
+    apps: Map<AppName, RegisteredAppHelper>;
     private constructor();
     static fromHelpers(apps: InternalAppHelper<any>[]): MSafeApps;
     addLegacyHelper(app: IAppHelperInternalLegacy<any>): void;
     addHelper(app: IAppHelperInternal<any>): void;
     addGrpcHelper(app: IAppHelperInternalGrpc<any>): void;
-    getAppHelper(appName: string): IAppHelper<any>;
+    getAppHelper<K extends AppName>(appName: K): IAppHelper<AppRegistry[K]>;
+    getAppHelper(appName: string): IAppHelper<unknown>;
+    private setApp;
 }
 
 declare const appHelpers: MSafeApps;
 
-export { appHelpers };
+export { type AppIntentionData, type AppName, type AppRegistry, appHelpers };