@msafe/sui3-sdk 0.0.12 → 0.0.14

package/dist/index.d.ts

@@ -3,10 +3,10 @@ import { PublicKey as PublicKey$1 } from '@mysten/sui.js/src/cryptography';
 import * as _mysten_sui_js_client from '@mysten/sui.js/client';
 import { SuiClient, GasCostSummary, DryRunTransactionBlockResponse, ExecuteTransactionRequestType, SuiTransactionBlockResponseOptions, SuiTransactionBlockResponse, CoinMetadata, SuiObjectDataOptions, SuiObjectResponse, SuiObjectData, CoinStruct } from '@mysten/sui.js/client';
 import * as _msafe_sui3_utils from '@msafe/sui3-utils';
-import { AuthLoginRequest, MSafeAccountInfo, UserWithOwnedMSafe, HistoryTransaction, CreateMSafeAccountInfoRequest, MultisigAccountManager } from '@msafe/sui3-utils';
-import { PublicKey, SerializedSignature, SignatureScheme } from '@mysten/sui.js/cryptography';
+import { IAuthLoginReq, JWTToken, IMSafeInfoResp, IUserInfoResp, UserMSafeStatus, IPageOptions, IPagedResult, HistoryTransaction, ICreateMSafeReq, IGetAddressBookResult, UpdateAddressBookEntry, IMSafeConfig, MultiSigAccount } from '@msafe/sui3-utils';
+import * as _mysten_sui_js_cryptography from '@mysten/sui.js/cryptography';
+import { SerializedSignature, PublicKey } from '@mysten/sui.js/cryptography';
 import * as _mysten_sui_js_dist_cjs_builder from '@mysten/sui.js/dist/cjs/builder';
-import { ModelConfig } from '@msafe/sui3-model/common';
 import { SignatureWithBytes } from '@mysten/sui.js/src/cryptography/keypair';
 import { TransactionBlock } from '@mysten/sui.js/transactions';
 
@@ -43,25 +43,6 @@ declare class IntentionHelper {
     }): Promise<_mysten_sui_js_dist_cjs_builder.TransactionBlock>;
 }
 
-interface CreateMSafeAccountInfo {
-    ownerWithWeight: {
-        address: string;
-        weight: number;
-    }[];
-    threshold: number;
-    name: string;
-    description?: string;
-    creationNonce: number;
-}
-interface CreatePermissionInfo {
-    ownerWithWeight: {
-        address: string;
-        weight: number;
-    }[];
-    threshold: number;
-    creationNonce: number;
-}
-
 interface PendingTx {
     digest: string;
     payload: string;
@@ -117,6 +98,16 @@ interface FutureIntention {
     statusRemark?: string;
     createdAt: Date;
 }
+interface ProposeIntention {
+    application: string;
+    txType: string;
+    txSubType: string;
+    intention: TxIntention;
+    sequenceNumber: number;
+    userAddress: string;
+    msafeAddress: string;
+    signature: SerializedSignature;
+}
 interface SimulationResult {
     success: boolean;
     errorMsg?: string;
@@ -125,97 +116,29 @@ interface SimulationResult {
     dryRunResult: DryRunTransactionBlockResponse;
 }
 
-interface IWallet {
-    walletType: string;
-    address(): Promise<string>;
-    signPersonalMessage(input: {
-        messageStr: string;
-    }): Promise<SignatureWithBytes>;
-    signTransactionBlock(input: {
-        transactionBlock: TransactionBlock | Uint8Array;
-    }): Promise<SignatureWithBytes>;
-    signAndExecuteTransactionBlock(input: {
-        transactionBlock: TransactionBlock;
-        requestType?: ExecuteTransactionRequestType;
-        options?: SuiTransactionBlockResponseOptions;
-    }): Promise<SuiTransactionBlockResponse>;
-}
-
-interface PagedResult<T> {
-    data: T[];
-    meta: PagedMeta;
-}
-interface PagedMeta {
-    page: number;
-    limit: number;
-    total: number;
-    hasNext: boolean;
-}
-
-declare enum OpAddressBookType {
-    Delete = "delete",
-    Upsert = "upsert"
-}
-type UpdateAddressBookEntry = DeleteAddressBookEntry | UpsertAddressBookEntry;
-interface DeleteAddressBookEntry {
-    opType: OpAddressBookType.Delete;
-    address: string;
-}
-interface UpsertAddressBookEntry {
-    opType: OpAddressBookType.Upsert;
-    address: string;
-    addressName: string;
-    remark?: string;
-}
-type GetAddressBookResult = PagedResult<GetAddressBookResultEntry>;
-interface GetAddressBookResultEntry {
-    address: string;
-    addressName: string;
-    remark?: string;
-    updatedAt: Date;
-}
-
-type JWTToken = string;
-interface PaginationOption {
-    page?: number;
-    limit?: number;
-}
-interface PaginationResponse<T> {
-    items: T[];
-    meta: PaginationMeta;
-}
-interface PaginationMeta {
-    totalItems: number;
-    itemCount: number;
-    itemsPerPage: number;
-    totalPages: number;
-    currentPage: number;
-}
-
 interface IBackend {
-    authSign(input: AuthLoginRequest): Promise<JWTToken>;
+    authSign(input: IAuthLoginReq): Promise<JWTToken>;
     verifyToken(jwt?: JWTToken): Promise<boolean>;
     setJWTToken(token: JWTToken): void;
     getPublicKey(address: string): Promise<PublicKey | undefined>;
     getPublicKeyBatch(addresses: string[]): Promise<(PublicKey | undefined)[]>;
-    getMSafeAccountInfo(msafeAddress: string): Promise<MSafeAccountInfo>;
-    getUserInfo(userAddress: string): Promise<UserWithOwnedMSafe>;
+    getMSafeAccountInfo(msafeAddress: string): Promise<IMSafeInfoResp>;
+    getUserInfo(): Promise<IUserInfoResp>;
+    getOwnedMSafeByStatus(input: {
+        status?: UserMSafeStatus;
+        pagination?: IPageOptions;
+    }): Promise<IPagedResult<IMSafeInfoResp>>;
+    updateMSafeStatus(input: {
+        msafeAddress: string;
+        status: UserMSafeStatus;
+    }): Promise<void>;
     getPendingTransactions(msafeAddress: string): Promise<PendingTx[]>;
-    getHistoryTransactions(msafeAddress: string, paginationOption?: PaginationOption): Promise<PagedResult<HistoryTransaction>>;
-    getFutureIntentions(msafeAddress: string, paginationOption?: PaginationOption): Promise<PagedResult<FutureIntention>>;
+    getHistoryTransactions(msafeAddress: string, paginationOption?: IPageOptions): Promise<IPagedResult<HistoryTransaction>>;
+    getFutureIntentions(msafeAddress: string, paginationOption?: IPageOptions): Promise<IPagedResult<FutureIntention>>;
     getCurrentSequenceNumber(msafeAddress: string): Promise<number>;
     getNextSequenceNumber(msafeAddress: string): Promise<number>;
-    createMSafeAccount(input: CreateMSafeAccountInfoRequest): Promise<void>;
-    proposeIntention(input: {
-        intention: TxIntention;
-        sequenceNumber: number;
-        userAddress: string;
-        msafeAddress: string;
-        signature: SerializedSignature;
-        application: string;
-        txType: string;
-        txSubType: string;
-    }): Promise<void>;
+    createMSafeAccount(input: ICreateMSafeReq): Promise<void>;
+    proposeIntention(input: ProposeIntention): Promise<void>;
     proposePendingTransaction(input: {
         intention: TxIntention;
         userAddress: string;
@@ -243,7 +166,7 @@ interface IBackend {
         userAddress: string;
     }): Promise<void>;
     processExecutedTransaction(digest: string): Promise<void>;
-    getAddressBookEntries(pagination?: PaginationOption): Promise<GetAddressBookResult>;
+    getAddressBookEntries(pagination?: IPageOptions): Promise<IGetAddressBookResult>;
     updateAddressBook(input: {
         updates: UpdateAddressBookEntry[];
         signature: SerializedSignature;
@@ -261,20 +184,19 @@ interface MSafeConfig {
     suiClient: {
         url: string;
     };
-    backend: DBConfig;
-    apiURL: string;
+    backend: {
+        url: string;
+    };
     syncingURL: string;
 }
 interface MSafeConfigOptions {
     suiClient?: {
         url?: string;
     };
-    backend?: DBConfig;
+    backend?: {
+        url?: string;
+    };
 }
-type DBConfig = ModelConfig;
-declare const UNIT_DATABASE_CONFIG: DBConfig;
-declare const LOCAL_DATABASE_CONFIG: DBConfig;
-declare const DEV_DATABASE_CONFIG: DBConfig;
 declare const MSAFE_APPLICATION = "msafe";
 declare const TESTNET_RPC_URL = "https://sui-testnet.blockvision.org/v1/2Sgk89ivT64MnKdcGzjmyjY2ndD";
 declare const MAINNET_RPC_URL = "https://sui-mainnet.blockvision.org/v1/2Sgk7NPvqkd7mESYkxF01yX15l7";
@@ -284,7 +206,22 @@ declare const DEV_API_URL = "http://13.56.226.148";
 declare const DEV_SYNCING_URL = "http://52.53.228.20";
 declare const ENV_CONFIGS: Map<MSafeEnv, MSafeConfig>;
 declare function getMSafeConfig(env: MSafeEnv, options?: MSafeConfigOptions): MSafeConfig;
-declare const AUTH_SIGN_MESSAGE = "Welcome to MSafe";
+
+interface IWallet {
+    walletType: string;
+    address(): Promise<string>;
+    signPersonalMessage(input: {
+        messageStr: string;
+    }): Promise<SignatureWithBytes>;
+    signTransactionBlock(input: {
+        transactionBlock: TransactionBlock | Uint8Array;
+    }): Promise<SignatureWithBytes>;
+    signAndExecuteTransactionBlock(input: {
+        transactionBlock: TransactionBlock;
+        requestType?: ExecuteTransactionRequestType;
+        options?: SuiTransactionBlockResponseOptions;
+    }): Promise<SuiTransactionBlockResponse>;
+}
 
 declare class MSafeGlobals {
     readonly backend: IBackend;
@@ -317,40 +254,43 @@ declare class PublicKeyHelper {
     private getPublicKeyFromChain;
 }
 
+interface CreateMSafeInfo {
+    name: string;
+    description?: string;
+    owners: {
+        address: string;
+        weight: number;
+    }[];
+    creationNonce: number;
+    threshold: number;
+}
+
 declare class CreateHelper {
     readonly globals: MSafeGlobals;
     readonly pkHelper: PublicKeyHelper;
     constructor(globals: MSafeGlobals, pkHelper: PublicKeyHelper);
     getPublicKeyBatch(addresses: string[]): Promise<(_mysten_sui_js_src_cryptography.PublicKey | undefined)[]>;
-    calculateMSafeAddress(info: CreatePermissionInfo): Promise<string>;
-    validateCreateInfo(createInfo: CreateMSafeAccountInfo): Promise<string>;
-    submitMSafeCreation(creationInfo: CreateMSafeAccountInfo): Promise<string>;
+    calculateMSafeAddress(info: CreateMSafeInfo): Promise<string>;
+    validateCreateInfo(createInfo: CreateMSafeInfo): Promise<string>;
+    submitMSafeCreation(creationInfo: CreateMSafeInfo): Promise<string>;
     private reduceCreationInfoToRawConfig;
     private submitToBackend;
 }
 
-declare class MessageHelper {
-    static createMSafeMessage(msafeAddress: string): string;
-    static deCreateMSafeMessage(msg: string): string | undefined;
-    static welcomeMessage(timestamp: string): string;
-    static deWelcomeMessage(msg: string): string | undefined;
-    static proposeIntentionMessage(data: ProposeIntentionData): string;
-    static deProposeIntentionMessage(s: string): ProposeIntentionData;
-    static updateAddressBookMessage(updates: UpdateAddressBookEntry[]): string;
-}
-interface ProposeIntentionData {
-    msafeAddress: string;
-    intention: TxIntention;
-    sn: number;
-}
-
 declare class AddressBookSDK {
     readonly globals: MSafeGlobals;
     constructor(globals: MSafeGlobals);
-    getEntries(pagination?: PaginationOption): Promise<GetAddressBookResult>;
+    getEntries(pagination?: IPageOptions): Promise<_msafe_sui3_utils.IGetAddressBookResult>;
     update(updates: UpdateAddressBookEntry[]): Promise<void>;
 }
 
+declare class InvitationSDK {
+    readonly globals: MSafeGlobals;
+    constructor(globals: MSafeGlobals);
+    getMSafeByStatus(status: UserMSafeStatus, pagination?: IPageOptions): Promise<_msafe_sui3_utils.IPagedResult<_msafe_sui3_utils.IMSafeInfoResp>>;
+    updateMSafeStatus(msafeAddress: string, status: UserMSafeStatus): Promise<void>;
+}
+
 interface OwnedCoin {
     type: string;
     balance: bigint;
@@ -366,19 +306,25 @@ interface BatchObjectOptions {
 
 declare class MSafeAccount {
     readonly globals: MSafeGlobals;
-    readonly info: MSafeAccountInfo;
-    multisigManager: MultisigAccountManager;
+    readonly info: IMSafeConfig;
+    multiSig: MultiSigAccount;
     private coinHelper;
-    constructor(globals: MSafeGlobals, info: MSafeAccountInfo);
-    static new(globals: MSafeGlobals, address: string): Promise<MSafeAccountInfo>;
+    constructor(globals: MSafeGlobals, info: IMSafeConfig);
+    static New(globals: MSafeGlobals, address: string): Promise<void>;
     ownedCoins(): Promise<OwnedCoin[]>;
     ownedObjects(options?: BatchObjectOptions): Promise<SuiObjectData[]>;
     pendingTransaction(): Promise<PendingTx | undefined>;
-    historyTransaction(paginationOption?: PaginationOption): Promise<PagedResult<_msafe_sui3_utils.HistoryTransaction>>;
-    futureIntentions(paginationOption?: PaginationOption): Promise<FutureIntention[]>;
+    historyTransaction(paginationOption?: IPageOptions): Promise<_msafe_sui3_utils.IPagedResult<_msafe_sui3_utils.HistoryTransaction>>;
+    futureIntentions(paginationOption?: IPageOptions): Promise<FutureIntention[]>;
     currentSequenceNumber(): Promise<number>;
     nextSequenceNumber(): Promise<number>;
-    proposeIntention(intention: TxIntention, sequenceNumber: number): Promise<void>;
+    proposeIntention(input: {
+        application: string;
+        txType: string;
+        txSubType: string;
+        intention: TxIntention;
+        sequenceNumber: number;
+    }): Promise<void>;
     voteForTransaction(digest: string, payload: string): Promise<void>;
     proposePendingTransaction(intention: TxIntention): Promise<void>;
     rejectCurrentTx(pending?: PendingTx): Promise<void>;
@@ -404,9 +350,10 @@ declare class MSafeClient {
         jwtToken?: JWTToken;
     }): Promise<JWTToken>;
     private authSign;
-    userInfo(): Promise<_msafe_sui3_utils.UserWithOwnedMSafe>;
-    createAccount(info: CreateMSafeAccountInfo): Promise<string>;
-    getMSafeAccount(info: MSafeAccountInfo): MSafeAccount;
+    userInfo(): Promise<_msafe_sui3_utils.IUserInfoResp>;
+    ownedMSafe(pagination?: IPageOptions): Promise<_msafe_sui3_utils.IPagedResult<_msafe_sui3_utils.IMSafeInfoResp>>;
+    createAccount(info: CreateMSafeInfo): Promise<string>;
+    getMSafeAccount(info: IMSafeConfig): MSafeAccount;
     getMSafeAccountFromAddress(msafeAddress: string): Promise<MSafeAccount>;
     get creationHelper(): CreateHelper;
     get publicKeyHelper(): PublicKeyHelper;
@@ -414,6 +361,7 @@ declare class MSafeClient {
     get backend(): IBackend;
     get wallet(): IWallet;
     get AddressBook(): AddressBookSDK;
+    get Invitation(): InvitationSDK;
     private walletAddress;
 }
 
@@ -426,11 +374,11 @@ declare class SignatureVerifier {
         message: Uint8Array;
         messageType: 'TransactionBlock' | 'Personal';
         signature: SerializedSignature;
-    }): Promise<PublicKey>;
+    }): Promise<_mysten_sui_js_cryptography.PublicKey>;
     static getPublicKeyFromPersonalSignature(input: {
         messageStr: string;
         signature: SerializedSignature;
-    }): Promise<PublicKey>;
+    }): Promise<_mysten_sui_js_cryptography.PublicKey>;
     static verifySignature(input: {
         message: Uint8Array;
         messageType: 'TransactionBlock' | 'Personal';
@@ -448,16 +396,6 @@ declare class SignatureVerifier {
         targetAddress: string;
     }): Promise<boolean>;
 }
-declare class PublicKeySerde {
-    static ser(publicKey: PublicKey): {
-        publicKey: string;
-        scheme: "ED25519" | "Secp256k1" | "Secp256r1" | "MultiSig" | "ZkLogin";
-    };
-    static de(input: {
-        publicKey: string | Uint8Array;
-        scheme: SignatureScheme;
-    }): PublicKey;
-}
 
 declare class Formatter {
     static normalizeSuiAddress(addr: string): string;
@@ -489,4 +427,4 @@ declare class Coin {
     static getBalance(data: SuiObjectData): bigint | undefined;
 }
 
-export { AUTH_SIGN_MESSAGE, AddressBookSDK, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeAccountInfo, type CreatePermissionInfo, type DBConfig, DEV_API_URL, DEV_DATABASE_CONFIG, DEV_SYNCING_URL, type DeleteAddressBookEntry, ENV_CONFIGS, Formatter, type FutureIntention, type GetAddressBookResult, type GetAddressBookResultEntry, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, type IntentionCoinTransfer, IntentionHelper, type IntentionObjectTransfer, type JWTToken, LOCAL_API_URL, LOCAL_DATABASE_CONFIG, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSAFE_APPLICATION, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnv, MSafeGlobals, MessageHelper, OpAddressBookType, type PagedMeta, type PagedResult, type PaginationMeta, type PaginationOption, type PaginationResponse, type PendingTx, type PendingVote, PublicKeySerde, type ReceiveTransaction, SUI_COIN, SignatureVerifier, type SimulationResult, TESTNET_RPC_URL, type TxIntention, UNIT_DATABASE_CONFIG, Uint8ArrayToHex, type UpdateAddressBookEntry, type UpsertAddressBookEntry, getAllCoins, getMSafeConfig, getPublicKeyFromChain, stringToBuffer };
+export { AddressBookSDK, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeInfo, DEV_API_URL, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, type IntentionCoinTransfer, IntentionHelper, type IntentionObjectTransfer, LOCAL_API_URL, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSAFE_APPLICATION, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnv, MSafeGlobals, type PendingTx, type PendingVote, type ProposeIntention, type ReceiveTransaction, SUI_COIN, SignatureVerifier, type SimulationResult, TESTNET_RPC_URL, type TxIntention, Uint8ArrayToHex, getAllCoins, getMSafeConfig, getPublicKeyFromChain, stringToBuffer };