@lightsparkdev/lightspark-sdk 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/dist/{BitcoinNetwork-a816c0be.d.ts → BitcoinNetwork-37e9f091.d.ts} +8 -3
- package/dist/env.d.cts +1 -1
- package/dist/env.d.ts +1 -1
- package/dist/{index-eb604025.d.ts → index-449c9f58.d.ts} +1461 -675
- package/dist/index.cjs +341 -307
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +323 -289
- package/dist/objects/index.d.cts +2 -2
- package/dist/objects/index.d.ts +2 -2
- package/dist/objects/index.js +1 -1
- package/package.json +4 -4
- package/src/NodeKeyLoaderCache.ts +4 -3
- package/src/SigningKeyLoader.ts +12 -7
- package/src/client.ts +99 -65
- package/src/env.ts +3 -1
- package/src/objects/Account.ts +7 -3
- package/src/objects/AccountToApiTokensConnection.ts +7 -3
- package/src/objects/AccountToChannelsConnection.ts +3 -2
- package/src/objects/AccountToNodesConnection.ts +7 -3
- package/src/objects/AccountToPaymentRequestsConnection.ts +7 -3
- package/src/objects/AccountToTransactionsConnection.ts +13 -9
- package/src/objects/AccountToWalletsConnection.ts +7 -3
- package/src/objects/ApiToken.ts +13 -7
- package/src/objects/Balances.ts +22 -12
- package/src/objects/BitcoinNetwork.ts +8 -3
- package/src/objects/BlockchainBalance.ts +4 -1
- package/src/objects/Channel.ts +37 -14
- package/src/objects/ChannelClosingTransaction.ts +22 -11
- package/src/objects/ChannelFees.ts +4 -1
- package/src/objects/ChannelOpeningTransaction.ts +22 -11
- package/src/objects/ChannelStatus.ts +33 -8
- package/src/objects/ChannelToTransactionsConnection.ts +9 -8
- package/src/objects/ComplianceProvider.ts +3 -2
- package/src/objects/Connection.ts +7 -3
- package/src/objects/CreateApiTokenInput.ts +4 -1
- package/src/objects/CreateApiTokenOutput.ts +3 -3
- package/src/objects/CreateLnurlInvoiceInput.ts +3 -2
- package/src/objects/CreateTestModePaymentInput.ts +2 -2
- package/src/objects/CreateTestModePaymentoutput.ts +5 -1
- package/src/objects/CurrencyAmount.ts +6 -4
- package/src/objects/CurrencyUnit.ts +36 -9
- package/src/objects/Deposit.ts +22 -11
- package/src/objects/Entity.ts +8 -3
- package/src/objects/FeeEstimate.ts +5 -1
- package/src/objects/GraphNode.ts +30 -14
- package/src/objects/Hop.ts +12 -4
- package/src/objects/HtlcAttemptFailureCode.ts +7 -3
- package/src/objects/IncentivesIneligibilityReason.ts +33 -9
- package/src/objects/IncentivesStatus.ts +14 -4
- package/src/objects/IncomingPayment.ts +18 -7
- package/src/objects/IncomingPaymentAttempt.ts +8 -3
- package/src/objects/IncomingPaymentAttemptStatus.ts +7 -3
- package/src/objects/IncomingPaymentToAttemptsConnection.ts +7 -3
- package/src/objects/Invoice.ts +2 -2
- package/src/objects/InvoiceData.ts +7 -3
- package/src/objects/InvoiceType.ts +3 -2
- package/src/objects/LightningFeeEstimateForInvoiceInput.ts +2 -2
- package/src/objects/LightningTransaction.ts +12 -4
- package/src/objects/LightsparkNode.ts +33 -18
- package/src/objects/LightsparkNodeOwner.ts +2 -2
- package/src/objects/LightsparkNodeStatus.ts +3 -2
- package/src/objects/LightsparkNodeToChannelsConnection.ts +7 -3
- package/src/objects/LightsparkNodeWithOSK.ts +35 -19
- package/src/objects/LightsparkNodeWithRemoteSigning.ts +31 -18
- package/src/objects/Node.ts +28 -14
- package/src/objects/NodeAddressType.ts +7 -3
- package/src/objects/NodeToAddressesConnection.ts +7 -3
- package/src/objects/OnChainTransaction.ts +23 -11
- package/src/objects/OutgoingPayment.ts +24 -7
- package/src/objects/OutgoingPaymentAttempt.ts +28 -13
- package/src/objects/OutgoingPaymentAttemptStatus.ts +7 -3
- package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts +12 -4
- package/src/objects/OutgoingPaymentToAttemptsConnection.ts +7 -3
- package/src/objects/PageInfo.ts +6 -1
- package/src/objects/PayInvoiceInput.ts +6 -3
- package/src/objects/PaymentDirection.ts +3 -2
- package/src/objects/PaymentFailureReason.ts +7 -3
- package/src/objects/PaymentRequest.ts +8 -3
- package/src/objects/PaymentRequestData.ts +5 -1
- package/src/objects/PaymentRequestStatus.ts +7 -3
- package/src/objects/Permission.ts +7 -3
- package/src/objects/PostTransactionData.ts +6 -3
- package/src/objects/RegionCode.ts +43 -12
- package/src/objects/RegisterPaymentInput.ts +12 -7
- package/src/objects/RemoteSigningSubEventType.ts +7 -3
- package/src/objects/RequestWithdrawalInput.ts +2 -2
- package/src/objects/RiskRating.ts +8 -3
- package/src/objects/RoutingTransaction.ts +20 -7
- package/src/objects/RoutingTransactionFailureReason.ts +8 -3
- package/src/objects/ScreenNodeInput.ts +3 -2
- package/src/objects/SendPaymentInput.ts +4 -1
- package/src/objects/SetInvoicePaymentHashInput.ts +3 -2
- package/src/objects/Signable.ts +2 -2
- package/src/objects/SignablePayload.ts +6 -3
- package/src/objects/SignablePayloadStatus.ts +3 -2
- package/src/objects/Transaction.ts +14 -4
- package/src/objects/TransactionFailures.ts +4 -1
- package/src/objects/TransactionStatus.ts +16 -5
- package/src/objects/TransactionType.ts +30 -8
- package/src/objects/TransactionUpdate.ts +6 -3
- package/src/objects/UmaInvitation.ts +10 -4
- package/src/objects/Wallet.ts +13 -4
- package/src/objects/WalletStatus.ts +36 -9
- package/src/objects/WalletToPaymentRequestsConnection.ts +7 -3
- package/src/objects/WalletToTransactionsConnection.ts +7 -3
- package/src/objects/WebhookEventType.ts +7 -3
- package/src/objects/Withdrawal.ts +22 -11
- package/src/objects/WithdrawalMode.ts +7 -3
- package/src/objects/WithdrawalRequest.ts +15 -6
- package/src/objects/WithdrawalRequestStatus.ts +3 -2
- package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +11 -4
- package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +11 -4
- package/src/objects/index.ts +6 -6
- package/src/tests/integration/general-regtest.test.ts +1 -1
- /package/dist/{chunk-GLL4KTUT.js → chunk-NCPWHRFO.js} +0 -0
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
export enum SignablePayloadStatus {
|
|
4
4
|
/**
|
|
5
|
-
* This is an enum value that represents values that could be added in the
|
|
6
|
-
* Clients should support unknown values as more of them could be
|
|
5
|
+
* This is an enum value that represents values that could be added in the
|
|
6
|
+
* future. Clients should support unknown values as more of them could be
|
|
7
|
+
* added without notice.
|
|
7
8
|
*/
|
|
8
9
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
9
10
|
|
|
@@ -26,11 +26,18 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
|
|
|
26
26
|
import TransactionStatus from "./TransactionStatus.js";
|
|
27
27
|
import type Withdrawal from "./Withdrawal.js";
|
|
28
28
|
|
|
29
|
-
/**
|
|
29
|
+
/**
|
|
30
|
+
* This object represents a payment transaction.
|
|
31
|
+
* The transaction can occur either on a Bitcoin Network,
|
|
32
|
+
* or over the Lightning Network. You can retrieve this object to receive
|
|
33
|
+
* specific information about a particular transaction tied to your Lightspark
|
|
34
|
+
* Node.
|
|
35
|
+
* *
|
|
36
|
+
*/
|
|
30
37
|
interface Transaction {
|
|
31
38
|
/**
|
|
32
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
33
|
-
* string.
|
|
39
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
40
|
+
* Should be treated as an opaque string.
|
|
34
41
|
**/
|
|
35
42
|
id: string;
|
|
36
43
|
|
|
@@ -52,7 +59,10 @@ interface Transaction {
|
|
|
52
59
|
/** The date and time when this transaction was completed or failed. **/
|
|
53
60
|
resolvedAt?: string | undefined;
|
|
54
61
|
|
|
55
|
-
/**
|
|
62
|
+
/**
|
|
63
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
64
|
+
* Lightning Network. *
|
|
65
|
+
*/
|
|
56
66
|
transactionHash?: string | undefined;
|
|
57
67
|
}
|
|
58
68
|
|
|
@@ -3,7 +3,10 @@
|
|
|
3
3
|
import PaymentFailureReason from "./PaymentFailureReason.js";
|
|
4
4
|
import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
|
|
5
5
|
|
|
6
|
-
/**
|
|
6
|
+
/**
|
|
7
|
+
* This object represents payment failures associated with your Lightspark
|
|
8
|
+
* Node. *
|
|
9
|
+
*/
|
|
7
10
|
interface TransactionFailures {
|
|
8
11
|
paymentFailures?: PaymentFailureReason[] | undefined;
|
|
9
12
|
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
|
|
2
2
|
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* This is an enum of the potential statuses a transaction associated with your
|
|
5
|
+
* Lightspark Node can take. *
|
|
6
|
+
*/
|
|
4
7
|
export enum TransactionStatus {
|
|
5
8
|
/**
|
|
6
|
-
* This is an enum value that represents values that could be added in the
|
|
7
|
-
* Clients should support unknown values as more of them could be
|
|
9
|
+
* This is an enum value that represents values that could be added in the
|
|
10
|
+
* future. Clients should support unknown values as more of them could be
|
|
11
|
+
* added without notice.
|
|
8
12
|
*/
|
|
9
13
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
10
14
|
/** Transaction succeeded.. **/
|
|
@@ -13,9 +17,16 @@ export enum TransactionStatus {
|
|
|
13
17
|
FAILED = "FAILED",
|
|
14
18
|
/** Transaction has been initiated and is currently in-flight. **/
|
|
15
19
|
PENDING = "PENDING",
|
|
16
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* For transaction type PAYMENT_REQUEST only.
|
|
22
|
+
* No payments have been made to a payment request.
|
|
23
|
+
* *
|
|
24
|
+
*/
|
|
17
25
|
NOT_STARTED = "NOT_STARTED",
|
|
18
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* For transaction type PAYMENT_REQUEST only. A payment request has expired.
|
|
28
|
+
* *
|
|
29
|
+
*/
|
|
19
30
|
EXPIRED = "EXPIRED",
|
|
20
31
|
/** For transaction type PAYMENT_REQUEST only. **/
|
|
21
32
|
CANCELLED = "CANCELLED",
|
|
@@ -1,31 +1,53 @@
|
|
|
1
1
|
// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
|
|
2
2
|
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* This is an enum of the potential types of transactions that can be
|
|
5
|
+
* associated with your Lightspark Node.
|
|
6
|
+
* *
|
|
7
|
+
*/
|
|
4
8
|
export enum TransactionType {
|
|
5
9
|
/**
|
|
6
|
-
* This is an enum value that represents values that could be added in the
|
|
7
|
-
* Clients should support unknown values as more of them could be
|
|
10
|
+
* This is an enum value that represents values that could be added in the
|
|
11
|
+
* future. Clients should support unknown values as more of them could be
|
|
12
|
+
* added without notice.
|
|
8
13
|
*/
|
|
9
14
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
10
15
|
/** Transactions initiated from a Lightspark node on Lightning Network. **/
|
|
11
16
|
OUTGOING_PAYMENT = "OUTGOING_PAYMENT",
|
|
12
17
|
/** Transactions received by a Lightspark node on Lightning Network. **/
|
|
13
18
|
INCOMING_PAYMENT = "INCOMING_PAYMENT",
|
|
14
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Transactions that forwarded payments through Lightspark nodes on Lightning
|
|
21
|
+
* Network. *
|
|
22
|
+
*/
|
|
15
23
|
ROUTED = "ROUTED",
|
|
16
|
-
/**
|
|
24
|
+
/**
|
|
25
|
+
* Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark
|
|
26
|
+
* node to a Bitcoin wallet. *
|
|
27
|
+
*/
|
|
17
28
|
L1_WITHDRAW = "L1_WITHDRAW",
|
|
18
29
|
/** Transactions on Bitcoin blockchain to fund a Lightspark node's wallet. **/
|
|
19
30
|
L1_DEPOSIT = "L1_DEPOSIT",
|
|
20
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Transactions on Bitcoin blockchain to open a channel on Lightning Network
|
|
33
|
+
* funded by the local Lightspark node.
|
|
34
|
+
* *
|
|
35
|
+
*/
|
|
21
36
|
CHANNEL_OPEN = "CHANNEL_OPEN",
|
|
22
|
-
/**
|
|
37
|
+
/**
|
|
38
|
+
* Transactions on Bitcoin blockchain to close a channel on Lightning Network
|
|
39
|
+
* where the balances are allocated back to local and remote nodes.
|
|
40
|
+
* *
|
|
41
|
+
*/
|
|
23
42
|
CHANNEL_CLOSE = "CHANNEL_CLOSE",
|
|
24
43
|
/** Transactions initiated from a Lightspark node on Lightning Network. **/
|
|
25
44
|
PAYMENT = "PAYMENT",
|
|
26
45
|
/** Payment requests from a Lightspark node on Lightning Network **/
|
|
27
46
|
PAYMENT_REQUEST = "PAYMENT_REQUEST",
|
|
28
|
-
/**
|
|
47
|
+
/**
|
|
48
|
+
* Transactions that forwarded payments through Lightspark nodes on Lightning
|
|
49
|
+
* Network. *
|
|
50
|
+
*/
|
|
29
51
|
ROUTE = "ROUTE",
|
|
30
52
|
}
|
|
31
53
|
|
|
@@ -6,8 +6,8 @@ import TransactionStatus from "./TransactionStatus.js";
|
|
|
6
6
|
|
|
7
7
|
type TransactionUpdate = {
|
|
8
8
|
/**
|
|
9
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
10
|
-
* string.
|
|
9
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
10
|
+
* Should be treated as an opaque string.
|
|
11
11
|
**/
|
|
12
12
|
id: string;
|
|
13
13
|
|
|
@@ -29,7 +29,10 @@ type TransactionUpdate = {
|
|
|
29
29
|
/** The date and time when this transaction was completed or failed. **/
|
|
30
30
|
resolvedAt?: string;
|
|
31
31
|
|
|
32
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
34
|
+
* Lightning Network. *
|
|
35
|
+
*/
|
|
33
36
|
transactionHash?: string;
|
|
34
37
|
};
|
|
35
38
|
|
|
@@ -7,8 +7,8 @@ import IncentivesStatus from "./IncentivesStatus.js";
|
|
|
7
7
|
/** This is an object representing an UMA.ME invitation. **/
|
|
8
8
|
interface UmaInvitation {
|
|
9
9
|
/**
|
|
10
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
11
|
-
* string.
|
|
10
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
11
|
+
* Should be treated as an opaque string.
|
|
12
12
|
**/
|
|
13
13
|
id: string;
|
|
14
14
|
|
|
@@ -27,7 +27,10 @@ interface UmaInvitation {
|
|
|
27
27
|
/** The UMA of the user who created the invitation. **/
|
|
28
28
|
inviterUma: string;
|
|
29
29
|
|
|
30
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* The current status of the incentives that may be tied to this invitation.
|
|
32
|
+
* *
|
|
33
|
+
*/
|
|
31
34
|
incentivesStatus: IncentivesStatus;
|
|
32
35
|
|
|
33
36
|
/** The typename of the object **/
|
|
@@ -36,7 +39,10 @@ interface UmaInvitation {
|
|
|
36
39
|
/** The UMA of the user who claimed the invitation. **/
|
|
37
40
|
inviteeUma?: string | undefined;
|
|
38
41
|
|
|
39
|
-
/**
|
|
42
|
+
/**
|
|
43
|
+
* The reason why the invitation is not eligible for incentives, if
|
|
44
|
+
* applicable. *
|
|
45
|
+
*/
|
|
40
46
|
incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
|
|
41
47
|
}
|
|
42
48
|
|
package/src/objects/Wallet.ts
CHANGED
|
@@ -17,19 +17,28 @@ import { WalletToPaymentRequestsConnectionFromJson } from "./WalletToPaymentRequ
|
|
|
17
17
|
import type WalletToTransactionsConnection from "./WalletToTransactionsConnection.js";
|
|
18
18
|
import { WalletToTransactionsConnectionFromJson } from "./WalletToTransactionsConnection.js";
|
|
19
19
|
|
|
20
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* This object represents a Lightspark Wallet, tied to your Lightspark account.
|
|
22
|
+
* Wallets can be used to send or receive funds over the Lightning Network.
|
|
23
|
+
* You can retrieve this object to receive information about a specific wallet
|
|
24
|
+
* tied to your Lightspark account. *
|
|
25
|
+
*/
|
|
21
26
|
class Wallet implements LightsparkNodeOwner, Entity {
|
|
22
27
|
constructor(
|
|
23
28
|
/**
|
|
24
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
25
|
-
* string.
|
|
29
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
30
|
+
* Should be treated as an opaque string.
|
|
26
31
|
**/
|
|
27
32
|
public readonly id: string,
|
|
28
33
|
/** The date and time when the entity was first created. **/
|
|
29
34
|
public readonly createdAt: string,
|
|
30
35
|
/** The date and time when the entity was last updated. **/
|
|
31
36
|
public readonly updatedAt: string,
|
|
32
|
-
/**
|
|
37
|
+
/**
|
|
38
|
+
* The unique identifier of this wallet,
|
|
39
|
+
* as provided by the Lightspark Customer during login.
|
|
40
|
+
* *
|
|
41
|
+
*/
|
|
33
42
|
public readonly thirdPartyIdentifier: string,
|
|
34
43
|
/** The status of this wallet. **/
|
|
35
44
|
public readonly status: WalletStatus,
|
|
@@ -1,29 +1,56 @@
|
|
|
1
1
|
// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
|
|
2
2
|
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* This is an enum of the potential statuses that your Lightspark wallet can
|
|
5
|
+
* take. *
|
|
6
|
+
*/
|
|
4
7
|
export enum WalletStatus {
|
|
5
8
|
/**
|
|
6
|
-
* This is an enum value that represents values that could be added in the
|
|
7
|
-
* Clients should support unknown values as more of them could be
|
|
9
|
+
* This is an enum value that represents values that could be added in the
|
|
10
|
+
* future. Clients should support unknown values as more of them could be
|
|
11
|
+
* added without notice.
|
|
8
12
|
*/
|
|
9
13
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
10
|
-
/**
|
|
14
|
+
/**
|
|
15
|
+
* The wallet has not been set up yet and is ready to be deployed.
|
|
16
|
+
* This is the default status after the first login.
|
|
17
|
+
* *
|
|
18
|
+
*/
|
|
11
19
|
NOT_SETUP = "NOT_SETUP",
|
|
12
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* The wallet is currently being deployed in the Lightspark infrastructure.
|
|
22
|
+
* *
|
|
23
|
+
*/
|
|
13
24
|
DEPLOYING = "DEPLOYING",
|
|
14
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* The wallet has been deployed in the Lightspark infrastructure and is ready
|
|
27
|
+
* to be initialized. *
|
|
28
|
+
*/
|
|
15
29
|
DEPLOYED = "DEPLOYED",
|
|
16
30
|
/** The wallet is currently being initialized. **/
|
|
17
31
|
INITIALIZING = "INITIALIZING",
|
|
18
32
|
/** The wallet is available and ready to be used. **/
|
|
19
33
|
READY = "READY",
|
|
20
|
-
/**
|
|
34
|
+
/**
|
|
35
|
+
* The wallet is temporarily available,
|
|
36
|
+
* due to a transient issue or a scheduled maintenance.
|
|
37
|
+
* *
|
|
38
|
+
*/
|
|
21
39
|
UNAVAILABLE = "UNAVAILABLE",
|
|
22
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* The wallet had an unrecoverable failure.
|
|
42
|
+
* This status is not expected to happend and will be investigated by the
|
|
43
|
+
* Lightspark team. *
|
|
44
|
+
*/
|
|
23
45
|
FAILED = "FAILED",
|
|
24
46
|
/** The wallet is being terminated. **/
|
|
25
47
|
TERMINATING = "TERMINATING",
|
|
26
|
-
/**
|
|
48
|
+
/**
|
|
49
|
+
* The wallet has been terminated and is not available in the Lightspark
|
|
50
|
+
* infrastructure anymore. It is not connected to the Lightning network and
|
|
51
|
+
* its funds can only be accessed using the Funds Recovery flow.
|
|
52
|
+
* *
|
|
53
|
+
*/
|
|
27
54
|
TERMINATED = "TERMINATED",
|
|
28
55
|
}
|
|
29
56
|
|
|
@@ -10,12 +10,16 @@ import {
|
|
|
10
10
|
|
|
11
11
|
interface WalletToPaymentRequestsConnection {
|
|
12
12
|
/**
|
|
13
|
-
* The total count of objects in this connection, using the current filters.
|
|
14
|
-
* number of objects returned in the current page
|
|
13
|
+
* The total count of objects in this connection, using the current filters.
|
|
14
|
+
* It is different from the number of objects returned in the current page
|
|
15
|
+
* (in the `entities` field).
|
|
15
16
|
**/
|
|
16
17
|
count: number;
|
|
17
18
|
|
|
18
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* An object that holds pagination information about the objects in this
|
|
21
|
+
* connection. *
|
|
22
|
+
*/
|
|
19
23
|
pageInfo: PageInfo;
|
|
20
24
|
|
|
21
25
|
/** The payment requests for the current page of this connection. **/
|
|
@@ -7,12 +7,16 @@ import { TransactionFromJson, TransactionToJson } from "./Transaction.js";
|
|
|
7
7
|
|
|
8
8
|
interface WalletToTransactionsConnection {
|
|
9
9
|
/**
|
|
10
|
-
* The total count of objects in this connection, using the current filters.
|
|
11
|
-
* number of objects returned in the current page
|
|
10
|
+
* The total count of objects in this connection, using the current filters.
|
|
11
|
+
* It is different from the number of objects returned in the current page
|
|
12
|
+
* (in the `entities` field).
|
|
12
13
|
**/
|
|
13
14
|
count: number;
|
|
14
15
|
|
|
15
|
-
/**
|
|
16
|
+
/**
|
|
17
|
+
* An object that holds pagination information about the objects in this
|
|
18
|
+
* connection. *
|
|
19
|
+
*/
|
|
16
20
|
pageInfo: PageInfo;
|
|
17
21
|
|
|
18
22
|
/** The transactions for the current page of this connection. **/
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
|
|
2
2
|
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* This is an enum of the potential event types that can be associated with
|
|
5
|
+
* your Lightspark wallets. *
|
|
6
|
+
*/
|
|
4
7
|
export enum WebhookEventType {
|
|
5
8
|
/**
|
|
6
|
-
* This is an enum value that represents values that could be added in the
|
|
7
|
-
* Clients should support unknown values as more of them could be
|
|
9
|
+
* This is an enum value that represents values that could be added in the
|
|
10
|
+
* future. Clients should support unknown values as more of them could be
|
|
11
|
+
* added without notice.
|
|
8
12
|
*/
|
|
9
13
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
10
14
|
|
|
@@ -8,11 +8,16 @@ import {
|
|
|
8
8
|
} from "./CurrencyAmount.js";
|
|
9
9
|
import TransactionStatus from "./TransactionStatus.js";
|
|
10
10
|
|
|
11
|
-
/**
|
|
11
|
+
/**
|
|
12
|
+
* This object represents an L1 withdrawal from your Lightspark Node to any
|
|
13
|
+
* Bitcoin wallet. You can retrieve this object to receive detailed information
|
|
14
|
+
* about any L1 withdrawal associated with your Lightspark Node or account.
|
|
15
|
+
* *
|
|
16
|
+
*/
|
|
12
17
|
interface Withdrawal {
|
|
13
18
|
/**
|
|
14
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
15
|
-
* string.
|
|
19
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
20
|
+
* Should be treated as an opaque string.
|
|
16
21
|
**/
|
|
17
22
|
id: string;
|
|
18
23
|
|
|
@@ -29,8 +34,8 @@ interface Withdrawal {
|
|
|
29
34
|
amount: CurrencyAmount;
|
|
30
35
|
|
|
31
36
|
/**
|
|
32
|
-
* The height of the block that included this transaction.
|
|
33
|
-
* transactions.
|
|
37
|
+
* The height of the block that included this transaction.
|
|
38
|
+
* This will be zero for unconfirmed transactions.
|
|
34
39
|
**/
|
|
35
40
|
blockHeight: number;
|
|
36
41
|
|
|
@@ -46,22 +51,28 @@ interface Withdrawal {
|
|
|
46
51
|
/** The date and time when this transaction was completed or failed. **/
|
|
47
52
|
resolvedAt?: string | undefined;
|
|
48
53
|
|
|
49
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
56
|
+
* Lightning Network. *
|
|
57
|
+
*/
|
|
50
58
|
transactionHash?: string | undefined;
|
|
51
59
|
|
|
52
60
|
/**
|
|
53
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
54
|
-
* blockchain.
|
|
61
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
62
|
+
* to the Bitcoin blockchain.
|
|
55
63
|
**/
|
|
56
64
|
fees?: CurrencyAmount | undefined;
|
|
57
65
|
|
|
58
66
|
/**
|
|
59
|
-
* The hash of the block that included this transaction.
|
|
60
|
-
* transactions.
|
|
67
|
+
* The hash of the block that included this transaction.
|
|
68
|
+
* This will be null for unconfirmed transactions.
|
|
61
69
|
**/
|
|
62
70
|
blockHash?: string | undefined;
|
|
63
71
|
|
|
64
|
-
/**
|
|
72
|
+
/**
|
|
73
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
74
|
+
* *
|
|
75
|
+
*/
|
|
65
76
|
numConfirmations?: number | undefined;
|
|
66
77
|
}
|
|
67
78
|
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
|
|
2
2
|
|
|
3
|
-
/**
|
|
3
|
+
/**
|
|
4
|
+
* This is an enum of the potential modes that your Bitcoin withdrawal can
|
|
5
|
+
* take. *
|
|
6
|
+
*/
|
|
4
7
|
export enum WithdrawalMode {
|
|
5
8
|
/**
|
|
6
|
-
* This is an enum value that represents values that could be added in the
|
|
7
|
-
* Clients should support unknown values as more of them could be
|
|
9
|
+
* This is an enum value that represents values that could be added in the
|
|
10
|
+
* future. Clients should support unknown values as more of them could be
|
|
11
|
+
* added without notice.
|
|
8
12
|
*/
|
|
9
13
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
10
14
|
|
|
@@ -16,12 +16,18 @@ import { WithdrawalRequestToChannelClosingTransactionsConnectionFromJson } from
|
|
|
16
16
|
import type WithdrawalRequestToChannelOpeningTransactionsConnection from "./WithdrawalRequestToChannelOpeningTransactionsConnection.js";
|
|
17
17
|
import { WithdrawalRequestToChannelOpeningTransactionsConnectionFromJson } from "./WithdrawalRequestToChannelOpeningTransactionsConnection.js";
|
|
18
18
|
|
|
19
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* This object represents a request made for an L1 withdrawal from your
|
|
21
|
+
* Lightspark Node to any Bitcoin wallet.
|
|
22
|
+
* You can retrieve this object to receive detailed information about any
|
|
23
|
+
* withdrawal request made from your Lightspark account.
|
|
24
|
+
* *
|
|
25
|
+
*/
|
|
20
26
|
class WithdrawalRequest implements Entity {
|
|
21
27
|
constructor(
|
|
22
28
|
/**
|
|
23
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
24
|
-
* string.
|
|
29
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
30
|
+
* Should be treated as an opaque string.
|
|
25
31
|
**/
|
|
26
32
|
public readonly id: string,
|
|
27
33
|
/** The date and time when the entity was first created. **/
|
|
@@ -32,15 +38,18 @@ class WithdrawalRequest implements Entity {
|
|
|
32
38
|
public readonly amount: CurrencyAmount,
|
|
33
39
|
/** The bitcoin address where the funds should be sent. **/
|
|
34
40
|
public readonly bitcoinAddress: string,
|
|
35
|
-
/**
|
|
41
|
+
/**
|
|
42
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
43
|
+
* *
|
|
44
|
+
*/
|
|
36
45
|
public readonly withdrawalMode: WithdrawalMode,
|
|
37
46
|
/** The current status of this withdrawal request. **/
|
|
38
47
|
public readonly status: WithdrawalRequestStatus,
|
|
39
48
|
/** The typename of the object **/
|
|
40
49
|
public readonly typename: string,
|
|
41
50
|
/**
|
|
42
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
43
|
-
* for the withdrawal.
|
|
51
|
+
* If the requested amount is `-1` (i.e. everything),
|
|
52
|
+
* this field may contain an estimate of the amount for the withdrawal.
|
|
44
53
|
**/
|
|
45
54
|
public readonly estimatedAmount?: CurrencyAmount | undefined,
|
|
46
55
|
/** The time at which this request was completed. **/
|
|
@@ -3,8 +3,9 @@
|
|
|
3
3
|
/** This is an enum of the potential statuses that a Withdrawal can take. **/
|
|
4
4
|
export enum WithdrawalRequestStatus {
|
|
5
5
|
/**
|
|
6
|
-
* This is an enum value that represents values that could be added in the
|
|
7
|
-
* Clients should support unknown values as more of them could be
|
|
6
|
+
* This is an enum value that represents values that could be added in the
|
|
7
|
+
* future. Clients should support unknown values as more of them could be
|
|
8
|
+
* added without notice.
|
|
8
9
|
*/
|
|
9
10
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
10
11
|
|
|
@@ -9,16 +9,23 @@ import type PageInfo from "./PageInfo.js";
|
|
|
9
9
|
import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
|
|
10
10
|
|
|
11
11
|
interface WithdrawalRequestToChannelClosingTransactionsConnection {
|
|
12
|
-
/**
|
|
12
|
+
/**
|
|
13
|
+
* An object that holds pagination information about the objects in this
|
|
14
|
+
* connection. *
|
|
15
|
+
*/
|
|
13
16
|
pageInfo: PageInfo;
|
|
14
17
|
|
|
15
18
|
/**
|
|
16
|
-
* The total count of objects in this connection, using the current filters.
|
|
17
|
-
* number of objects returned in the current page
|
|
19
|
+
* The total count of objects in this connection, using the current filters.
|
|
20
|
+
* It is different from the number of objects returned in the current page
|
|
21
|
+
* (in the `entities` field).
|
|
18
22
|
**/
|
|
19
23
|
count: number;
|
|
20
24
|
|
|
21
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* The channel closing transactions for the current page of this connection.
|
|
27
|
+
* *
|
|
28
|
+
*/
|
|
22
29
|
entities: ChannelClosingTransaction[];
|
|
23
30
|
}
|
|
24
31
|
|
|
@@ -9,16 +9,23 @@ import type PageInfo from "./PageInfo.js";
|
|
|
9
9
|
import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
|
|
10
10
|
|
|
11
11
|
interface WithdrawalRequestToChannelOpeningTransactionsConnection {
|
|
12
|
-
/**
|
|
12
|
+
/**
|
|
13
|
+
* An object that holds pagination information about the objects in this
|
|
14
|
+
* connection. *
|
|
15
|
+
*/
|
|
13
16
|
pageInfo: PageInfo;
|
|
14
17
|
|
|
15
18
|
/**
|
|
16
|
-
* The total count of objects in this connection, using the current filters.
|
|
17
|
-
* number of objects returned in the current page
|
|
19
|
+
* The total count of objects in this connection, using the current filters.
|
|
20
|
+
* It is different from the number of objects returned in the current page
|
|
21
|
+
* (in the `entities` field).
|
|
18
22
|
**/
|
|
19
23
|
count: number;
|
|
20
24
|
|
|
21
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* The channel opening transactions for the current page of this connection.
|
|
27
|
+
* *
|
|
28
|
+
*/
|
|
22
29
|
entities: ChannelOpeningTransaction[];
|
|
23
30
|
}
|
|
24
31
|
|
package/src/objects/index.ts
CHANGED
|
@@ -102,12 +102,13 @@ export { default as OutgoingPayment } from "./OutgoingPayment.js";
|
|
|
102
102
|
export { default as OutgoingPaymentAttempt } from "./OutgoingPaymentAttempt.js";
|
|
103
103
|
export { default as OutgoingPaymentAttemptStatus } from "./OutgoingPaymentAttemptStatus.js";
|
|
104
104
|
export { default as OutgoingPaymentAttemptToHopsConnection } from "./OutgoingPaymentAttemptToHopsConnection.js";
|
|
105
|
+
export { default as OutgoingPaymentToAttemptsConnection } from "./OutgoingPaymentToAttemptsConnection.js";
|
|
105
106
|
export { default as OutgoingPaymentsForInvoiceQueryInput } from "./OutgoingPaymentsForInvoiceQueryInput.js";
|
|
106
107
|
export { default as OutgoingPaymentsForInvoiceQueryOutput } from "./OutgoingPaymentsForInvoiceQueryOutput.js";
|
|
107
|
-
export { default as OutgoingPaymentToAttemptsConnection } from "./OutgoingPaymentToAttemptsConnection.js";
|
|
108
108
|
export { default as PageInfo } from "./PageInfo.js";
|
|
109
109
|
export { default as PayInvoiceInput } from "./PayInvoiceInput.js";
|
|
110
110
|
export { default as PayInvoiceOutput } from "./PayInvoiceOutput.js";
|
|
111
|
+
export { default as PayUmaInvoiceInput } from "./PayUmaInvoiceInput.js";
|
|
111
112
|
export { default as PaymentDirection } from "./PaymentDirection.js";
|
|
112
113
|
export { default as PaymentFailureReason } from "./PaymentFailureReason.js";
|
|
113
114
|
export {
|
|
@@ -116,7 +117,6 @@ export {
|
|
|
116
117
|
} from "./PaymentRequest.js";
|
|
117
118
|
export { default as PaymentRequestData } from "./PaymentRequestData.js";
|
|
118
119
|
export { default as PaymentRequestStatus } from "./PaymentRequestStatus.js";
|
|
119
|
-
export { default as PayUmaInvoiceInput } from "./PayUmaInvoiceInput.js";
|
|
120
120
|
export { default as Permission } from "./Permission.js";
|
|
121
121
|
export { default as PostTransactionData } from "./PostTransactionData.js";
|
|
122
122
|
export { default as RegionCode } from "./RegionCode.js";
|
|
@@ -143,16 +143,16 @@ export { default as SendPaymentInput } from "./SendPaymentInput.js";
|
|
|
143
143
|
export { default as SendPaymentOutput } from "./SendPaymentOutput.js";
|
|
144
144
|
export { default as SetInvoicePaymentHashInput } from "./SetInvoicePaymentHashInput.js";
|
|
145
145
|
export { default as SetInvoicePaymentHashOutput } from "./SetInvoicePaymentHashOutput.js";
|
|
146
|
+
export { default as SignInvoiceInput } from "./SignInvoiceInput.js";
|
|
147
|
+
export { default as SignInvoiceOutput } from "./SignInvoiceOutput.js";
|
|
148
|
+
export { default as SignMessagesInput } from "./SignMessagesInput.js";
|
|
149
|
+
export { default as SignMessagesOutput } from "./SignMessagesOutput.js";
|
|
146
150
|
export { default as Signable, getSignableQuery } from "./Signable.js";
|
|
147
151
|
export {
|
|
148
152
|
default as SignablePayload,
|
|
149
153
|
getSignablePayloadQuery,
|
|
150
154
|
} from "./SignablePayload.js";
|
|
151
155
|
export { default as SignablePayloadStatus } from "./SignablePayloadStatus.js";
|
|
152
|
-
export { default as SignInvoiceInput } from "./SignInvoiceInput.js";
|
|
153
|
-
export { default as SignInvoiceOutput } from "./SignInvoiceOutput.js";
|
|
154
|
-
export { default as SignMessagesInput } from "./SignMessagesInput.js";
|
|
155
|
-
export { default as SignMessagesOutput } from "./SignMessagesOutput.js";
|
|
156
156
|
export { default as SingleNodeDashboard } from "./SingleNodeDashboard.js";
|
|
157
157
|
export { default as Transaction, getTransactionQuery } from "./Transaction.js";
|
|
158
158
|
export { default as TransactionFailures } from "./TransactionFailures.js";
|
|
@@ -213,7 +213,7 @@ describe(initSuiteName, () => {
|
|
|
213
213
|
throw new TypeError("No connections in account");
|
|
214
214
|
}
|
|
215
215
|
|
|
216
|
-
const [regtestNode] = nodesConnection
|
|
216
|
+
const [regtestNode] = nodesConnection.entities;
|
|
217
217
|
regtestNodeId = regtestNode?.id;
|
|
218
218
|
log("regtestNodeId", regtestNode?.id);
|
|
219
219
|
|
|
File without changes
|