@lightsparkdev/lightspark-sdk 0.3.4 → 0.4.0

package/dist/{index-d2343f8f.d.ts → index-aa922ada.d.ts}

@@ -405,6 +405,7 @@ declare class LightsparkNode implements Node {
     readonly bitcoinNetwork: BitcoinNetwork;
     readonly displayName: string;
     readonly accountId: string;
+    readonly ownerId: string;
     readonly typename: string;
     readonly alias?: string | undefined;
     readonly color?: string | undefined;
@@ -418,7 +419,7 @@ declare class LightsparkNode implements Node {
     readonly purpose?: LightsparkNodePurpose | undefined;
     readonly remoteBalance?: CurrencyAmount | undefined;
     readonly status?: LightsparkNodeStatus | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, accountId: string, typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, blockchainBalance?: BlockchainBalance | undefined, encryptedSigningPrivateKey?: Secret | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, purpose?: LightsparkNodePurpose | undefined, remoteBalance?: CurrencyAmount | undefined, status?: LightsparkNodeStatus | undefined);
+    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, accountId: string, ownerId: string, typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, blockchainBalance?: BlockchainBalance | undefined, encryptedSigningPrivateKey?: Secret | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, purpose?: LightsparkNodePurpose | undefined, remoteBalance?: CurrencyAmount | undefined, status?: LightsparkNodeStatus | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeQuery(id: string): Query<LightsparkNode>;
@@ -585,18 +586,60 @@ type Balances = {
     availableToWithdrawBalance: CurrencyAmount;
 };
 
-declare class Wallet implements Entity {
+type LightsparkNodeOwner = Entity & {
+    /**
+     * 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 typename of the object **/
+    typename: string;
+};
+declare const getLightsparkNodeOwnerQuery: (id: string) => Query<LightsparkNodeOwner>;
+
+declare enum WalletStatus {
+    /**
+     * 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 wallet has not been set up yet and is ready to be deployed. This is the default status after the first login. **/
+    NOT_SETUP = "NOT_SETUP",
+    /** The wallet is currently being deployed in the Lightspark infrastructure. **/
+    DEPLOYING = "DEPLOYING",
+    /** The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized. **/
+    DEPLOYED = "DEPLOYED",
+    /** The wallet is currently being initialized. **/
+    INITIALIZING = "INITIALIZING",
+    /** The wallet is available and ready to be used. **/
+    READY = "READY",
+    /** The wallet is temporarily available, due to a transient issue or a scheduled maintenance. **/
+    UNAVAILABLE = "UNAVAILABLE",
+    /** The wallet had an unrecoverable failure. This status is not expected to happend and will be investigated by the Lightspark team. **/
+    FAILED = "FAILED",
+    /** The wallet is being terminated. **/
+    TERMINATING = "TERMINATING",
+    /** The wallet has been terminated and is not available in the Lightspark infrastructure anymore. It is not connected to the Lightning network and its funds can only be accessed using the Funds Recovery flow. **/
+    TERMINATED = "TERMINATED"
+}
+
+declare class Wallet implements LightsparkNodeOwner {
     readonly id: string;
     readonly createdAt: string;
     readonly updatedAt: string;
     readonly thirdPartyIdentifier: string;
+    readonly status: WalletStatus;
     readonly typename: string;
     readonly lastLoginAt?: string | undefined;
     readonly balances?: Balances | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, thirdPartyIdentifier: string, typename: string, lastLoginAt?: string | undefined, balances?: Balances | undefined);
+    constructor(id: string, createdAt: string, updatedAt: string, thirdPartyIdentifier: string, status: WalletStatus, typename: string, lastLoginAt?: string | undefined, balances?: Balances | undefined);
     getTotalAmountReceived(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
     getTotalAmountSent(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
-    static getWalletQuery(): Query<Wallet>;
+    static getWalletQuery(id: string): Query<Wallet>;
 }
 
 type AccountToWalletsConnection = {
@@ -644,7 +687,7 @@ type TransactionFailures = {
     routingTransactionFailures?: RoutingTransactionFailureReason[];
 };
 
-declare class Account implements Entity {
+declare class Account implements LightsparkNodeOwner {
     readonly id: string;
     readonly createdAt: string;
     readonly updatedAt: string;
@@ -704,6 +747,28 @@ type InvoiceData = PaymentRequestData & {
     memo?: string;
 };
 
+/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) initiated by a Lightspark Node. **/
+type Invoice = PaymentRequest & Entity & {
+    /**
+     * 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 details of the invoice. **/
+    data: InvoiceData;
+    /** The status of the payment request. **/
+    status: PaymentRequestStatus;
+    /** The typename of the object **/
+    typename: string;
+    /** The total amount that has been paid to this invoice. **/
+    amountPaid?: CurrencyAmount;
+};
+declare const getInvoiceQuery: (id: string) => Query<Invoice>;
+
 declare enum InvoiceType {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1227,6 +1292,21 @@ declare class LightsparkClient {
      * @returns An encoded payment request for the invoice, or undefined if the invoice could not be created.
      */
     createInvoice(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined): Promise<string | undefined>;
+    /**
+     * Generates a Lightning Invoice (follows the Bolt 11 specification) to request a payment
+     * from another Lightning Node. This should only be used for generating invoices for LNURLs,
+     * with [createInvoice] preferred in the general case.
+     *
+     * Test mode note: You can simulate a payment of this invoice in test move using [createTestModePayment].
+     *
+     * @param nodeId The node ID for which to create an invoice.
+     * @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
+     * @param metadata The LNURL metadata payload field in the initial payreq response. This wil be hashed and present in the
+     *     h-tag (SHA256 purpose of payment) of the resulting Bolt 11 invoice. See
+     *     [this spec](https://github.com/lnurl/luds/blob/luds/06.md#pay-to-static-qrnfclink) for details.
+     * @returns An Invoice object representing the generated invoice.
+     */
+    createLnurlInvoice(nodeId: string, amountMsats: number, metadata: string): Promise<Invoice | undefined>;
     /**
      * Decodes an encoded lightning invoice string.
      *
@@ -1404,6 +1484,18 @@ type CreateInvoiceOutput = {
     invoiceId: string;
 };
 
+type CreateLnurlInvoiceInput = {
+    /** The node from which to create the invoice. **/
+    nodeId: string;
+    /** The amount for which the invoice should be created, in millisatoshis. **/
+    amountMsats: number;
+    /**
+     * The SHA256 hash of the LNURL metadata payload. This will be present in the h-tag (SHA256 purpose of
+     * payment) of the resulting Bolt 11 invoice.
+     **/
+    metadataHash: string;
+};
+
 type CreateNodeWalletAddressInput = {
     nodeId: string;
 };
@@ -1586,28 +1678,6 @@ declare class IncomingPayment implements LightningTransaction {
     static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
 }
 
-/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) initiated by a Lightspark Node. **/
-type Invoice = PaymentRequest & Entity & {
-    /**
-     * 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 details of the invoice. **/
-    data: InvoiceData;
-    /** The status of the payment request. **/
-    status: PaymentRequestStatus;
-    /** The typename of the object **/
-    typename: string;
-    /** The total amount that has been paid to this invoice. **/
-    amountPaid?: CurrencyAmount;
-};
-declare const getInvoiceQuery: (id: string) => Query<Invoice>;
-
 type LightningFeeEstimateForInvoiceInput = {
     /** The node from where you want to send the payment. **/
     nodeId: string;
@@ -1789,4 +1859,4 @@ type Withdrawal = OnChainTransaction & Transaction & Entity & {
 };
 declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
 
-export { InvoiceData as $, Account as A, Balances as B, Channel as C, CreateTestModePaymentoutput as D, CurrencyAmount as E, CurrencyUnit as F, DeleteApiTokenInput as G, DeleteApiTokenOutput as H, Deposit as I, getDepositQuery as J, Entity as K, LightsparkClient as L, FeeEstimate as M, FundNodeInput as N, FundNodeOutput as O, GraphNode as P, Hop as Q, getHopQuery as R, HtlcAttemptFailureCode as S, IncomingPayment as T, IncomingPaymentAttempt as U, getIncomingPaymentAttemptQuery as V, WebhookEventType as W, IncomingPaymentAttemptStatus as X, IncomingPaymentToAttemptsConnection as Y, Invoice as Z, getInvoiceQuery as _, AccountToApiTokensConnection as a, InvoiceType as a0, LightningFeeEstimateForInvoiceInput as a1, LightningFeeEstimateForNodeInput as a2, LightningFeeEstimateOutput as a3, LightningTransaction as a4, getLightningTransactionQuery as a5, LightsparkNode as a6, LightsparkNodePurpose as a7, LightsparkNodeStatus as a8, LightsparkNodeToChannelsConnection as a9, Secret as aA, SendPaymentInput as aB, SendPaymentOutput as aC, SingleNodeDashboard as aD, Transaction as aE, getTransactionQuery as aF, TransactionFailures as aG, TransactionStatus as aH, TransactionType as aI, TransactionUpdate as aJ, Wallet as aK, Withdrawal as aL, getWithdrawalQuery as aM, WithdrawalMode as aN, WithdrawalRequest as aO, WithdrawalRequestStatus as aP, WithdrawalRequestToChannelClosingTransactionsConnection as aQ, WithdrawalRequestToChannelOpeningTransactionsConnection as aR, Node as aa, NodeAddress as ab, NodeAddressType as ac, NodeToAddressesConnection as ad, OnChainTransaction as ae, getOnChainTransactionQuery as af, OutgoingPayment as ag, OutgoingPaymentAttempt as ah, OutgoingPaymentAttemptStatus as ai, OutgoingPaymentAttemptToHopsConnection as aj, OutgoingPaymentToAttemptsConnection as ak, PageInfo as al, PayInvoiceInput as am, PayInvoiceOutput as an, PaymentFailureReason as ao, PaymentRequest as ap, getPaymentRequestQuery as aq, PaymentRequestData as ar, PaymentRequestStatus as as, Permission as at, RequestWithdrawalInput as au, RequestWithdrawalOutput as av, RichText as aw, RoutingTransaction as ax, getRoutingTransactionQuery as ay, RoutingTransactionFailureReason as az, AccountToChannelsConnection as b, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BitcoinNetwork as i, BlockchainBalance as j, ChannelClosingTransaction as k, getChannelClosingTransactionQuery as l, ChannelFees as m, ChannelOpeningTransaction as n, getChannelOpeningTransactionQuery as o, ChannelStatus as p, ChannelToTransactionsConnection as q, CreateApiTokenInput as r, CreateApiTokenOutput as s, CreateInvoiceInput as t, CreateInvoiceOutput as u, CreateNodeWalletAddressInput as v, CreateNodeWalletAddressOutput as w, CreateTestModeInvoiceInput as x, CreateTestModeInvoiceOutput as y, CreateTestModePaymentInput as z };
+export { getInvoiceQuery as $, Account as A, Balances as B, Channel as C, CreateTestModePaymentInput as D, CreateTestModePaymentoutput as E, CurrencyAmount as F, CurrencyUnit as G, DeleteApiTokenInput as H, DeleteApiTokenOutput as I, Deposit as J, getDepositQuery as K, LightsparkClient as L, Entity as M, FeeEstimate as N, FundNodeInput as O, FundNodeOutput as P, GraphNode as Q, Hop as R, getHopQuery as S, HtlcAttemptFailureCode as T, IncomingPayment as U, IncomingPaymentAttempt as V, WebhookEventType as W, getIncomingPaymentAttemptQuery as X, IncomingPaymentAttemptStatus as Y, IncomingPaymentToAttemptsConnection as Z, Invoice as _, AccountToApiTokensConnection as a, InvoiceData as a0, InvoiceType as a1, LightningFeeEstimateForInvoiceInput as a2, LightningFeeEstimateForNodeInput as a3, LightningFeeEstimateOutput as a4, LightningTransaction as a5, getLightningTransactionQuery as a6, LightsparkNode as a7, LightsparkNodeOwner as a8, getLightsparkNodeOwnerQuery as a9, RoutingTransaction as aA, getRoutingTransactionQuery as aB, RoutingTransactionFailureReason as aC, Secret as aD, SendPaymentInput as aE, SendPaymentOutput as aF, SingleNodeDashboard as aG, Transaction as aH, getTransactionQuery as aI, TransactionFailures as aJ, TransactionStatus as aK, TransactionType as aL, TransactionUpdate as aM, Wallet as aN, WalletStatus as aO, Withdrawal as aP, getWithdrawalQuery as aQ, WithdrawalMode as aR, WithdrawalRequest as aS, WithdrawalRequestStatus as aT, WithdrawalRequestToChannelClosingTransactionsConnection as aU, WithdrawalRequestToChannelOpeningTransactionsConnection as aV, LightsparkNodePurpose as aa, LightsparkNodeStatus as ab, LightsparkNodeToChannelsConnection as ac, Node as ad, NodeAddress as ae, NodeAddressType as af, NodeToAddressesConnection as ag, OnChainTransaction as ah, getOnChainTransactionQuery as ai, OutgoingPayment as aj, OutgoingPaymentAttempt as ak, OutgoingPaymentAttemptStatus as al, OutgoingPaymentAttemptToHopsConnection as am, OutgoingPaymentToAttemptsConnection as an, PageInfo as ao, PayInvoiceInput as ap, PayInvoiceOutput as aq, PaymentFailureReason as ar, PaymentRequest as as, getPaymentRequestQuery as at, PaymentRequestData as au, PaymentRequestStatus as av, Permission as aw, RequestWithdrawalInput as ax, RequestWithdrawalOutput as ay, RichText as az, AccountToChannelsConnection as b, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BitcoinNetwork as i, BlockchainBalance as j, ChannelClosingTransaction as k, getChannelClosingTransactionQuery as l, ChannelFees as m, ChannelOpeningTransaction as n, getChannelOpeningTransactionQuery as o, ChannelStatus as p, ChannelToTransactionsConnection as q, CreateApiTokenInput as r, CreateApiTokenOutput as s, CreateInvoiceInput as t, CreateInvoiceOutput as u, CreateLnurlInvoiceInput as v, CreateNodeWalletAddressInput as w, CreateNodeWalletAddressOutput as x, CreateTestModeInvoiceInput as y, CreateTestModeInvoiceOutput as z };