@lightsparkdev/lightspark-sdk 1.1.5 → 1.1.7

package/dist/{index-5235e43b.d.ts → index-d31f4469.d.ts}

@@ -322,6 +322,30 @@ declare class AccountToChannelsConnection {
     constructor(count: number, entities: Channel[]);
 }
 
+/** This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations. **/
+type Balances = {
+    /**
+     * This represents the balance that should be displayed when asked "how much do I own right now?". It
+     * represents the amount currently owned, including things that may not be owned soon (e.g. in-flight
+     * outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a snapshot of what is
+     * officially owned at this instant.
+     **/
+    ownedBalance: CurrencyAmount;
+    /**
+     * This represents the balance that should be displayed when asked "how much can I send on Lightning
+     * right now?". It represents the amount currently available to be sent on the Lightning network. We
+     * remove from the balance all the funds that are temporarily locked (e.g. channel reserves).
+     **/
+    availableToSendBalance: CurrencyAmount;
+    /**
+     * This represents the balance that should be displayed when asked "how much money can I withdraw on
+     * the Bitcoin network right now?". It represents the amount currently available to withdraw and is
+     * usually equal to the `owned_balance` but it does not include in-flight operations (which would
+     * likely succeed and therefore likely make your withdrawal fail).
+     **/
+    availableToWithdrawBalance: CurrencyAmount;
+};
+
 /** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
 type BlockchainBalance = {
     /** The total wallet balance, including unconfirmed UTXOs. **/
@@ -408,7 +432,8 @@ declare class LightsparkNode implements Node {
     readonly localBalance?: CurrencyAmount | undefined;
     readonly remoteBalance?: CurrencyAmount | undefined;
     readonly blockchainBalance?: BlockchainBalance | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined);
+    readonly balances?: Balances | undefined;
+    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, balances?: Balances | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeQuery(id: string): Query<LightsparkNode>;
@@ -556,30 +581,6 @@ type AccountToTransactionsConnection = Connection & {
     totalAmountTransacted?: CurrencyAmount;
 };
 
-/** This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations. **/
-type Balances = {
-    /**
-     * This represents the balance that should be displayed when asked "how much do I own right now?". It
-     * represents the amount currently owned, including things that may not be owned soon (e.g. in-flight
-     * outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a snapshot of what is
-     * officially owned at this instant.
-     **/
-    ownedBalance: CurrencyAmount;
-    /**
-     * This represents the balance that should be displayed when asked "how much can I send on Lightning
-     * right now?". It represents the amount currently available to be sent on the Lightning network. We
-     * remove from the balance all the funds that are temporarily locked (e.g. channel reserves).
-     **/
-    availableToSendBalance: CurrencyAmount;
-    /**
-     * This represents the balance that should be displayed when asked "how much money can I withdraw on
-     * the Bitcoin network right now?". It represents the amount currently available to withdraw and is
-     * usually equal to the `owned_balance` but it does not include in-flight operations (which would
-     * likely succeed and therefore likely make your withdrawal fail).
-     **/
-    availableToWithdrawBalance: CurrencyAmount;
-};
-
 /** This is an object representing the owner of a LightsparkNode. **/
 type LightsparkNodeOwner = Entity & {
     /**
@@ -924,9 +925,13 @@ declare enum InvoiceType {
 }
 
 type ChannelSnapshot = {
+    channelId: string;
+    timestamp: string;
     localBalance?: CurrencyAmount;
     localUnsettledBalance?: CurrencyAmount;
     localChannelReserve?: CurrencyAmount;
+    remoteBalance?: CurrencyAmount;
+    remoteUnsettledBalance?: CurrencyAmount;
 };
 
 /** This is an enum representing a particular reason why an htlc sent over the Lightning Network may have failed. **/
@@ -960,6 +965,7 @@ declare enum HtlcAttemptFailureCode {
     EXPIRY_TOO_FAR = "EXPIRY_TOO_FAR",
     MPP_TIMEOUT = "MPP_TIMEOUT",
     INVALID_ONION_PAYLOAD = "INVALID_ONION_PAYLOAD",
+    INVALID_ONION_BLINDING = "INVALID_ONION_BLINDING",
     INTERNAL_FAILURE = "INTERNAL_FAILURE",
     UNKNOWN_FAILURE = "UNKNOWN_FAILURE",
     UNREADABLE_FAILURE = "UNREADABLE_FAILURE"
@@ -1969,8 +1975,9 @@ declare class LightsparkNodeWithOSK implements LightsparkNode {
     readonly localBalance?: CurrencyAmount | undefined;
     readonly remoteBalance?: CurrencyAmount | undefined;
     readonly blockchainBalance?: BlockchainBalance | undefined;
+    readonly balances?: Balances | undefined;
     readonly encryptedSigningPrivateKey?: Secret | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, encryptedSigningPrivateKey?: Secret | undefined);
+    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, balances?: Balances | undefined, encryptedSigningPrivateKey?: Secret | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeWithOSKQuery(id: string): Query<LightsparkNodeWithOSK>;
@@ -1996,7 +2003,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode {
     readonly localBalance?: CurrencyAmount | undefined;
     readonly remoteBalance?: CurrencyAmount | undefined;
     readonly blockchainBalance?: BlockchainBalance | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined);
+    readonly balances?: Balances | undefined;
+    constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, balances?: Balances | undefined);
     getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
     getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
     static getLightsparkNodeWithRemoteSigningQuery(id: string): Query<LightsparkNodeWithRemoteSigning>;