@safe-global/api-kit 3.0.0-alpha.2 → 3.0.0

package/dist/cjs/index.cjs

@@ -28,11 +28,11 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  default: () => src_default
+var index_exports = {};
+__export(index_exports, {
+  default: () => index_default
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/utils/httpRequests.ts
 async function sendRequest({ url, method, body }) {
@@ -111,9 +111,11 @@ var TRANSACTION_SERVICE_URLS = {
   "10": "https://safe-transaction-optimism.safe.global/api",
   "56": "https://safe-transaction-bsc.safe.global/api",
   "100": "https://safe-transaction-gnosis-chain.safe.global/api",
+  "130": "https://safe-transaction-unichain.safe.global/api",
   "137": "https://safe-transaction-polygon.safe.global/api",
   "196": "https://safe-transaction-xlayer.safe.global/api",
   "324": "https://safe-transaction-zksync.safe.global/api",
+  "480": "https://safe-transaction-worldchain.safe.global/api",
   "1101": "https://safe-transaction-zkevm.safe.global/api",
   "5000": "https://safe-transaction-mantle.safe.global/api",
   "8453": "https://safe-transaction-base.safe.global/api",
@@ -153,6 +155,11 @@ var isSafeOperation = (obj) => {
   return "signatures" in obj && "getUserOperation" in obj && "getHash" in obj;
 };
 
+// src/utils/queryParamsMap.ts
+var QUERY_PARAMS_MAP = {
+  from: "_from"
+};
+
 // src/SafeApiKit.ts
 var SafeApiKit = class {
   #chainId;
@@ -182,6 +189,24 @@ var SafeApiKit = class {
   #getEip3770Address(fullAddress) {
     return (0, import_protocol_kit.validateEip3770Address)(fullAddress, this.#chainId);
   }
+  /**
+   * Adds query parameters from an options object to a given URL.
+   * Converts parameter names to snake_case automatically. If a specific mapping exists in QUERY_PARAMS_MAP,
+   * it will be used instead of the converted name.
+   *
+   * @param {URL} url - The URL object to which query parameters will be added.
+   * @param {T} options - An object containing key-value pairs representing query parameters.
+   * @returns {void}
+   */
+  #addUrlQueryParams(url, options) {
+    const camelToSnake = (str) => str.replace(/([A-Z])/g, "_$1").toLowerCase();
+    Object.entries(options || {}).forEach(([key, value]) => {
+      if (value !== void 0) {
+        const name = QUERY_PARAMS_MAP[key] ?? camelToSnake(key);
+        url.searchParams.set(name, value.toString());
+      }
+    });
+  }
   /**
    * Returns the information and configuration of the service.
    *
@@ -228,125 +253,6 @@ var SafeApiKit = class {
       body: dataDecoderRequest
     });
   }
-  /**
-   * Returns the list of Safes where the address provided is an owner.
-   *
-   * @param ownerAddress - The owner address
-   * @returns The list of Safes where the address provided is an owner
-   * @throws "Invalid owner address"
-   * @throws "Checksum address validation failed"
-   */
-  async getSafesByOwner(ownerAddress) {
-    if (ownerAddress === "") {
-      throw new Error("Invalid owner address");
-    }
-    const { address } = this.#getEip3770Address(ownerAddress);
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/owners/${address}/safes/`,
-      method: "get" /* Get */
-    });
-  }
-  /**
-   * Returns the list of Safes where the module address provided is enabled.
-   *
-   * @param moduleAddress - The Safe module address
-   * @returns The list of Safe addresses where the module provided is enabled
-   * @throws "Invalid module address"
-   * @throws "Module address checksum not valid"
-   */
-  async getSafesByModule(moduleAddress) {
-    if (moduleAddress === "") {
-      throw new Error("Invalid module address");
-    }
-    const { address } = this.#getEip3770Address(moduleAddress);
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/modules/${address}/safes/`,
-      method: "get" /* Get */
-    });
-  }
-  /**
-   * Returns all the information of a Safe transaction.
-   *
-   * @param safeTxHash - Hash of the Safe transaction
-   * @returns The information of a Safe transaction
-   * @throws "Invalid safeTxHash"
-   * @throws "Not found."
-   */
-  async getTransaction(safeTxHash) {
-    if (safeTxHash === "") {
-      throw new Error("Invalid safeTxHash");
-    }
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/multisig-transactions/${safeTxHash}/`,
-      method: "get" /* Get */
-    });
-  }
-  /**
-   * Returns the list of confirmations for a given a Safe transaction.
-   *
-   * @param safeTxHash - The hash of the Safe transaction
-   * @returns The list of confirmations
-   * @throws "Invalid safeTxHash"
-   */
-  async getTransactionConfirmations(safeTxHash) {
-    if (safeTxHash === "") {
-      throw new Error("Invalid safeTxHash");
-    }
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/multisig-transactions/${safeTxHash}/confirmations/`,
-      method: "get" /* Get */
-    });
-  }
-  /**
-   * Adds a confirmation for a Safe transaction.
-   *
-   * @param safeTxHash - Hash of the Safe transaction that will be confirmed
-   * @param signature - Signature of the transaction
-   * @returns
-   * @throws "Invalid safeTxHash"
-   * @throws "Invalid signature"
-   * @throws "Malformed data"
-   * @throws "Error processing data"
-   */
-  async confirmTransaction(safeTxHash, signature) {
-    if (safeTxHash === "") {
-      throw new Error("Invalid safeTxHash");
-    }
-    if (signature === "") {
-      throw new Error("Invalid signature");
-    }
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/multisig-transactions/${safeTxHash}/confirmations/`,
-      method: "post" /* Post */,
-      body: {
-        signature
-      }
-    });
-  }
-  /**
-   * Returns the information and configuration of the provided Safe address.
-   *
-   * @param safeAddress - The Safe address
-   * @returns The information and configuration of the provided Safe address
-   * @throws "Invalid Safe address"
-   * @throws "Checksum address validation failed"
-   */
-  async getSafeInfo(safeAddress) {
-    if (safeAddress === "") {
-      throw new Error("Invalid Safe address");
-    }
-    const { address } = this.#getEip3770Address(safeAddress);
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/safes/${address}/`,
-      method: "get" /* Get */
-    }).then((response) => {
-      if (!response?.singleton) {
-        const { masterCopy, ...rest } = response;
-        return { ...rest, singleton: masterCopy };
-      }
-      return response;
-    });
-  }
   /**
    * Returns the list of delegates.
    *
@@ -468,6 +374,189 @@ var SafeApiKit = class {
       }
     });
   }
+  /**
+   * Get a message by its safe message hash
+   * @param messageHash The Safe message hash
+   * @returns The message
+   */
+  async getMessage(messageHash) {
+    if (!messageHash) {
+      throw new Error("Invalid messageHash");
+    }
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/messages/${messageHash}/`,
+      method: "get" /* Get */
+    });
+  }
+  /**
+   * Get the list of messages associated to a Safe account
+   * @param safeAddress The safe address
+   * @param options The options to filter the list of messages
+   * @returns The paginated list of messages
+   */
+  async getMessages(safeAddress, options = {}) {
+    if (!this.#isValidAddress(safeAddress)) {
+      throw new Error("Invalid safeAddress");
+    }
+    const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${safeAddress}/messages/`);
+    this.#addUrlQueryParams(url, options);
+    return sendRequest({
+      url: url.toString(),
+      method: "get" /* Get */
+    });
+  }
+  /**
+   * Creates a new message with an initial signature
+   * Add more signatures from other owners using addMessageSignature()
+   * @param safeAddress The safe address
+   * @param options The raw message to add, signature and safeAppId if any
+   */
+  async addMessage(safeAddress, addMessageOptions) {
+    if (!this.#isValidAddress(safeAddress)) {
+      throw new Error("Invalid safeAddress");
+    }
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/safes/${safeAddress}/messages/`,
+      method: "post" /* Post */,
+      body: addMessageOptions
+    });
+  }
+  /**
+   * Add a signature to an existing message
+   * @param messageHash The safe message hash
+   * @param signature The signature
+   */
+  async addMessageSignature(messageHash, signature) {
+    if (!messageHash || !signature) {
+      throw new Error("Invalid messageHash or signature");
+    }
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/messages/${messageHash}/signatures/`,
+      method: "post" /* Post */,
+      body: {
+        signature
+      }
+    });
+  }
+  /**
+   * Returns the list of Safes where the address provided is an owner.
+   *
+   * @param ownerAddress - The owner address
+   * @returns The list of Safes where the address provided is an owner
+   * @throws "Invalid owner address"
+   * @throws "Checksum address validation failed"
+   */
+  async getSafesByOwner(ownerAddress) {
+    if (ownerAddress === "") {
+      throw new Error("Invalid owner address");
+    }
+    const { address } = this.#getEip3770Address(ownerAddress);
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/owners/${address}/safes/`,
+      method: "get" /* Get */
+    });
+  }
+  /**
+   * Returns the list of Safes where the module address provided is enabled.
+   *
+   * @param moduleAddress - The Safe module address
+   * @returns The list of Safe addresses where the module provided is enabled
+   * @throws "Invalid module address"
+   * @throws "Module address checksum not valid"
+   */
+  async getSafesByModule(moduleAddress) {
+    if (moduleAddress === "") {
+      throw new Error("Invalid module address");
+    }
+    const { address } = this.#getEip3770Address(moduleAddress);
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/modules/${address}/safes/`,
+      method: "get" /* Get */
+    });
+  }
+  /**
+   * Returns all the information of a Safe transaction.
+   *
+   * @param safeTxHash - Hash of the Safe transaction
+   * @returns The information of a Safe transaction
+   * @throws "Invalid safeTxHash"
+   * @throws "Not found."
+   */
+  async getTransaction(safeTxHash) {
+    if (safeTxHash === "") {
+      throw new Error("Invalid safeTxHash");
+    }
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/multisig-transactions/${safeTxHash}/`,
+      method: "get" /* Get */
+    });
+  }
+  /**
+   * Returns the list of confirmations for a given a Safe transaction.
+   *
+   * @param safeTxHash - The hash of the Safe transaction
+   * @returns The list of confirmations
+   * @throws "Invalid safeTxHash"
+   */
+  async getTransactionConfirmations(safeTxHash) {
+    if (safeTxHash === "") {
+      throw new Error("Invalid safeTxHash");
+    }
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/multisig-transactions/${safeTxHash}/confirmations/`,
+      method: "get" /* Get */
+    });
+  }
+  /**
+   * Adds a confirmation for a Safe transaction.
+   *
+   * @param safeTxHash - Hash of the Safe transaction that will be confirmed
+   * @param signature - Signature of the transaction
+   * @returns
+   * @throws "Invalid safeTxHash"
+   * @throws "Invalid signature"
+   * @throws "Malformed data"
+   * @throws "Error processing data"
+   */
+  async confirmTransaction(safeTxHash, signature) {
+    if (safeTxHash === "") {
+      throw new Error("Invalid safeTxHash");
+    }
+    if (signature === "") {
+      throw new Error("Invalid signature");
+    }
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/multisig-transactions/${safeTxHash}/confirmations/`,
+      method: "post" /* Post */,
+      body: {
+        signature
+      }
+    });
+  }
+  /**
+   * Returns the information and configuration of the provided Safe address.
+   *
+   * @param safeAddress - The Safe address
+   * @returns The information and configuration of the provided Safe address
+   * @throws "Invalid Safe address"
+   * @throws "Checksum address validation failed"
+   */
+  async getSafeInfo(safeAddress) {
+    if (safeAddress === "") {
+      throw new Error("Invalid Safe address");
+    }
+    const { address } = this.#getEip3770Address(safeAddress);
+    return sendRequest({
+      url: `${this.#txServiceBaseUrl}/v1/safes/${address}/`,
+      method: "get" /* Get */
+    }).then((response) => {
+      if (!response?.singleton) {
+        const { masterCopy, ...rest } = response;
+        return { ...rest, singleton: masterCopy };
+      }
+      return response;
+    });
+  }
   /**
    * Returns the creation information of a Safe.
    *
@@ -558,17 +647,20 @@ var SafeApiKit = class {
    * Returns the history of incoming transactions of a Safe account.
    *
    * @param safeAddress - The Safe address
+   * @param options - Optional parameters to filter or modify the response
    * @returns The history of incoming transactions
    * @throws "Invalid Safe address"
    * @throws "Checksum address validation failed"
    */
-  async getIncomingTransactions(safeAddress) {
+  async getIncomingTransactions(safeAddress, options) {
     if (safeAddress === "") {
       throw new Error("Invalid Safe address");
     }
     const { address } = this.#getEip3770Address(safeAddress);
+    const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${address}/incoming-transfers/`);
+    this.#addUrlQueryParams(url, options);
     return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/safes/${address}/incoming-transfers?executed=true`,
+      url: url.toString(),
       method: "get" /* Get */
     });
   }
@@ -576,18 +668,21 @@ var SafeApiKit = class {
    * Returns the history of module transactions of a Safe account.
    *
    * @param safeAddress - The Safe address
+   * @param options - Optional parameters to filter or modify the response
    * @returns The history of module transactions
    * @throws "Invalid Safe address"
    * @throws "Invalid data"
    * @throws "Invalid ethereum address"
    */
-  async getModuleTransactions(safeAddress) {
+  async getModuleTransactions(safeAddress, options) {
     if (safeAddress === "") {
       throw new Error("Invalid Safe address");
     }
     const { address } = this.#getEip3770Address(safeAddress);
+    const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${address}/module-transactions/`);
+    this.#addUrlQueryParams(url, options);
     return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/safes/${address}/module-transactions/`,
+      url: url.toString(),
       method: "get" /* Get */
     });
   }
@@ -595,38 +690,38 @@ var SafeApiKit = class {
    * Returns the history of multi-signature transactions of a Safe account.
    *
    * @param safeAddress - The Safe address
+   * @param options - Optional parameters to filter or modify the response
    * @returns The history of multi-signature transactions
    * @throws "Invalid Safe address"
    * @throws "Checksum address validation failed"
    */
-  async getMultisigTransactions(safeAddress) {
+  async getMultisigTransactions(safeAddress, options) {
     if (safeAddress === "") {
       throw new Error("Invalid Safe address");
     }
     const { address } = this.#getEip3770Address(safeAddress);
+    const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${address}/multisig-transactions/`);
+    this.#addUrlQueryParams(url, options);
     return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/safes/${address}/multisig-transactions/`,
+      url: url.toString(),
       method: "get" /* Get */
     });
   }
-  async getPendingTransactions(safeAddress, propsOrCurrentNonce = {}) {
+  /**
+   * Returns the list of multi-signature transactions that are waiting for the confirmation of the Safe owners.
+   *
+   * @param safeAddress - The Safe address
+   * @param {PendingTransactionsOptions} options The options to filter the list of transactions
+   * @returns The list of transactions waiting for the confirmation of the Safe owners
+   * @throws "Invalid Safe address"
+   * @throws "Invalid data"
+   * @throws "Invalid ethereum address"
+   */
+  async getPendingTransactions(safeAddress, options = {}) {
     if (safeAddress === "") {
       throw new Error("Invalid Safe address");
     }
-    let currentNonce;
-    let hasConfirmations;
-    let ordering;
-    let limit;
-    let offset;
-    if (typeof propsOrCurrentNonce === "object") {
-      ;
-      ({ currentNonce, hasConfirmations, ordering, limit, offset } = propsOrCurrentNonce);
-    } else {
-      console.warn(
-        "Deprecated: Use `currentNonce` inside an object instead. See `PendingTransactionsOptions`."
-      );
-      currentNonce = propsOrCurrentNonce;
-    }
+    const { currentNonce, hasConfirmations, ordering, limit, offset } = options;
     const { address } = this.#getEip3770Address(safeAddress);
     const nonce = currentNonce ? currentNonce : (await this.getSafeInfo(address)).nonce;
     const url = new URL(
@@ -653,9 +748,11 @@ var SafeApiKit = class {
    * Returns a list of transactions for a Safe. The list has different structures depending on the transaction type
    *
    * @param safeAddress - The Safe address
+   * @param options - Optional parameters to filter or modify the response
    * @returns The list of transactions waiting for the confirmation of the Safe owners
    * @throws "Invalid Safe address"
    * @throws "Checksum address validation failed"
+   * @throws "Ordering field is not valid"
    */
   async getAllTransactions(safeAddress, options) {
     if (safeAddress === "") {
@@ -663,12 +760,7 @@ var SafeApiKit = class {
     }
     const { address } = this.#getEip3770Address(safeAddress);
     const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${address}/all-transactions/`);
-    const trusted = options?.trusted?.toString() || "true";
-    url.searchParams.set("trusted", trusted);
-    const queued = options?.queued?.toString() || "true";
-    url.searchParams.set("queued", queued);
-    const executed = options?.executed?.toString() || "false";
-    url.searchParams.set("executed", executed);
+    this.#addUrlQueryParams(url, options);
     return sendRequest({
       url: url.toString(),
       method: "get" /* Get */
@@ -702,11 +794,14 @@ var SafeApiKit = class {
   /**
    * Returns the list of all the ERC20 tokens handled by the Safe.
    *
+   * @param options - Optional parameters to filter or modify the response
    * @returns The list of all the ERC20 tokens
    */
-  async getTokenList() {
+  async getTokenList(options) {
+    const url = new URL(`${this.#txServiceBaseUrl}/v1/tokens/`);
+    this.#addUrlQueryParams(url, options);
     return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/tokens/`,
+      url: url.toString(),
       method: "get" /* Get */
     });
   }
@@ -728,113 +823,21 @@ var SafeApiKit = class {
       method: "get" /* Get */
     });
   }
-  /**
-   * Get a message by its safe message hash
-   * @param messageHash The Safe message hash
-   * @returns The message
-   */
-  async getMessage(messageHash) {
-    if (!messageHash) {
-      throw new Error("Invalid messageHash");
-    }
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/messages/${messageHash}/`,
-      method: "get" /* Get */
-    });
-  }
-  /**
-   * Get the list of messages associated to a Safe account
-   * @param safeAddress The safe address
-   * @param options The options to filter the list of messages
-   * @returns The paginated list of messages
-   */
-  async getMessages(safeAddress, { ordering, limit, offset } = {}) {
-    if (!this.#isValidAddress(safeAddress)) {
-      throw new Error("Invalid safeAddress");
-    }
-    const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${safeAddress}/messages/`);
-    if (ordering) {
-      url.searchParams.set("ordering", ordering);
-    }
-    if (limit != null) {
-      url.searchParams.set("limit", limit.toString());
-    }
-    if (offset != null) {
-      url.searchParams.set("offset", offset.toString());
-    }
-    return sendRequest({
-      url: url.toString(),
-      method: "get" /* Get */
-    });
-  }
-  /**
-   * Creates a new message with an initial signature
-   * Add more signatures from other owners using addMessageSignature()
-   * @param safeAddress The safe address
-   * @param options The raw message to add, signature and safeAppId if any
-   */
-  async addMessage(safeAddress, addMessageProps) {
-    if (!this.#isValidAddress(safeAddress)) {
-      throw new Error("Invalid safeAddress");
-    }
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/safes/${safeAddress}/messages/`,
-      method: "post" /* Post */,
-      body: addMessageProps
-    });
-  }
-  /**
-   * Add a signature to an existing message
-   * @param messageHash The safe message hash
-   * @param signature The signature
-   */
-  async addMessageSignature(messageHash, signature) {
-    if (!messageHash || !signature) {
-      throw new Error("Invalid messageHash or signature");
-    }
-    return sendRequest({
-      url: `${this.#txServiceBaseUrl}/v1/messages/${messageHash}/signatures/`,
-      method: "post" /* Post */,
-      body: {
-        signature
-      }
-    });
-  }
   /**
    * Get the SafeOperations that were sent from a particular address.
-   * @param getSafeOperationsProps - The parameters to filter the list of SafeOperations
+   * @param safeAddress - The Safe address
+   * @param options - Optional parameters to filter or modify the response
    * @throws "Safe address must not be empty"
    * @throws "Invalid Ethereum address {safeAddress}"
    * @returns The SafeOperations sent from the given Safe's address
    */
-  async getSafeOperationsByAddress({
-    safeAddress,
-    executed,
-    hasConfirmations,
-    ordering,
-    limit,
-    offset
-  }) {
+  async getSafeOperationsByAddress(safeAddress, options) {
     if (!safeAddress) {
       throw new Error("Safe address must not be empty");
     }
     const { address } = this.#getEip3770Address(safeAddress);
     const url = new URL(`${this.#txServiceBaseUrl}/v1/safes/${address}/safe-operations/`);
-    if (ordering) {
-      url.searchParams.set("ordering", ordering);
-    }
-    if (limit != null) {
-      url.searchParams.set("limit", limit.toString());
-    }
-    if (offset != null) {
-      url.searchParams.set("offset", offset.toString());
-    }
-    if (hasConfirmations != null) {
-      url.searchParams.set("has_confirmations", hasConfirmations.toString());
-    }
-    if (executed != null) {
-      url.searchParams.set("executed", executed.toString());
-    }
+    this.#addUrlQueryParams(url, options);
     return sendRequest({
       url: url.toString(),
       method: "get" /* Get */
@@ -842,14 +845,15 @@ var SafeApiKit = class {
   }
   /**
    * Get the SafeOperations that are pending to send to the bundler
-   * @param getSafeOperationsProps - The parameters to filter the list of SafeOperations
+   * @param safeAddress - The Safe address
+   * @param options - Optional parameters to filter or modify the response
    * @throws "Safe address must not be empty"
    * @throws "Invalid Ethereum address {safeAddress}"
    * @returns The pending SafeOperations
    */
-  async getPendingSafeOperations(props) {
-    return this.getSafeOperationsByAddress({
-      ...props,
+  async getPendingSafeOperations(safeAddress, options) {
+    return this.getSafeOperationsByAddress(safeAddress, {
+      ...options,
       executed: false
     });
   }
@@ -990,4 +994,4 @@ var SafeApiKit = class {
 var SafeApiKit_default = SafeApiKit;
 
 // src/index.ts
-var src_default = SafeApiKit_default;
+var index_default = SafeApiKit_default;