@atomiqlabs/sdk 7.0.12 → 8.0.7

package/dist/intermediaries/apis/TrustedIntermediaryAPI.d.ts

@@ -0,0 +1,154 @@
+import { FieldTypeEnum, RequestSchemaResult } from "../../http/paramcoders/SchemaVerifier";
+export declare enum AddressStatusResponseCodes {
+    EXPIRED = 10001,
+    PAID = 10000,
+    AWAIT_PAYMENT = 10010,
+    AWAIT_CONFIRMATION = 10011,
+    PENDING = 10013,
+    TX_SENT = 10012,
+    REFUNDED = 10014,
+    DOUBLE_SPENT = 10015,
+    REFUNDABLE = 10016
+}
+export type AddressStatusResponse = {
+    code: AddressStatusResponseCodes.TX_SENT | AddressStatusResponseCodes.PAID;
+    msg: string;
+    data: {
+        adjustedAmount: string;
+        adjustedTotal: string;
+        adjustedFee?: string;
+        adjustedFeeSats?: string;
+        txId: string;
+        scTxId: string;
+    };
+} | {
+    code: AddressStatusResponseCodes.AWAIT_CONFIRMATION | AddressStatusResponseCodes.PENDING;
+    msg: string;
+    data: {
+        adjustedAmount: string;
+        adjustedTotal: string;
+        adjustedFee?: string;
+        adjustedFeeSats?: string;
+        txId: string;
+    };
+} | {
+    code: AddressStatusResponseCodes.REFUNDABLE;
+    msg: string;
+    data: {
+        adjustedAmount: string;
+    };
+} | {
+    code: AddressStatusResponseCodes.REFUNDED | AddressStatusResponseCodes.DOUBLE_SPENT;
+    msg: string;
+    data: {
+        txId: string;
+    };
+} | {
+    code: AddressStatusResponseCodes.AWAIT_PAYMENT | AddressStatusResponseCodes.EXPIRED;
+    msg: string;
+};
+export type TrustedFromBTCInit = {
+    address: string;
+    amount: bigint;
+    token: string;
+    refundAddress?: string;
+};
+declare const TrustedFromBTCResponseSchema: {
+    readonly paymentHash: FieldTypeEnum.String;
+    readonly sequence: FieldTypeEnum.BigInt;
+    readonly btcAddress: FieldTypeEnum.String;
+    readonly amountSats: FieldTypeEnum.BigInt;
+    readonly swapFeeSats: FieldTypeEnum.BigInt;
+    readonly swapFee: FieldTypeEnum.BigInt;
+    readonly total: FieldTypeEnum.BigInt;
+    readonly intermediaryKey: FieldTypeEnum.String;
+    readonly recommendedFee: FieldTypeEnum.Number;
+    readonly expiresAt: FieldTypeEnum.Number;
+};
+export type TrustedFromBTCResponseType = RequestSchemaResult<typeof TrustedFromBTCResponseSchema>;
+export declare enum InvoiceStatusResponseCodes {
+    EXPIRED = 10001,
+    PAID = 10000,
+    AWAIT_PAYMENT = 10010,
+    PENDING = 10011,
+    TX_SENT = 10012
+}
+export type InvoiceStatusResponse = {
+    code: InvoiceStatusResponseCodes.TX_SENT | InvoiceStatusResponseCodes.PAID;
+    msg: string;
+    data: {
+        txId: string;
+    };
+} | {
+    code: Exclude<InvoiceStatusResponseCodes, InvoiceStatusResponseCodes.TX_SENT | InvoiceStatusResponseCodes.PAID>;
+    msg: string;
+};
+export type TrustedFromBTCLNInit = {
+    address: string;
+    amount: bigint;
+    token: string;
+};
+declare const TrustedFromBTCLNResponseSchema: {
+    readonly pr: FieldTypeEnum.String;
+    readonly swapFee: FieldTypeEnum.BigInt;
+    readonly total: FieldTypeEnum.BigInt;
+};
+export type TrustedFromBTCLNResponseType = RequestSchemaResult<typeof TrustedFromBTCLNResponseSchema>;
+export declare class TrustedIntermediaryAPI {
+    /**
+     * Fetches the invoice status from the intermediary node
+     *
+     * @param url Url of the trusted intermediary
+     * @param paymentHash Payment hash of the lightning invoice
+     * @param timeout Timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} if non-200 http response is returned
+     */
+    static getInvoiceStatus(url: string, paymentHash: string, timeout?: number, abortSignal?: AbortSignal): Promise<InvoiceStatusResponse>;
+    /**
+     * Initiate a trusted swap from BTCLN to SC native currency, retries!
+     *
+     * @param chainIdentifier
+     * @param baseUrl Base url of the trusted swap intermediary
+     * @param init Initialization parameters
+     * @param timeout Timeout in milliseconds for the request
+     * @param abortSignal
+     * @throws {RequestError} If the response is non-200
+     */
+    static initTrustedFromBTCLN(chainIdentifier: string, baseUrl: string, init: TrustedFromBTCLNInit, timeout?: number, abortSignal?: AbortSignal): Promise<TrustedFromBTCLNResponseType>;
+    /**
+     * Fetches the address status from the intermediary node
+     *
+     * @param url Url of the trusted intermediary
+     * @param paymentHash Payment hash of the swap
+     * @param sequence Sequence number of the swap
+     * @param timeout Timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} if non-200 http response is returned
+     */
+    static getAddressStatus(url: string, paymentHash: string, sequence: bigint, timeout?: number, abortSignal?: AbortSignal): Promise<AddressStatusResponse>;
+    /**
+     * Sets the refund address for an on-chain gas swap
+     *
+     * @param url Url of the trusted intermediary
+     * @param paymentHash Payment hash of the swap
+     * @param sequence Sequence number of the swap
+     * @param refundAddress Refund address to set for the swap
+     * @param timeout Timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} if non-200 http response is returned
+     */
+    static setRefundAddress(url: string, paymentHash: string, sequence: bigint, refundAddress: string, timeout?: number, abortSignal?: AbortSignal): Promise<void>;
+    /**
+     * Initiate a trusted swap from BTC to SC native currency, retries!
+     *
+     * @param chainIdentifier
+     * @param baseUrl Base url of the trusted swap intermediary
+     * @param init Initialization parameters
+     * @param timeout Timeout in milliseconds for the request
+     * @param abortSignal
+     * @throws {RequestError} If the response is non-200
+     */
+    static initTrustedFromBTC(chainIdentifier: string, baseUrl: string, init: TrustedFromBTCInit, timeout?: number, abortSignal?: AbortSignal): Promise<TrustedFromBTCResponseType>;
+}
+export {};

package/dist/intermediaries/apis/TrustedIntermediaryAPI.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrustedIntermediaryAPI = exports.InvoiceStatusResponseCodes = exports.AddressStatusResponseCodes = void 0;
+const RequestError_1 = require("../../errors/RequestError");
+const SchemaVerifier_1 = require("../../http/paramcoders/SchemaVerifier");
+const HttpUtils_1 = require("../../http/HttpUtils");
+const RetryUtils_1 = require("../../utils/RetryUtils");
+var AddressStatusResponseCodes;
+(function (AddressStatusResponseCodes) {
+    AddressStatusResponseCodes[AddressStatusResponseCodes["EXPIRED"] = 10001] = "EXPIRED";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["PAID"] = 10000] = "PAID";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["AWAIT_PAYMENT"] = 10010] = "AWAIT_PAYMENT";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["AWAIT_CONFIRMATION"] = 10011] = "AWAIT_CONFIRMATION";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["PENDING"] = 10013] = "PENDING";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["TX_SENT"] = 10012] = "TX_SENT";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["REFUNDED"] = 10014] = "REFUNDED";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["DOUBLE_SPENT"] = 10015] = "DOUBLE_SPENT";
+    AddressStatusResponseCodes[AddressStatusResponseCodes["REFUNDABLE"] = 10016] = "REFUNDABLE";
+})(AddressStatusResponseCodes = exports.AddressStatusResponseCodes || (exports.AddressStatusResponseCodes = {}));
+const TrustedFromBTCResponseSchema = {
+    paymentHash: SchemaVerifier_1.FieldTypeEnum.String,
+    sequence: SchemaVerifier_1.FieldTypeEnum.BigInt,
+    btcAddress: SchemaVerifier_1.FieldTypeEnum.String,
+    amountSats: SchemaVerifier_1.FieldTypeEnum.BigInt,
+    swapFeeSats: SchemaVerifier_1.FieldTypeEnum.BigInt,
+    swapFee: SchemaVerifier_1.FieldTypeEnum.BigInt,
+    total: SchemaVerifier_1.FieldTypeEnum.BigInt,
+    intermediaryKey: SchemaVerifier_1.FieldTypeEnum.String,
+    recommendedFee: SchemaVerifier_1.FieldTypeEnum.Number,
+    expiresAt: SchemaVerifier_1.FieldTypeEnum.Number
+};
+var InvoiceStatusResponseCodes;
+(function (InvoiceStatusResponseCodes) {
+    InvoiceStatusResponseCodes[InvoiceStatusResponseCodes["EXPIRED"] = 10001] = "EXPIRED";
+    InvoiceStatusResponseCodes[InvoiceStatusResponseCodes["PAID"] = 10000] = "PAID";
+    InvoiceStatusResponseCodes[InvoiceStatusResponseCodes["AWAIT_PAYMENT"] = 10010] = "AWAIT_PAYMENT";
+    InvoiceStatusResponseCodes[InvoiceStatusResponseCodes["PENDING"] = 10011] = "PENDING";
+    InvoiceStatusResponseCodes[InvoiceStatusResponseCodes["TX_SENT"] = 10012] = "TX_SENT";
+})(InvoiceStatusResponseCodes = exports.InvoiceStatusResponseCodes || (exports.InvoiceStatusResponseCodes = {}));
+const TrustedFromBTCLNResponseSchema = {
+    pr: SchemaVerifier_1.FieldTypeEnum.String,
+    swapFee: SchemaVerifier_1.FieldTypeEnum.BigInt,
+    total: SchemaVerifier_1.FieldTypeEnum.BigInt
+};
+class TrustedIntermediaryAPI {
+    /**
+     * Fetches the invoice status from the intermediary node
+     *
+     * @param url Url of the trusted intermediary
+     * @param paymentHash Payment hash of the lightning invoice
+     * @param timeout Timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} if non-200 http response is returned
+     */
+    static async getInvoiceStatus(url, paymentHash, timeout, abortSignal) {
+        return (0, RetryUtils_1.tryWithRetries)(() => (0, HttpUtils_1.httpGet)(url + "/getInvoiceStatus?paymentHash=" + encodeURIComponent(paymentHash), timeout, abortSignal), undefined, RequestError_1.RequestError, abortSignal);
+    }
+    /**
+     * Initiate a trusted swap from BTCLN to SC native currency, retries!
+     *
+     * @param chainIdentifier
+     * @param baseUrl Base url of the trusted swap intermediary
+     * @param init Initialization parameters
+     * @param timeout Timeout in milliseconds for the request
+     * @param abortSignal
+     * @throws {RequestError} If the response is non-200
+     */
+    static async initTrustedFromBTCLN(chainIdentifier, baseUrl, init, timeout, abortSignal) {
+        const resp = await (0, RetryUtils_1.tryWithRetries)(() => (0, HttpUtils_1.httpGet)(baseUrl + "/lnforgas/createInvoice" +
+            "?address=" + encodeURIComponent(init.address) +
+            "&amount=" + encodeURIComponent(init.amount.toString(10)) +
+            "&chain=" + encodeURIComponent(chainIdentifier) +
+            "&token=" + encodeURIComponent(init.token), timeout, abortSignal), undefined, RequestError_1.RequestError, abortSignal);
+        if (resp.code !== 10000)
+            throw RequestError_1.RequestError.parse(JSON.stringify(resp), 400);
+        const res = (0, SchemaVerifier_1.verifySchema)(resp.data, TrustedFromBTCLNResponseSchema);
+        if (res == null)
+            throw new Error("Invalid response returned from LP");
+        return res;
+    }
+    /**
+     * Fetches the address status from the intermediary node
+     *
+     * @param url Url of the trusted intermediary
+     * @param paymentHash Payment hash of the swap
+     * @param sequence Sequence number of the swap
+     * @param timeout Timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} if non-200 http response is returned
+     */
+    static async getAddressStatus(url, paymentHash, sequence, timeout, abortSignal) {
+        return (0, RetryUtils_1.tryWithRetries)(() => (0, HttpUtils_1.httpGet)(url + "/getAddressStatus?paymentHash=" + encodeURIComponent(paymentHash) + "&sequence=" + encodeURIComponent(sequence.toString(10)), timeout, abortSignal), undefined, RequestError_1.RequestError, abortSignal);
+    }
+    /**
+     * Sets the refund address for an on-chain gas swap
+     *
+     * @param url Url of the trusted intermediary
+     * @param paymentHash Payment hash of the swap
+     * @param sequence Sequence number of the swap
+     * @param refundAddress Refund address to set for the swap
+     * @param timeout Timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} if non-200 http response is returned
+     */
+    static async setRefundAddress(url, paymentHash, sequence, refundAddress, timeout, abortSignal) {
+        return (0, RetryUtils_1.tryWithRetries)(() => (0, HttpUtils_1.httpGet)(url + "/setRefundAddress" +
+            "?paymentHash=" + encodeURIComponent(paymentHash) +
+            "&sequence=" + encodeURIComponent(sequence.toString(10)) +
+            "&refundAddress=" + encodeURIComponent(refundAddress), timeout, abortSignal), undefined, RequestError_1.RequestError, abortSignal);
+    }
+    /**
+     * Initiate a trusted swap from BTC to SC native currency, retries!
+     *
+     * @param chainIdentifier
+     * @param baseUrl Base url of the trusted swap intermediary
+     * @param init Initialization parameters
+     * @param timeout Timeout in milliseconds for the request
+     * @param abortSignal
+     * @throws {RequestError} If the response is non-200
+     */
+    static async initTrustedFromBTC(chainIdentifier, baseUrl, init, timeout, abortSignal) {
+        const resp = await (0, RetryUtils_1.tryWithRetries)(() => (0, HttpUtils_1.httpGet)(baseUrl + "/frombtc_trusted/getAddress?chain=" + encodeURIComponent(chainIdentifier) +
+            "&address=" + encodeURIComponent(init.address) +
+            "&amount=" + encodeURIComponent(init.amount.toString(10)) +
+            (init.refundAddress == null ? "" : "&refundAddress=" + encodeURIComponent(init.refundAddress)) +
+            "&exactIn=true" +
+            "&token=" + encodeURIComponent(init.token), timeout, abortSignal), undefined, RequestError_1.RequestError, abortSignal);
+        if (resp.code !== 10000)
+            throw RequestError_1.RequestError.parse(JSON.stringify(resp), 400);
+        const res = (0, SchemaVerifier_1.verifySchema)(resp.data, TrustedFromBTCResponseSchema);
+        if (res == null)
+            throw new Error("Invalid response returned from LP");
+        return res;
+    }
+}
+exports.TrustedIntermediaryAPI = TrustedIntermediaryAPI;

package/dist/lnurl/LNURL.d.ts

@@ -0,0 +1,102 @@
+import { PaymentRequestObject, TagsObject } from "@atomiqlabs/bolt11";
+import { LNURLWithdraw, LNURLWithdrawParamsWithUrl } from "../types/lnurl/LNURLWithdraw";
+import { LNURLDecodedSuccessAction, LNURLPay, LNURLPayParamsWithUrl } from "../types/lnurl/LNURLPay";
+export type LNURLPaySuccessAction = {
+    tag: string;
+    description: string | null;
+    url: string | null;
+    message: string | null;
+    ciphertext: string | null;
+    iv: string | null;
+};
+export declare function isLNURLPaySuccessAction(obj: any, domain?: string): obj is LNURLPaySuccessAction;
+/**
+ * LNURL encoding/decoding and callback handling
+ * @category Bitcoin
+ */
+export declare class LNURL {
+    private static findBech32LNURL;
+    private static isBech32LNURL;
+    /**
+     * Checks whether a provided string is bare (non bech32 encoded) lnurl
+     * @param str
+     * @private
+     */
+    private static isBareLNURL;
+    /**
+     * Checks if the provided string is a lightning network address (e.g. satoshi@nakamoto.com)
+     * @param str
+     * @private
+     */
+    private static isLightningAddress;
+    /**
+     * Checks whether a given string is a LNURL or lightning address
+     * @param str
+     */
+    static isLNURL(str: string): boolean;
+    /**
+     * Extracts the URL that needs to be request from LNURL or lightning address
+     * @param str
+     * @private
+     * @returns An URL to send the request to, or null if it cannot be parsed
+     */
+    private static extractCallUrl;
+    /**
+     * Sends a request to obtain data about a specific LNURL or lightning address
+     *
+     * @param str A lnurl or lightning address
+     * @param shouldRetry Whether we should retry in case of network failure
+     * @param timeout Request timeout in milliseconds
+     * @param abortSignal
+     */
+    static getLNURL(str: string, shouldRetry?: boolean, timeout?: number, abortSignal?: AbortSignal): Promise<LNURLPayParamsWithUrl | LNURLWithdrawParamsWithUrl | null>;
+    /**
+     * Sends a request to obtain data about a specific LNURL or lightning address
+     *
+     * @param str A lnurl or lightning address
+     * @param shouldRetry Whether we should retry in case of network failure
+     * @param timeout Request timeout in milliseconds
+     * @param abortSignal
+     */
+    static getLNURLType(str: string, shouldRetry?: boolean, timeout?: number, abortSignal?: AbortSignal): Promise<LNURLPay | LNURLWithdraw | null>;
+    /**
+     * Uses a LNURL-pay request by obtaining a lightning network invoice from it
+     *
+     * @param payRequest LNURL params as returned from the getLNURL call
+     * @param amount Amount of sats (BTC) to pay
+     * @param comment Optional comment for the payment request
+     * @param timeout Request timeout in milliseconds
+     * @param abortSignal
+     * @throws {RequestError} If the response is non-200, status: ERROR, or invalid format
+     */
+    static useLNURLPay(payRequest: LNURLPayParamsWithUrl, amount: bigint, comment?: string, timeout?: number, abortSignal?: AbortSignal): Promise<{
+        invoice: string;
+        parsedInvoice: PaymentRequestObject & {
+            tagsObject: TagsObject;
+        };
+        successAction?: LNURLPaySuccessAction;
+    }>;
+    /**
+     * Submits the bolt11 lightning invoice to the lnurl withdraw url
+     *
+     * @param withdrawRequest Withdraw request to use
+     * @param withdrawRequest.k1 K1 parameter
+     * @param withdrawRequest.callback A URL to call
+     * @param lnpr bolt11 lightning network invoice to submit to the withdrawal endpoint
+     * @throws {RequestError} If the response is non-200 or status: ERROR
+     */
+    static postInvoiceToLNURLWithdraw(withdrawRequest: {
+        k1: string;
+        callback: string;
+    }, lnpr: string): Promise<void>;
+    /**
+     * Uses a LNURL-withdraw request by submitting a lightning network invoice to it
+     *
+     * @param withdrawRequest Withdrawal request as returned from getLNURL call
+     * @param lnpr bolt11 lightning network invoice to submit to the withdrawal endpoint
+     * @throws {UserError} In case the provided bolt11 lightning invoice has an amount that is out of bounds for
+     *  the specified LNURL-withdraw request
+     */
+    static useLNURLWithdraw(withdrawRequest: LNURLWithdrawParamsWithUrl, lnpr: string): Promise<void>;
+    static decodeSuccessAction(successAction?: LNURLPaySuccessAction | null, secret?: string | null): LNURLDecodedSuccessAction | null;
+}