@funkit/api-base 0.0.1 → 0.0.2

package/src/services/mesh/endpoints.ts

@@ -1,164 +0,0 @@
-import { API_BASE_URL } from '../../consts'
-import { sendGetRequest, sendPostRequest } from '../../utils'
-import {
-  ExecuteTransferRequest,
-  GetCryptocurrencyHoldingsRequest,
-  GetLinkTokenRequest,
-  GetLinkTokenResponse,
-  GetTransferIntegrationsRequest,
-  GetTransferIntegrationsResponse,
-  PreviewTransferRequest,
-} 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/reference/post_api-v1-holdings-get
- */
-export async function meshGetCryptocurrencyHoldings({
-  authToken,
-  type,
-  apiKey,
-}: GetCryptocurrencyHoldingsRequest): Promise<any> {
-  const res = await sendPostRequest({
-    uri: `${API_BASE_URL}/mesh/holdings/get`,
-    body: { authToken, type },
-    apiKey,
-  })
-  return res
-}
-
-/**
- * @return https://docs.meshconnect.com/reference/get_api-v1-transfers-managed-integrations
- */
-export async function meshGetTransferIntegrations({
-  apiKey,
-}: GetTransferIntegrationsRequest): Promise<GetTransferIntegrationsResponse> {
-  const res = await sendGetRequest({
-    uri: `${API_BASE_URL}/mesh/transfers/managed/integrations`,
-    apiKey,
-  })
-  return res
-}
-
-/**
- * @param userId A unique Id representing the end user. Typically this will be a user Id from the
-client application. Personally identifiable information, such as an email address or phone number,
-should not be used. 50 characters length maximum.
- * @param integrationId A unique identifier representing a specific integration obtained from the list of available integrations.
- * @param restrictMultipleAccounts The final screen of Link allows users to “continue” back to your app or “Link another account.”
-If this param is present then this button will be hidden.
- * @param transferOptions Encapsulates transaction-related parameters, including destination addresses and the amount to transfer in fiat currency.
- * @return https://docs.meshconnect.com/reference/post_api-v1-linktoken
- */
-export async function meshGetLinkToken({
-  userId,
-  integrationId,
-  restrictMultipleAccounts,
-  transferOptions,
-  apiKey,
-}: GetLinkTokenRequest): Promise<GetLinkTokenResponse> {
-  let body: any = { userId }
-  if (integrationId) {
-    body = { ...body, integrationId }
-  }
-  if (restrictMultipleAccounts) {
-    body = { ...body, restrictMultipleAccounts }
-  }
-  if (transferOptions) {
-    body = { ...body, transferOptions }
-  }
-  const res = await sendPostRequest({
-    uri: `${API_BASE_URL}/mesh/linktoken`,
-    body,
-    apiKey,
-  })
-  return res
-}
-
-/**
- * @param fromAuthToken The authentication token to send the asset from.
- * @param fromType The type of the integration to send the asset from.
- * @param toAuthToken The authentication token of the target integration. Can be used alternatively to the address in the ToAddress field. If used, toType should also be provided.
- * @param toType The type of the target integration to send assets to. Used along with the toAuthToken alternatively to ToAddress.
- * @param networkId The network to send the asset over. This is generated by Mesh, it isn't a chainId or chain name.
- * @param symbol The symbol of the digital asset to send.
- * @param toAddress The target address to send the asset to.
- * @param amount The amount to send, in crypto.
- * @param amountInFiat The amount to send, in fiat currency. Can be used alternatively to Amount.
- * @param fiatCurrency Fiat currency that is to get corresponding converted fiat values of transfer and fee amounts. If not provided, defaults to USD.
- * @returns https://docs.meshconnect.com/reference/post_api-v1-transfers-managed-preview
- */
-export async function meshPreviewTransfer({
-  fromAuthToken,
-  fromType,
-  toAuthToken,
-  toType,
-  networkId,
-  symbol,
-  toAddress,
-  amount,
-  amountInFiat,
-  fiatCurrency,
-  apiKey,
-}: PreviewTransferRequest): Promise<any> {
-  let body: any = { fromAuthToken, fromType }
-  if (toAuthToken) {
-    body = { ...body, toAuthToken }
-  }
-  if (toType) {
-    body = { ...body, toType }
-  }
-  if (networkId) {
-    body = { ...body, networkId }
-  }
-  if (symbol) {
-    body = { ...body, symbol }
-  }
-  if (toAddress) {
-    body = { ...body, toAddress }
-  }
-  if (amount) {
-    body = { ...body, amount }
-  }
-  if (amountInFiat) {
-    body = { ...body, amountInFiat }
-  }
-  if (fiatCurrency) {
-    body = { ...body, fiatCurrency }
-  }
-
-  const res = await sendPostRequest({
-    uri: `${API_BASE_URL}/mesh/transfers/managed/preview`,
-    body,
-    apiKey,
-    retryOptions: { maxAttempts: 1 },
-  })
-  return res
-}
-/**
- *
- * @param fromAuthToken The authentication token to send the asset from.
- * @param fromType The type of the integration to send the asset from.
- * @param previewId The preview ID of the transfer to execute.
- * @param mfaCode Multi-factor auth code that should be provided if the status of the transfer was MfaRequired.
- * @returns https://docs.meshconnect.com/reference/post_api-v1-transfers-managed-execute
- */
-export async function meshExecuteTransfer({
-  fromAuthToken,
-  fromType,
-  previewId,
-  mfaCode,
-  apiKey,
-}: ExecuteTransferRequest): Promise<any> {
-  let body: any = { fromAuthToken, fromType, previewId }
-  if (mfaCode) {
-    body = { ...body, mfaCode }
-  }
-  const res = await sendPostRequest({
-    uri: `${API_BASE_URL}/mesh/transfers/managed/execute`,
-    body,
-    apiKey,
-  })
-  return res
-}

package/src/services/mesh/index.ts

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

package/src/services/mesh/types.ts

@@ -1,63 +0,0 @@
-export interface GetCryptocurrencyHoldingsRequest {
-  authToken: string
-  type: string
-  apiKey: string
-}
-
-export interface GetTransferIntegrationsRequest {
-  apiKey: string
-}
-
-interface IntegrationNetworkInfo {
-  chainId: string
-  id: string
-  logoUrl: string
-  name: string
-  nativeSymbol: string
-  supportedTokens: string[]
-}
-
-interface TransferIntegration {
-  networks: IntegrationNetworkInfo[]
-  supportsIncomingTransfers: boolean
-  supportsOutgoingTransfers: boolean
-  type: string
-}
-
-export interface GetTransferIntegrationsResponse {
-  integrations: TransferIntegration[]
-}
-
-export interface GetLinkTokenRequest {
-  userId: string
-  integrationId?: string | null
-  restrictMultipleAccounts?: boolean
-  transferOptions?: any | null
-  apiKey: string
-}
-
-export interface GetLinkTokenResponse {
-  linkToken: string
-}
-
-export interface PreviewTransferRequest {
-  apiKey: string
-  fromAuthToken: string
-  fromType: string
-  toAuthToken?: string | null
-  toType?: string | null
-  networkId?: string
-  symbol?: string | null
-  toAddress?: string | null
-  amount?: string | null
-  amountInFiat?: string | null
-  fiatCurrency?: string | null
-}
-
-export interface ExecuteTransferRequest {
-  apiKey: string
-  fromAuthToken: string
-  fromType: string
-  previewId: string
-  mfaCode?: string | null
-}

package/src/services/moonpay/endpoints.ts

@@ -1,62 +0,0 @@
-import { API_BASE_URL } from '../../consts'
-import { ErrorCode, InternalFailureError } from '../../errors'
-import { sendGetRequest, sendPostRequest } from '../../utils'
-import {
-  GetMoonpayBuyQuoteForCreditCardRequest,
-  GetMoonpayUrlSignatureRequest,
-} from './types'
-
-export async function getMoonpayUrlSignature({
-  url,
-  isSandbox,
-  apiKey,
-}: GetMoonpayUrlSignatureRequest): Promise<string> {
-  const signature = await sendPostRequest({
-    uri: `${API_BASE_URL}/on-ramp/moonpay-signature/`,
-    body: { url, isSandbox },
-    apiKey,
-  })
-  if (!signature || !signature?.url) {
-    throw new InternalFailureError(
-      ErrorCode.UnknownServerError,
-      'No onramp url found.',
-      { url },
-      'This is an internal error, please contact support.',
-      'https://docs.fun.xyz',
-    )
-  }
-  return signature.url
-}
-
-export async function getMoonpayBuyQuoteForCreditCard({
-  currencyCode,
-  baseCurrencyCode,
-  quoteCurrencyAmount,
-  baseCurrencyAmount,
-  extraFeePercentage,
-  areFeesIncluded,
-  apiKey,
-}: GetMoonpayBuyQuoteForCreditCardRequest): Promise<any> {
-  const params = new URLSearchParams({
-    currencyCode,
-    baseCurrencyCode,
-    quoteCurrencyAmount,
-    paymentMethod: 'credit_debit_card',
-    ...(baseCurrencyAmount == null
-      ? {}
-      : { baseCurrencyAmount: baseCurrencyAmount.toString() }),
-    ...(extraFeePercentage == null
-      ? {}
-      : { extraFeePercentage: extraFeePercentage.toString() }),
-    ...(areFeesIncluded == null
-      ? {}
-      : { areFeesIncluded: areFeesIncluded.toString() }),
-  }).toString()
-
-  const res = await sendGetRequest({
-    uri: `${API_BASE_URL}/on-ramp/moonpay-buy-quote?${params}`,
-    apiKey,
-    retryOptions: { maxAttempts: 1 },
-  })
-  return res
-}

package/src/services/moonpay/index.ts

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

package/src/services/moonpay/types.ts

@@ -1,15 +0,0 @@
-export interface GetMoonpayUrlSignatureRequest {
-  apiKey: string
-  url: string
-  isSandbox?: boolean
-}
-
-export interface GetMoonpayBuyQuoteForCreditCardRequest {
-  apiKey: string
-  currencyCode: string
-  baseCurrencyCode: string
-  quoteCurrencyAmount: string
-  baseCurrencyAmount?: number
-  extraFeePercentage?: number
-  areFeesIncluded?: boolean
-}

package/src/utils/checkout.ts

@@ -1,17 +0,0 @@
-import { toHex } from 'viem'
-
-const randomBytes = (length: number) => {
-  const bytes = new Uint8Array(length)
-  for (let i = 0; i < length; i++) {
-    bytes[i] = Math.floor(Math.random() * 256)
-  }
-  return toHex(bytes)
-}
-
-export function generateRandomCheckoutSalt() {
-  return BigInt(randomBytes(32))
-}
-
-export function roundToNearestBottomTenth(n: number) {
-  return Math.floor(n / 10) * 10
-}

package/src/utils/error.ts

@@ -1,15 +0,0 @@
-import {
-  InvalidParameterError,
-  ResourceNotFoundError,
-  UserOpFailureError,
-} from '../errors'
-
-export const errorAbortHandler = (err: any, context: any) => {
-  if (
-    err instanceof ResourceNotFoundError ||
-    err instanceof InvalidParameterError ||
-    err instanceof UserOpFailureError
-  ) {
-    context.abort()
-  }
-}

package/src/utils/index.ts

@@ -1,3 +0,0 @@
-export * from './checkout'
-export * from './error'
-export * from './request'

package/src/utils/request.ts

@@ -1,198 +0,0 @@
-import { retry } from '@lifeomic/attempt'
-import { toHex } from 'viem'
-
-const fetch = (...args) =>
-  import('node-fetch').then(({ default: fetch }) => fetch(...args))
-
-import { BaseRequest } from '../consts/request'
-import { DEFAULT_RETRY_OPTIONS, RetryOptions } from '../consts/retry'
-import {
-  AccessDeniedError,
-  ErrorCode,
-  InternalFailureError,
-  InvalidParameterError,
-  ResourceNotFoundError,
-  ThrottlingError,
-  UserOpFailureError,
-} from '../errors'
-import {
-  BaseResponse,
-  DeleteRequest,
-  GetRequest,
-  PostRequest,
-  PutRequest,
-} from './../consts/request'
-
-const stringifyWithBigIntSanitization = (object: any) => {
-  return JSON.stringify(
-    object,
-    (_, value) => (typeof value === 'bigint' ? toHex(value) : value), // return everything else unchanged
-  )
-}
-
-export const sendRequest = async ({
-  uri,
-  method,
-  apiKey,
-  body = {},
-  retryOptions = {},
-}: BaseRequest): Promise<BaseResponse> => {
-  try {
-    const headers = {
-      'Content-Type': 'application/json',
-      ...(apiKey ? { 'X-Api-Key': apiKey } : {}),
-    }
-
-    const finalRetryOptions = {
-      ...DEFAULT_RETRY_OPTIONS,
-      ...(retryOptions || {}),
-    } as RetryOptions
-
-    return retry(async function () {
-      const response = await fetch(uri, {
-        method,
-        headers,
-        redirect: 'follow',
-        body:
-          method !== 'GET' ? stringifyWithBigIntSanitization(body) : undefined,
-      })
-      const json = await response.json()
-      if (response.ok) {
-        return json
-      } else if (response.status === 400) {
-        throw new InvalidParameterError(
-          ErrorCode.InvalidParameter,
-          `bad request ${JSON.stringify(json)}`,
-          { body },
-          'check the api call parameters. its mostly because some call parameters are wrong',
-          'https://docs.fun.xyz',
-        )
-      } else if (response.status === 403) {
-        throw new AccessDeniedError(
-          ErrorCode.Unauthorized,
-          'Invalid API key or insufficient access.',
-          { apiKey },
-          'Check your api key at https://app.fun.xyz and check with fun team if you believe something is off',
-          'https://docs.fun.xyz',
-        )
-      } else if (response.status === 404) {
-        throw new ResourceNotFoundError(
-          ErrorCode.ServerMissingData,
-          JSON.stringify(json),
-          { body },
-          'check the api call parameters. its mostly because some call parameters are wrong',
-          'https://docs.fun.xyz',
-        )
-      } else if (response.status === 429) {
-        throw new ThrottlingError(
-          ErrorCode.RequestLimitExceeded,
-          `too many requests ${JSON.stringify(json)}`,
-
-          { body },
-          'you are making too many requests. please slow down. Reach out to fun team if you need more quota',
-          'https://docs.fun.xyz',
-        )
-      } else if (response.status === 500) {
-        if ((json as any).errorCode === ErrorCode.UserOpFailureError) {
-          throw new UserOpFailureError(
-            ErrorCode.UserOpFailureError,
-            JSON.stringify(json),
-            { body },
-            'fix user op failure. Most of the time this is due to invalid parameters',
-            'https://docs.fun.xyz',
-          )
-        } else {
-          throw new InternalFailureError(
-            ErrorCode.ServerFailure,
-            `server failure ${JSON.stringify(json)}`,
-            { body },
-            'retry later. if it still fails, please contact us.',
-            'https://docs.fun.xyz',
-          )
-        }
-      } else if (response.status === 504) {
-        throw new InternalFailureError(
-          ErrorCode.ServerTimeout,
-          `server timeout failure ${JSON.stringify(json)}`,
-          { body },
-          'retry later. if it still fails, please contact us.',
-          'https://docs.fun.xyz',
-        )
-      } else if (!response.ok) {
-        throw new InternalFailureError(
-          ErrorCode.UnknownServerError,
-          `unknown server failure ${JSON.stringify(json)}`,
-          { body },
-          'retry later. if it still fails, please contact us.',
-          'https://docs.fun.xyz',
-        )
-      }
-      return {}
-    }, finalRetryOptions)
-  } catch (err) {
-    throw new InternalFailureError(
-      ErrorCode.ServerConnectionError,
-      `Cannot connect to Fun API Service ${err}`,
-
-      { body },
-      'retry later. if it still fails, please contact us.',
-      'https://docs.fun.xyz',
-    )
-  }
-}
-
-export async function sendGetRequest({
-  uri,
-  apiKey,
-  retryOptions,
-}: GetRequest): Promise<BaseResponse> {
-  return await sendRequest({
-    uri,
-    apiKey,
-    retryOptions,
-    method: 'GET',
-  })
-}
-
-export async function sendPostRequest({
-  uri,
-  body,
-  apiKey,
-  retryOptions,
-}: PostRequest): Promise<BaseResponse> {
-  return await sendRequest({
-    uri,
-    apiKey,
-    body,
-    retryOptions,
-    method: 'POST',
-  })
-}
-
-export async function sendDeleteRequest({
-  uri,
-  apiKey,
-  retryOptions,
-}: DeleteRequest): Promise<void> {
-  await sendRequest({
-    uri,
-    method: 'DELETE',
-    apiKey,
-    retryOptions,
-  })
-}
-
-export async function sendPutRequest({
-  uri,
-  body,
-  apiKey,
-  retryOptions,
-}: PutRequest): Promise<BaseResponse> {
-  return await sendRequest({
-    uri,
-    apiKey,
-    body,
-    retryOptions,
-    method: 'PUT',
-  })
-}

package/test/services/assets.test.ts

@@ -1,41 +0,0 @@
-import {
-  getAllWalletTokens,
-  getAllWalletTokensByChainId,
-  getAssetPriceInfo,
-} from '../../'
-
-describe('assets service', () => {
-  test('getAssetPriceInfo returns valid result', async () => {
-    const assetPriceInfo = await getAssetPriceInfo({
-      chainId: '1',
-      assetTokenAddress: '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee',
-      apiKey: global.TEST_API_KEY,
-    })
-    expect(assetPriceInfo.amount).toBe(1)
-    expect(assetPriceInfo.unitPrice).toBeGreaterThan(0)
-    expect(assetPriceInfo.total).toBeGreaterThan(0)
-  })
-
-  test('getAllWalletTokens returns valid result', async () => {
-    const walletBalance = await getAllWalletTokens({
-      walletAddress: global.TEST_WALLET_ADDRESS,
-      onlyVerifiedTokens: true,
-      apiKey: global.TEST_API_KEY,
-    })
-    expect(walletBalance['1']).toBeTruthy()
-    expect(walletBalance['137']).toBeTruthy()
-    expect(walletBalance['8453']).toBeTruthy()
-    expect(walletBalance['324']).toBeTruthy()
-    expect(walletBalance['42161']).toBeTruthy()
-  })
-
-  test('getAllWalletTokensByChainId returns valid result', async () => {
-    const ethereumBalance = await getAllWalletTokensByChainId({
-      chainId: '1',
-      walletAddress: global.TEST_WALLET_ADDRESS,
-      onlyVerifiedTokens: true,
-      apiKey: global.TEST_API_KEY,
-    })
-    expect(ethereumBalance).toBeTruthy()
-  })
-})

package/test/services/checkout.test.ts

@@ -1,53 +0,0 @@
-import {
-  getCheckoutQuote,
-  getCheckoutsByRecipientAddress,
-  initializeCheckout,
-} from '../../'
-
-const QUOTE_TEST_TIMEOUT = 30000 // 30 seconds
-
-describe('checkout service', () => {
-  let quoteId: string
-  test(
-    'getCheckoutQuote and initializeCheckout returns valid result',
-    async () => {
-      const quoteParams = {
-        fromChainId: '8453',
-        fromTokenAddress:
-          '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee' as `0x${string}`,
-        fromTokenDecimals: 18,
-        toChainId: '137',
-        toTokenAddress:
-          '0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee' as `0x${string}`,
-        toTokenDecimals: 18,
-        toTokenAmount: 5,
-        expirationTimestampMs: 300_000, // 5 minutes
-        sponsorInitialTransferGasLimit: '0',
-        recipientAddr: global.TEST_WALLET_ADDRESS,
-        needsRefuel: false,
-        apiKey: global.TEST_API_KEY,
-      }
-      const quote = await getCheckoutQuote(quoteParams)
-      quoteId = quote.quoteId
-      expect(quote.quoteId).toBeTruthy()
-
-      const checkoutInitParams = {
-        quoteId,
-        sourceOfFund: `balance|eoa|${global.TEST_WALLET_ADDRESS}`,
-        apiKey: global.TEST_API_KEY,
-        clientMetadata: {},
-      }
-      const depositAddr = await initializeCheckout(checkoutInitParams)
-      expect(depositAddr).toBeTruthy()
-    },
-    QUOTE_TEST_TIMEOUT,
-  )
-
-  test('getCheckoutsByRecipientAddress returns valid result', async () => {
-    const checkouts = await getCheckoutsByRecipientAddress({
-      recipientAddress: global.TEST_WALLET_ADDRESS,
-      apiKey: global.TEST_API_KEY,
-    })
-    expect(checkouts.length).toBeGreaterThan(0)
-  })
-})

package/test/services/mesh.test.ts

@@ -1,10 +0,0 @@
-import { meshGetTransferIntegrations } from '../../'
-
-describe('mesh service', () => {
-  test('meshGetTransferIntegrations returns valid result', async () => {
-    const integrationsResponse = await meshGetTransferIntegrations({
-      apiKey: global.TEST_API_KEY,
-    })
-    expect(integrationsResponse.integrations.length).toBeGreaterThan(0)
-  })
-})

package/test/services/moonpay.test.ts

@@ -1,24 +0,0 @@
-import { getMoonpayBuyQuoteForCreditCard, getMoonpayUrlSignature } from '../../'
-
-describe('moonpay service', () => {
-  test('getMoonpayUrlSignature returns valid result', async () => {
-    const urlSignature = await getMoonpayUrlSignature({
-      apiKey: global.TEST_API_KEY,
-      isSandbox: true,
-      url: 'https://buy.moonpay.com/?apiKey=pk_test_dWfAhBbvVexIId9S5hPd78mKM7ivIsqu&currencyCode=usdc&walletAddress=0x931122fD30c218e208A3546A3faa2f40F6c06A3e&colorCode=%2331a3f8&theme=light&baseCurrencyCode=usd&quoteCurrencyAmount=106.23&lockAmount=true&externalCustomerId=0x6ec0c2f25d323e7779925Cc20c3740101f990d9F%7C0x6ec0c2f25d323e7779925Cc20c3740101f990d9F%7CgsWiq9zk0W5Rh4vzpqURI6nyauFL0tSm9m0EydTI&mpSdk=%7B%22version%22%3A%221.8.0%22%2C%22environment%22%3A%22production%22%2C%22flow%22%3A%22buy%22%2C%22variant%22%3A%22embedded%22%2C%22platform%22%3A%22web%22%7D',
-    })
-    expect(urlSignature).toBeTruthy()
-  })
-
-  test('getMoonpayBuyQuoteForCreditCard returns valid result', async () => {
-    const buyQuote = await getMoonpayBuyQuoteForCreditCard({
-      apiKey: global.TEST_API_KEY,
-      baseCurrencyCode: 'usd',
-      currencyCode: 'usdc',
-      quoteCurrencyAmount: '106.23',
-      areFeesIncluded: true,
-    })
-    expect(buyQuote.accountId).toBeTruthy()
-    expect(buyQuote.baseCurrencyCode).toBe('usd')
-  })
-})

package/test/setup.ts

@@ -1,9 +0,0 @@
-beforeAll(() => {
-  global.TEST_API_KEY = 'hnHevQR0y394nBprGrvNx4HgoZHUwMet5mXTOBhf'
-  global.TEST_WALLET_ADDRESS = '0xD646AF38161B2d9Fd65F5116C7Ecdf23562644b0'
-})
-
-afterAll(() => {
-  delete global.TEST_API_KEY
-  delete global.TEST_WALLET_ADDRESS
-})