@buildonspark/spark-sdk 0.0.7 → 0.0.9

package/dist/LightningSendRequest-CNJFhLVc.d.cts

@@ -0,0 +1,374 @@
+import { Query } from '@lightsparkdev/core';
+
+declare enum SparkCoopExitRequestStatus {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    INITIATED = "INITIATED",
+    FAILED = "FAILED",
+    SUCCEEDED = "SUCCEEDED"
+}
+
+/** This enum identifies the unit of currency associated with a CurrencyAmount. **/
+declare enum CurrencyUnit {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    /** Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium for value transfer for the Lightning Network. **/
+    BITCOIN = "BITCOIN",
+    /** 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most commonly used in Lightning transactions. **/
+    SATOSHI = "SATOSHI",
+    /** 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    MILLISATOSHI = "MILLISATOSHI",
+    /** United States Dollar. **/
+    USD = "USD",
+    /** Mexican Peso. **/
+    MXN = "MXN",
+    /** Philippine Peso. **/
+    PHP = "PHP",
+    /** 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    NANOBITCOIN = "NANOBITCOIN",
+    /** 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    MICROBITCOIN = "MICROBITCOIN",
+    /** 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+    MILLIBITCOIN = "MILLIBITCOIN"
+}
+
+/** This object represents the value and unit for an amount of currency. **/
+interface CurrencyAmount {
+    /** The original numeric value for this CurrencyAmount. **/
+    originalValue: number;
+    /** The original unit of currency for this CurrencyAmount. **/
+    originalUnit: CurrencyUnit;
+    /** The unit of user's preferred currency. **/
+    preferredCurrencyUnit: CurrencyUnit;
+    /**
+ * The rounded numeric value for this CurrencyAmount in the very base level of user's preferred
+ * currency. For example, for USD, the value will be in cents.
+**/
+    preferredCurrencyValueRounded: number;
+    /**
+ * The approximate float value for this CurrencyAmount in the very base level of user's preferred
+ * currency. For example, for USD, the value will be in cents.
+**/
+    preferredCurrencyValueApprox: number;
+}
+
+interface CoopExitRequest {
+    /**
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+ * string.
+**/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /**
+ * The fee includes what user pays for the coop exit and the L1 broadcast fee. The amount user will
+ * receive on L1 is total_amount - fee.
+**/
+    fee: CurrencyAmount;
+    /** The status of the request. **/
+    status: SparkCoopExitRequestStatus;
+    /** The time when the coop exit request expires and the UTXOs are released. **/
+    expiresAt: string;
+    /** The raw connector transaction. **/
+    rawConnectorTransaction: string;
+    /** The typename of the object **/
+    typename: string;
+}
+declare const getCoopExitRequestQuery: (id: string) => Query<CoopExitRequest>;
+
+declare enum LightningSendRequestStatus {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    CREATED = "CREATED",
+    REQUEST_VALIDATED = "REQUEST_VALIDATED",
+    LIGHTNING_PAYMENT_INITIATED = "LIGHTNING_PAYMENT_INITIATED",
+    LIGHTNING_PAYMENT_FAILED = "LIGHTNING_PAYMENT_FAILED",
+    LIGHTNING_PAYMENT_SUCCEEDED = "LIGHTNING_PAYMENT_SUCCEEDED",
+    PREIMAGE_PROVIDED = "PREIMAGE_PROVIDED",
+    TRANSFER_COMPLETED = "TRANSFER_COMPLETED"
+}
+
+/** This is an enum identifying a particular Bitcoin Network. **/
+declare enum BitcoinNetwork {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    /** The production version of the Bitcoin Blockchain. **/
+    MAINNET = "MAINNET",
+    /** A test version of the Bitcoin Blockchain, maintained by Lightspark. **/
+    REGTEST = "REGTEST",
+    /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
+    SIGNET = "SIGNET",
+    /** A test version of the Bitcoin Blockchain, publicly available. **/
+    TESTNET = "TESTNET"
+}
+
+interface CompleteCoopExitInput {
+    userOutboundTransferExternalId: string;
+    coopExitRequestId: string;
+}
+
+interface CompleteLeavesSwapInput {
+    adaptorSecretKey: string;
+    userOutboundTransferExternalId: string;
+    leavesSwapRequestId: string;
+}
+
+/** This is an object representing information about a page returned by the Lightspark API. For more information, please see the “Pagination” section of our API docs for more information about its usage. **/
+interface PageInfo {
+    hasNextPage?: boolean | undefined;
+    hasPreviousPage?: boolean | undefined;
+    startCursor?: string | undefined;
+    endCursor?: string | undefined;
+}
+
+interface CoopExitFeeEstimateInput {
+    leafExternalIds: string[];
+    withdrawalAddress: string;
+}
+
+interface CoopExitFeeEstimateOutput {
+    feeEstimate: CurrencyAmount;
+}
+
+interface Invoice {
+    encodedEnvoice: string;
+    bitcoinNetwork: BitcoinNetwork;
+    paymentHash: string;
+    amount: CurrencyAmount;
+    createdAt: string;
+    expiresAt: string;
+    memo?: string | undefined;
+}
+
+interface Leaf {
+    /** The amount of the leaf. **/
+    amount: CurrencyAmount;
+    /** The id of the leaf known at signing operators. **/
+    sparkNodeId: string;
+}
+
+declare enum SparkLeavesSwapRequestStatus {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    INITIATED = "INITIATED",
+    FAILED = "FAILED",
+    SUCCEEDED = "SUCCEEDED"
+}
+
+interface SwapLeaf {
+    leafId: string;
+    rawUnsignedRefundTransaction: string;
+    adaptorSignedSignature: string;
+}
+
+interface LeavesSwapRequest {
+    /**
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+ * string.
+**/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The status of the request. **/
+    status: SparkLeavesSwapRequestStatus;
+    /** The total amount of leaves user sent for swap. **/
+    totalAmount: CurrencyAmount;
+    /** The target amount of leaves user wanted to get from the swap. **/
+    targetAmount: CurrencyAmount;
+    /** The fee user needs to pay for swap. **/
+    fee: CurrencyAmount;
+    /** The leaves transfer to user. **/
+    inboundTransfer: Transfer;
+    /** The time when the leaves swap request expires. **/
+    expiresAt: string;
+    /** The swap leaves returned to the user **/
+    swapLeaves: SwapLeaf[];
+    /** The typename of the object **/
+    typename: string;
+    /** The leaves transfer out from user. **/
+    outboundTransfer?: Transfer | undefined;
+}
+declare const getLeavesSwapRequestQuery: (id: string) => Query<LeavesSwapRequest>;
+
+interface LightningReceiveFeeEstimateOutput {
+    feeEstimate: CurrencyAmount;
+}
+
+declare enum LightningReceiveRequestStatus {
+    /**
+     * This is an enum value that represents values that could be added in the future.
+     * Clients should support unknown values as more of them could be added without notice.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    INVOICE_CREATED = "INVOICE_CREATED",
+    TRANSFER_CREATED = "TRANSFER_CREATED",
+    TRANSFER_CREATION_FAILED = "TRANSFER_CREATION_FAILED",
+    REFUND_SIGNING_COMMITMENTS_QUERYING_FAILED = "REFUND_SIGNING_COMMITMENTS_QUERYING_FAILED",
+    REFUND_SIGNING_FAILED = "REFUND_SIGNING_FAILED",
+    PAYMENT_PREIMAGE_RECOVERED = "PAYMENT_PREIMAGE_RECOVERED",
+    PAYMENT_PREIMAGE_RECOVERING_FAILED = "PAYMENT_PREIMAGE_RECOVERING_FAILED",
+    LIGHTNING_PAYMENT_RECEIVED = "LIGHTNING_PAYMENT_RECEIVED",
+    TRANSFER_FAILED = "TRANSFER_FAILED",
+    TRANSFER_COMPLETED = "TRANSFER_COMPLETED"
+}
+
+interface LightningReceiveRequest {
+    /**
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+ * string.
+**/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The lightning invoice generated to receive lightning payment. **/
+    invoice: Invoice;
+    /** The fee charged for receiving the lightning invoice. **/
+    fee: CurrencyAmount;
+    /** The status of the request. **/
+    status: LightningReceiveRequestStatus;
+    /** The typename of the object **/
+    typename: string;
+    /** The leaves transfer after lightning payment was received. **/
+    transfer?: Transfer | undefined;
+}
+declare const getLightningReceiveRequestQuery: (id: string) => Query<LightningReceiveRequest>;
+
+interface LightningSendFeeEstimateOutput {
+    feeEstimate: CurrencyAmount;
+}
+
+interface RequestCoopExitInput {
+    leafExternalIds: string[];
+    withdrawalAddress: string;
+}
+
+interface UserLeafInput {
+    leaf_id: string;
+    raw_unsigned_refund_transaction: string;
+    adaptor_added_signature: string;
+}
+
+interface RequestLeavesSwapInput {
+    adaptorPubkey: string;
+    totalAmountSats: number;
+    targetAmountSats: number;
+    feeSats: number;
+    userLeaves: UserLeafInput[];
+}
+
+interface RequestLightningReceiveInput {
+    /** The bitcoin network the lightning invoice is created on. **/
+    network: BitcoinNetwork;
+    /** The amount for which the lightning invoice should be created in satoshis. **/
+    amountSats: number;
+    /** The 32-byte hash of the payment preimage to use when generating the lightning invoice. **/
+    paymentHash: string;
+    /** The expiry of the lightning invoice in seconds. Default value is 3600 (1 hour). **/
+    expirySecs?: number | undefined;
+    /** The memo to include in the lightning invoice. **/
+    memo?: string | undefined;
+}
+
+interface RequestLightningSendInput {
+    encodedInvoice: string;
+    idempotencyKey: string;
+}
+
+interface SparkTransferToLeavesConnection {
+    /**
+ * The total count of objects in this connection, using the current filters. It is different from the
+ * number of objects returned in the current page (in the `entities` field).
+**/
+    count: number;
+    /** An object that holds pagination information about the objects in this connection. **/
+    pageInfo: PageInfo;
+    /** The leaves for the current page of this connection. **/
+    entities: Leaf[];
+    /** The typename of the object **/
+    typename: string;
+}
+
+declare class SspClient {
+    private readonly requester;
+    private identityPublicKey;
+    private readonly signingKey?;
+    constructor(identityPublicKey: string);
+    executeRawQuery<T>(query: Query<T>): Promise<T | null>;
+    getLightningReceiveFeeEstimate(amountSats: number, network: BitcoinNetwork): Promise<LightningReceiveFeeEstimateOutput | null>;
+    getLightningSendFeeEstimate(encodedInvoice: string): Promise<LightningSendFeeEstimateOutput | null>;
+    getCoopExitFeeEstimate({ leafExternalIds, withdrawalAddress, }: CoopExitFeeEstimateInput): Promise<CoopExitFeeEstimateOutput | null>;
+    getCurrentUser(): Promise<void>;
+    completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
+    requestCoopExit({ leafExternalIds, withdrawalAddress, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
+    requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
+    requestLightningSend({ encodedInvoice, idempotencyKey, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
+    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
+    completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
+}
+
+declare class Transfer {
+    /** The total amount of the transfer. **/
+    readonly totalAmount: CurrencyAmount;
+    /** The id of the transfer known at signing operators. If not set, the transfer hasn't been
+     * initialized. **/
+    readonly sparkId?: string | undefined;
+    constructor(
+    /** The total amount of the transfer. **/
+    totalAmount: CurrencyAmount, 
+    /** The id of the transfer known at signing operators. If not set, the transfer hasn't been
+     * initialized. **/
+    sparkId?: string | undefined);
+    getLeaves(client: SspClient, first?: number | undefined, after?: string | undefined): Promise<SparkTransferToLeavesConnection>;
+    toJson(): {
+        transfer_total_amount: any;
+        transfer_spark_id: string | undefined;
+    };
+}
+
+interface LightningSendRequest {
+    /**
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+ * string.
+**/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The lightning invoice user requested to pay. **/
+    encodedInvoice: string;
+    /** The fee charged for paying the lightning invoice. **/
+    fee: CurrencyAmount;
+    /** The idempotency key of the request. **/
+    idempotencyKey: string;
+    /** The status of the request. **/
+    status: LightningSendRequestStatus;
+    /** The typename of the object **/
+    typename: string;
+    /** The leaves transfer after lightning payment was sent. **/
+    transfer?: Transfer | undefined;
+}
+declare const getLightningSendRequestQuery: (id: string) => Query<LightningSendRequest>;
+
+export { BitcoinNetwork as B, type CurrencyAmount as C, type Invoice as I, type Leaf as L, type PageInfo as P, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type CompleteCoopExitInput as a, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimateInput as c, type CoopExitFeeEstimateOutput as d, type CoopExitRequest as e, CurrencyUnit as f, getCoopExitRequestQuery as g, getLeavesSwapRequestQuery as h, type LeavesSwapRequest as i, type LightningReceiveFeeEstimateOutput as j, getLightningReceiveRequestQuery as k, type LightningReceiveRequest as l, LightningReceiveRequestStatus as m, type LightningSendFeeEstimateOutput as n, getLightningSendRequestQuery as o, type LightningSendRequest as p, LightningSendRequestStatus as q, type RequestLeavesSwapInput as r, type RequestLightningReceiveInput as s, type RequestLightningSendInput as t, SparkLeavesSwapRequestStatus as u, type SparkTransferToLeavesConnection as v, type SwapLeaf as w };