@funkit/api-base 1.4.2 → 1.5.1

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

@@ -0,0 +1,149 @@
+import type { Address, Hex } from 'viem';
+export declare enum OperationStatus {
+    ALL = "",
+    PENDING_APPROVED = "PENDING_APPROVED",
+    APPROVED = "APPROVED",
+    PENDING = "PENDING",
+    OP_SUCCEED = "OP_SUCCEED",
+    OP_REVERTED = "OP_REVERTED",
+    SCHEDULED = "SCHEDULED"
+}
+export type OperationMetadata = {
+    opId?: Hex;
+    chainId: string;
+    opType: OperationType;
+    authType: AuthType;
+    groupId?: Hex;
+    message?: string;
+    walletAddr: Address;
+    status?: OperationStatus;
+    proposer: string;
+    proposedTime?: number;
+    executedBy?: string;
+    executedTime?: number;
+    relatedOpIds?: Hex[];
+    signatures?: Signature[];
+    txid?: string;
+    gasUsed?: string;
+    opFeeUSD?: string;
+    opFee?: string;
+    executedBlockNumber?: number;
+    executedBlockTimeStamp?: number;
+};
+export interface OperationData extends OperationMetadata {
+    userOp: UserOperation;
+}
+export declare enum AuthType {
+    ECDSA = 0,
+    MULTI_SIG = 1
+}
+export type Signature = {
+    userId: Hex;
+    signature: Hex;
+    signedTime: number;
+};
+export declare enum OperationType {
+    SINGLE_OPERATION = "SINGLE_OPERATION",
+    GROUP_OPERATION = "GROUP_OPERATION",
+    REJECTION = "REJECTION"
+}
+export type GroupInfo = {
+    threshold: number;
+    memberIds: Hex[];
+};
+export type UserOperation = {
+    sender: string;
+    nonce: bigint;
+    initCode?: string;
+    callData: string;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas?: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterAndData?: string;
+    signature?: string;
+};
+export interface ExecutionReceipt {
+    userOpHash: string;
+    txId?: Hex;
+    gasUsed?: string;
+    opFeeUSD?: string;
+    opFee?: string;
+}
+export type EstimatedGas = {
+    preVerificationGas: bigint;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+};
+export interface CreateOpRequest {
+    op: OperationData;
+    apiKey: string;
+}
+export interface GetOpsOfWalletRequest {
+    walletAddr: Address;
+    chainId: string;
+    apiKey: string;
+    status?: OperationStatus;
+}
+export interface GetOpsRequest {
+    opIds: Hex[];
+    chainId: string;
+    apiKey: string;
+}
+export interface DeleteOpRequest {
+    opId: Hex;
+    chainId: string;
+    apiKey: string;
+}
+export interface SignOpRequest {
+    opId: Hex;
+    chainId: string;
+    signature: Hex;
+    signedBy: Address;
+    apiKey: string;
+    threshold?: number;
+}
+export type OpRequest<T> = {
+    input: T;
+    apiKey: string;
+};
+export type ExecuteOpInput = {
+    opId: Hex;
+    chainId: string;
+    executedBy: string;
+    entryPointAddress: Address;
+    signature: Hex;
+    userOp?: UserOperation;
+    groupInfo?: GroupInfo;
+};
+export type EstimateOpInput = {
+    opId?: Hex;
+    chainId: string;
+    entryPointAddress?: Address;
+    signature?: Hex;
+    userOp?: UserOperation;
+};
+export type ScheduleOpInput = {
+    opId: Hex;
+    chainId: string;
+    scheduledBy: string;
+    entryPointAddress: Address;
+    signature: Hex;
+    userOp?: UserOperation;
+    groupInfo?: GroupInfo;
+};
+export interface GetFullReceiptRequest {
+    opId: string;
+    chainId: string;
+    userOpHash: string;
+    apiKey: string;
+}
+export interface GetUserOpGasPriceRequest {
+    chainId: string;
+    apiKey: string;
+}
+export type UserOperationGasPrice = {
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+};

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,24 @@
+import type { ExecutionReceipt } from '../fw-operation';
+export interface PaymasterTransaction {
+    action: string;
+    amount: number;
+    from: string;
+    to: string;
+    token: string;
+    txid?: string;
+}
+export interface AddPaymasterTransactionRequest {
+    chainId: string;
+    timestamp: number;
+    txid: ExecutionReceipt['txId'] | string;
+    transaction: PaymasterTransaction;
+    paymasterType: PaymasterType;
+    sponsorAddress: string;
+    apiKey: string;
+}
+export declare enum PaymasterType {
+    BaseSponsor = "base",
+    GaslessSponsor = "gasless",
+    TokenSponsor = "token",
+    CheckoutSponsor = "checkout"
+}

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

@@ -0,0 +1,10 @@
+import { type Hex } from 'viem';
+import type { AddUserToWalletRequest, CreateUserRequest, GetUserUniqueIdRequest, GetUserWalletIdentitiesRequest, GetUserWalletsByAddrRequest, Wallet } from './types';
+export declare function createUser({ authId, addr, method, userUniqueId, apiKey, }: CreateUserRequest): Promise<void>;
+export declare function getUserUniqueId({ authId, apiKey, }: GetUserUniqueIdRequest): Promise<string>;
+export declare function getUserWalletsByAddr({ addr, apiKey, chainId, }: GetUserWalletsByAddrRequest): Promise<Wallet[]>;
+export declare function addUserToWallet({ authId, chainId, walletAddr, userIds, apiKey, walletUniqueId, }: AddUserToWalletRequest): Promise<void>;
+/**
+ * @returns userIds of the specified Wallet.
+ */
+export declare function getUserWalletIdentities({ authId, chainId, walletAddr, apiKey, }: GetUserWalletIdentitiesRequest): Promise<Hex[]>;

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

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

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

@@ -0,0 +1,36 @@
+import type { Address, Hex } from 'viem';
+export type Wallet = {
+    walletUniqueId?: string;
+    walletAddr: Address;
+    userIds: Hex[];
+};
+export interface CreateUserRequest {
+    authId: string;
+    addr: string;
+    method: string;
+    userUniqueId: string;
+    apiKey: string;
+}
+export interface GetUserUniqueIdRequest {
+    authId: string;
+    apiKey: string;
+}
+export interface GetUserWalletsByAddrRequest {
+    addr: string;
+    apiKey: string;
+    chainId?: string;
+}
+export interface AddUserToWalletRequest {
+    authId: string;
+    chainId: string;
+    walletAddr: Address;
+    userIds: Hex[];
+    apiKey: string;
+    walletUniqueId?: string;
+}
+export interface GetUserWalletIdentitiesRequest {
+    authId: string;
+    chainId: string;
+    walletAddr: Address;
+    apiKey: string;
+}

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

@@ -1,6 +1,12 @@
 export * from './assets';
 export * from './checkout';
 export * from './faucet';
+export * from './fw-access';
+export * from './fw-group';
+export * from './fw-info';
+export * from './fw-operation';
+export * from './fw-paymaster';
+export * from './fw-user';
 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, GetCryptocurrencyHoldingsResponse, 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 meshGetCryptocurrencyHoldings({ authToken, type, apiKey, }: GetCryptocurrencyHoldingsRequest): Promise<GetCryptocurrencyHoldingsResponse>;
+export declare function meshGetCryptocurrencyHoldingsProxy({ apiKey, ...props }: GetCryptocurrencyHoldingsRequestProxy): Promise<GetCryptocurrencyHoldingsResponse>;
 /**
  * @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;
 }
@@ -27,7 +31,7 @@ export interface GetLinkTokenRequest {
     userId: string;
     integrationId?: string | null;
     restrictMultipleAccounts?: boolean;
-    transferOptions?: any | null;
+    transferOptions?: Record<string, unknown> | null;
     apiKey: string;
 }
 export interface GetLinkTokenResponse {
@@ -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/utils/error.d.ts

@@ -1 +1,2 @@
-export declare const errorAbortHandler: (err: any, context: any) => void;
+import type { AttemptContext } from '@lifeomic/attempt';
+export declare const errorAbortHandler: (err: Error, context: AttemptContext) => void;

package/dist/src/utils/request.d.ts

@@ -1,8 +1,8 @@
 import type { BaseRequest } from '../consts/request';
 import { type BaseResponse } from '../consts/retry';
 import type { DeleteRequest, GetRequest, PostRequest, PutRequest } from './../consts/request';
-export declare const sendRequest: ({ uri, method, apiKey, body, retryOptions, signal, }: BaseRequest) => Promise<BaseResponse>;
-export declare function sendGetRequest({ uri, apiKey, retryOptions, signal, }: GetRequest): Promise<BaseResponse>;
-export declare function sendPostRequest({ uri, body, apiKey, retryOptions, signal, }: PostRequest): Promise<BaseResponse>;
+export declare function sendRequest<T = BaseResponse>({ uri, method, apiKey, body, retryOptions, signal, }: BaseRequest): Promise<T>;
+export declare function sendGetRequest<T = BaseResponse>({ uri, apiKey, retryOptions, signal, }: GetRequest): Promise<T>;
+export declare function sendPostRequest<T = BaseResponse>({ uri, body, apiKey, retryOptions, signal, }: PostRequest): Promise<T>;
 export declare function sendDeleteRequest({ uri, apiKey, retryOptions, signal, }: DeleteRequest): Promise<void>;
 export declare function sendPutRequest({ uri, body, apiKey, retryOptions, signal, }: PutRequest): Promise<BaseResponse>;

package/package.json

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