@lightsparkdev/lightspark-sdk 0.2.3 → 0.2.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lightsparkdev/lightspark-sdk
 
+## 0.2.4
+
+### Patch Changes
+
+- 5fb981cf8: Rename WalletDashboard to SingleNodeDashboard
+
 ## 0.2.3
 
 ### Patch Changes

package/README.md

@@ -116,7 +116,6 @@ Then, run the examples:
 ```bash
 $ cd examples/node-scripts
 $ npm install
-$ ts-node getWalletDashboard.ts
 $ ts-node createInvoice.ts -a "100" -m "Whasssupppp"
 ```
 

package/dist/{Withdrawal-cc441c06.d.ts → Withdrawal-f68ab02c.d.ts}

@@ -1,4 +1,4 @@
-import { Maybe, Query, AuthProvider, NodeKeyCache, CryptoInterface } from '@lightsparkdev/core';
+import { Maybe, Query, AuthProvider, CryptoInterface } from '@lightsparkdev/core';
 import Observable from 'zen-observable';
 
 declare enum CurrencyUnit {
@@ -879,29 +879,7 @@ declare class OutgoingPayment implements LightningTransaction {
     static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
 }
 
-type TransactionUpdate = {
-    /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
-     **/
-    id: string;
-    /** The date and time when this transaction was initiated. **/
-    createdAt: string;
-    /** The date and time when the entity was last updated. **/
-    updatedAt: string;
-    /** The current status of this transaction. **/
-    status: TransactionStatus;
-    /** The amount of money involved in this transaction. **/
-    amount: CurrencyAmount;
-    /** The typename of the object **/
-    typename: string;
-    /** The date and time when this transaction was completed or failed. **/
-    resolvedAt?: string;
-    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
-    transactionHash?: string;
-};
-
-type WalletDashboard = {
+type SingleNodeDashboard = {
     id: string;
     displayName: string;
     purpose: Maybe<LightsparkNodePurpose>;
@@ -925,6 +903,28 @@ type WalletDashboard = {
     recentTransactions: Transaction[];
 };
 
+type TransactionUpdate = {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when this transaction was initiated. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The current status of this transaction. **/
+    status: TransactionStatus;
+    /** The amount of money involved in this transaction. **/
+    amount: CurrencyAmount;
+    /** The typename of the object **/
+    typename: string;
+    /** The date and time when this transaction was completed or failed. **/
+    resolvedAt?: string;
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+    transactionHash?: string;
+};
+
 declare enum WithdrawalMode {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1147,9 +1147,9 @@ declare class WithdrawalRequest implements Entity {
 declare class LightsparkClient {
     private authProvider;
     private readonly serverUrl;
-    private readonly nodeKeyCache;
     private readonly cryptoImpl;
     private requester;
+    private readonly nodeKeyCache;
     /**
      * Constructs a new LightsparkClient.
      *
@@ -1159,7 +1159,7 @@ declare class LightsparkClient {
      * @param nodeKeyCache This is used to cache node keys for the duration of the session. Defaults to a new instance of
      *     `NodeKeyCache`. You should not need to change this.
      */
-    constructor(authProvider?: AuthProvider, serverUrl?: string, nodeKeyCache?: NodeKeyCache, cryptoImpl?: CryptoInterface);
+    constructor(authProvider?: AuthProvider, serverUrl?: string, cryptoImpl?: CryptoInterface);
     /**
      * Sets the auth provider for the client. This is useful for switching between auth providers if you are using
      * multiple accounts or waiting for the user to log in.
@@ -1203,7 +1203,7 @@ declare class LightsparkClient {
      */
     getAccountDashboard(nodeIds?: string[] | undefined, bitcoinNetwork?: BitcoinNetwork): Promise<AccountDashboard>;
     /**
-     * Gets a basic dashboard for a single node, including recent transactions. See `WalletDashboard` for which info is
+     * Gets a basic dashboard for a single node, including recent transactions. See `SingleNodeDashboard` for which info is
      * included.
      *
      * @param nodeId The node ID for which to get a dashboard.
@@ -1212,7 +1212,7 @@ declare class LightsparkClient {
      *     Defaults to undefined (no limit).
      * @returns A basic dashboard for the given node ID.
      */
-    getSingleNodeDashboard(nodeId: string, bitcoinNetwork?: BitcoinNetwork, transactionsAfterDate?: Maybe<string>): Promise<WalletDashboard>;
+    getSingleNodeDashboard(nodeId: string, bitcoinNetwork?: BitcoinNetwork, transactionsAfterDate?: Maybe<string>): Promise<SingleNodeDashboard>;
     /**
      * Creates an invoice for the given node.
      *
@@ -1736,4 +1736,4 @@ type Withdrawal = OnChainTransaction & Transaction & Entity & {
 };
 declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
 
-export { LightningTransaction as $, Account as A, Balances as B, Channel as C, DeleteApiTokenInput as D, Deposit as E, getDepositQuery as F, Entity as G, FeeEstimate as H, FundNodeInput as I, FundNodeOutput as J, GraphNode as K, LightsparkClient as L, Hop as M, getHopQuery as N, HtlcAttemptFailureCode as O, IncomingPayment as P, IncomingPaymentAttempt as Q, getIncomingPaymentAttemptQuery as R, IncomingPaymentAttemptStatus as S, IncomingPaymentToAttemptsConnection as T, Invoice as U, getInvoiceQuery as V, InvoiceData as W, InvoiceType as X, LightningFeeEstimateForInvoiceInput as Y, LightningFeeEstimateForNodeInput as Z, LightningFeeEstimateOutput as _, AccountToApiTokensConnection as a, getLightningTransactionQuery as a0, LightsparkNode as a1, LightsparkNodePurpose as a2, LightsparkNodeStatus as a3, LightsparkNodeToChannelsConnection as a4, Node as a5, NodeAddress as a6, NodeAddressType as a7, NodeToAddressesConnection as a8, OnChainTransaction as a9, TransactionFailures as aA, TransactionStatus as aB, TransactionType as aC, TransactionUpdate as aD, Wallet as aE, WalletDashboard as aF, WebhookEventType as aG, Withdrawal as aH, getWithdrawalQuery as aI, WithdrawalMode as aJ, WithdrawalRequest as aK, WithdrawalRequestStatus as aL, WithdrawalRequestToChannelClosingTransactionsConnection as aM, WithdrawalRequestToChannelOpeningTransactionsConnection as aN, getOnChainTransactionQuery as aa, OutgoingPayment as ab, OutgoingPaymentAttempt as ac, OutgoingPaymentAttemptStatus as ad, OutgoingPaymentAttemptToHopsConnection as ae, OutgoingPaymentToAttemptsConnection as af, PageInfo as ag, PayInvoiceInput as ah, PayInvoiceOutput as ai, PaymentFailureReason as aj, PaymentRequest as ak, getPaymentRequestQuery as al, PaymentRequestData as am, PaymentRequestStatus as an, Permission as ao, RequestWithdrawalInput as ap, RequestWithdrawalOutput as aq, RichText as ar, RoutingTransaction as as, getRoutingTransactionQuery as at, RoutingTransactionFailureReason as au, Secret as av, SendPaymentInput as aw, SendPaymentOutput as ax, Transaction as ay, getTransactionQuery 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, CurrencyAmount as x, CurrencyUnit as y, DeleteApiTokenOutput as z };
+export { LightningTransaction as $, Account as A, Balances as B, Channel as C, DeleteApiTokenInput as D, Deposit as E, getDepositQuery as F, Entity as G, FeeEstimate as H, FundNodeInput as I, FundNodeOutput as J, GraphNode as K, LightsparkClient as L, Hop as M, getHopQuery as N, HtlcAttemptFailureCode as O, IncomingPayment as P, IncomingPaymentAttempt as Q, getIncomingPaymentAttemptQuery as R, IncomingPaymentAttemptStatus as S, IncomingPaymentToAttemptsConnection as T, Invoice as U, getInvoiceQuery as V, InvoiceData as W, InvoiceType as X, LightningFeeEstimateForInvoiceInput as Y, LightningFeeEstimateForNodeInput as Z, LightningFeeEstimateOutput as _, AccountToApiTokensConnection as a, getLightningTransactionQuery as a0, LightsparkNode as a1, LightsparkNodePurpose as a2, LightsparkNodeStatus as a3, LightsparkNodeToChannelsConnection as a4, Node as a5, NodeAddress as a6, NodeAddressType as a7, NodeToAddressesConnection as a8, OnChainTransaction as a9, getTransactionQuery as aA, TransactionFailures as aB, TransactionStatus as aC, TransactionType as aD, TransactionUpdate as aE, Wallet as aF, WebhookEventType as aG, Withdrawal as aH, getWithdrawalQuery as aI, WithdrawalMode as aJ, WithdrawalRequest as aK, WithdrawalRequestStatus as aL, WithdrawalRequestToChannelClosingTransactionsConnection as aM, WithdrawalRequestToChannelOpeningTransactionsConnection as aN, getOnChainTransactionQuery as aa, OutgoingPayment as ab, OutgoingPaymentAttempt as ac, OutgoingPaymentAttemptStatus as ad, OutgoingPaymentAttemptToHopsConnection as ae, OutgoingPaymentToAttemptsConnection as af, PageInfo as ag, PayInvoiceInput as ah, PayInvoiceOutput as ai, PaymentFailureReason as aj, PaymentRequest as ak, getPaymentRequestQuery as al, PaymentRequestData as am, PaymentRequestStatus as an, Permission as ao, RequestWithdrawalInput as ap, RequestWithdrawalOutput as aq, RichText as ar, RoutingTransaction as as, getRoutingTransactionQuery as at, RoutingTransactionFailureReason as au, Secret as av, SendPaymentInput as aw, SendPaymentOutput as ax, SingleNodeDashboard as ay, Transaction 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, CurrencyAmount as x, CurrencyUnit as y, DeleteApiTokenOutput as z };

package/dist/{Withdrawal-bf5c1b52.d.ts → Withdrawal-f8570ed4.d.ts}

@@ -1,4 +1,4 @@
-import { Maybe, Query, AuthProvider, NodeKeyCache } from '@lightsparkdev/core';
+import { Maybe, Query, AuthProvider, CryptoInterface } from '@lightsparkdev/core';
 import Observable from 'zen-observable';
 
 declare enum CurrencyUnit {
@@ -879,29 +879,7 @@ declare class OutgoingPayment implements LightningTransaction {
     static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
 }
 
-type TransactionUpdate = {
-    /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
-     **/
-    id: string;
-    /** The date and time when this transaction was initiated. **/
-    createdAt: string;
-    /** The date and time when the entity was last updated. **/
-    updatedAt: string;
-    /** The current status of this transaction. **/
-    status: TransactionStatus;
-    /** The amount of money involved in this transaction. **/
-    amount: CurrencyAmount;
-    /** The typename of the object **/
-    typename: string;
-    /** The date and time when this transaction was completed or failed. **/
-    resolvedAt?: string;
-    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
-    transactionHash?: string;
-};
-
-type WalletDashboard = {
+type SinglesNodeDashboard = {
     id: string;
     displayName: string;
     purpose: Maybe<LightsparkNodePurpose>;
@@ -925,6 +903,28 @@ type WalletDashboard = {
     recentTransactions: Transaction[];
 };
 
+type TransactionUpdate = {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when this transaction was initiated. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The current status of this transaction. **/
+    status: TransactionStatus;
+    /** The amount of money involved in this transaction. **/
+    amount: CurrencyAmount;
+    /** The typename of the object **/
+    typename: string;
+    /** The date and time when this transaction was completed or failed. **/
+    resolvedAt?: string;
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+    transactionHash?: string;
+};
+
 declare enum WithdrawalMode {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -1147,8 +1147,9 @@ declare class WithdrawalRequest implements Entity {
 declare class LightsparkClient {
     private authProvider;
     private readonly serverUrl;
-    private readonly nodeKeyCache;
+    private readonly cryptoImpl;
     private requester;
+    private readonly nodeKeyCache;
     /**
      * Constructs a new LightsparkClient.
      *
@@ -1158,7 +1159,7 @@ declare class LightsparkClient {
      * @param nodeKeyCache This is used to cache node keys for the duration of the session. Defaults to a new instance of
      *     `NodeKeyCache`. You should not need to change this.
      */
-    constructor(authProvider?: AuthProvider, serverUrl?: string, nodeKeyCache?: NodeKeyCache);
+    constructor(authProvider?: AuthProvider, serverUrl?: string, cryptoImpl?: CryptoInterface);
     /**
      * Sets the auth provider for the client. This is useful for switching between auth providers if you are using
      * multiple accounts or waiting for the user to log in.
@@ -1202,7 +1203,7 @@ declare class LightsparkClient {
      */
     getAccountDashboard(nodeIds?: string[] | undefined, bitcoinNetwork?: BitcoinNetwork): Promise<AccountDashboard>;
     /**
-     * Gets a basic dashboard for a single node, including recent transactions. See `WalletDashboard` for which info is
+     * Gets a basic dashboard for a single node, including recent transactions. See `SinglesNodeDashboard` for which info is
      * included.
      *
      * @param nodeId The node ID for which to get a dashboard.
@@ -1211,7 +1212,7 @@ declare class LightsparkClient {
      *     Defaults to undefined (no limit).
      * @returns A basic dashboard for the given node ID.
      */
-    getSingleNodeDashboard(nodeId: string, bitcoinNetwork?: BitcoinNetwork, transactionsAfterDate?: Maybe<string>): Promise<WalletDashboard>;
+    getSinglesNodeDashboard(nodeId: string, bitcoinNetwork?: BitcoinNetwork, transactionsAfterDate?: Maybe<string>): Promise<SinglesNodeDashboard>;
     /**
      * Creates an invoice for the given node.
      *
@@ -1735,4 +1736,4 @@ type Withdrawal = OnChainTransaction & Transaction & Entity & {
 };
 declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
 
-export { LightningTransaction as $, Account as A, Balances as B, Channel as C, DeleteApiTokenInput as D, Deposit as E, getDepositQuery as F, Entity as G, FeeEstimate as H, FundNodeInput as I, FundNodeOutput as J, GraphNode as K, LightsparkClient as L, Hop as M, getHopQuery as N, HtlcAttemptFailureCode as O, IncomingPayment as P, IncomingPaymentAttempt as Q, getIncomingPaymentAttemptQuery as R, IncomingPaymentAttemptStatus as S, IncomingPaymentToAttemptsConnection as T, Invoice as U, getInvoiceQuery as V, InvoiceData as W, InvoiceType as X, LightningFeeEstimateForInvoiceInput as Y, LightningFeeEstimateForNodeInput as Z, LightningFeeEstimateOutput as _, AccountToApiTokensConnection as a, getLightningTransactionQuery as a0, LightsparkNode as a1, LightsparkNodePurpose as a2, LightsparkNodeStatus as a3, LightsparkNodeToChannelsConnection as a4, Node as a5, NodeAddress as a6, NodeAddressType as a7, NodeToAddressesConnection as a8, OnChainTransaction as a9, TransactionFailures as aA, TransactionStatus as aB, TransactionType as aC, TransactionUpdate as aD, Wallet as aE, WalletDashboard as aF, WebhookEventType as aG, Withdrawal as aH, getWithdrawalQuery as aI, WithdrawalMode as aJ, WithdrawalRequest as aK, WithdrawalRequestStatus as aL, WithdrawalRequestToChannelClosingTransactionsConnection as aM, WithdrawalRequestToChannelOpeningTransactionsConnection as aN, getOnChainTransactionQuery as aa, OutgoingPayment as ab, OutgoingPaymentAttempt as ac, OutgoingPaymentAttemptStatus as ad, OutgoingPaymentAttemptToHopsConnection as ae, OutgoingPaymentToAttemptsConnection as af, PageInfo as ag, PayInvoiceInput as ah, PayInvoiceOutput as ai, PaymentFailureReason as aj, PaymentRequest as ak, getPaymentRequestQuery as al, PaymentRequestData as am, PaymentRequestStatus as an, Permission as ao, RequestWithdrawalInput as ap, RequestWithdrawalOutput as aq, RichText as ar, RoutingTransaction as as, getRoutingTransactionQuery as at, RoutingTransactionFailureReason as au, Secret as av, SendPaymentInput as aw, SendPaymentOutput as ax, Transaction as ay, getTransactionQuery 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, CurrencyAmount as x, CurrencyUnit as y, DeleteApiTokenOutput as z };
+export { LightningTransaction as $, Account as A, Balances as B, Channel as C, DeleteApiTokenInput as D, Deposit as E, getDepositQuery as F, Entity as G, FeeEstimate as H, FundNodeInput as I, FundNodeOutput as J, GraphNode as K, LightsparkClient as L, Hop as M, getHopQuery as N, HtlcAttemptFailureCode as O, IncomingPayment as P, IncomingPaymentAttempt as Q, getIncomingPaymentAttemptQuery as R, IncomingPaymentAttemptStatus as S, IncomingPaymentToAttemptsConnection as T, Invoice as U, getInvoiceQuery as V, InvoiceData as W, InvoiceType as X, LightningFeeEstimateForInvoiceInput as Y, LightningFeeEstimateForNodeInput as Z, LightningFeeEstimateOutput as _, AccountToApiTokensConnection as a, getLightningTransactionQuery as a0, LightsparkNode as a1, LightsparkNodePurpose as a2, LightsparkNodeStatus as a3, LightsparkNodeToChannelsConnection as a4, Node as a5, NodeAddress as a6, NodeAddressType as a7, NodeToAddressesConnection as a8, OnChainTransaction as a9, getTransactionQuery as aA, TransactionFailures as aB, TransactionStatus as aC, TransactionType as aD, TransactionUpdate as aE, Wallet as aF, WebhookEventType as aG, Withdrawal as aH, getWithdrawalQuery as aI, WithdrawalMode as aJ, WithdrawalRequest as aK, WithdrawalRequestStatus as aL, WithdrawalRequestToChannelClosingTransactionsConnection as aM, WithdrawalRequestToChannelOpeningTransactionsConnection as aN, getOnChainTransactionQuery as aa, OutgoingPayment as ab, OutgoingPaymentAttempt as ac, OutgoingPaymentAttemptStatus as ad, OutgoingPaymentAttemptToHopsConnection as ae, OutgoingPaymentToAttemptsConnection as af, PageInfo as ag, PayInvoiceInput as ah, PayInvoiceOutput as ai, PaymentFailureReason as aj, PaymentRequest as ak, getPaymentRequestQuery as al, PaymentRequestData as am, PaymentRequestStatus as an, Permission as ao, RequestWithdrawalInput as ap, RequestWithdrawalOutput as aq, RichText as ar, RoutingTransaction as as, getRoutingTransactionQuery as at, RoutingTransactionFailureReason as au, Secret as av, SendPaymentInput as aw, SendPaymentOutput as ax, SinglesNodeDashboard as ay, Transaction 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, CurrencyAmount as x, CurrencyUnit as y, DeleteApiTokenOutput as z };