@funkit/api-base - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

CHANGELOG.md

 # @funkit/api-base
 
+## 1.1.2
+
+### Patch Changes
+
+- a90f273: chore: export type for mesh connect
+
 ## 1.1.1
@@ -4,0 +10,0 @@

dist/src/services/assets/types.d.ts

@@ -29,8 +29,8 @@ export interface GetAssetPriceInfoRequest {
 }
-export interface ChainAssetBalanceInfo {
+export type ChainAssetBalanceInfo = {
     [tokenAddress: string]: AssetBalanceInfo;
-}
-export interface GetAllWalletTokensResponse {
+};
+export type GetAllWalletTokensResponse = {
     [chainId: number]: ChainAssetBalanceInfo;
-}
+};
 export interface GetAllWalletTokensByChainIdRequest {
@@ -37,0 +37,0 @@ chainId: string;

dist/src/services/mesh/endpoints.d.ts

@@ -1,2 +0,2 @@
-import { GetCryptocurrencyHoldingsRequest, GetLinkTokenRequest, GetLinkTokenResponse, GetTransferIntegrationsRequest, GetTransferIntegrationsResponse, MeshExecuteTransferRequest, MeshExecuteTransferResponse, PreviewTransferRequest } from './types';
+import { GetCryptocurrencyHoldingsRequest, GetLinkTokenRequest, GetLinkTokenResponse, GetTransferIntegrationsRequest, GetTransferIntegrationsResponse, MeshExecuteTransferRequest, MeshExecuteTransferResponse, PreviewTransferRequest, PreviewTransferResponse } from './types';
 /**
@@ -36,3 +36,3 @@ * @param authToken The authentication token to send the asset from.
  */
-export declare function meshPreviewTransfer({ fromAuthToken, fromType, toAuthToken, toType, networkId, symbol, toAddress, amount, amountInFiat, fiatCurrency, apiKey, }: PreviewTransferRequest): Promise<any>;
+export declare function meshPreviewTransfer({ fromAuthToken, fromType, toAuthToken, toType, networkId, symbol, toAddress, amount, amountInFiat, fiatCurrency, apiKey, }: PreviewTransferRequest): Promise<PreviewTransferResponse>;
 /**
@@ -39,0 +39,0 @@ *

dist/src/services/mesh/types.d.ts

@@ -84,1 +84,58 @@ export interface GetCryptocurrencyHoldingsRequest {
 }
+export interface PreviewTransferResponse {
+    /** The status of the operation. */
+    status: 'succeeded' | 'failed' | 'requiresFunding';
+    /** Error message, if the operation did not complete successfully. */
+    errorMessage: string | null;
+    /** Result of the preview. */
+    previewResult: PreviewTransferResult | null;
+    transferBalanceFundingAvailability: TransferBalanceFundingAvailability | null;
+}
+export interface PreviewTransferResult {
+    previewId: string;
+    previewExpiresIn: number;
+    fromAddress: string | null;
+    toAddress: string | null;
+    addressTag: string | null;
+    symbol: string | null;
+    amount: number;
+    amountInFiat: number;
+    totalEstimatedAmount: number;
+    totalEstimatedAmountInFiat: number;
+    networkId: string;
+    networkName: string | null;
+    contractAddress: string | null;
+    institutionTransferFee: TransferFee | null;
+    estimatedNetworkGasFee: TransferFee | null;
+    decimalPlaces: number | null;
+    unitPrice: number;
+    clientTransactionId: string | null;
+    clientFee: number | null;
+    customClientFee: TransferFee | null;
+    processingFeeRetainMethod: ProcessingFeeRetainMethod | null;
+    transferType: TransferTypeEnum | null;
+    isCustomClientFeeProvided: boolean;
+    amountWithCustomClientFee: number;
+    isFeeIncluded: boolean;
+    amountToReceive: number;
+    amountToReceiveInFiat: number;
+    transferAmountToRequest: number;
+}
+export interface TransferFee {
+    fee: number;
+    feeCurrency: string | null;
+    feeInFiat: number;
+}
+export interface ProcessingFeeRetainMethod {
+    type: 'default' | 'smartDeposit';
+    processingFeeAddress: string | null;
+}
+export type TransferTypeEnum = 'deposit' | 'payment' | 'onramp';
+export interface TransferBalanceFundingAvailability {
+    status: 'disabled' | 'available' | 'requiresAmountLowering' | 'notApplicable' | 'unavailable';
+    transferTotalAmount: number;
+    unitPrice: number;
+    gasFeeBuffer: TransferFee | null;
+    symbol: string | null;
+    transferTotalAmountInFiat: number;
+}

package.json

 {
   "name": "@funkit/api-base",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Base API for Funkit",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

216282

increased by2.02%

Lines of code

2609

increased by2.27%

Worsened metrics

Published versions last months

3

decreased by-25%

Published versions last week

0

decreased by-100%

No dependency changes