@msafe/sui3-sdk 0.0.9 → 0.0.10

package/dist/index.d.cts

@@ -10,23 +10,6 @@ import { SignatureWithBytes } from '@mysten/sui.js/src/cryptography/keypair';
 import { TransactionBlock } from '@mysten/sui.js/transactions';
 import * as _mysten_sui_js_dist_cjs_client from '@mysten/sui.js/dist/cjs/client';
 
-type JWTToken = string;
-interface PaginationOption {
-    page?: number;
-    pageSize: number;
-}
-interface PaginationResponse<T> {
-    items: T[];
-    meta: PaginationMeta;
-}
-interface PaginationMeta {
-    totalItems: number;
-    itemCount: number;
-    itemsPerPage: number;
-    totalPages: number;
-    currentPage: number;
-}
-
 interface IntentionCoinTransfer {
     txType: 'CoinTransfer';
     recipient: string;
@@ -60,6 +43,25 @@ 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;
@@ -112,6 +114,73 @@ interface FutureIntention {
     createdAt: Date;
 }
 
+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>;
     verifyToken(jwt?: JWTToken): Promise<boolean>;
@@ -160,6 +229,11 @@ interface IBackend {
         userAddress: string;
     }): Promise<void>;
     processExecutedTransaction(digest: string): Promise<void>;
+    getAddressBookEntries(pagination?: PaginationOption): Promise<GetAddressBookResult>;
+    updateAddressBook(input: {
+        updates: UpdateAddressBookEntry[];
+        signature: SerializedSignature;
+    }): Promise<void>;
 }
 
 declare enum MSafeEnv {
@@ -197,22 +271,6 @@ 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;
     readonly suiClient: SuiClient;
@@ -244,25 +302,6 @@ declare class PublicKeyHelper {
     private getPublicKeyFromChain;
 }
 
-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;
-}
-
 declare class CreateHelper {
     readonly globals: MSafeGlobals;
     readonly pkHelper: PublicKeyHelper;
@@ -282,12 +321,20 @@ declare class MessageHelper {
     static deWelcomeMessage(msg: string): string | undefined;
     static proposeIntentionMessage(data: ProposeIntentionData): string;
     static deProposeIntentionMessage(s: string): ProposeIntentionData;
+    static updateAddressBookMessage(updates: UpdateAddressBookEntry[]): string;
 }
 interface ProposeIntentionData {
     intention: TxIntention;
     sn: number;
 }
 
+declare class AddressBookSDK {
+    readonly globals: MSafeGlobals;
+    constructor(globals: MSafeGlobals);
+    getEntries(pagination?: PaginationOption): Promise<GetAddressBookResult>;
+    update(updates: UpdateAddressBookEntry[]): Promise<void>;
+}
+
 declare class MSafeAccount {
     readonly globals: MSafeGlobals;
     readonly info: MSafeAccountInfo;
@@ -333,6 +380,7 @@ declare class MSafeClient {
     get config(): MSafeConfig;
     get backend(): IBackend;
     get wallet(): IWallet;
+    get AddressBook(): AddressBookSDK;
     private walletAddress;
 }
 
@@ -408,4 +456,4 @@ declare class Coin {
     static getBalance(data: SuiObjectData): bigint | undefined;
 }
 
-export { AUTH_SIGN_MESSAGE, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeAccountInfo, type CreatePermissionInfo, type DBConfig, DEV_API_URL, DEV_DATABASE_CONFIG, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, type IntentionCoinTransfer, IntentionHelper, type IntentionObjectTransfer, LOCAL_API_URL, LOCAL_DATABASE_CONFIG, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnv, MSafeGlobals, MessageHelper, type PendingTx, type PendingVote, PublicKeySerde, type ReceiveTransaction, SUI_COIN, SignatureVerifier, TESTNET_RPC_URL, type TxIntention, UNIT_DATABASE_CONFIG, Uint8ArrayToHex, getAllCoins, getMSafeConfig, getPublicKeyFromChain, stringToBuffer };
+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, 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, TESTNET_RPC_URL, type TxIntention, UNIT_DATABASE_CONFIG, Uint8ArrayToHex, type UpdateAddressBookEntry, type UpsertAddressBookEntry, getAllCoins, getMSafeConfig, getPublicKeyFromChain, stringToBuffer };

package/dist/index.d.ts

@@ -10,23 +10,6 @@ import { SignatureWithBytes } from '@mysten/sui.js/src/cryptography/keypair';
 import { TransactionBlock } from '@mysten/sui.js/transactions';
 import * as _mysten_sui_js_dist_cjs_client from '@mysten/sui.js/dist/cjs/client';
 
-type JWTToken = string;
-interface PaginationOption {
-    page?: number;
-    pageSize: number;
-}
-interface PaginationResponse<T> {
-    items: T[];
-    meta: PaginationMeta;
-}
-interface PaginationMeta {
-    totalItems: number;
-    itemCount: number;
-    itemsPerPage: number;
-    totalPages: number;
-    currentPage: number;
-}
-
 interface IntentionCoinTransfer {
     txType: 'CoinTransfer';
     recipient: string;
@@ -60,6 +43,25 @@ 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;
@@ -112,6 +114,73 @@ interface FutureIntention {
     createdAt: Date;
 }
 
+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>;
     verifyToken(jwt?: JWTToken): Promise<boolean>;
@@ -160,6 +229,11 @@ interface IBackend {
         userAddress: string;
     }): Promise<void>;
     processExecutedTransaction(digest: string): Promise<void>;
+    getAddressBookEntries(pagination?: PaginationOption): Promise<GetAddressBookResult>;
+    updateAddressBook(input: {
+        updates: UpdateAddressBookEntry[];
+        signature: SerializedSignature;
+    }): Promise<void>;
 }
 
 declare enum MSafeEnv {
@@ -197,22 +271,6 @@ 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;
     readonly suiClient: SuiClient;
@@ -244,25 +302,6 @@ declare class PublicKeyHelper {
     private getPublicKeyFromChain;
 }
 
-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;
-}
-
 declare class CreateHelper {
     readonly globals: MSafeGlobals;
     readonly pkHelper: PublicKeyHelper;
@@ -282,12 +321,20 @@ declare class MessageHelper {
     static deWelcomeMessage(msg: string): string | undefined;
     static proposeIntentionMessage(data: ProposeIntentionData): string;
     static deProposeIntentionMessage(s: string): ProposeIntentionData;
+    static updateAddressBookMessage(updates: UpdateAddressBookEntry[]): string;
 }
 interface ProposeIntentionData {
     intention: TxIntention;
     sn: number;
 }
 
+declare class AddressBookSDK {
+    readonly globals: MSafeGlobals;
+    constructor(globals: MSafeGlobals);
+    getEntries(pagination?: PaginationOption): Promise<GetAddressBookResult>;
+    update(updates: UpdateAddressBookEntry[]): Promise<void>;
+}
+
 declare class MSafeAccount {
     readonly globals: MSafeGlobals;
     readonly info: MSafeAccountInfo;
@@ -333,6 +380,7 @@ declare class MSafeClient {
     get config(): MSafeConfig;
     get backend(): IBackend;
     get wallet(): IWallet;
+    get AddressBook(): AddressBookSDK;
     private walletAddress;
 }
 
@@ -408,4 +456,4 @@ declare class Coin {
     static getBalance(data: SuiObjectData): bigint | undefined;
 }
 
-export { AUTH_SIGN_MESSAGE, COIN_TYPE_ARG_REGEX, Coin, CoinHelper, CreateHelper, type CreateMSafeAccountInfo, type CreatePermissionInfo, type DBConfig, DEV_API_URL, DEV_DATABASE_CONFIG, DEV_SYNCING_URL, ENV_CONFIGS, Formatter, type FutureIntention, HexToUint8Array, type HistorySendTx, type HistoryVote, type IWallet, type IntentionCoinTransfer, IntentionHelper, type IntentionObjectTransfer, LOCAL_API_URL, LOCAL_DATABASE_CONFIG, LOCAL_SYNCING_URL, MAINNET_RPC_URL, MSafeAccount, MSafeClient, type MSafeConfig, type MSafeConfigOptions, MSafeEnv, MSafeGlobals, MessageHelper, type PendingTx, type PendingVote, PublicKeySerde, type ReceiveTransaction, SUI_COIN, SignatureVerifier, TESTNET_RPC_URL, type TxIntention, UNIT_DATABASE_CONFIG, Uint8ArrayToHex, getAllCoins, getMSafeConfig, getPublicKeyFromChain, stringToBuffer };
+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, 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, TESTNET_RPC_URL, type TxIntention, UNIT_DATABASE_CONFIG, Uint8ArrayToHex, type UpdateAddressBookEntry, type UpsertAddressBookEntry, getAllCoins, getMSafeConfig, getPublicKeyFromChain, stringToBuffer };

package/dist/index.js

@@ -224,6 +224,10 @@ var CreateHelper = class {
   }
 };
 
+// src/core/MessageHelper.ts
+import { normalizeSuiAddress as normalizeSuiAddress2 } from "@mysten/sui.js/utils";
+import { MD5 } from "crypto-js";
+
 // src/transactions/coin-transfer.ts
 import { TransactionBlock } from "@mysten/sui.js/transactions";
 
@@ -495,6 +499,38 @@ var MessageHelper = class {
       intention: IntentionHelper.de(intentionData)
     };
   }
+  static updateAddressBookMessage(updates) {
+    const normalized = updates.map((update) => ({
+      ...update,
+      address: normalizeSuiAddress2(update.address)
+    }));
+    function sortObjectKeys(obj) {
+      return Object.keys(obj).sort().reduce((result, key) => ({ ...result, [key]: obj[key] }), {});
+    }
+    const sortedUpdates = normalized.map((update) => sortObjectKeys(update));
+    const raw = JSON.stringify(sortedUpdates, null, 2);
+    const encoded = stringToBuffer(raw);
+    if (encoded.length <= 1024) {
+      return raw;
+    }
+    const md5 = MD5(raw);
+    return `Bulk address book update: ${md5}`;
+  }
+};
+
+// src/core/AddressBookSDK.ts
+var AddressBookSDK = class {
+  constructor(globals) {
+    this.globals = globals;
+  }
+  async getEntries(pagination) {
+    return this.globals.backend.getAddressBookEntries(pagination);
+  }
+  async update(updates) {
+    const messageStr = MessageHelper.updateAddressBookMessage(updates);
+    const sig = await this.globals.wallet.signPersonalMessage({ messageStr });
+    return this.globals.backend.updateAddressBook({ updates, signature: sig.signature });
+  }
 };
 
 // src/core/MSafeAccount.ts
@@ -916,7 +952,7 @@ var BackendImpl = class {
       {
         params: {
           page: paginationOption?.page,
-          limit: paginationOption?.pageSize
+          limit: paginationOption?.limit
         },
         headers: this.headers()
       }
@@ -932,7 +968,7 @@ var BackendImpl = class {
       {
         params: {
           page: paginationOption?.page,
-          limit: paginationOption?.pageSize
+          limit: paginationOption?.limit
         },
         headers: this.headers()
       }
@@ -1050,6 +1086,22 @@ var BackendImpl = class {
       throw new Error(`invalid skipNextFailedIntention return: ${res}`);
     }
   }
+  async getAddressBookEntries(pagination) {
+    const res = await axios.get(`${this.apiURL}/address-book`, {
+      headers: this.headers(),
+      params: pagination
+    });
+    if (res.status !== 200) {
+      throw new Error(`Invalid address-book return: ${res}`);
+    }
+    return res.data;
+  }
+  async updateAddressBook(input) {
+    const res = await axios.post(`${this.apiURL}/address-book`, input, { headers: this.headers() });
+    if (res.status !== 200 && res.status !== 201) {
+      throw new Error(`invalid updateAddressBook return: ${res}`);
+    }
+  }
   async processExecutedTransaction(digest) {
   }
   headers(token) {
@@ -1165,12 +1217,23 @@ var MSafeClient = class _MSafeClient {
   get wallet() {
     return this.globals.wallet;
   }
+  get AddressBook() {
+    return new AddressBookSDK(this.globals);
+  }
   async walletAddress() {
     return this.wallet.address();
   }
 };
+
+// src/types/address-book.ts
+var OpAddressBookType = /* @__PURE__ */ ((OpAddressBookType2) => {
+  OpAddressBookType2["Delete"] = "delete";
+  OpAddressBookType2["Upsert"] = "upsert";
+  return OpAddressBookType2;
+})(OpAddressBookType || {});
 export {
   AUTH_SIGN_MESSAGE,
+  AddressBookSDK,
   COIN_TYPE_ARG_REGEX,
   Coin,
   CoinHelper,
@@ -1191,6 +1254,7 @@ export {
   MSafeEnv,
   MSafeGlobals,
   MessageHelper,
+  OpAddressBookType,
   PublicKeySerde,
   SUI_COIN,
   SignatureVerifier,