@merkl/api 0.18.13 → 0.18.14

package/dist/src/utils/throw.js

@@ -1,6 +1,12 @@
 import { isSupportedChain } from "@sdk";
 import { utils } from "ethers";
 import { InvalidParameter, UnsupportedNetwork } from "./error";
+/**
+ * Use this function to throw an error if the address is invalid
+ * and normalize the address to its checksum version
+ *
+ * @dev Usage: params.address = throwOnInvalidAddress(params.address);
+ */
 export const throwOnInvalidRequiredAddress = (address) => {
     try {
         if (!address)
@@ -11,6 +17,14 @@ export const throwOnInvalidRequiredAddress = (address) => {
         throw new InvalidParameter(`Address ${address} is invalid`);
     }
 };
+/**
+ * Use this function to throw an error if the address is invalid
+ * and normalize the address to its checksum version
+ *
+ * Address can be null or undefined
+ *
+ * @dev Usage: params.address = throwOnInvalidAddress(params.address);
+ */
 export const throwOnInvalidAddress = (address) => {
     try {
         if (!address)
@@ -21,6 +35,9 @@ export const throwOnInvalidAddress = (address) => {
         throw new InvalidParameter(`Address ${address} is invalid`);
     }
 };
+/**
+ * Use this function to throw an error if the chainId is not supported by Merkl
+ */
 export const throwOnUnsupportedChainId = (chainId) => {
     if (chainId && !isSupportedChain(chainId, "merkl"))
         throw new UnsupportedNetwork(chainId);