@agglayer/sdk 1.0.0-beta.18 → 1.0.0-beta.19

package/dist/index.d.mts

@@ -346,6 +346,21 @@ type BuildClaimTransactionRequestParam = {
 };
 type BuildClaimTransactionResponse = UnsignedTransaction;
 
+/**
+ * Arc API Token Mapping Types
+ *
+ * Defines the request and response types for the token mapping endpoint.
+ */
+type TokenMappingQueryParams = {
+    tokenAddress: string;
+};
+type TokenMappingResponse = Array<{
+    originTokenNetwork: number;
+    originTokenAddress: string;
+    wrappedTokenNetwork: number;
+    wrappedTokenAddress: string;
+}>;
+
 /**
  * Chain Types
  *
@@ -835,6 +850,13 @@ declare class CoreClient {
      * Get all transactions via web sockets
      */
     getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
+    /**
+     * Get token mappings by token address
+     * @developer Note: Do not misinterpret network ID as chain ID.
+     *
+     * @param tokenAddress
+     */
+    getTokenMappings(tokenMappingQueryParams: TokenMappingQueryParams): Promise<TokenMappingResponse>;
 }
 
 /**
@@ -888,4 +910,4 @@ declare class AggLayerSDK {
     getNative(): NativeClient;
 }
 
-export { AggLayerSDK, ApiError, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildClaimTransactionRequestParam, type BuildClaimTransactionResponse, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };
+export { AggLayerSDK, ApiError, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildClaimTransactionRequestParam, type BuildClaimTransactionResponse, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenMappingQueryParams, type TokenMappingResponse, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };

package/dist/index.d.ts

@@ -346,6 +346,21 @@ type BuildClaimTransactionRequestParam = {
 };
 type BuildClaimTransactionResponse = UnsignedTransaction;
 
+/**
+ * Arc API Token Mapping Types
+ *
+ * Defines the request and response types for the token mapping endpoint.
+ */
+type TokenMappingQueryParams = {
+    tokenAddress: string;
+};
+type TokenMappingResponse = Array<{
+    originTokenNetwork: number;
+    originTokenAddress: string;
+    wrappedTokenNetwork: number;
+    wrappedTokenAddress: string;
+}>;
+
 /**
  * Chain Types
  *
@@ -835,6 +850,13 @@ declare class CoreClient {
      * Get all transactions via web sockets
      */
     getTransactions(transactionsRequestQueryParams: TransactionsRequestQueryParams): Promise<TransactionsResponse>;
+    /**
+     * Get token mappings by token address
+     * @developer Note: Do not misinterpret network ID as chain ID.
+     *
+     * @param tokenAddress
+     */
+    getTokenMappings(tokenMappingQueryParams: TokenMappingQueryParams): Promise<TokenMappingResponse>;
 }
 
 /**
@@ -888,4 +910,4 @@ declare class AggLayerSDK {
     getNative(): NativeClient;
 }
 
-export { AggLayerSDK, ApiError, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildClaimTransactionRequestParam, type BuildClaimTransactionResponse, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };
+export { AggLayerSDK, ApiError, type ApiResponse, type BaseContractConfig, type BridgeAssetParams, type BridgeConfig, type BridgeMessageParams, type BridgeOptions, type BuildClaimTransactionRequestParam, type BuildClaimTransactionResponse, type BuildTransactionRequestBody, type BuildTransactionResponse, type ChainConfig, type ChainsQueryParams, type ChainsResponse, type ClaimAssetParams, type ClaimMessageParams, type CoreConfig, type CursorPagination, type CustomChainConfig, type ERC20Config, type ErrorResponse, type FeeCost, type GasCost, type IChain, type IsClaimedParams, type NativeConfig, type OffsetPagination, type OriginTokenInfoParams, type Pagination, type PrecalculatedWrapperParams, type ProviderMetadata, type RiskFactors, type RiskLevel, type Route, type RoutePreferences, type RouteStep, type RoutesRequestParams, type RoutesResponse, type SDKConfig, type SDKMode, SDK_MODES, type Step, type StepAction, type StepEstimate, type StepType, type SuccessResponse, type TokenInfo, type TokenMappingQueryParams, type TokenMappingResponse, type TokenReference, type ToolDetails, type Transaction, type TransactionParams, type TransactionsRequestQueryParams, type TransactionsResponse, type WrappedTokenParams };

package/dist/index.js

@@ -1734,6 +1734,10 @@ var ArcApiService = class {
       transactionsRequestQueryParams
     });
   }
+  async tokenMappings(tokenMappingQueryParams) {
+    const { tokenAddress } = tokenMappingQueryParams;
+    return this.httpClient.get(`/token-mappings/${tokenAddress}`);
+  }
 };
 
 // src/core/utils/apiError.ts
@@ -2003,6 +2007,31 @@ var CoreClient = class {
       throw ApiError.createFallbackError(error, "Get transactions");
     }
   }
+  /**
+   * Get token mappings by token address
+   * @developer Note: Do not misinterpret network ID as chain ID.
+   *
+   * @param tokenAddress
+   */
+  async getTokenMappings(tokenMappingQueryParams) {
+    try {
+      const response = await this.arcApiService.tokenMappings(
+        tokenMappingQueryParams
+      );
+      if (response.data.status === "success") {
+        return response.data.data;
+      }
+      throw ApiError.fromErrorResponse(response.data);
+    } catch (error) {
+      if (error instanceof ApiError) {
+        throw error;
+      }
+      throw ApiError.createFallbackError(
+        error,
+        "Get custom token mappings"
+      );
+    }
+  }
 };
 
 // src/index.ts