@funkit/fun-relay 2.1.16-next.2 → 2.2.0-next.4

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @funkit/fun-relay
 
+## 2.2.0-next.4
+
+### Patch Changes
+
+- 7312429: adopt checkedIndexedAccess for safety
+
+## 2.2.0-next.3
+
+### Minor Changes
+
+- c289ca6: feat(fun-relay): require api key for relay to prevent rate limiting
+  feat(connect): pass pseudo api key to fun-relay
+- aa767b0: feat: add tron adapter
+
+### Patch Changes
+
+- fd5fe29: fix(fun-relay): add protocolVersion to tests
+
 ## 2.1.16-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export { getRelayAssetPriceInfo } from './src/price';
 export { getRelayAssetInfo } from './src/currency';
 export { type GetRelayQuoteParams, type RelayQuote, getRelayQuote, getReferrer, RelayQuoteClientError, } from './src/quote';
 export { type SolanaAddress, type SolanaTxHash, type SolanaWallet, getSolanaWallet, } from './src/solana';
+export { type TronAddress, type TronTxHash, type TronWallet, getTronWallet, } from './src/tron';
 export type { LighterAccountIndex, LighterWallet } from './src/lighter';
 export { getRelayExecutionRefundState, getRelayExecutionState, isRelayExecutionTerminalStatus, convertFunToRelayTokenAddress, convertFunToRelayChainId, } from './src/utils';
 export { LogLevel, type RelayExecutionInfo, type RelayExecutionStatus, type RelayTokenPriceInfo, } from './src/types';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,gBAAgB,EAChB,0BAA0B,GAC3B,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,KAAK,2BAA2B,GACjC,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAC5B,uBAAuB,GACxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,aAAa,EACb,WAAW,EACX,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,eAAe,GAChB,MAAM,cAAc,CAAA;AACrB,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,6BAA6B,EAC7B,wBAAwB,GACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,GACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxE,YAAY,EACV,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,2BAA2B,EAC3B,cAAc,EACd,eAAe,GAChB,MAAM,2BAA2B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,aAAa,EAClB,KAAK,aAAa,EAClB,gBAAgB,EAChB,0BAA0B,GAC3B,MAAM,eAAe,CAAA;AACtB,OAAO,EACL,cAAc,EACd,qBAAqB,EACrB,KAAK,2BAA2B,GACjC,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,sBAAsB,EACtB,6BAA6B,EAC7B,0BAA0B,EAC1B,4BAA4B,EAC5B,kBAAkB,EAClB,qBAAqB,EACrB,4BAA4B,EAC5B,uBAAuB,GACxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,KAAK,uBAAuB,EAC5B,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,KAAK,WAAW,EAChB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAClD,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,aAAa,EACb,WAAW,EACX,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EACjB,eAAe,GAChB,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,UAAU,EACf,aAAa,GACd,MAAM,YAAY,CAAA;AACnB,YAAY,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,6BAA6B,EAC7B,wBAAwB,GACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,GACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AACxE,YAAY,EACV,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,2BAA2B,EAC3B,cAAc,EACd,eAAe,GAChB,MAAM,2BAA2B,CAAA"}

package/dist/index.js

@@ -47,6 +47,7 @@ __export(index_exports, {
   getRelayExecutionState: () => getRelayExecutionState,
   getRelayQuote: () => getRelayQuote,
   getSolanaWallet: () => getSolanaWallet,
+  getTronWallet: () => getTronWallet,
   initDynamicRouting: () => initDynamicRouting,
   initializeRelayClient: () => initializeRelayClient,
   isRelayExecutionTerminalStatus: () => isRelayExecutionTerminalStatus,
@@ -84,6 +85,8 @@ var FUN_SOLANA_CHAIN_ID_NUMBER = 1151111081099710;
 var FUN_HYPERCORE_CHAIN_ID_NUMBER = 1337;
 var RELAY_LIGHTER_CHAIN_ID_NUMBER = 3586256;
 var RELAY_LIGHTER_CHAIN_ID = `${RELAY_LIGHTER_CHAIN_ID_NUMBER}`;
+var RELAY_TRON_CHAIN_ID_NUMBER = 728126428;
+var RELAY_TRON_CHAIN_ID = `${RELAY_TRON_CHAIN_ID_NUMBER}`;
 var FUNKIT_NATIVE_TOKEN = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee";
 var RELAY_NATIVE_TOKEN = "0x0000000000000000000000000000000000000000";
 var RELAY_NATIVE_TOKEN_HYPERCORE = "0x00000000000000000000000000000000";
@@ -215,6 +218,15 @@ function indexBy(items, getKey) {
   }
   return indexedItems;
 }
+function filterNullishHeaders(params) {
+  const result = {};
+  for (const [key, value] of Object.entries(params)) {
+    if (value != null) {
+      result[key] = value;
+    }
+  }
+  return result;
+}
 
 // src/execution.ts
 function getTxHash({
@@ -232,7 +244,7 @@ function getTxHash({
   };
   logger.info(`${logPrefix}:started`, logProps);
   const getTxHashFromTxHashes = () => {
-    const rawTxHashWithUnreliableTyping = txHashes[0].txHash;
+    const rawTxHashWithUnreliableTyping = txHashes[0]?.txHash;
     const txHash = typeof rawTxHashWithUnreliableTyping === "object" ? rawTxHashWithUnreliableTyping.id : rawTxHashWithUnreliableTyping;
     logger.info(`${logPrefix}:txHashesMode`, {
       ...logProps,
@@ -367,12 +379,14 @@ async function executeRelayQuote({
         ) {
           logger.info(`${logPrefix}:onTransactionConfirmed`, txHashes);
           isTransactionConfirmed = true;
-          if (relayQuote.steps[0].requestId) {
+          const firstStep = relayQuote.steps[0];
+          const firstItem = firstStep?.items[0];
+          if (firstStep?.requestId && firstItem) {
             manuallyRegisterIndex(logger, {
-              requestId: relayQuote.steps[0].requestId,
-              chainId: relayQuote.steps[0].items[0].data.chainId,
+              requestId: firstStep.requestId,
+              chainId: firstItem.data.chainId,
               tx: jsonStringifyWithBigIntSanitization({
-                ...relayQuote.steps[0].items[0].data,
+                ...firstItem.data,
                 txHash
               })
             });
@@ -426,9 +440,11 @@ async function manuallyRegisterIndex(logger, registerRequest) {
     });
   }
 }
-async function getRelayExecutionInfo(requestId) {
+async function getRelayExecutionInfo(requestId, apiKey) {
   const url = `${import_relay_sdk3.MAINNET_RELAY_API}/intents/status/v2?requestId=${requestId}`;
-  const response = await fetch(url);
+  const response = await fetch(url, {
+    headers: { "x-api-key": apiKey }
+  });
   if (!response.ok) {
     throw Error(response.statusText);
   }
@@ -510,7 +526,8 @@ function parseRelayFees({
 var import_relay_sdk4 = require("@relayprotocol/relay-sdk");
 async function getRelayAssetPriceInfo({
   chainId,
-  address
+  address,
+  apiKey
 }) {
   const relayChainId = convertFunToRelayChainId(Number(chainId));
   const relayTokenAddress = convertFunToRelayTokenAddress(
@@ -518,7 +535,8 @@ async function getRelayAssetPriceInfo({
     relayChainId
   );
   const url = `${import_relay_sdk4.MAINNET_RELAY_API}/currencies/token/price?chainId=${relayChainId}&address=${relayTokenAddress}`;
-  const response = await fetch(url);
+  const headers = filterNullishHeaders({ "x-api-key": apiKey });
+  const response = await fetch(url, { headers });
   if (!response.ok) {
     throw Error(response.statusText);
   }
@@ -530,7 +548,8 @@ async function getRelayAssetPriceInfo({
 var import_relay_sdk5 = require("@relayprotocol/relay-sdk");
 async function getRelayAssetInfo({
   chainId,
-  address
+  address,
+  apiKey
 }) {
   const relayChainId = convertFunToRelayChainId(Number(chainId));
   const relayTokenAddress = convertFunToRelayTokenAddress(
@@ -538,13 +557,17 @@ async function getRelayAssetInfo({
     relayChainId
   );
   const url = `${import_relay_sdk5.MAINNET_RELAY_API}/currencies/v2`;
+  const headers = filterNullishHeaders({
+    "Content-Type": "application/json",
+    "x-api-key": apiKey
+  });
   const body = {
     chainIds: [relayChainId],
     address: relayTokenAddress
   };
   const response = await fetch(url, {
     method: "POST",
-    headers: { "Content-Type": "application/json" },
+    headers,
     body: JSON.stringify(body)
   });
   if (!response.ok) {
@@ -561,7 +584,8 @@ async function getQuoteEstUsdValue({
   tokenChainId,
   tokenAddress,
   tokenAmountBaseUnit,
-  logger
+  logger,
+  apiKey
 }) {
   try {
     const normalizedChainId = convertFunToRelayChainId(
@@ -574,11 +598,13 @@ async function getQuoteEstUsdValue({
     const [tokenPriceRes, tokenInfoRes] = await Promise.all([
       getRelayAssetPriceInfo({
         chainId: normalizedChainId,
-        address: normalizedTokenAddress
+        address: normalizedTokenAddress,
+        apiKey
       }),
       getRelayAssetInfo({
         chainId: normalizedChainId,
-        address: normalizedTokenAddress
+        address: normalizedTokenAddress,
+        apiKey
       })
     ]);
     const isWUsdeEthereal = normalizedChainId === "5064014" && normalizedTokenAddress.toLowerCase() === "0xB6fC4B1BFF391e5F6b4a3D2C7Bda1FeE3524692D".toLowerCase();
@@ -609,11 +635,9 @@ var RelayQuoteClientError = class extends Error {
     Object.setPrototypeOf(this, new.target.prototype);
   }
 };
-var getHeaders = (funRelayConfig, subsidizeFeesSecretKey) => {
-  const subsidizeFees = !!funRelayConfig.config.options.subsidizeFees;
+var getHeaders = (funRelayConfig, apiKey) => {
   const headers = {
-    // only apply subsidizeFeesSecretKey if subsidizeFees is true
-    ...subsidizeFees && subsidizeFeesSecretKey ? { "x-api-key": subsidizeFeesSecretKey } : {},
+    "x-api-key": apiKey,
     // Remote headers will override passed in headers
     ...funRelayConfig.headers ? { ...funRelayConfig.headers } : {}
   };
@@ -635,7 +659,7 @@ async function getRelayQuote({
     toTokenAddress,
     tradeType,
     userAddress,
-    subsidizeFeesSecretKey
+    apiKey
   } = params;
   const vmType = walletClient && "vmType" in walletClient ? walletClient.vmType : "evm";
   try {
@@ -668,7 +692,8 @@ async function getRelayQuote({
       tokenChainId: queryTokenChainId,
       tokenAddress: queryTokenAddress,
       tokenAmountBaseUnit: queryTokenAmountBaseUnit.toString(),
-      logger
+      logger,
+      apiKey
     });
     const funRelayConfig = await getFunRelayFees({
       clientId,
@@ -680,7 +705,7 @@ async function getRelayQuote({
       toTokenAddress,
       toChainId
     });
-    const headers = getHeaders(funRelayConfig, subsidizeFeesSecretKey);
+    const headers = getHeaders(funRelayConfig, apiKey);
     const appFeeBp = funRelayConfig.b + funRelayConfig.v;
     logger.info("getRelayQuoteParams", {
       ...params,
@@ -839,6 +864,12 @@ function getSolanaWallet(walletAddress, connection, signTransaction, payerKey) {
   );
 }
 
+// src/tron.ts
+var import_relay_tron_wallet_adapter = require("@relayprotocol/relay-tron-wallet-adapter");
+function getTronWallet(walletAddress, tronWeb) {
+  return (0, import_relay_tron_wallet_adapter.adaptTronWallet)(walletAddress, tronWeb);
+}
+
 // src/dynamicRoutes/lighter.ts
 var import_viem4 = require("viem");
 var import_chains2 = require("viem/chains");