@coin-voyage/shared 0.0.11 → 0.0.12

package/dist/api/client.d.ts

@@ -0,0 +1,179 @@
+import { CurrencyWithBalance, PayOrder } from "../common/index";
+import { DepositPayOrderParams, PaymentDetails, PaymentDetailsParams, PayOrderQuoteParams, SalePayOrderParams } from "../types/api";
+import { APIEnvironment } from "./config";
+export declare class ApiClient {
+    private readonly apiKey;
+    private readonly environment?;
+    private readonly sessionId?;
+    private readonly version?;
+    constructor({ apiKey, sessionId, environment: env, version }: {
+        apiKey: string;
+        sessionId?: string;
+        environment?: APIEnvironment;
+        version?: string;
+    });
+    private request;
+    /**
+    * Fetches a PayOrder by its ID.
+    *
+    * Retrieves a PayOrder object from the API using the provided payOrderId.
+    * This function requires an API key for authentication.
+    *
+    * @param {string} payOrderId - The unique identifier of the PayOrder.
+    * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
+    *
+    * @example
+    * const payOrder = await getPayOrder('123456');
+    */
+    getPayOrder(payOrderId: string): Promise<PayOrder | undefined>;
+    /**
+    * Creates a `DEPOSIT` type PayOrder.
+    *
+    * Generates a PayOrder of type `DEPOSIT` with the provided parameters.
+    * This function ensures the request parameters are valid using a schema validation.
+    *
+    * @param {DepositPayOrderParams} params - Parameters required to create a deposit PayOrder.
+    * @param {boolean} [throwOnFailure] - Whether to throw an error if the request fails.
+    * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
+    *
+    * @example
+    * const apiKey = 'yourApiKey';
+    * const depositOrderParams = {
+    *   amount: 1000,
+    *   currency: 'USD',
+    *   metadata: { description: 'Deposit for account' }
+    * };
+    * const depositPayOrder = await createDepositPayOrder(depositOrderParams);
+    */
+    createDepositPayOrder(params: DepositPayOrderParams, throwOnFailure?: boolean): Promise<PayOrder | undefined>;
+    /**
+    * Generates a `sale` type PayOrder.
+    *
+    * Creates a `sale` type PayOrder with a fixed valueOut `destination_value_usd`.
+    * This function should be executed
+    *
+    * and a SHA-512 hash signature of the concatenated API key, secret, and timestamp.
+    *
+    * @param {SalePayOrderParams} params - destination_value_usd and metadata for this payOrder.
+    * @param {string} signature - signature generated by the `generateAuthorizationSignature` function.
+    * @returns {PayOrder | undefined} - A PayOrder object if the request was successful.
+    *
+    * @example
+    * const apiKey = 'yourApiKey';
+    * const apiSecret = 'yourApiSecret';
+    * const authSignature = generateAuthorizationSignature(apiKey, apiSecret);
+    * const payOrder = await createSalePayOrder(
+    * createSalePayOrder({
+    *  destination_value_usd: 200,
+    *  metadata: {
+    *    items: [
+    *     {
+    *       name: "t-shirt",
+    *       description: "a nice t-shirt",
+    *       image: "https://example.com/tshirt.jpg",
+    *       quantity: 1,
+    *       unit_price: 200,
+    *       currency: "USD"
+    *     }
+    *   ]
+    *  }}, authSignature)
+    */
+    createSalePayOrder(params: SalePayOrderParams, signature: string): Promise<PayOrder | undefined>;
+    /**
+   * Generates a PayOrder Quote.
+   *
+   * Creates a PayOrder Quote for an existing PayOrder by providing wallet information and chain details.
+   * This function requires an API key for authentication.
+   *
+   * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
+   * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, chain_id`.
+   * @returns {CurrencyWithBalance[] | undefined} - An array of PayTokens if the request was successful.
+   *
+   * @example
+   * const orderId = 'existingOrderId';
+   * const apiKey = 'yourApiKey';
+   * const quoteParams = {
+   *   wallet_address: '0x1234...abcd',
+   *   chain_type: ChainType.EVM,
+   *   chain_id: 1 // Ethereum Mainnet
+   * };
+   *
+   * const payOrderQuote = await payOrderQuote(orderId, quoteParams, apiKey);
+  
+   */
+    payOrderQuote(orderId: string, quoteParams: PayOrderQuoteParams): Promise<CurrencyWithBalance[] | undefined>;
+    /**
+  * Retrieves payment details for a specific PayOrder.
+  *
+  * This function fetches payment details associated with a specific PayOrder ID.
+  * It allows specifying the token and blockchain network (via `outTokenAddress` and `outChainId`)
+  * to retrieve source currency information, as well as a refund address for the transaction.
+  *
+  * The request is authenticated using the provided API key in the headers.
+  *
+  * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
+  * @param {string} params.payOrderId - The unique identifier of the PayOrder for which payment details are fetched.
+  * @param {string} [params.outTokenAddress] - (Optional) The token address of the source currency.
+  * @param {ChainId} params.outChainId - The blockchain network ID where the token resides.
+  * @param {string} params.refundAddress - The address where funds will be refunded in case of a failed transaction.
+  *
+  * @returns {Promise<PaymentDetails | undefined>} - The payment details object if the request is successful.
+  *
+  * @example
+  * const paymentDetails = await payOrderPaymentDetails({
+  *   payOrderId: '12345',
+  *   outTokenAddress: '0x1234567890abcdef1234567890abcdef12345678',
+  *   outChainId: 1,
+  *   refundAddress: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+  * });
+  *
+  * console.log(paymentDetails);
+  */
+    payOrderPaymentDetails(params: PaymentDetailsParams): Promise<PaymentDetails | undefined>;
+    /**
+    * Processes a PayOrder transaction.
+    *
+    * This function triggers the processing of a PayOrder by providing the transaction hash
+    * that represents the payment on the blockchain. The request is authenticated using an API key.
+    *
+    * @param {Object} params - Parameters required to process the PayOrder.
+    * @param {string} params.payOrderId - The unique identifier of the PayOrder to be processed.
+    * @param {string} params.sourceTransactionHash - The transaction hash representing the payment on the blockchain.
+    *
+    * @returns {Promise<void>}
+    *
+    * @example
+    * const processedPayment = await processPayOrder({
+    *   payOrderId: '12345',
+    *   sourceTransactionHash: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+    * });
+    *
+    * console.log(processedPayment);
+    */
+    processPayOrder(payOrderId: string, sourceTransactionHash: string): Promise<void>;
+    /**
+     * Generates an authorization signature for API requests.
+     *
+     * ⚠️ **Warning:** This function should only be run on the server.
+     * It uses the API secret, which must remain confidential. Running this
+     * code in a client-side environment risks exposing sensitive information
+     * to end users or malicious actors.
+     *
+     * This function creates a signed authorization string using the provided API key and secret.
+     * The generated string includes the API key, a timestamp (in seconds since epoch),
+     * and a SHA-512 hash signature of the concatenated API key, secret, and timestamp.
+     *
+     * @param {string} apiSecret - The API secret used to generate the signature.
+     * @returns {string} - A formatted authorization string in the format:
+     *                     `APIKey=<apiKey>,signature=<signature>,timestamp=<timestamp>`.
+     *
+     * @example
+     * const apiKey = 'yourApiKey';
+     * const apiSecret = 'yourApiSecret';
+     * const authSignature = generateAuthorizationSignature(apiKey, apiSecret);
+     * console.log(authSignature);
+     * // Example output:
+     * // APIKey=yourApiKey,signature=2ee76043a90a...,timestamp=1737106896
+     */
+    generateAuthorizationSignature(apiSecret: string): string;
+}

package/dist/api/client.js

@@ -0,0 +1,266 @@
+import { createHash } from "crypto";
+import { z } from "zod";
+import { PayOrderMode, zDepositPayOrder, zPayOrderMetadata } from "../common/index";
+import { API_URL } from "./config";
+import { fetchApi } from "./fetcher";
+export class ApiClient {
+    constructor({ apiKey, sessionId, environment: env = "production", version }) {
+        this.apiKey = apiKey;
+        this.environment = env;
+        this.sessionId = sessionId;
+        this.version = version;
+    }
+    async request(args) {
+        const baseUrl = API_URL[this.environment ?? "production"];
+        return fetchApi({
+            ...args,
+            path: `${baseUrl}/${args.path}`,
+            options: {
+                ...args.options,
+                headers: {
+                    ...args.options?.headers,
+                    "X-API-KEY": this.apiKey,
+                    ...this.sessionId ? { "X-Session-ID": this.sessionId } : {},
+                    ...this.version ? { "X-Client-Version": this.version } : {},
+                },
+            },
+            throwOnFailure: args.throwOnFailure,
+        });
+    }
+    /**
+    * Fetches a PayOrder by its ID.
+    *
+    * Retrieves a PayOrder object from the API using the provided payOrderId.
+    * This function requires an API key for authentication.
+    *
+    * @param {string} payOrderId - The unique identifier of the PayOrder.
+    * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
+    *
+    * @example
+    * const payOrder = await getPayOrder('123456');
+    */
+    async getPayOrder(payOrderId) {
+        return this.request({ path: `pay-orders/${payOrderId}` });
+    }
+    /**
+    * Creates a `DEPOSIT` type PayOrder.
+    *
+    * Generates a PayOrder of type `DEPOSIT` with the provided parameters.
+    * This function ensures the request parameters are valid using a schema validation.
+    *
+    * @param {DepositPayOrderParams} params - Parameters required to create a deposit PayOrder.
+    * @param {boolean} [throwOnFailure] - Whether to throw an error if the request fails.
+    * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
+    *
+    * @example
+    * const apiKey = 'yourApiKey';
+    * const depositOrderParams = {
+    *   amount: 1000,
+    *   currency: 'USD',
+    *   metadata: { description: 'Deposit for account' }
+    * };
+    * const depositPayOrder = await createDepositPayOrder(depositOrderParams);
+    */
+    async createDepositPayOrder(params, throwOnFailure) {
+        const result = zDepositPayOrder.safeParse(params);
+        if (!result.success)
+            return;
+        return this.request({
+            path: `pay-orders`,
+            options: {
+                method: "POST",
+                body: JSON.stringify({ mode: PayOrderMode.DEPOSIT, ...params }),
+            },
+            throwOnFailure: throwOnFailure,
+        });
+    }
+    /**
+    * Generates a `sale` type PayOrder.
+    *
+    * Creates a `sale` type PayOrder with a fixed valueOut `destination_value_usd`.
+    * This function should be executed
+    *
+    * and a SHA-512 hash signature of the concatenated API key, secret, and timestamp.
+    *
+    * @param {SalePayOrderParams} params - destination_value_usd and metadata for this payOrder.
+    * @param {string} signature - signature generated by the `generateAuthorizationSignature` function.
+    * @returns {PayOrder | undefined} - A PayOrder object if the request was successful.
+    *
+    * @example
+    * const apiKey = 'yourApiKey';
+    * const apiSecret = 'yourApiSecret';
+    * const authSignature = generateAuthorizationSignature(apiKey, apiSecret);
+    * const payOrder = await createSalePayOrder(
+    * createSalePayOrder({
+    *  destination_value_usd: 200,
+    *  metadata: {
+    *    items: [
+    *     {
+    *       name: "t-shirt",
+    *       description: "a nice t-shirt",
+    *       image: "https://example.com/tshirt.jpg",
+    *       quantity: 1,
+    *       unit_price: 200,
+    *       currency: "USD"
+    *     }
+    *   ]
+    *  }}, authSignature)
+    */
+    async createSalePayOrder(params, signature) {
+        try {
+            if (params.metadata)
+                zPayOrderMetadata.parse(params.metadata);
+            return this.request({
+                path: "pay-orders", options: {
+                    method: "POST",
+                    body: JSON.stringify({ mode: PayOrderMode.SALE, ...params }),
+                    headers: { Authorization: signature },
+                },
+            }); // Ensure the API key is set in the headers
+        }
+        catch (err) {
+            if (err instanceof z.ZodError) {
+                throw new Error(err.errors.map(e => e.message).join(", "));
+            }
+            throw err;
+        }
+    }
+    /**
+   * Generates a PayOrder Quote.
+   *
+   * Creates a PayOrder Quote for an existing PayOrder by providing wallet information and chain details.
+   * This function requires an API key for authentication.
+   *
+   * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
+   * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, chain_id`.
+   * @returns {CurrencyWithBalance[] | undefined} - An array of PayTokens if the request was successful.
+   *
+   * @example
+   * const orderId = 'existingOrderId';
+   * const apiKey = 'yourApiKey';
+   * const quoteParams = {
+   *   wallet_address: '0x1234...abcd',
+   *   chain_type: ChainType.EVM,
+   *   chain_id: 1 // Ethereum Mainnet
+   * };
+   *
+   * const payOrderQuote = await payOrderQuote(orderId, quoteParams, apiKey);
+  
+   */
+    async payOrderQuote(orderId, quoteParams) {
+        return this.request({
+            path: `pay-orders/${orderId}/quote`,
+            options: {
+                method: "POST",
+                body: JSON.stringify(quoteParams),
+            },
+        });
+    }
+    /**
+  * Retrieves payment details for a specific PayOrder.
+  *
+  * This function fetches payment details associated with a specific PayOrder ID.
+  * It allows specifying the token and blockchain network (via `outTokenAddress` and `outChainId`)
+  * to retrieve source currency information, as well as a refund address for the transaction.
+  *
+  * The request is authenticated using the provided API key in the headers.
+  *
+  * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
+  * @param {string} params.payOrderId - The unique identifier of the PayOrder for which payment details are fetched.
+  * @param {string} [params.outTokenAddress] - (Optional) The token address of the source currency.
+  * @param {ChainId} params.outChainId - The blockchain network ID where the token resides.
+  * @param {string} params.refundAddress - The address where funds will be refunded in case of a failed transaction.
+  *
+  * @returns {Promise<PaymentDetails | undefined>} - The payment details object if the request is successful.
+  *
+  * @example
+  * const paymentDetails = await payOrderPaymentDetails({
+  *   payOrderId: '12345',
+  *   outTokenAddress: '0x1234567890abcdef1234567890abcdef12345678',
+  *   outChainId: 1,
+  *   refundAddress: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+  * });
+  *
+  * console.log(paymentDetails);
+  */
+    async payOrderPaymentDetails(params) {
+        const { payOrderId, outTokenAddress, outChainId, refundAddress } = params;
+        return this.request({
+            path: `pay-orders/${payOrderId}/payment-details`,
+            options: {
+                method: "POST",
+                body: JSON.stringify({
+                    source_currency: {
+                        address: outTokenAddress,
+                        chain_id: outChainId,
+                    },
+                    refund_address: refundAddress,
+                }),
+            },
+        });
+    }
+    /**
+    * Processes a PayOrder transaction.
+    *
+    * This function triggers the processing of a PayOrder by providing the transaction hash
+    * that represents the payment on the blockchain. The request is authenticated using an API key.
+    *
+    * @param {Object} params - Parameters required to process the PayOrder.
+    * @param {string} params.payOrderId - The unique identifier of the PayOrder to be processed.
+    * @param {string} params.sourceTransactionHash - The transaction hash representing the payment on the blockchain.
+    *
+    * @returns {Promise<void>}
+    *
+    * @example
+    * const processedPayment = await processPayOrder({
+    *   payOrderId: '12345',
+    *   sourceTransactionHash: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
+    * });
+    *
+    * console.log(processedPayment);
+    */
+    async processPayOrder(payOrderId, sourceTransactionHash) {
+        return this.request({
+            path: `pay-orders/${payOrderId}/process?tx_hash=${sourceTransactionHash}`,
+            options: { method: "GET" },
+        });
+    }
+    /**
+     * Generates an authorization signature for API requests.
+     *
+     * ⚠️ **Warning:** This function should only be run on the server.
+     * It uses the API secret, which must remain confidential. Running this
+     * code in a client-side environment risks exposing sensitive information
+     * to end users or malicious actors.
+     *
+     * This function creates a signed authorization string using the provided API key and secret.
+     * The generated string includes the API key, a timestamp (in seconds since epoch),
+     * and a SHA-512 hash signature of the concatenated API key, secret, and timestamp.
+     *
+     * @param {string} apiSecret - The API secret used to generate the signature.
+     * @returns {string} - A formatted authorization string in the format:
+     *                     `APIKey=<apiKey>,signature=<signature>,timestamp=<timestamp>`.
+     *
+     * @example
+     * const apiKey = 'yourApiKey';
+     * const apiSecret = 'yourApiSecret';
+     * const authSignature = generateAuthorizationSignature(apiKey, apiSecret);
+     * console.log(authSignature);
+     * // Example output:
+     * // APIKey=yourApiKey,signature=2ee76043a90a...,timestamp=1737106896
+     */
+    generateAuthorizationSignature(apiSecret) {
+        // Get the current timestamp as a string
+        const timestamp = Math.floor(Date.now() / 1000).toString();
+        // Create the data string
+        const data = this.apiKey + apiSecret + timestamp;
+        // Create a SHA-512 hash of the data
+        const hash = createHash('sha512');
+        hash.update(data);
+        // Encode the hash as a hexadecimal string
+        const signature = hash.digest('hex');
+        // Format the final string
+        return `APIKey=${this.apiKey},signature=${signature},timestamp=${timestamp}`;
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/api/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAiC,YAAY,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEnH,OAAO,EAAE,OAAO,EAAkB,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,MAAM,OAAO,SAAS;IAMpB,YAAY,EACV,MAAM,EACN,SAAS,EACT,WAAW,EAAE,GAAG,GAAG,YAAY,EAC/B,OAAO,EAMR;QACC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC;QACvB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,OAAO,CAAI,IAAuC;QAC9D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,IAAI,YAAY,CAAC,CAAC;QAC1D,OAAO,QAAQ,CAAI;YACjB,GAAG,IAAI;YACP,IAAI,EAAE,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE;YAC/B,OAAO,EAAE;gBACP,GAAG,IAAI,CAAC,OAAO;gBACf,OAAO,EAAE;oBACP,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO;oBACxB,WAAW,EAAE,IAAI,CAAC,MAAM;oBACxB,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE;oBAC3D,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,kBAAkB,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;iBAC5D;aACF;YACD,cAAc,EAAE,IAAI,CAAC,cAAc;SACpC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;MAWE;IACF,KAAK,CAAC,WAAW,CAAC,UAAkB;QAClC,OAAO,IAAI,CAAC,OAAO,CAAW,EAAE,IAAI,EAAE,cAAc,UAAU,EAAE,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;MAkBE;IACF,KAAK,CAAC,qBAAqB,CAAC,MAA6B,EAAE,cAAwB;QACjF,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,OAAO;QAE5B,OAAO,IAAI,CAAC,OAAO,CAAW;YAC5B,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE;gBACP,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,GAAG,MAAM,EAAE,CAAC;aAChE;YACD,cAAc,EAAE,cAAc;SAC/B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA+BE;IACF,KAAK,CAAC,kBAAkB,CAAC,MAA0B,EAAE,SAAiB;QACpE,IAAI,CAAC;YACH,IAAI,MAAM,CAAC,QAAQ;gBAAE,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAE9D,OAAO,IAAI,CAAC,OAAO,CAAW;gBAC5B,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE;oBAC3B,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC;oBAC5D,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,EAAE;iBACtC;aACF,CAAC,CAAC,CAAC,2CAA2C;QACjD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;gBAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;KAqBC;IACD,KAAK,CAAC,aAAa,CAAC,OAAe,EAAE,WAAgC;QACnE,OAAO,IAAI,CAAC,OAAO,CAAwB;YACzC,IAAI,EAAE,cAAc,OAAO,QAAQ;YACnC,OAAO,EAAE;gBACP,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;IA0BA;IACA,KAAK,CAAC,sBAAsB,CAAC,MAA4B;QACvD,MAAM,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAiB;YAClC,IAAI,EAAE,cAAc,UAAU,kBAAkB;YAChD,OAAO,EAAE;gBACP,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,eAAe,EAAE;wBACf,OAAO,EAAE,eAAe;wBACxB,QAAQ,EAAE,UAAU;qBACrB;oBACD,cAAc,EAAE,aAAa;iBAC9B,CAAC;aACH;SACF,CAAC,CAAC;IACL,CAAC;IAGD;;;;;;;;;;;;;;;;;;;MAmBE;IACF,KAAK,CAAC,eAAe,CAAC,UAAkB,EAAE,qBAA6B;QACrE,OAAO,IAAI,CAAC,OAAO,CAAO;YACxB,IAAI,EAAE,cAAc,UAAU,oBAAoB,qBAAqB,EAAE;YACzE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,8BAA8B,CAAC,SAAiB;QAC9C,wCAAwC;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;QAE3D,yBAAyB;QACzB,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;QAEjD,oCAAoC;QACpC,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAElB,0CAA0C;QAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAErC,0BAA0B;QAC1B,OAAO,UAAU,IAAI,CAAC,MAAM,cAAc,SAAS,cAAc,SAAS,EAAE,CAAC;IAC/E,CAAC;CACF"}

package/dist/api/config.d.ts

@@ -1 +1,2 @@
-export declare const API_URL = "https://api.coinvoyage.io";
+export declare const API_URL: Record<string, string>;
+export type APIEnvironment = keyof typeof API_URL;

package/dist/api/config.js

@@ -1,2 +1,5 @@
-export const API_URL = "https://api.coinvoyage.io";
+export const API_URL = {
+    "development": "https://acc-api.coinvoyage.io",
+    "production": "https://api.coinvoyage.io"
+};
 //# sourceMappingURL=config.js.map

package/dist/api/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/api/config.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,2BAA2B,CAAA"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/api/config.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAA2B;IAC3C,aAAa,EAAE,+BAA+B;IAC9C,YAAY,EAAE,2BAA2B;CAC5C,CAAA"}

package/dist/api/fetcher.js

@@ -1,7 +1,6 @@
-import { API_URL } from "./config";
 export async function fetchApi(opts) {
     try {
-        const response = await fetch(`${API_URL}/${opts.path}`, {
+        const response = await fetch(opts.path, {
             ...opts.options,
             headers: {
                 ...opts.options?.headers,

package/dist/api/fetcher.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetcher.js","sourceRoot":"","sources":["../../src/api/fetcher.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAQnC,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,IAAqB;IACnD,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE;YACpD,GAAG,IAAI,CAAC,OAAO;YACf,OAAO,EAAE;gBACL,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO;gBACxB,cAAc,EAAE,kBAAkB;gBAClC,iBAAiB,EAAE,mBAAmB;aACzC;SACJ,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CACT,IAAI,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,IAAI;aAChB,CAAC,CACL,CAAC;YACF,OAAO;QACX,CAAC;QACD,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,cAAc,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;AACL,CAAC"}
+{"version":3,"file":"fetcher.js","sourceRoot":"","sources":["../../src/api/fetcher.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAI,IAAqB;IACnD,IAAI,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;YACpC,GAAG,IAAI,CAAC,OAAO;YACf,OAAO,EAAE;gBACL,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO;gBACxB,cAAc,EAAE,kBAAkB;gBAClC,iBAAiB,EAAE,mBAAmB;aACzC;SACJ,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,OAAO,CAAC,KAAK,CACT,IAAI,CAAC,SAAS,CAAC;gBACX,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,IAAI;aAChB,CAAC,CACL,CAAC;YACF,OAAO;QACX,CAAC;QACD,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACjC,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,cAAc,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/api/index.d.ts

@@ -1,3 +1,3 @@
+export * from "./client";
 export * from "./config";
 export * from "./fetcher";
-export * from "./pay-order";

package/dist/api/index.js

@@ -1,4 +1,4 @@
+export * from "./client";
 export * from "./config";
 export * from "./fetcher";
-export * from "./pay-order";
 //# sourceMappingURL=index.js.map

package/dist/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA"}

package/dist/types/api.d.ts

@@ -0,0 +1,82 @@
+import { PayOrderMetadata, CurrencyBase, ChainType, ChainId, PayOrderStatus, CurrencyWithAmount, CurrencyAmount } from "../common";
+/** PayOrder parameters. The payOrder is created only after user taps pay. */
+export interface DepositPayOrderParams {
+    /**
+     * Metadata to attach to the payOrder.
+     */
+    metadata?: PayOrderMetadata;
+    /**
+     * Value in USD received from the Deposit.
+     */
+    destination_value_usd?: number;
+    /**
+     * Desired output token + chain.
+     */
+    destination_currency: CurrencyBase;
+    /**
+     * Output amount to deposit in human readable format (e.g. "10" for 10 tokens).
+     */
+    destination_amount?: string;
+    /**
+     * Receiving address for the deposit.
+     */
+    receiving_address: string;
+}
+export type SalePayOrderParams = {
+    /**
+     * Metadata to attach to the payOrder.
+     */
+    metadata?: PayOrderMetadata;
+    /**
+     * Expected value in USD to be received from the Sale.
+     */
+    destination_value_usd: number;
+    /**
+     * Expected token on what chain to receive the value from the Sale.
+     */
+    destination_currency?: CurrencyBase;
+    /**
+     * Expected receiving address to receive the value from the Sale.
+     */
+    receiving_address?: string;
+} | {
+    /**
+     * Metadata to attach to the payOrder.
+     */
+    metadata?: PayOrderMetadata;
+    /**
+     * Expected token on what chain to receive the value from the Sale.
+     */
+    destination_currency: CurrencyBase;
+    /**
+     * Expected amount to be received from the Sale.
+     */
+    destination_amount: string;
+    /**
+     * Expected receiving address to receive the value from the Sale.
+     */
+    receiving_address?: string;
+};
+export type PayOrderQuoteParams = {
+    wallet_address: string;
+    chain_type: ChainType;
+    chain_id?: ChainId;
+};
+export type PaymentDetailsParams = {
+    payOrderId: string;
+    outTokenAddress?: string;
+    outChainId: ChainId;
+    refundAddress: string;
+};
+export type PaymentDetails = {
+    payorder_id: string;
+    status: PayOrderStatus;
+    expires_at: Date;
+    refund_address: string;
+    deposit_address: string;
+    receiving_address?: string;
+    source_currency: CurrencyWithAmount;
+    source_amount: CurrencyAmount;
+    destination_currency?: CurrencyWithAmount;
+    destination_amount?: CurrencyAmount;
+};

package/dist/types/api.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=api.js.map

package/dist/types/api.js.map

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coin-voyage/shared",
   "description": "Shared utilities for Coin Voyage",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "private": false,
   "sideEffects": false,
   "exports": {
@@ -30,7 +30,6 @@
     "build": "tsc --build --force",
     "clean": "rm -rf dist tsconfig.tsbuildinfo",
     "release:build": "pnpm clean && pnpm build",
-    "pre:release": "pnpm version prerelease --preid=beta",
     "type-check": "tsc --noEmit",
     "test": "vitest run"
   }

package/dist/api/pay-order.d.ts

@@ -1,233 +0,0 @@
-import { ChainId, ChainType, CurrencyAmount, CurrencyBase, CurrencyWithAmount, CurrencyWithBalance, PayOrder, PayOrderMetadata, PayOrderStatus } from "../common/index";
-/**
- * Fetches a PayOrder by its ID.
- *
- * Retrieves a PayOrder object from the API using the provided payOrderId.
- * This function requires an API key for authentication.
- *
- * @param {string} payOrderId - The unique identifier of the PayOrder.
- * @param {string} apiKey - The API key required for authentication.
- * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
- *
- * @example
- * const apiKey = 'yourApiKey';
- * const payOrder = await getPayOrder('123456', apiKey);
- */
-export declare function getPayOrder(payOrderId: string, apiKey: string): Promise<PayOrder | undefined>;
-/** PayOrder parameters. The payOrder is created only after user taps pay. */
-export interface DepositPayOrderParams {
-    /**
-     * Metadata to attach to the payOrder.
-     */
-    metadata?: PayOrderMetadata;
-    /**
-     * Value in USD received from the Deposit.
-     */
-    destination_value_usd?: number;
-    /**
-     * Desired output token + chain.
-     */
-    destination_currency: CurrencyBase;
-    /**
-     * Output amount to deposit in human readable format (e.g. "10" for 10 tokens).
-     */
-    destination_amount?: string;
-    /**
-     * Receiving address for the deposit.
-     */
-    receiving_address: string;
-}
-/**
- * Creates a `DEPOSIT` type PayOrder.
- *
- * Generates a PayOrder of type `DEPOSIT` with the provided parameters.
- * This function ensures the request parameters are valid using a schema validation.
- *
- * @param {DepositPayOrderParams} createOrderParams - Parameters required to create a deposit PayOrder.
- * @param {string} apiKey - The API key required for authentication.
- * @param {boolean} [throwOnFailure] - Whether to throw an error if the request fails.
- * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
- *
- * @example
- * const apiKey = 'yourApiKey';
- * const depositOrderParams = {
- *   amount: 1000,
- *   currency: 'USD',
- *   metadata: { description: 'Deposit for account' }
- * };
- * const depositPayOrder = await createDepositPayOrder(depositOrderParams, apiKey);
- */
-export declare function createDepositPayOrder(createOrderParams: DepositPayOrderParams, apiKey: string, throwOnFailure?: boolean): Promise<PayOrder | undefined>;
-export type SalePayOrderParams = {
-    /**
-     * Metadata to attach to the payOrder.
-     */
-    metadata?: PayOrderMetadata;
-    /**
-     * Expected value in USD to be received from the Sale.
-     */
-    destination_value_usd: number;
-    /**
-     * Expected token on what chain to receive the value from the Sale.
-     */
-    destination_currency?: CurrencyBase;
-    /**
-     * Expected receiving address to receive the value from the Sale.
-     */
-    receiving_address?: string;
-} | {
-    /**
-     * Metadata to attach to the payOrder.
-     */
-    metadata?: PayOrderMetadata;
-    /**
-     * Expected token on what chain to receive the value from the Sale.
-     */
-    destination_currency: CurrencyBase;
-    /**
-     * Expected amount to be received from the Sale.
-     */
-    destination_amount: string;
-    /**
-     * Expected receiving address to receive the value from the Sale.
-     */
-    receiving_address?: string;
-};
-/**
- * Generates a `sale` type PayOrder.
- *
- * Creates a `sale` type PayOrder with a fixed valueOut `destination_value_usd`.
- * This function should be executed
- *
- * and a SHA-512 hash signature of the concatenated API key, secret, and timestamp.
- *
- * @param {SalePayOrderParams} payOrderParams - destination_value_usd and metadata for this payOrder.
- * @param {string} signature - signature generated by the `generateAuthorizationSignature` function.
- * @returns {PayOrder | undefined} - A PayOrder object if the request was successful.
- *
- * @example
- * const apiKey = 'yourApiKey';
- * const apiSecret = 'yourApiSecret';
- * const authSignature = generateAuthorizationSignature(apiKey, apiSecret);
- * const payOrder = await createSalePayOrder(
- * createSalePayOrder({
- *  destination_value_usd: 200,
- *  metadata: {
- *    items: [
- *     {
- *       name: "t-shirt",
- *       description: "a nice t-shirt",
- *       image: "https://example.com/tshirt.jpg",
- *       quantity: 1,
- *       unit_price: 200,
- *       currency: "USD"
- *     }
- *   ]
- *  }}, authSignature)
- */
-export declare function createSalePayOrder(createOrderParams: SalePayOrderParams, signature: string): Promise<PayOrder | undefined>;
-export type PayOrderQuoteParams = {
-    wallet_address: string;
-    chain_type: ChainType;
-    chain_id?: ChainId;
-};
-/**
- * Generates a PayOrder Quote.
- *
- * Creates a PayOrder Quote for an existing PayOrder by providing wallet information and chain details.
- * This function requires an API key for authentication.
- *
- * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
- * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, chain_id`.
- * @param {string} apiKey - The API key for authorization.
- * @returns {CurrencyWithBalance[] | undefined} - An array of PayTokens if the request was successful.
- *
- * @example
- * const orderId = 'existingOrderId';
- * const apiKey = 'yourApiKey';
- * const quoteParams = {
- *   wallet_address: '0x1234...abcd',
- *   chain_type: ChainType.EVM,
- *   chain_id: 1 // Ethereum Mainnet
- * };
- *
- * const payOrderQuote = await payOrderQuote(orderId, quoteParams, apiKey);
-
- */
-export declare function payOrderQuote(orderId: string, quoteParams: PayOrderQuoteParams, apiKey: string): Promise<CurrencyWithBalance[] | undefined>;
-export type PaymentDetailsParams = {
-    payOrderId: string;
-    outTokenAddress?: string;
-    outChainId: ChainId;
-    refundAddress: string;
-    apiKey: string;
-};
-export type PaymentDetails = {
-    payorder_id: string;
-    status: PayOrderStatus;
-    expires_at: Date;
-    refund_address: string;
-    deposit_address: string;
-    receiving_address?: string;
-    source_currency: CurrencyWithAmount;
-    source_amount: CurrencyAmount;
-    destination_currency?: CurrencyWithAmount;
-    destination_amount?: CurrencyAmount;
-};
-/**
- * Retrieves payment details for a specific PayOrder.
- *
- * This function fetches payment details associated with a specific PayOrder ID.
- * It allows specifying the token and blockchain network (via `outTokenAddress` and `outChainId`)
- * to retrieve source currency information, as well as a refund address for the transaction.
- *
- * The request is authenticated using the provided API key in the headers.
- *
- * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
- * @param {string} params.payOrderId - The unique identifier of the PayOrder for which payment details are fetched.
- * @param {string} [params.outTokenAddress] - (Optional) The token address of the source currency.
- * @param {ChainId} params.outChainId - The blockchain network ID where the token resides.
- * @param {string} params.refundAddress - The address where funds will be refunded in case of a failed transaction.
- * @param {string} params.apiKey - The API key used to authenticate the request.
- *
- * @returns {Promise<PaymentDetails | undefined>} - The payment details object if the request is successful.
- *
- * @example
- * const paymentDetails = await payOrderPaymentDetails({
- *   payOrderId: '12345',
- *   outTokenAddress: '0x1234567890abcdef1234567890abcdef12345678',
- *   outChainId: 1,
- *   refundAddress: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
- *   apiKey: 'yourApiKey'
- * });
- *
- * console.log(paymentDetails);
- */
-export declare function payOrderPaymentDetails({ payOrderId, outTokenAddress, outChainId, refundAddress, apiKey }: PaymentDetailsParams): Promise<PaymentDetails | undefined>;
-/**
- * Processes a PayOrder transaction.
- *
- * This function triggers the processing of a PayOrder by providing the transaction hash
- * that represents the payment on the blockchain. The request is authenticated using an API key.
- *
- * @param {Object} params - Parameters required to process the PayOrder.
- * @param {string} params.payOrderId - The unique identifier of the PayOrder to be processed.
- * @param {string} params.sourceTransactionHash - The transaction hash representing the payment on the blockchain.
- * @param {string} params.apiKey - The API key used to authenticate the request.
- *
- * @returns {Promise<void>}
- *
- * @example
- * const processedPayment = await processPayOrder({
- *   payOrderId: '12345',
- *   sourceTransactionHash: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
- *   apiKey: 'yourApiKey'
- * });
- *
- * console.log(processedPayment);
- */
-export declare function processPayOrder({ payOrderId, sourceTransactionHash, apiKey }: {
-    payOrderId: string;
-    sourceTransactionHash: string;
-    apiKey: string;
-}): Promise<void>;

package/dist/api/pay-order.js

@@ -1,238 +0,0 @@
-import { z } from "zod";
-import { PayOrderMode, zDepositPayOrder, zPayOrderMetadata } from "../common/index";
-import { fetchApi } from "./fetcher";
-/**
- * Fetches a PayOrder by its ID.
- *
- * Retrieves a PayOrder object from the API using the provided payOrderId.
- * This function requires an API key for authentication.
- *
- * @param {string} payOrderId - The unique identifier of the PayOrder.
- * @param {string} apiKey - The API key required for authentication.
- * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
- *
- * @example
- * const apiKey = 'yourApiKey';
- * const payOrder = await getPayOrder('123456', apiKey);
- */
-export async function getPayOrder(payOrderId, apiKey) {
-    return fetchApi({
-        path: `pay-orders/${payOrderId}`,
-        options: {
-            headers: {
-                "X-API-KEY": apiKey
-            }
-        }
-    });
-}
-/**
- * Creates a `DEPOSIT` type PayOrder.
- *
- * Generates a PayOrder of type `DEPOSIT` with the provided parameters.
- * This function ensures the request parameters are valid using a schema validation.
- *
- * @param {DepositPayOrderParams} createOrderParams - Parameters required to create a deposit PayOrder.
- * @param {string} apiKey - The API key required for authentication.
- * @param {boolean} [throwOnFailure] - Whether to throw an error if the request fails.
- * @returns {Promise<PayOrder | undefined>} - The PayOrder object if the request is successful.
- *
- * @example
- * const apiKey = 'yourApiKey';
- * const depositOrderParams = {
- *   amount: 1000,
- *   currency: 'USD',
- *   metadata: { description: 'Deposit for account' }
- * };
- * const depositPayOrder = await createDepositPayOrder(depositOrderParams, apiKey);
- */
-export async function createDepositPayOrder(createOrderParams, apiKey, throwOnFailure) {
-    const result = zDepositPayOrder.safeParse(createOrderParams);
-    if (result.error) {
-        return;
-    }
-    return fetchApi({
-        path: `pay-orders`, options: {
-            method: "POST",
-            body: JSON.stringify({
-                mode: PayOrderMode.DEPOSIT,
-                ...createOrderParams
-            }),
-            headers: {
-                "X-API-KEY": apiKey
-            }
-        },
-        throwOnFailure: throwOnFailure
-    });
-}
-/**
- * Generates a `sale` type PayOrder.
- *
- * Creates a `sale` type PayOrder with a fixed valueOut `destination_value_usd`.
- * This function should be executed
- *
- * and a SHA-512 hash signature of the concatenated API key, secret, and timestamp.
- *
- * @param {SalePayOrderParams} payOrderParams - destination_value_usd and metadata for this payOrder.
- * @param {string} signature - signature generated by the `generateAuthorizationSignature` function.
- * @returns {PayOrder | undefined} - A PayOrder object if the request was successful.
- *
- * @example
- * const apiKey = 'yourApiKey';
- * const apiSecret = 'yourApiSecret';
- * const authSignature = generateAuthorizationSignature(apiKey, apiSecret);
- * const payOrder = await createSalePayOrder(
- * createSalePayOrder({
- *  destination_value_usd: 200,
- *  metadata: {
- *    items: [
- *     {
- *       name: "t-shirt",
- *       description: "a nice t-shirt",
- *       image: "https://example.com/tshirt.jpg",
- *       quantity: 1,
- *       unit_price: 200,
- *       currency: "USD"
- *     }
- *   ]
- *  }}, authSignature)
- */
-export async function createSalePayOrder(createOrderParams, signature) {
-    try {
-        if (createOrderParams?.metadata) {
-            zPayOrderMetadata.parse(createOrderParams.metadata);
-        }
-        return fetchApi({
-            path: `pay-orders`, options: {
-                method: "POST",
-                body: JSON.stringify({
-                    mode: PayOrderMode.SALE,
-                    ...createOrderParams
-                }),
-                headers: {
-                    "Authorization": signature
-                }
-            }
-        });
-    }
-    catch (err) {
-        if (err instanceof z.ZodError) {
-            throw new Error(err.errors.map(e => e.message).join(", "));
-        }
-        throw err;
-    }
-}
-/**
- * Generates a PayOrder Quote.
- *
- * Creates a PayOrder Quote for an existing PayOrder by providing wallet information and chain details.
- * This function requires an API key for authentication.
- *
- * @param {string} orderId - The unique identifier of the PayOrder for which the quote is requested.
- * @param {PayOrderQuoteParams} quoteParams - Contains `wallet_address`, `chain_type`, chain_id`.
- * @param {string} apiKey - The API key for authorization.
- * @returns {CurrencyWithBalance[] | undefined} - An array of PayTokens if the request was successful.
- *
- * @example
- * const orderId = 'existingOrderId';
- * const apiKey = 'yourApiKey';
- * const quoteParams = {
- *   wallet_address: '0x1234...abcd',
- *   chain_type: ChainType.EVM,
- *   chain_id: 1 // Ethereum Mainnet
- * };
- *
- * const payOrderQuote = await payOrderQuote(orderId, quoteParams, apiKey);
-
- */
-export async function payOrderQuote(orderId, quoteParams, apiKey) {
-    return fetchApi({
-        path: `pay-orders/${orderId}/quote`, options: {
-            method: "POST",
-            body: JSON.stringify({
-                ...quoteParams
-            }),
-            headers: {
-                "X-API-KEY": apiKey
-            },
-        }
-    });
-}
-/**
- * Retrieves payment details for a specific PayOrder.
- *
- * This function fetches payment details associated with a specific PayOrder ID.
- * It allows specifying the token and blockchain network (via `outTokenAddress` and `outChainId`)
- * to retrieve source currency information, as well as a refund address for the transaction.
- *
- * The request is authenticated using the provided API key in the headers.
- *
- * @param {PaymentDetailsParams} params - Parameters to retrieve the payment details.
- * @param {string} params.payOrderId - The unique identifier of the PayOrder for which payment details are fetched.
- * @param {string} [params.outTokenAddress] - (Optional) The token address of the source currency.
- * @param {ChainId} params.outChainId - The blockchain network ID where the token resides.
- * @param {string} params.refundAddress - The address where funds will be refunded in case of a failed transaction.
- * @param {string} params.apiKey - The API key used to authenticate the request.
- *
- * @returns {Promise<PaymentDetails | undefined>} - The payment details object if the request is successful.
- *
- * @example
- * const paymentDetails = await payOrderPaymentDetails({
- *   payOrderId: '12345',
- *   outTokenAddress: '0x1234567890abcdef1234567890abcdef12345678',
- *   outChainId: 1,
- *   refundAddress: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
- *   apiKey: 'yourApiKey'
- * });
- *
- * console.log(paymentDetails);
- */
-export async function payOrderPaymentDetails({ payOrderId, outTokenAddress, outChainId, refundAddress, apiKey }) {
-    return fetchApi({
-        path: `pay-orders/${payOrderId}/payment-details`, options: {
-            method: "POST",
-            body: JSON.stringify({
-                source_currency: {
-                    address: outTokenAddress,
-                    chain_id: outChainId
-                },
-                refund_address: refundAddress
-            }),
-            headers: {
-                "X-API-KEY": apiKey
-            },
-        }
-    });
-}
-/**
- * Processes a PayOrder transaction.
- *
- * This function triggers the processing of a PayOrder by providing the transaction hash
- * that represents the payment on the blockchain. The request is authenticated using an API key.
- *
- * @param {Object} params - Parameters required to process the PayOrder.
- * @param {string} params.payOrderId - The unique identifier of the PayOrder to be processed.
- * @param {string} params.sourceTransactionHash - The transaction hash representing the payment on the blockchain.
- * @param {string} params.apiKey - The API key used to authenticate the request.
- *
- * @returns {Promise<void>}
- *
- * @example
- * const processedPayment = await processPayOrder({
- *   payOrderId: '12345',
- *   sourceTransactionHash: '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd',
- *   apiKey: 'yourApiKey'
- * });
- *
- * console.log(processedPayment);
- */
-export async function processPayOrder({ payOrderId, sourceTransactionHash, apiKey }) {
-    return fetchApi({
-        path: `pay-orders/${payOrderId}/process?tx_hash=${sourceTransactionHash}`, options: {
-            method: "GET",
-            headers: {
-                "X-API-KEY": apiKey
-            },
-        }
-    });
-}
-//# sourceMappingURL=pay-order.js.map

package/dist/api/pay-order.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"pay-order.js","sourceRoot":"","sources":["../../src/api/pay-order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAyH,YAAY,EAAkB,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC3N,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,UAAkB,EAAE,MAAc;IAClE,OAAO,QAAQ,CAAW;QACxB,IAAI,EAAE,cAAc,UAAU,EAAE;QAChC,OAAO,EAAE;YACP,OAAO,EAAE;gBACP,WAAW,EAAE,MAAM;aACpB;SACF;KACF,CAAC,CAAA;AACJ,CAAC;AA0BD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,iBAAwC,EAAE,MAAc,EAAE,cAAwB;IAC5H,MAAM,MAAM,GAAG,gBAAgB,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC7D,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAM;IACR,CAAC;IAED,OAAO,QAAQ,CAAW;QACxB,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE;YAC3B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,IAAI,EAAE,YAAY,CAAC,OAAO;gBAC1B,GAAG,iBAAiB;aACrB,CAAC;YACF,OAAO,EAAE;gBACP,WAAW,EAAE,MAAM;aACpB;SACF;QACD,cAAc,EAAE,cAAc;KAC/B,CAAC,CAAA;AACJ,CAAC;AAuCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,iBAAqC,EAAE,SAAiB;IAC/F,IAAI,CAAC;QACH,IAAI,iBAAiB,EAAE,QAAQ,EAAE,CAAC;YAChC,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QACtD,CAAC;QACD,OAAO,QAAQ,CAAW;YACxB,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE;gBAC3B,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;oBACnB,IAAI,EAAE,YAAY,CAAC,IAAI;oBACvB,GAAG,iBAAiB;iBACrB,CAAC;gBACF,OAAO,EAAE;oBACP,eAAe,EAAE,SAAS;iBAC3B;aACF;SACF,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,IAAI,GAAG,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;QAC5D,CAAC;QACD,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAQD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAe,EAAE,WAAgC,EAAE,MAAc;IACnG,OAAO,QAAQ,CAAwB;QACrC,IAAI,EAAE,cAAc,OAAO,QAAQ,EAAE,OAAO,EAAE;YAC5C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,GAAG,WAAW;aACf,CAAC;YACF,OAAO,EAAE;gBACP,WAAW,EAAE,MAAM;aACpB;SACF;KACF,CAAC,CAAA;AACJ,CAAC;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,EAC3C,UAAU,EACV,eAAe,EACf,UAAU,EACV,aAAa,EACb,MAAM,EACe;IACrB,OAAO,QAAQ,CAAiB;QAC9B,IAAI,EAAE,cAAc,UAAU,kBAAkB,EAAE,OAAO,EAAE;YACzD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,eAAe,EAAE;oBACf,OAAO,EAAE,eAAe;oBACxB,QAAQ,EAAE,UAAU;iBACrB;gBACD,cAAc,EAAE,aAAa;aAC9B,CAAC;YACF,OAAO,EAAE;gBACP,WAAW,EAAE,MAAM;aACpB;SACF;KACF,CAAC,CAAA;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,EACpC,UAAU,EACV,qBAAqB,EACrB,MAAM,EAKP;IACC,OAAO,QAAQ,CAAO;QACpB,IAAI,EAAE,cAAc,UAAU,oBAAoB,qBAAqB,EAAE,EAAE,OAAO,EAAE;YAClF,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,WAAW,EAAE,MAAM;aACpB;SACF;KACF,CAAC,CAAA;AACJ,CAAC"}