@funkit/api-base 0.0.1

package/dist/src/errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,gDAA6B;AAC7B,gDAA6B;AAC7B,0CAAuB"}

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

@@ -0,0 +1,60 @@
+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"
+}

package/dist/src/errors/types.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorCode = exports.ErrorType = exports.ErrorBaseType = void 0;
+var ErrorBaseType;
+(function (ErrorBaseType) {
+    ErrorBaseType["ClientError"] = "ClientError";
+    ErrorBaseType["ServerError"] = "ServerError";
+})(ErrorBaseType || (exports.ErrorBaseType = ErrorBaseType = {}));
+var ErrorType;
+(function (ErrorType) {
+    ErrorType["InvalidParameter"] = "InvalidParameter";
+    ErrorType["InternalServerFailure"] = "InternalServerFailure";
+    ErrorType["ResourceNotFound"] = "ResourceNotFound";
+    ErrorType["InvalidAction"] = "InvalidAction";
+    ErrorType["ThrottlingError"] = "ThrottlingError";
+    ErrorType["AccessDeniedError"] = "AccessDeniedError";
+    ErrorType["UserOpFailureError"] = "UserOpFailureError";
+})(ErrorType || (exports.ErrorType = ErrorType = {}));
+var ErrorCode;
+(function (ErrorCode) {
+    ErrorCode["MissingParameter"] = "MissingParameter";
+    ErrorCode["InvalidParameter"] = "InvalidParameter";
+    ErrorCode["InvalidThreshold"] = "InvalidThreshold";
+    ErrorCode["InvalidChainIdentifier"] = "InvalidChainIdentifier";
+    ErrorCode["InvalidNFTIdentifier"] = "InvalidNFTIdentifier";
+    ErrorCode["InsufficientSignatures"] = "InsufficientSignatures";
+    ErrorCode["InvalidParameterCombination"] = "InvalidParameterCombination";
+    ErrorCode["CheckPointHintsNotFound"] = "CheckPointHintsNotFound";
+    ErrorCode["GroupNotFound"] = "GroupNotFound";
+    ErrorCode["TokenNotFound"] = "TokenNotFound";
+    ErrorCode["AddressNotFound"] = "AddressNotFound";
+    ErrorCode["UserAlreadyExists"] = "UserAlreadyExists";
+    ErrorCode["UserNotFound"] = "UserNotFound";
+    ErrorCode["ChainNotSupported"] = "ChainNotSupported";
+    ErrorCode["ServerMissingData"] = "ServerMissingData";
+    ErrorCode["ServerFailure"] = "ServerFailure";
+    ErrorCode["ServerTimeout"] = "ServerTimeout";
+    ErrorCode["UnknownServerError"] = "UnknownServerError";
+    ErrorCode["ServerConnectionError"] = "ServerConnectionError";
+    ErrorCode["UserOpFailureError"] = "UserOpFailureError";
+    ErrorCode["Unauthorized"] = "Unauthorized";
+    ErrorCode["RequestLimitExceeded"] = "RequestLimitExceeded";
+    ErrorCode["WalletPrefundError"] = "PrefundError";
+    ErrorCode["GasSponsorFundError"] = "GasSponsorFundError";
+    ErrorCode["FunWalletErrorCode"] = "FunWalletErrorCode";
+    ErrorCode["BridgeRouteNotFound"] = "BridgeRouteNotFound";
+    ErrorCode["BridgeAllowanceDataNotFound"] = "BridgeAllowanceDataNotFound";
+    ErrorCode["BridgeApproveTxDataNotFound"] = "BridgeApproveTxDataNotFound";
+    ErrorCode["CheckoutInitDepositAddrNotFound"] = "CheckoutInitDepositAddrNotFound";
+})(ErrorCode || (exports.ErrorCode = ErrorCode = {}));
+//# sourceMappingURL=types.js.map

package/dist/src/errors/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/errors/types.ts"],"names":[],"mappings":";;;AAkBA,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,4CAA2B,CAAA;IAC3B,4CAA2B,CAAA;AAC7B,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB;AAED,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,kDAAqC,CAAA;IACrC,4DAA+C,CAAA;IAC/C,kDAAqC,CAAA;IACrC,4CAA+B,CAAA;IAC/B,gDAAmC,CAAA;IACnC,oDAAuC,CAAA;IACvC,sDAAyC,CAAA;AAC3C,CAAC,EARW,SAAS,yBAAT,SAAS,QAQpB;AAED,IAAY,SA8BX;AA9BD,WAAY,SAAS;IACnB,kDAAqC,CAAA;IACrC,kDAAqC,CAAA;IACrC,kDAAqC,CAAA;IACrC,8DAAiD,CAAA;IACjD,0DAA6C,CAAA;IAC7C,8DAAiD,CAAA;IACjD,wEAA2D,CAAA;IAC3D,gEAAmD,CAAA;IACnD,4CAA+B,CAAA;IAC/B,4CAA+B,CAAA;IAC/B,gDAAmC,CAAA;IACnC,oDAAuC,CAAA;IACvC,0CAA6B,CAAA;IAC7B,oDAAuC,CAAA;IACvC,oDAAuC,CAAA;IACvC,4CAA+B,CAAA;IAC/B,4CAA+B,CAAA;IAC/B,sDAAyC,CAAA;IACzC,4DAA+C,CAAA;IAC/C,sDAAyC,CAAA;IACzC,0CAA6B,CAAA;IAC7B,0DAA6C,CAAA;IAC7C,gDAAmC,CAAA;IACnC,wDAA2C,CAAA;IAC3C,sDAAyC,CAAA;IACzC,wDAA2C,CAAA;IAC3C,wEAA2D,CAAA;IAC3D,wEAA2D,CAAA;IAC3D,gFAAmE,CAAA;AACrE,CAAC,EA9BW,SAAS,yBAAT,SAAS,QA8BpB"}

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

@@ -0,0 +1,50 @@
+import { GetAllWalletNFTsByChainIdRequest, GetAllWalletNFTsByChainIdResponse, GetAllWalletNFTsRequest, GetAllWalletNFTsResponse, GetAllWalletTokensByChainIdRequest, GetAllWalletTokensByChainIdResponse, GetAllWalletTokensRequest, GetAllWalletTokensResponse, GetAssetPriceInfoRequest, GetAssetPriceInfoResponse, GetWalletLidoWithdrawalsByChainId, GetWalletLidoWithdrawalsByChainIdResponse } from './types';
+/**===========================================================
+ * REFERENCE CORE FILE: /packages/core/src/apis/AssetApis.ts
+ * TODO: Remove this comment once migration is complete
+ *===========================================================*/
+/**
+ * Gets the estimated dollar unit price of a tokenAddress for checkout
+ * @param chainId https://chainlist.org/ e.g. "1" for ethereum
+ * @param assetTokenAddress tokenAddress of the asset on the given chain
+ * @param apiKey
+ */
+export declare function getAssetPriceInfo({ chainId, assetTokenAddress, apiKey, }: GetAssetPriceInfoRequest): Promise<GetAssetPriceInfoResponse>;
+/**
+ * Get all tokens for a given wallet address
+ * @param walletAddress
+ * @param onlyVerifiedTokens If true, only return alchemy tokens that are verified(filters spam)
+ * @param apiKey
+ */
+export declare function getAllWalletTokens({ walletAddress, onlyVerifiedTokens, apiKey, }: GetAllWalletTokensRequest): Promise<GetAllWalletTokensResponse>;
+/**
+ * Get all tokens for a given wallet address on a specific chain
+ * @param chainId https://chainlist.org/
+ * @param walletAddress
+ * @param onlyVerifiedTokens If true, only return alchemy tokens that are verified(filters spam)
+ * @param apiKey
+ */
+export declare function getAllWalletTokensByChainId({ chainId, walletAddress, onlyVerifiedTokens, apiKey, }: GetAllWalletTokensByChainIdRequest): Promise<GetAllWalletTokensByChainIdResponse>;
+/**=======================
+ * POTENTIAL DEPRECATION
+ *=======================*/
+/**
+ * Get all the NFTs owned by a wallet
+ * @param walletAddress
+ * @param apiKey
+ */
+export declare function getAllWalletNFTs({ walletAddress, apiKey, }: GetAllWalletNFTsRequest): Promise<GetAllWalletNFTsResponse>;
+/**
+ * Get all the NFTs owned by a wallet on a specific chain
+ * @param chainId From https://chainlist.org/
+ * @param walletAddress Address of holder
+ * @param apiKey
+ */
+export declare function getAllWalletNFTsByChainId({ chainId, walletAddress, apiKey, }: GetAllWalletNFTsByChainIdRequest): Promise<GetAllWalletNFTsByChainIdResponse>;
+/**
+ * Get all lido withdrawal request ids for a wallet address on a specific chain
+ * @param {string} chainId https://chainlist.org/ ie "1" for ethereum
+ * @param {string} holderAddr Address of holder
+ * @returns [readyToWithdrawRequestIds, notReadyToWithdrawRequestIds]
+ */
+export declare function getWalletLidoWithdrawalsByChainId({ chainId, walletAddress, apiKey, }: GetWalletLidoWithdrawalsByChainId): Promise<GetWalletLidoWithdrawalsByChainIdResponse>;

package/dist/src/services/assets/endpoints.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWalletLidoWithdrawalsByChainId = exports.getAllWalletNFTsByChainId = exports.getAllWalletNFTs = exports.getAllWalletTokensByChainId = exports.getAllWalletTokens = exports.getAssetPriceInfo = void 0;
+const consts_1 = require("../../consts");
+const utils_1 = require("../../utils");
+/**===========================================================
+ * REFERENCE CORE FILE: /packages/core/src/apis/AssetApis.ts
+ * TODO: Remove this comment once migration is complete
+ *===========================================================*/
+/**
+ * Gets the estimated dollar unit price of a tokenAddress for checkout
+ * @param chainId https://chainlist.org/ e.g. "1" for ethereum
+ * @param assetTokenAddress tokenAddress of the asset on the given chain
+ * @param apiKey
+ */
+async function getAssetPriceInfo({ chainId, assetTokenAddress, apiKey, }) {
+    const priceInfo = await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/asset/erc20/price/${chainId}/${assetTokenAddress}`,
+        apiKey,
+        retryOptions: { maxAttempts: 2 },
+    });
+    return priceInfo;
+}
+exports.getAssetPriceInfo = getAssetPriceInfo;
+/**
+ * Get all tokens for a given wallet address
+ * @param walletAddress
+ * @param onlyVerifiedTokens If true, only return alchemy tokens that are verified(filters spam)
+ * @param apiKey
+ */
+async function getAllWalletTokens({ walletAddress, onlyVerifiedTokens, apiKey, }) {
+    return await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/assets/erc20s/${walletAddress}?onlyVerifiedTokens=${onlyVerifiedTokens}`,
+        apiKey,
+        retryOptions: { maxAttempts: 2 },
+    });
+}
+exports.getAllWalletTokens = getAllWalletTokens;
+/**
+ * Get all tokens for a given wallet address on a specific chain
+ * @param chainId https://chainlist.org/
+ * @param walletAddress
+ * @param onlyVerifiedTokens If true, only return alchemy tokens that are verified(filters spam)
+ * @param apiKey
+ */
+async function getAllWalletTokensByChainId({ chainId, walletAddress, onlyVerifiedTokens, apiKey, }) {
+    return await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/assets/erc20s/${walletAddress}/${chainId}?onlyVerifiedTokens=${onlyVerifiedTokens}`,
+        apiKey,
+        retryOptions: { maxAttempts: 2 },
+    });
+}
+exports.getAllWalletTokensByChainId = getAllWalletTokensByChainId;
+/**=======================
+ * POTENTIAL DEPRECATION
+ *=======================*/
+/**
+ * Get all the NFTs owned by a wallet
+ * @param walletAddress
+ * @param apiKey
+ */
+async function getAllWalletNFTs({ walletAddress, apiKey, }) {
+    return await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/assets/nfts/${walletAddress}`,
+        apiKey,
+    });
+}
+exports.getAllWalletNFTs = getAllWalletNFTs;
+/**
+ * Get all the NFTs owned by a wallet on a specific chain
+ * @param chainId From https://chainlist.org/
+ * @param walletAddress Address of holder
+ * @param apiKey
+ */
+async function getAllWalletNFTsByChainId({ chainId, walletAddress, apiKey, }) {
+    return await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/assets/nfts/${walletAddress}/${chainId}`,
+        apiKey,
+    });
+}
+exports.getAllWalletNFTsByChainId = getAllWalletNFTsByChainId;
+/**
+ * Get all lido withdrawal request ids for a wallet address on a specific chain
+ * @param {string} chainId https://chainlist.org/ ie "1" for ethereum
+ * @param {string} holderAddr Address of holder
+ * @returns [readyToWithdrawRequestIds, notReadyToWithdrawRequestIds]
+ */
+async function getWalletLidoWithdrawalsByChainId({ chainId, walletAddress, apiKey, }) {
+    return await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/assets/lido-withdrawals/${walletAddress}/${chainId}`,
+        apiKey,
+    });
+}
+exports.getWalletLidoWithdrawalsByChainId = getWalletLidoWithdrawalsByChainId;
+//# sourceMappingURL=endpoints.js.map

package/dist/src/services/assets/endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../../../src/services/assets/endpoints.ts"],"names":[],"mappings":";;;AAAA,yCAA2C;AAC3C,uCAA4C;AAgB5C;;;+DAG+D;AAE/D;;;;;GAKG;AACI,KAAK,UAAU,iBAAiB,CAAC,EACtC,OAAO,EACP,iBAAiB,EACjB,MAAM,GACmB;IACzB,MAAM,SAAS,GAAG,MAAM,IAAA,sBAAc,EAAC;QACrC,GAAG,EAAE,GAAG,qBAAY,sBAAsB,OAAO,IAAI,iBAAiB,EAAE;QACxE,MAAM;QACN,YAAY,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE;KACjC,CAAC,CAAA;IACF,OAAO,SAAS,CAAA;AAClB,CAAC;AAXD,8CAWC;AAED;;;;;GAKG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,aAAa,EACb,kBAAkB,EAClB,MAAM,GACoB;IAC1B,OAAO,MAAM,IAAA,sBAAc,EAAC;QAC1B,GAAG,EAAE,GAAG,qBAAY,kBAAkB,aAAa,uBAAuB,kBAAkB,EAAE;QAC9F,MAAM;QACN,YAAY,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE;KACjC,CAAC,CAAA;AACJ,CAAC;AAVD,gDAUC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,2BAA2B,CAAC,EAChD,OAAO,EACP,aAAa,EACb,kBAAkB,EAClB,MAAM,GAC6B;IACnC,OAAO,MAAM,IAAA,sBAAc,EAAC;QAC1B,GAAG,EAAE,GAAG,qBAAY,kBAAkB,aAAa,IAAI,OAAO,uBAAuB,kBAAkB,EAAE;QACzG,MAAM;QACN,YAAY,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE;KACjC,CAAC,CAAA;AACJ,CAAC;AAXD,kEAWC;AAED;;2BAE2B;AAE3B;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAAC,EACrC,aAAa,EACb,MAAM,GACkB;IACxB,OAAO,MAAM,IAAA,sBAAc,EAAC;QAC1B,GAAG,EAAE,GAAG,qBAAY,gBAAgB,aAAa,EAAE;QACnD,MAAM;KACP,CAAC,CAAA;AACJ,CAAC;AARD,4CAQC;AAED;;;;;GAKG;AACI,KAAK,UAAU,yBAAyB,CAAC,EAC9C,OAAO,EACP,aAAa,EACb,MAAM,GAC2B;IACjC,OAAO,MAAM,IAAA,sBAAc,EAAC;QAC1B,GAAG,EAAE,GAAG,qBAAY,gBAAgB,aAAa,IAAI,OAAO,EAAE;QAC9D,MAAM;KACP,CAAC,CAAA;AACJ,CAAC;AATD,8DASC;AAED;;;;;GAKG;AACI,KAAK,UAAU,iCAAiC,CAAC,EACtD,OAAO,EACP,aAAa,EACb,MAAM,GAC4B;IAClC,OAAO,MAAM,IAAA,sBAAc,EAAC;QAC1B,GAAG,EAAE,GAAG,qBAAY,4BAA4B,aAAa,IAAI,OAAO,EAAE;QAC1E,MAAM;KACP,CAAC,CAAA;AACJ,CAAC;AATD,8EASC"}

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

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

package/dist/src/services/assets/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./endpoints"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/services/assets/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/assets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,0CAAuB"}

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

@@ -0,0 +1,65 @@
+export interface GetAssetPriceInfoRequest {
+    chainId: string;
+    assetTokenAddress: string;
+    apiKey: string;
+}
+interface AssetPriceInfo {
+    unitPrice: number;
+    amount: number;
+    total: number;
+}
+export type GetAssetPriceInfoResponse = AssetPriceInfo;
+export interface GetAllWalletTokensRequest {
+    walletAddress: string;
+    onlyVerifiedTokens: boolean;
+    apiKey: string;
+}
+interface AssetBalanceInfo {
+    chainId: string;
+    contractAddress: string;
+    decimals: number;
+    logo: string;
+    name: string;
+    price: number | null;
+    symbol: string;
+    tokenBalance: string;
+    totalUsdValue: number | null;
+}
+interface ChainAssetBalanceInfo {
+    [tokenAddress: string]: AssetBalanceInfo;
+}
+export interface GetAllWalletTokensResponse {
+    [chainId: number]: ChainAssetBalanceInfo;
+}
+export interface GetAllWalletTokensByChainIdRequest {
+    chainId: string;
+    walletAddress: string;
+    onlyVerifiedTokens: boolean;
+    apiKey: string;
+}
+export type GetAllWalletTokensByChainIdResponse = ChainAssetBalanceInfo;
+export interface GetAllWalletNFTsRequest {
+    walletAddress: string;
+    apiKey: string;
+}
+interface ChainNFTInfo {
+    address: string;
+    token_id: string;
+    floor_price: string;
+}
+export interface GetAllWalletNFTsResponse {
+    [chainId: string]: ChainNFTInfo[];
+}
+export interface GetAllWalletNFTsByChainIdRequest {
+    chainId: string;
+    walletAddress: string;
+    apiKey: string;
+}
+export type GetAllWalletNFTsByChainIdResponse = ChainNFTInfo[];
+export interface GetWalletLidoWithdrawalsByChainId {
+    chainId: string;
+    walletAddress: string;
+    apiKey: string;
+}
+export type GetWalletLidoWithdrawalsByChainIdResponse = [number[], number[]];
+export {};

package/dist/src/services/assets/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/src/services/assets/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/services/assets/types.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,55 @@
+import { Address } from 'viem';
+import { CheckoutHistoryItem, CheckoutInitParams, CheckoutQuoteParams, CheckoutQuoteResponse, CheckoutTransferSponsorshipParams, CheckoutTransferSponsorshipResponse } from './types';
+/**
+ * Gets a checkout quote (estimation).
+ * @param fromChainId The ID of the chain where funds will be provided from.
+ * @param fromTokenAddress The asset to fund the checkout. This must be either a chain native token or an ERC-20, on the fromChainId.
+ * @param fromTokenDecimals The number of decimals for the fromTokenAddress.
+ * @param toChainId The ID of the chain where the checkout operation is to be performed.
+ * @param toTokenAddress The wanted asset for the checkout operation. This must be either a chain native token or an ERC-20, on the target chain.
+ * @param toTokenAmount The amount of wanted asset for the checkout operation in base units.
+ * @param toTokenDecimals The number of decimals for the toTokenAddress.
+ * @param expirationTimestampMs The amount of time (duration) from now before the checkout operation expires.
+ * @param apiKey A valid fun api key.
+ * @return {Promise<CheckoutCoreQuoteResponse>} The formatted quote object
+ */
+export declare function getCheckoutQuote({ fromChainId, fromTokenAddress, fromTokenDecimals, toChainId, toTokenAddress, toTokenDecimals, toTokenAmount, expirationTimestampMs, sponsorInitialTransferGasLimit, recipientAddr, needsRefuel, apiKey, }: CheckoutQuoteParams): Promise<CheckoutQuoteResponse>;
+/**
+ * Initializes a checkout
+ * @param userOp The checkout UserOp, signed.
+ * @param quoteId The quoteId specific to the checkout.
+ * @param apiKey A valid fun api key.
+ * @return {Address} The generated deposit address
+ */
+export declare function initializeCheckout({ userOp, quoteId, sourceOfFund, apiKey, clientMetadata, }: CheckoutInitParams): Promise<Address>;
+/**
+ * Gets a checkout given a depositAddress
+ * @param depositAddress A unique deposit address associated with a backend checkout item.
+ * @param apiKey A valid fun api key.
+ * @returns The checkout object if exists. Otherwise, null.
+ */
+export declare function getCheckoutByDepositAddress({ depositAddress, apiKey, }: {
+    depositAddress: Address;
+    apiKey: string;
+}): Promise<CheckoutHistoryItem | null>;
+/**
+ * Gets all checkouts associated with a funWallet
+ * @param funWalletAddress A funWallet address.
+ * @param apiKey A valid fun api key.
+ * @returns A list of checkout objects if exists. Otherwise, an empty array.
+ */
+export declare function getCheckoutsByFunWalletAddress({ funWalletAddress, apiKey, }: {
+    funWalletAddress: Address;
+    apiKey: string;
+}): Promise<CheckoutHistoryItem[]>;
+/**
+ * Gets all checkouts associated with a recipient address
+ * @param recipientAddress A wallet address.
+ * @param apiKey A valid fun api key.
+ * @returns A list of checkout objects if exists. Otherwise, an empty array.
+ */
+export declare function getCheckoutsByRecipientAddress({ recipientAddress, apiKey, }: {
+    recipientAddress: Address;
+    apiKey: string;
+}): Promise<CheckoutHistoryItem[]>;
+export declare function getPaymasterDataForCheckoutSponsoredTransfer({ depositAddress, transferUserOp, apiKey, }: CheckoutTransferSponsorshipParams): Promise<CheckoutTransferSponsorshipResponse>;

package/dist/src/services/checkout/endpoints.js

@@ -0,0 +1,169 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPaymasterDataForCheckoutSponsoredTransfer = exports.getCheckoutsByRecipientAddress = exports.getCheckoutsByFunWalletAddress = exports.getCheckoutByDepositAddress = exports.initializeCheckout = exports.getCheckoutQuote = void 0;
+const big_js_1 = __importDefault(require("big.js"));
+const consts_1 = require("../../consts");
+const errors_1 = require("../../errors");
+const utils_1 = require("../../utils");
+/**
+ * Gets a checkout quote (estimation).
+ * @param fromChainId The ID of the chain where funds will be provided from.
+ * @param fromTokenAddress The asset to fund the checkout. This must be either a chain native token or an ERC-20, on the fromChainId.
+ * @param fromTokenDecimals The number of decimals for the fromTokenAddress.
+ * @param toChainId The ID of the chain where the checkout operation is to be performed.
+ * @param toTokenAddress The wanted asset for the checkout operation. This must be either a chain native token or an ERC-20, on the target chain.
+ * @param toTokenAmount The amount of wanted asset for the checkout operation in base units.
+ * @param toTokenDecimals The number of decimals for the toTokenAddress.
+ * @param expirationTimestampMs The amount of time (duration) from now before the checkout operation expires.
+ * @param apiKey A valid fun api key.
+ * @return {Promise<CheckoutCoreQuoteResponse>} The formatted quote object
+ */
+async function getCheckoutQuote({ fromChainId, fromTokenAddress, fromTokenDecimals, toChainId, toTokenAddress, toTokenDecimals, toTokenAmount, expirationTimestampMs, sponsorInitialTransferGasLimit, recipientAddr, needsRefuel, apiKey, }) {
+    try {
+        const toMultipler = 10 ** toTokenDecimals;
+        const toAmountBaseUnitBI = BigInt(Math.floor(toTokenAmount * toMultipler));
+        const queryParams = {
+            fromChainId,
+            fromTokenAddress,
+            toChainId,
+            toTokenAddress,
+            toAmountBaseUnit: toAmountBaseUnitBI.toString(),
+            // Only pass in recipientAddr if specified
+            ...(recipientAddr ? { recipientAddr } : {}),
+            // Rounding nearest tenth second (instead of seconds) to better support backend quote caching feature
+            // Reference: https://vintage-heaven-3cd.notion.site/API-Gateway-Caching-and-Pre-Warming-System-Draft-ee7909d9b85f43c793ce7bd2607bec02?pvs=4
+            // Note: Rounding *down* instead of a regular round to safeguard against edge case of timing passing frontend range validation but failing backend range validation
+            checkoutExpirationTimestampSeconds: (0, utils_1.roundToNearestBottomTenth)(Math.round((Date.now() + expirationTimestampMs) / 1000)).toString(),
+            sponsorInitialTransferGasLimit,
+            refuel: needsRefuel.toString(),
+        };
+        const searchParams = new URLSearchParams(queryParams);
+        const quoteRes = (await (0, utils_1.sendGetRequest)({
+            uri: `${consts_1.API_BASE_URL}/checkout/quote?${searchParams}`,
+            apiKey,
+        }));
+        const fromMultipler = 10 ** fromTokenDecimals;
+        // Format the response for frontend usage
+        return {
+            quoteId: quoteRes.quoteId,
+            fromTokenAddress: quoteRes.fromTokenAddress,
+            estFeesUsd: quoteRes.estFeesUsd,
+            estSubtotalUsd: quoteRes.estSubtotalUsd,
+            estTotalUsd: quoteRes.estTotalUsd,
+            estCheckoutTimeMs: quoteRes.estCheckoutTimeMs,
+            estTotalFromAmountBaseUnit: quoteRes.estTotalFromAmountBaseUnit,
+            estSubtotalFromAmountBaseUnit: quoteRes.estSubtotalFromAmountBaseUnit,
+            estFeesFromAmountBaseUnit: quoteRes.estFeesFromAmountBaseUnit,
+            // Added fields
+            estFeesFromAmount: new big_js_1.default(quoteRes.estFeesFromAmountBaseUnit)
+                .div(fromMultipler)
+                .toString(),
+            estSubtotalFromAmount: new big_js_1.default(quoteRes.estSubtotalFromAmountBaseUnit)
+                .div(fromMultipler)
+                .toString(),
+            estTotalFromAmount: new big_js_1.default(quoteRes.estTotalFromAmountBaseUnit)
+                .div(fromMultipler)
+                .toString(),
+        };
+    }
+    catch (err) {
+        throw new Error(`An error occured trying to generate a checkout quote: ${err.message}`);
+    }
+}
+exports.getCheckoutQuote = getCheckoutQuote;
+/**
+ * Initializes a checkout
+ * @param userOp The checkout UserOp, signed.
+ * @param quoteId The quoteId specific to the checkout.
+ * @param apiKey A valid fun api key.
+ * @return {Address} The generated deposit address
+ */
+async function initializeCheckout({ userOp, quoteId, sourceOfFund, apiKey, clientMetadata, }) {
+    const body = {
+        ...(userOp ? { userOp } : {}),
+        quoteId,
+        sourceOfFund,
+        salt: (0, utils_1.generateRandomCheckoutSalt)(),
+        clientMetadata,
+    };
+    const res = await (0, utils_1.sendPostRequest)({
+        uri: `${consts_1.API_BASE_URL}/checkout`,
+        body,
+        apiKey,
+    });
+    if (!res?.depositAddr) {
+        throw new errors_1.ResourceNotFoundError(errors_1.ErrorCode.CheckoutInitDepositAddrNotFound, 'Unable to initialize checkout', body, '', 'https://docs.fun.xyz');
+    }
+    return res.depositAddr;
+}
+exports.initializeCheckout = initializeCheckout;
+/**
+ * Gets a checkout given a depositAddress
+ * @param depositAddress A unique deposit address associated with a backend checkout item.
+ * @param apiKey A valid fun api key.
+ * @returns The checkout object if exists. Otherwise, null.
+ */
+async function getCheckoutByDepositAddress({ depositAddress, apiKey, }) {
+    try {
+        return await (0, utils_1.sendGetRequest)({
+            uri: `${consts_1.API_BASE_URL}/checkout/${depositAddress}`,
+            apiKey,
+        });
+    }
+    catch (err) {
+        if (err instanceof errors_1.ResourceNotFoundError) {
+            return null;
+        }
+        throw err;
+    }
+}
+exports.getCheckoutByDepositAddress = getCheckoutByDepositAddress;
+/**
+ * Gets all checkouts associated with a funWallet
+ * @param funWalletAddress A funWallet address.
+ * @param apiKey A valid fun api key.
+ * @returns A list of checkout objects if exists. Otherwise, an empty array.
+ */
+async function getCheckoutsByFunWalletAddress({ funWalletAddress, apiKey, }) {
+    const res = await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/checkout/fun-wallet/${funWalletAddress}`,
+        apiKey,
+    });
+    return res || [];
+}
+exports.getCheckoutsByFunWalletAddress = getCheckoutsByFunWalletAddress;
+/**
+ * Gets all checkouts associated with a recipient address
+ * @param recipientAddress A wallet address.
+ * @param apiKey A valid fun api key.
+ * @returns A list of checkout objects if exists. Otherwise, an empty array.
+ */
+async function getCheckoutsByRecipientAddress({ recipientAddress, apiKey, }) {
+    const res = await (0, utils_1.sendGetRequest)({
+        uri: `${consts_1.API_BASE_URL}/checkout/recipient/${recipientAddress}`,
+        apiKey,
+    });
+    return res || [];
+}
+exports.getCheckoutsByRecipientAddress = getCheckoutsByRecipientAddress;
+async function getPaymasterDataForCheckoutSponsoredTransfer({ depositAddress, transferUserOp, apiKey, }) {
+    const body = {
+        depositAddress,
+        userOp: transferUserOp,
+    };
+    const res = await (0, utils_1.sendPostRequest)({
+        uri: `${consts_1.API_BASE_URL}/checkout/sponsorship`,
+        body,
+        apiKey,
+    });
+    if (!res) {
+        // TODO: Better error handling
+        throw new Error('Unable to get sponsorship information');
+    }
+    return res;
+}
+exports.getPaymasterDataForCheckoutSponsoredTransfer = getPaymasterDataForCheckoutSponsoredTransfer;
+//# sourceMappingURL=endpoints.js.map

package/dist/src/services/checkout/endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.js","sourceRoot":"","sources":["../../../../src/services/checkout/endpoints.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAwB;AAGxB,yCAA2C;AAC3C,yCAA+D;AAC/D,uCAKoB;AAepB;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,gBAAgB,CAAC,EACrC,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,eAAe,EACf,aAAa,EACb,qBAAqB,EACrB,8BAA8B,EAC9B,aAAa,EACb,WAAW,EACX,MAAM,GACc;IACpB,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,EAAE,IAAI,eAAe,CAAA;QACzC,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,WAAW,CAAC,CAAC,CAAA;QAC1E,MAAM,WAAW,GAAG;YAClB,WAAW;YACX,gBAAgB;YAChB,SAAS;YACT,cAAc;YACd,gBAAgB,EAAE,kBAAkB,CAAC,QAAQ,EAAE;YAC/C,0CAA0C;YAC1C,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,qGAAqG;YACrG,4IAA4I;YAC5I,mKAAmK;YACnK,kCAAkC,EAAE,IAAA,iCAAyB,EAC3D,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,qBAAqB,CAAC,GAAG,IAAI,CAAC,CACxD,CAAC,QAAQ,EAAE;YACZ,8BAA8B;YAC9B,MAAM,EAAE,WAAW,CAAC,QAAQ,EAAE;SACL,CAAA;QAE3B,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAA;QACrD,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAA,sBAAc,EAAC;YACrC,GAAG,EAAE,GAAG,qBAAY,mBAAmB,YAAY,EAAE;YACrD,MAAM;SACP,CAAC,CAA6B,CAAA;QAE/B,MAAM,aAAa,GAAG,EAAE,IAAI,iBAAiB,CAAA;QAC7C,yCAAyC;QACzC,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB;YAC3C,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,cAAc,EAAE,QAAQ,CAAC,cAAc;YACvC,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;YAC7C,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B;YAC/D,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B;YACrE,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB;YAC7D,eAAe;YACf,iBAAiB,EAAE,IAAI,gBAAG,CAAC,QAAQ,CAAC,yBAAyB,CAAC;iBAC3D,GAAG,CAAC,aAAa,CAAC;iBAClB,QAAQ,EAAE;YACb,qBAAqB,EAAE,IAAI,gBAAG,CAAC,QAAQ,CAAC,6BAA6B,CAAC;iBACnE,GAAG,CAAC,aAAa,CAAC;iBAClB,QAAQ,EAAE;YACb,kBAAkB,EAAE,IAAI,gBAAG,CAAC,QAAQ,CAAC,0BAA0B,CAAC;iBAC7D,GAAG,CAAC,aAAa,CAAC;iBAClB,QAAQ,EAAE;SACW,CAAA;IAC5B,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,yDAAyD,GAAG,CAAC,OAAO,EAAE,CACvE,CAAA;IACH,CAAC;AACH,CAAC;AArED,4CAqEC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EACN,OAAO,EACP,YAAY,EACZ,MAAM,EACN,cAAc,GACK;IACnB,MAAM,IAAI,GAAG;QACX,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7B,OAAO;QACP,YAAY;QACZ,IAAI,EAAE,IAAA,kCAA0B,GAAE;QAClC,cAAc;KACU,CAAA;IAC1B,MAAM,GAAG,GAAG,MAAM,IAAA,uBAAe,EAAC;QAChC,GAAG,EAAE,GAAG,qBAAY,WAAW;QAC/B,IAAI;QACJ,MAAM;KACP,CAAC,CAAA;IACF,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,CAAC;QACtB,MAAM,IAAI,8BAAqB,CAC7B,kBAAS,CAAC,+BAA+B,EACzC,+BAA+B,EAC/B,IAAI,EACJ,EAAE,EACF,sBAAsB,CACvB,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAC,WAAmC,CAAA;AAChD,CAAC;AA7BD,gDA6BC;AAED;;;;;GAKG;AACI,KAAK,UAAU,2BAA2B,CAAC,EAChD,cAAc,EACd,MAAM,GAIP;IACC,IAAI,CAAC;QACH,OAAO,MAAM,IAAA,sBAAc,EAAC;YAC1B,GAAG,EAAE,GAAG,qBAAY,aAAa,cAAc,EAAE;YACjD,MAAM;SACP,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,8BAAqB,EAAE,CAAC;YACzC,OAAO,IAAI,CAAA;QACb,CAAC;QACD,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAlBD,kEAkBC;AAED;;;;;GAKG;AACI,KAAK,UAAU,8BAA8B,CAAC,EACnD,gBAAgB,EAChB,MAAM,GAIP;IACC,MAAM,GAAG,GAAG,MAAM,IAAA,sBAAc,EAAC;QAC/B,GAAG,EAAE,GAAG,qBAAY,wBAAwB,gBAAgB,EAAE;QAC9D,MAAM;KACP,CAAC,CAAA;IACF,OAAO,GAAG,IAAI,EAAE,CAAA;AAClB,CAAC;AAZD,wEAYC;AAED;;;;;GAKG;AACI,KAAK,UAAU,8BAA8B,CAAC,EACnD,gBAAgB,EAChB,MAAM,GAIP;IACC,MAAM,GAAG,GAAG,MAAM,IAAA,sBAAc,EAAC;QAC/B,GAAG,EAAE,GAAG,qBAAY,uBAAuB,gBAAgB,EAAE;QAC7D,MAAM;KACP,CAAC,CAAA;IACF,OAAO,GAAG,IAAI,EAAE,CAAA;AAClB,CAAC;AAZD,wEAYC;AAEM,KAAK,UAAU,4CAA4C,CAAC,EACjE,cAAc,EACd,cAAc,EACd,MAAM,GAC4B;IAClC,MAAM,IAAI,GAAG;QACX,cAAc;QACd,MAAM,EAAE,cAAc;KACiB,CAAA;IACzC,MAAM,GAAG,GAAG,MAAM,IAAA,uBAAe,EAAC;QAChC,GAAG,EAAE,GAAG,qBAAY,uBAAuB;QAC3C,IAAI;QACJ,MAAM;KACP,CAAC,CAAA;IACF,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,8BAA8B;QAC9B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;IAC1D,CAAC;IACD,OAAO,GAA0C,CAAA;AACnD,CAAC;AAnBD,oGAmBC"}

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

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

package/dist/src/services/checkout/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./endpoints"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/services/checkout/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/checkout/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,0CAAuB"}