@swapkit/toolboxes 1.0.0-beta.17 → 1.0.0-beta.18

package/src/cosmos/util.ts

@@ -1,6 +1,13 @@
 import type { OfflineSigner } from "@cosmjs/proto-signing";
 import type { SigningStargateClientOptions } from "@cosmjs/stargate";
-import { AssetValue, Chain, ChainId, type CosmosChain, SKConfig } from "@swapkit/helpers";
+import {
+  AssetValue,
+  Chain,
+  ChainId,
+  type CosmosChain,
+  SKConfig,
+  SwapKitError,
+} from "@swapkit/helpers";
 
 import type { CosmosCreateTransactionParams } from "./thorchainUtils";
 
@@ -126,7 +133,7 @@ const getTransferMsgTypeByChain = (chain: CosmosChain) => {
     case Chain.Kujira:
       return "/cosmos.bank.v1beta1.MsgSend";
     default:
-      throw new Error("Unsupported chain");
+      throw new SwapKitError("toolbox_cosmos_not_supported", { chain });
   }
 };
 
@@ -149,7 +156,7 @@ export const cosmosCreateTransaction = async ({
   const accountOnChain = await client.getAccount(sender);
 
   if (!accountOnChain) {
-    throw new Error("Account does not exist");
+    throw new SwapKitError("toolbox_cosmos_account_not_found", { sender });
   }
 
   const gasAsset = AssetValue.from({ chain });

package/src/evm/helpers.ts

@@ -8,6 +8,7 @@ import {
   FeeOption,
   type NetworkParams,
   SKConfig,
+  SwapKitError,
   SwapKitNumber,
 } from "@swapkit/helpers";
 import type { BrowserProvider, Provider } from "ethers";
@@ -71,7 +72,7 @@ export const estimateMaxSendableAmount = async ({
   const isFeeEVMLegacyCompatible = "gasPrice" in gasRate && gasRate.gasPrice !== undefined;
 
   if (!(gasRate && (isFeeEVMLegacyCompatible || isFeeEIP1559Compatible))) {
-    throw new Error("Could not fetch fee data");
+    throw new SwapKitError("toolbox_evm_no_fee_data");
   }
 
   const gasPrice = isFeeEIP1559Compatible
@@ -116,7 +117,7 @@ export function getEstimateTransactionFee({
       return assetValue.set(SwapKitNumber.fromBigInt(fee, assetValue.decimal));
     }
 
-    throw new Error("No gas price found");
+    throw new SwapKitError("toolbox_evm_no_gas_price");
   };
 }
 
@@ -168,6 +169,6 @@ function getNetworkInfo<C extends EVMChain>({ chain }: { chain: C }) {
         nativeCurrency: { name: "Polygon", symbol: Chain.Polygon, decimals },
       };
     default:
-      throw new Error(`Chain ${chain} is not supported`);
+      throw new SwapKitError("toolbox_evm_not_supported", { chain });
   }
 }

package/src/evm/toolbox/baseEVMToolbox.ts

@@ -208,7 +208,7 @@ export function getEstimateGasPrices({
       try {
         const { gasPrice } = await provider.getFeeData();
 
-        if (!gasPrice) throw new Error("No fee data available");
+        if (!gasPrice) throw new SwapKitError("toolbox_evm_no_fee_data");
 
         return {
           [FeeOption.Average]: { gasPrice },
@@ -216,9 +216,9 @@ export function getEstimateGasPrices({
           [FeeOption.Fastest]: { gasPrice },
         };
       } catch (error) {
-        throw new Error(
-          `Failed to estimate gas price: ${(error as any).msg ?? (error as any).toString()}`,
-        );
+        throw new SwapKitError("toolbox_evm_gas_estimation_error", {
+          error: (error as any).msg ?? (error as any).toString(),
+        });
       }
     };
   }
@@ -231,7 +231,7 @@ export function getEstimateGasPrices({
         const price = gasPrice as bigint;
 
         if (!(maxFeePerGas && maxPriorityFeePerGas)) {
-          throw new Error("No fee data available");
+          throw new SwapKitError("toolbox_evm_no_fee_data");
         }
 
         return {
@@ -255,9 +255,9 @@ export function getEstimateGasPrices({
           },
         };
       } catch (error) {
-        throw new Error(
-          `Failed to estimate gas price: ${(error as any).msg ?? (error as any).toString()}`,
-        );
+        throw new SwapKitError("toolbox_evm_gas_estimation_error", {
+          error: (error as any).msg ?? (error as any).toString(),
+        });
       }
     };
   }
@@ -290,9 +290,9 @@ export function getEstimateGasPrices({
         [FeeOption.Fastest]: { gasPrice: gasPrice * 2n },
       };
     } catch (error) {
-      throw new Error(
-        `Failed to estimate gas price: ${(error as any).msg ?? (error as any).toString()}`,
-      );
+      throw new SwapKitError("toolbox_evm_gas_estimation_error", {
+        error: (error as any).msg ?? (error as any).toString(),
+      });
     }
   };
 }
@@ -314,7 +314,10 @@ function getCall({ provider, isEIP1559Compatible, signer, chain }: ToolboxWrapPa
     feeOption = FeeOption.Fast,
   }: CallParams): Promise<T> {
     const contractProvider = callProvider || provider;
-    if (!contractAddress) throw new Error("contractAddress must be provided");
+    if (!contractAddress)
+      throw new SwapKitError("toolbox_evm_invalid_params", {
+        error: "contractAddress must be provided",
+      });
 
     const isStateChanging = isStateChangingCall({ abi, funcName });
 

package/src/evm/toolbox/index.ts

@@ -1,4 +1,4 @@
-import { Chain, type EVMChain } from "@swapkit/helpers";
+import { Chain, type EVMChain, SwapKitError } from "@swapkit/helpers";
 
 import { getProvider } from "../helpers";
 import type { EVMToolboxParams } from "../types";
@@ -27,7 +27,7 @@ export async function getEvmToolbox<T extends EVMChain>(chain: T, params?: EVMTo
     case Chain.Ethereum:
       return ETHToolbox(toolboxParams);
     default:
-      throw new Error(`Chain ${chain} is not supported`);
+      throw new SwapKitError("toolbox_evm_not_supported", { chain });
   }
 }
 

package/src/evm/toolbox/op.ts

@@ -1,4 +1,11 @@
-import { BaseDecimal, Chain, ChainId, ChainToExplorerUrl, SKConfig } from "@swapkit/helpers";
+import {
+  BaseDecimal,
+  Chain,
+  ChainId,
+  ChainToExplorerUrl,
+  SKConfig,
+  SwapKitError,
+} from "@swapkit/helpers";
 import type {
   Authorization,
   BrowserProvider,
@@ -38,7 +45,8 @@ function serializeTx<P extends JsonRpcProvider | BrowserProvider>(provider: P) {
   return async function serializeTx({ from, to, nonce, ...tx }: TransactionRequest) {
     const { Transaction } = await import("ethers");
 
-    if (!to) throw new Error("Missing to address");
+    if (!to)
+      throw new SwapKitError("toolbox_evm_invalid_transaction", { error: "Missing to address" });
 
     return Transaction.from({
       ...tx,

package/src/index.ts

@@ -6,6 +6,7 @@ import {
   FeeOption,
   type GenericCreateTransactionParams,
   type SubstrateChain,
+  SwapKitError,
   type UTXOChain,
 } from "@swapkit/helpers";
 import type { getCosmosToolbox } from "@swapkit/toolboxes/cosmos";
@@ -15,6 +16,7 @@ import type { RadixToolbox } from "@swapkit/toolboxes/radix";
 import type { getRippleToolbox } from "@swapkit/toolboxes/ripple";
 import type { SolanaCreateTransactionParams, getSolanaToolbox } from "@swapkit/toolboxes/solana";
 import type { getSubstrateToolbox } from "@swapkit/toolboxes/substrate";
+import type { createTronToolbox } from "@swapkit/toolboxes/tron";
 import type { getUtxoToolbox } from "@swapkit/toolboxes/utxo";
 
 export async function getAddressValidator() {
@@ -26,9 +28,11 @@ export async function getAddressValidator() {
   const { getSolanaAddressValidator } = await import("@swapkit/toolboxes/solana");
   const { rippleValidateAddress } = await import("@swapkit/toolboxes/ripple");
   const { radixValidateAddress } = await import("@swapkit/toolboxes/radix");
+  const { getTronAddressValidator } = await import("@swapkit/toolboxes/tron");
 
   const solanaValidateAddress = await getSolanaAddressValidator();
   const utxoValidateAddress = await getUTXOAddressValidator();
+  const tronValidateAddress = await getTronAddressValidator();
 
   return function validateAddress({ address, chain }: { address: string; chain: Chain }) {
     const isValid = match(chain)
@@ -54,70 +58,58 @@ export async function getAddressValidator() {
       .with(Chain.Radix, () => radixValidateAddress(address))
       .with(Chain.Ripple, () => rippleValidateAddress(address))
       .with(Chain.Solana, () => solanaValidateAddress(address))
+      .with(Chain.Tron, () => tronValidateAddress(address))
       .otherwise(() => false);
 
     return isValid;
   };
 }
 
-export async function getFeeEstimator<T extends keyof CreateTransactionParams>(chain: T) {
-  const toolbox = await getToolbox(chain);
-
+export function getFeeEstimator<T extends keyof CreateTransactionParams>(chain: T) {
   return async function estimateFee(params: CreateTransactionParams[T]) {
-    switch (chain) {
-      case Chain.Arbitrum:
-      case Chain.Avalanche:
-      case Chain.Optimism:
-      case Chain.BinanceSmartChain:
-      case Chain.Base:
-      case Chain.Polygon:
-      case Chain.Ethereum: {
-        const txObject = await (
-          toolbox as Awaited<ReturnType<typeof ETHToolbox>>
-        ).createTransaction(params as EVMCreateTransactionParams);
-        return (toolbox as Awaited<ReturnType<typeof ETHToolbox>>).estimateTransactionFee({
-          ...txObject,
-          feeOption: params.feeOptionKey || FeeOption.Fast,
-          chain,
-        });
-      }
-      case Chain.Bitcoin:
-      case Chain.BitcoinCash:
-      case Chain.Dogecoin:
-      case Chain.Dash:
-      case Chain.Litecoin: {
-        return (toolbox as Awaited<ReturnType<typeof getUtxoToolbox>>).estimateTransactionFee(
-          params as CreateTransactionParams[Chain.Bitcoin],
-        );
-      }
+    const { match } = await import("ts-pattern");
 
-      case Chain.THORChain:
-      case Chain.Maya:
-      case Chain.Kujira:
-      case Chain.Cosmos: {
+    return match(chain as Chain)
+      .returnType<Promise<AssetValue>>()
+      .with(
+        Chain.Arbitrum,
+        Chain.Avalanche,
+        Chain.Optimism,
+        Chain.BinanceSmartChain,
+        Chain.Base,
+        Chain.Polygon,
+        Chain.Ethereum,
+        async (chain) => {
+          const toolbox = await getToolbox(chain);
+          const txObject = await toolbox.createTransaction(params);
+
+          return (toolbox as Awaited<ReturnType<typeof ETHToolbox>>).estimateTransactionFee({
+            ...txObject,
+            feeOption: params.feeOptionKey || FeeOption.Fast,
+            chain,
+          });
+        },
+      )
+      .with(
+        Chain.Bitcoin,
+        Chain.BitcoinCash,
+        Chain.Dogecoin,
+        Chain.Dash,
+        Chain.Litecoin,
+        Chain.Polkadot,
+        Chain.Solana,
+        Chain.Ripple,
+        Chain.Tron,
+        async (chain) => {
+          const toolbox = await getToolbox(chain);
+          return toolbox.estimateTransactionFee(params) as Promise<AssetValue>;
+        },
+      )
+      .with(Chain.THORChain, Chain.Maya, Chain.Kujira, Chain.Cosmos, async () => {
         const { estimateTransactionFee } = await import("@swapkit/toolboxes/cosmos");
         return estimateTransactionFee(params);
-      }
-
-      case Chain.Polkadot: {
-        return (
-          toolbox as Awaited<ReturnType<typeof getSubstrateToolbox<Chain.Polkadot>>>
-        ).estimateTransactionFee(params);
-      }
-
-      case Chain.Solana: {
-        return (toolbox as Awaited<ReturnType<typeof getSolanaToolbox>>).estimateTransactionFee(
-          params as CreateTransactionParams[Chain.Solana],
-        );
-      }
-
-      case Chain.Ripple: {
-        return (toolbox as Awaited<ReturnType<typeof getRippleToolbox>>).estimateTransactionFee();
-      }
-
-      default:
-        return AssetValue.from({ chain });
-    }
+      })
+      .otherwise(async () => AssetValue.from({ chain }));
   };
 }
 
@@ -133,6 +125,7 @@ type Toolboxes = {
   [Chain.Radix]: Awaited<ReturnType<typeof RadixToolbox>>;
   [Chain.Ripple]: Awaited<ReturnType<typeof getRippleToolbox>>;
   [Chain.Solana]: Awaited<ReturnType<typeof getSolanaToolbox>>;
+  [Chain.Tron]: Awaited<ReturnType<typeof createTronToolbox>>;
 };
 
 type ToolboxParams = { [key in EVMChain]: Parameters<typeof getEvmToolbox>[1] } & {
@@ -145,6 +138,7 @@ type ToolboxParams = { [key in EVMChain]: Parameters<typeof getEvmToolbox>[1] }
   [Chain.Radix]: Parameters<typeof RadixToolbox>[0];
   [Chain.Ripple]: Parameters<typeof getRippleToolbox>[0];
   [Chain.Solana]: Parameters<typeof getSolanaToolbox>[0];
+  [Chain.Tron]: Parameters<typeof createTronToolbox>[0];
 };
 
 type CreateTransactionParams = { [key in EVMChain]: EVMCreateTransactionParams } & {
@@ -157,84 +151,90 @@ type CreateTransactionParams = { [key in EVMChain]: EVMCreateTransactionParams }
   [Chain.Radix]: GenericCreateTransactionParams;
   [Chain.Ripple]: GenericCreateTransactionParams;
   [Chain.Solana]: SolanaCreateTransactionParams;
+  [Chain.Tron]: GenericCreateTransactionParams;
 };
 
 export async function getToolbox<T extends keyof Toolboxes>(
   chain: T,
   params?: ToolboxParams[T],
 ): Promise<Toolboxes[T]> {
-  switch (chain) {
-    case Chain.Arbitrum:
-    case Chain.Avalanche:
-    case Chain.Optimism:
-    case Chain.BinanceSmartChain:
-    case Chain.Base:
-    case Chain.Polygon:
-    case Chain.Ethereum: {
-      const { getEvmToolbox } = await import("@swapkit/toolboxes/evm");
-      const evmToolbox = await getEvmToolbox(chain, params as Parameters<typeof getEvmToolbox>[1]);
-      return evmToolbox as Toolboxes[T];
-    }
-
-    case Chain.Litecoin:
-    case Chain.Dash:
-    case Chain.Dogecoin:
-    case Chain.BitcoinCash:
-    case Chain.Bitcoin: {
-      const { getUtxoToolbox } = await import("@swapkit/toolboxes/utxo");
-      const utxoToolbox = await getUtxoToolbox(
-        chain,
-        params as Parameters<typeof getUtxoToolbox>[1],
-      );
-      return utxoToolbox as Toolboxes[T];
-    }
+  const { match } = await import("ts-pattern");
 
-    case Chain.Cosmos:
-    case Chain.Kujira:
-    case Chain.Maya:
-    case Chain.THORChain: {
+  return match(chain as Chain)
+    .returnType<Promise<Toolboxes[T]>>()
+    .with(
+      Chain.Arbitrum,
+      Chain.Avalanche,
+      Chain.Optimism,
+      Chain.BinanceSmartChain,
+      Chain.Base,
+      Chain.Polygon,
+      Chain.Ethereum,
+      async () => {
+        const { getEvmToolbox } = await import("@swapkit/toolboxes/evm");
+        const evmToolbox = await getEvmToolbox(
+          chain as EVMChain,
+          params as Parameters<typeof getEvmToolbox>[1],
+        );
+        return evmToolbox as Toolboxes[T];
+      },
+    )
+    .with(
+      Chain.Litecoin,
+      Chain.Dash,
+      Chain.Dogecoin,
+      Chain.BitcoinCash,
+      Chain.Bitcoin,
+      async () => {
+        const { getUtxoToolbox } = await import("@swapkit/toolboxes/utxo");
+        const utxoToolbox = await getUtxoToolbox(
+          chain as UTXOChain,
+          params as Parameters<typeof getUtxoToolbox>[1],
+        );
+        return utxoToolbox as Toolboxes[T];
+      },
+    )
+    .with(Chain.Cosmos, Chain.Kujira, Chain.Maya, Chain.THORChain, async () => {
       const { getCosmosToolbox } = await import("@swapkit/toolboxes/cosmos");
       const cosmosToolbox = await getCosmosToolbox(
-        chain,
+        chain as CosmosChain,
         params as Parameters<typeof getCosmosToolbox>[1],
       );
-
       return cosmosToolbox as Toolboxes[T];
-    }
-
-    case Chain.Chainflip:
-    case Chain.Polkadot: {
+    })
+    .with(Chain.Chainflip, Chain.Polkadot, async () => {
       const { getSubstrateToolbox } = await import("@swapkit/toolboxes/substrate");
       const substrateToolbox = await getSubstrateToolbox(
-        chain,
+        chain as SubstrateChain,
         params as Parameters<typeof getSubstrateToolbox>[1],
       );
       return substrateToolbox as Toolboxes[T];
-    }
-
-    case Chain.Radix: {
+    })
+    .with(Chain.Radix, async () => {
       const { RadixToolbox } = await import("@swapkit/toolboxes/radix");
       const radixToolbox = await RadixToolbox(params as Parameters<typeof RadixToolbox>[0]);
       return radixToolbox as Toolboxes[T];
-    }
-
-    case Chain.Ripple: {
+    })
+    .with(Chain.Ripple, async () => {
       const { getRippleToolbox } = await import("@swapkit/toolboxes/ripple");
       const rippleToolbox = await getRippleToolbox(
         params as Parameters<typeof getRippleToolbox>[0],
       );
       return rippleToolbox as Toolboxes[T];
-    }
-
-    case Chain.Solana: {
+    })
+    .with(Chain.Solana, async () => {
       const { getSolanaToolbox } = await import("@swapkit/toolboxes/solana");
       const solanaToolbox = await getSolanaToolbox(
         params as Parameters<typeof getSolanaToolbox>[0],
       );
       return solanaToolbox as Toolboxes[T];
-    }
-
-    default:
-      throw new Error(`Chain ${chain} is not supported`);
-  }
+    })
+    .with(Chain.Tron, async () => {
+      const { createTronToolbox } = await import("@swapkit/toolboxes/tron");
+      const tronToolbox = await createTronToolbox(params);
+      return tronToolbox as Toolboxes[T];
+    })
+    .otherwise(() => {
+      throw new SwapKitError("toolbox_not_supported", { chain });
+    });
 }

package/src/radix/index.ts

@@ -5,7 +5,13 @@ import type {
   StateEntityFungiblesPageRequest,
   StateEntityFungiblesPageResponse,
 } from "@radixdlt/babylon-gateway-api-sdk";
-import { AssetValue, Chain, SKConfig, type SKConfigIntegrations } from "@swapkit/helpers";
+import {
+  AssetValue,
+  Chain,
+  SKConfig,
+  type SKConfigIntegrations,
+  SwapKitError,
+} from "@swapkit/helpers";
 
 export type RadixWallet = Awaited<ReturnType<typeof RadixToolbox>>;
 
@@ -144,7 +150,7 @@ export const RadixToolbox = async ({
     networkApi,
     validateAddress: radixValidateAddress,
     signAndBroadcast: (() => {
-      throw new Error("Not implemented");
+      throw new SwapKitError("toolbox_radix_method_not_supported", { method: "signAndBroadcast" });
     }) as (params: any) => Promise<string>,
   };
 };

package/src/substrate/substrate.ts

@@ -53,7 +53,7 @@ export function getSubstrateToolbox<T extends SubstrateChain>(chain: T, params?:
       return PolkadotToolbox(params);
     }
     default:
-      throw new Error(`Chain ${chain} is not supported`);
+      throw new SwapKitError("toolbox_substrate_not_supported", { chain });
   }
 }
 

package/src/tron/helpers/trc20.abi.ts

@@ -0,0 +1,40 @@
+export const trc20ABI = [
+  {
+    constant: true,
+    inputs: [{ name: "_owner", type: "address" }],
+    name: "balanceOf",
+    outputs: [{ name: "balance", type: "uint256" }],
+    type: "function",
+  },
+  {
+    constant: false,
+    inputs: [
+      { name: "_to", type: "address" },
+      { name: "_value", type: "uint256" },
+    ],
+    name: "transfer",
+    outputs: [{ name: "success", type: "bool" }],
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: "decimals",
+    outputs: [{ name: "", type: "uint8" }],
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: "symbol",
+    outputs: [{ name: "", type: "string" }],
+    type: "function",
+  },
+  {
+    constant: true,
+    inputs: [],
+    name: "name",
+    outputs: [{ name: "", type: "string" }],
+    type: "function",
+  },
+] as const;

package/src/tron/index.ts

@@ -0,0 +1,16 @@
+export {
+  createTronToolbox,
+  getTronAddressValidator,
+  getTronPrivateKeyFromMnemonic,
+} from "./toolbox";
+export type {
+  TronSigner,
+  TronToolboxOptions,
+  TronTransferParams,
+  TronContract,
+  TronTransaction,
+} from "./types";
+export { trc20ABI } from "./helpers/trc20.abi";
+
+import type { createTronToolbox } from "./toolbox.js";
+export type TronWallet = Awaited<ReturnType<typeof createTronToolbox>>;