@funkit/api-base 1.4.1 → 1.5.0

package/dist/src/services/fw-group/types.d.ts

@@ -0,0 +1,13 @@
+import type { Address, Hex } from 'viem';
+export type GroupMetadata = {
+    groupId: Hex;
+    chainId: string;
+    threshold: number;
+    walletAddr: Address;
+    memberIds: Hex[];
+};
+export interface GetGroupsRequest {
+    groupIds: Hex[];
+    chainId: string;
+    apiKey: string;
+}

package/dist/src/services/fw-paymaster/endpoints.d.ts

@@ -0,0 +1,2 @@
+import type { AddPaymasterTransactionRequest } from './types';
+export declare function addTransaction({ chainId, timestamp, txid, transaction, paymasterType, sponsorAddress, apiKey, }: AddPaymasterTransactionRequest): Promise<any>;

package/dist/src/services/fw-paymaster/index.d.ts

@@ -0,0 +1,2 @@
+export * from './endpoints';
+export * from './types';

package/dist/src/services/fw-paymaster/types.d.ts

@@ -0,0 +1,23 @@
+export interface PaymasterTransaction {
+    action: string;
+    amount: number;
+    from: string;
+    to: string;
+    token: string;
+    txid?: string;
+}
+export interface AddPaymasterTransactionRequest {
+    chainId: string;
+    timestamp: number;
+    txid: any;
+    transaction: PaymasterTransaction;
+    paymasterType: PaymasterType;
+    sponsorAddress: string;
+    apiKey: string;
+}
+export declare enum PaymasterType {
+    BaseSponsor = "base",
+    GaslessSponsor = "gasless",
+    TokenSponsor = "token",
+    CheckoutSponsor = "checkout"
+}

package/dist/src/services/index.d.ts

@@ -1,6 +1,9 @@
 export * from './assets';
 export * from './checkout';
 export * from './faucet';
+export * from './fw-access';
+export * from './fw-group';
+export * from './fw-paymaster';
 export * from './mesh';
 export * from './moonpay';
 export * from './stripe';

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

@@ -1,10 +1,11 @@
-import type { GetCryptocurrencyHoldingsRequest, GetLinkTokenRequest, GetLinkTokenResponse, GetTransferIntegrationsRequest, GetTransferIntegrationsResponse, MeshExecuteTransferRequest, MeshExecuteTransferResponse, PreviewTransferRequest, PreviewTransferResponse } from './types';
+import type { GetCryptocurrencyHoldingsRequest, GetCryptocurrencyHoldingsRequestProxy, GetLinkTokenRequest, GetLinkTokenResponse, GetTransferIntegrationsRequest, GetTransferIntegrationsResponse, MeshExecuteTransferRequest, MeshExecuteTransferRequestProxy, MeshExecuteTransferResponse, PreviewTransferRequest, PreviewTransferRequestProxy, PreviewTransferResponse } from './types';
 /**
  * @param authToken The authentication token to send the asset from.
  * @param type The type of the integration to send the asset from.
  * @return https://docs.meshconnect.com/api-reference/portfolio/get-holdings
  */
 export declare function meshGetCryptocurrencyHoldings({ authToken, type, apiKey, }: GetCryptocurrencyHoldingsRequest): Promise<any>;
+export declare function meshGetCryptocurrencyHoldingsProxy({ apiKey, ...props }: GetCryptocurrencyHoldingsRequestProxy): Promise<any>;
 /**
  * @return https://docs.meshconnect.com/api-reference/managed-transfers/get-integrations
  */
@@ -34,6 +35,7 @@ export declare function meshGetLinkToken({ userId, integrationId, restrictMultip
  * @returns https://docs.meshconnect.com/api-reference/managed-transfers/preview-transfer
  */
 export declare function meshPreviewTransfer({ fromAuthToken, fromType, toAuthToken, toType, networkId, symbol, toAddress, amount, amountInFiat, fiatCurrency, apiKey, }: PreviewTransferRequest): Promise<PreviewTransferResponse>;
+export declare function meshPreviewTransferProxy({ apiKey, ...props }: PreviewTransferRequestProxy): Promise<PreviewTransferResponse>;
 /**
  *
  * @param fromAuthToken The authentication token to send the asset from.
@@ -43,3 +45,34 @@ export declare function meshPreviewTransfer({ fromAuthToken, fromType, toAuthTok
  * @returns https://docs.meshconnect.com/api-reference/managed-transfers/execute-transfer
  */
 export declare function meshExecuteTransfer({ fromAuthToken, fromType, previewId, mfaCode, apiKey, }: MeshExecuteTransferRequest): Promise<MeshExecuteTransferResponse>;
+export declare function meshExecuteTransferProxy({ apiKey, ...props }: MeshExecuteTransferRequestProxy): Promise<MeshExecuteTransferResponse>;
+interface SaveTokensToMeshProxyRequestBody {
+    deviceId?: string | null;
+    brokerType: string;
+    accessToken: string;
+    refreshToken: string | null;
+    accessTokenExpiresIn: number;
+    accessTokenExpiresAt: string;
+    refreshTokenExpiresAt?: string | null;
+    apiKey: string;
+}
+interface SaveTokensToMeshProxyResponseBody {
+    id: number;
+    createdAt: Date;
+    updatedAt: Date;
+    deviceId: string;
+    integrationId: string;
+    accessToken: string;
+    accessTokenExpiresAt: Date | null;
+    accessTokenExpiresIn: number | null;
+    refreshToken: string | null;
+    refreshTokenExpiresAt: Date | null;
+}
+export declare function saveTokensToMeshProxy({ apiKey, ...props }: SaveTokensToMeshProxyRequestBody): Promise<SaveTokensToMeshProxyResponseBody>;
+interface RemoveTokensFromMeshProxyRequestBody {
+    deviceId: string;
+    brokerType: string;
+    apiKey: string;
+}
+export declare function removeTokensFromMeshProxy({ apiKey, ...props }: RemoveTokensFromMeshProxyRequestBody): Promise<void>;
+export {};

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

@@ -3,6 +3,10 @@ export interface GetCryptocurrencyHoldingsRequest {
     type: string;
     apiKey: string;
 }
+export interface GetCryptocurrencyHoldingsRequestProxy extends Omit<GetCryptocurrencyHoldingsRequest, 'authToken' | 'type'> {
+    deviceId: string;
+    brokerType: string;
+}
 export interface GetTransferIntegrationsRequest {
     apiKey: string;
 }
@@ -46,6 +50,10 @@ export interface PreviewTransferRequest {
     amountInFiat?: string | null;
     fiatCurrency?: string | null;
 }
+export interface PreviewTransferRequestProxy extends Omit<PreviewTransferRequest, 'fromAuthToken' | 'fromType'> {
+    deviceId: string;
+    brokerType: string;
+}
 export interface MeshExecuteTransferRequest {
     apiKey: string;
     fromAuthToken: string;
@@ -53,6 +61,10 @@ export interface MeshExecuteTransferRequest {
     previewId: string;
     mfaCode?: string | null;
 }
+export interface MeshExecuteTransferRequestProxy extends Omit<MeshExecuteTransferRequest, 'fromAuthToken' | 'fromType'> {
+    deviceId: string;
+    brokerType: string;
+}
 export declare enum MeshExecuteTransferStatus {
     succeeded = "succeeded",
     failed = "failed",
@@ -89,6 +101,9 @@ export interface MeshCryptoCurrencyPosition {
 export interface GetCryptocurrencyHoldingsResponse {
     cryptocurrencyPositions: MeshCryptoCurrencyPosition[];
 }
+export interface MeshProxyUnauthorizedResponse {
+    error: string;
+}
 export interface PreviewTransferResponse {
     /** The status of the operation. */
     status: 'succeeded' | 'failed' | 'requiresFunding';

package/dist/src/services/moonpay/endpoints.d.ts

@@ -1,11 +1,3 @@
-import type { GetMoonpayBuyQuoteForCreditCardRequest, GetMoonpayBuyQuoteForCreditCardResponse, GetMoonpayOffRampUrlRequest, GetMoonpayOnRampUrlRequest, GetMoonpayUrlSignatureRequest, MoonpayCurrency } from './types';
+import type { GetMoonpayBuyQuoteForCreditCardRequest, GetMoonpayBuyQuoteForCreditCardResponse, GetMoonpayUrlSignatureRequest } from './types';
 export declare function getMoonpayUrlSignature({ url, isSandbox, apiKey, }: GetMoonpayUrlSignatureRequest): Promise<string>;
 export declare function getMoonpayBuyQuoteForCreditCard({ currencyCode, baseCurrencyCode, quoteCurrencyAmount, baseCurrencyAmount, extraFeePercentage, areFeesIncluded, apiKey, }: GetMoonpayBuyQuoteForCreditCardRequest): Promise<GetMoonpayBuyQuoteForCreditCardResponse>;
-/**=======================
- * POTENTIAL DEPRECATION
- *=======================*/
-export declare function getMoonpayOnRampUrl({ apiKey, walletAddr, currencyCode, }: GetMoonpayOnRampUrlRequest): Promise<string>;
-export declare function getMoonpayOffRampUrl({ walletAddr, apiKey, }: GetMoonpayOffRampUrlRequest): Promise<string>;
-export declare function getMoonpayOnRampSupportedCurrencies({ apiKey, }: {
-    apiKey: string;
-}): Promise<MoonpayCurrency[]>;

package/dist/src/services/moonpay/types.d.ts

@@ -12,39 +12,6 @@ export interface GetMoonpayBuyQuoteForCreditCardRequest {
     extraFeePercentage?: number;
     areFeesIncluded?: boolean;
 }
-export interface GetMoonpayOnRampUrlRequest {
-    apiKey: string;
-    walletAddr: string;
-    currencyCode?: string;
-}
-export interface GetMoonpayOffRampUrlRequest {
-    apiKey: string;
-    walletAddr: string;
-}
-export interface MoonpayCurrency {
-    id: string;
-    name: string;
-    code: string;
-    createdAt?: string;
-    updatedAt?: string;
-    type?: string;
-    precision?: number;
-    addressRegex?: string;
-    testnetAddressRegex?: string;
-    maxAmount?: number;
-    maxBuyAmount?: number;
-    maxSellAmount?: number;
-    minAmount?: number;
-    minBuyAmount?: number;
-    minSellAmount?: number;
-    supportsAddressTag?: boolean;
-    addressTagRegex?: string;
-    supportsTestMode?: boolean;
-    isSuspended?: boolean;
-    isSupportedInUS?: boolean;
-    isSellSupported?: boolean;
-    notAllowedUSStates?: string[];
-}
 export interface GetMoonpayBuyQuoteForCreditCardResponse {
     accountId: string;
     baseCurrencyAmount: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@funkit/api-base",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Base API for Funkit",
   "main": "dist/index.js",
   "type": "module",
@@ -10,10 +10,11 @@
   },
   "dependencies": {
     "@lifeomic/attempt": "^3.1.0",
-    "big.js": "^6.2.1"
+    "big.js": "^6.2.1",
+    "@funkit/utils": "1.0.3"
   },
   "devDependencies": {
-    "ts-node": "^10.9.1",
+    "@types/big.js": "^6.2.2",
     "typescript": "^5.4.3",
     "vitest": "^2.0.5"
   },

package/dist/src/errors/BaseError.d.ts

@@ -1,10 +0,0 @@
-export declare class BaseError extends Error {
-    baseType: string;
-    type: string;
-    code: string;
-    rawMessage: string;
-    paramsUsed: any;
-    timestamp: string;
-    constructor(baseType: string, type: string, code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string, isInternal?: boolean);
-    loadEnd(): void;
-}

package/dist/src/errors/ClientError.d.ts

@@ -1,19 +0,0 @@
-import { BaseError } from './BaseError';
-export declare class ClientError extends BaseError {
-    constructor(type: string, code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}
-export declare class InvalidParameterError extends ClientError {
-    constructor(code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}
-export declare class ResourceNotFoundError extends ClientError {
-    constructor(code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}
-export declare class ThrottlingError extends ClientError {
-    constructor(code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}
-export declare class AccessDeniedError extends ClientError {
-    constructor(code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}
-export declare class UserOpFailureError extends ClientError {
-    constructor(code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}

package/dist/src/errors/ServerError.d.ts

@@ -1,7 +0,0 @@
-import { BaseError } from './BaseError';
-export declare class ServerError extends BaseError {
-    constructor(type: string, code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}
-export declare class InternalFailureError extends ServerError {
-    constructor(code: string, msg: string, rawMessage: string, paramsUsed: any, fixSuggestion: string, docLink: string);
-}

package/dist/src/errors/index.d.ts

@@ -1,4 +0,0 @@
-export * from './BaseError';
-export * from './ClientError';
-export * from './ServerError';
-export * from './types';

package/dist/src/errors/types.d.ts

@@ -1,60 +0,0 @@
-export type ErrorData = {
-    location: string;
-    error?: {
-        txDetails?: ErrorTransactionDetails;
-        reasonData?: {
-            title: string;
-            reasons: string[];
-        };
-    };
-};
-export type ErrorTransactionDetails = {
-    method: string;
-    params: any[];
-    contractAddress?: string;
-    chainId?: number | string;
-};
-export declare enum ErrorBaseType {
-    ClientError = "ClientError",
-    ServerError = "ServerError"
-}
-export declare enum ErrorType {
-    InvalidParameter = "InvalidParameter",
-    InternalServerFailure = "InternalServerFailure",
-    ResourceNotFound = "ResourceNotFound",
-    InvalidAction = "InvalidAction",
-    ThrottlingError = "ThrottlingError",
-    AccessDeniedError = "AccessDeniedError",
-    UserOpFailureError = "UserOpFailureError"
-}
-export declare enum ErrorCode {
-    MissingParameter = "MissingParameter",
-    InvalidParameter = "InvalidParameter",
-    InvalidThreshold = "InvalidThreshold",
-    InvalidChainIdentifier = "InvalidChainIdentifier",
-    InvalidNFTIdentifier = "InvalidNFTIdentifier",
-    InsufficientSignatures = "InsufficientSignatures",
-    InvalidParameterCombination = "InvalidParameterCombination",
-    CheckPointHintsNotFound = "CheckPointHintsNotFound",
-    GroupNotFound = "GroupNotFound",
-    TokenNotFound = "TokenNotFound",
-    AddressNotFound = "AddressNotFound",
-    UserAlreadyExists = "UserAlreadyExists",
-    UserNotFound = "UserNotFound",
-    ChainNotSupported = "ChainNotSupported",
-    ServerMissingData = "ServerMissingData",
-    ServerFailure = "ServerFailure",
-    ServerTimeout = "ServerTimeout",
-    UnknownServerError = "UnknownServerError",
-    ServerConnectionError = "ServerConnectionError",
-    UserOpFailureError = "UserOpFailureError",
-    Unauthorized = "Unauthorized",
-    RequestLimitExceeded = "RequestLimitExceeded",
-    WalletPrefundError = "PrefundError",
-    GasSponsorFundError = "GasSponsorFundError",
-    FunWalletErrorCode = "FunWalletErrorCode",
-    BridgeRouteNotFound = "BridgeRouteNotFound",
-    BridgeAllowanceDataNotFound = "BridgeAllowanceDataNotFound",
-    BridgeApproveTxDataNotFound = "BridgeApproveTxDataNotFound",
-    CheckoutInitDepositAddrNotFound = "CheckoutInitDepositAddrNotFound"
-}