lightspark_wallet library
Classes
- AmazonS3FundsRecoveryKit
- AuthProvider
- Balances
- 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.
- ChannelClosingTransaction
- This is an object representing a transaction which closes a channel on the Lightning Network. This operation allocates balances back to the local and remote nodes.
- ChannelOpeningTransaction
- This is an object representing a transaction which opens a channel on the Lightning Network. This object occurs only for channels funded by the local Lightspark node.
- CreateBitcoinFundingAddressOutput
- CreateInvoiceInput
- CreateInvoiceOutput
- CreateTestModeInvoiceInputWallet
- CreateTestModeInvoiceOutput
- CreateTestModePaymentInputWallet
- CreateTestModePaymentoutput
- This is an object identifying the output of a test mode payment. This object can be used to retrieve the associated payment made from a Test Mode Payment call.
- CurrencyAmount
- This object represents the value and unit for an amount of currency.
- DeleteFundsRecoveryKitOutput
- DeployWalletOutput
- Deposit
- This object represents a Deposit made to a Lightspark node wallet. This operation occurs for any L1 funding transaction to the wallet. You can retrieve this object to receive detailed information about the deposit.
- Entity
-
This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the
entityquery and its ID. - FeeEstimate
- This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates are separated by potential confirmation speeds for settlement.
- FundsRecoveryKit
- FundWalletInput
- FundWalletOutput
- GraphNode
- This object represents a node that exists on the Lightning Network, including nodes not managed by Lightspark. You can retrieve this object to get publicly available information about any node on the Lightning Network.
- IncomingPayment
- This object represents any payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific payment received by a Lightspark node.
- InitializeWalletInput
- InitializeWalletOutput
- InMemoryJwtStorage
- Invoice
- This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node.
- InvoiceData
- This object represents the data associated with a BOLT #11 invoice. You can retrieve this object to receive the relevant data associated with a specific invoice.
- JwtAuthProvider
- JwtStorage
- KeyInput
- LightningFeeEstimateForInvoiceInput
- LightningFeeEstimateForNodeInput
- LightningFeeEstimateOutput
- LightningTransaction
- This is an object representing a transaction made over the Lightning Network. You can retrieve this object to receive information about a specific transaction made over Lightning for a Lightspark node.
- LightsparkWallet
- LightsparkWalletClient
- The main entrypoint for interacting with the Lightspark Wallet SDK.
- LoginWithJWTInput
- LoginWithJWTOutput
- Node
- This object is an interface representing a Lightning Node on the Lightning Network, and could either be a Lightspark node or a node managed by a third party.
- NodeAddress
- This object represents the address of a node on the Lightning Network.
- NodeToAddressesConnection
- A connection between a node and the addresses it has announced for itself on Lightning Network.
- OnChainTransaction
- This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve this object to receive information about a specific on-chain transaction made on the Lightning Network associated with your Lightspark Node.
- OutgoingPayment
- This object represents a Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment sent from your Lightspark Node on the Lightning Network.
- PageInfo
- 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.
- PayInvoiceInput
- PayInvoiceOutput
- PaymentRequest
- This object contains information related to a payment request generated or received by a LightsparkNode. You can retrieve this object to receive payment information about a specific invoice.
- PaymentRequestData
- This object is an interface of a payment request on the Lightning Network (i.e., a Lightning Invoice). It contains data related to parsing the payment details of a Lightning Invoice.
-
Query<
T> - An object representing a graphQL query. Includes the query payload, variables, and a function to construct the object from the response.
- Requester
- RequestWithdrawalInput
- RequestWithdrawalOutput
- RichText
- SecureStorageJwtStorage
- SendPaymentInput
- SendPaymentOutput
- TerminateWalletOutput
- Transaction
- This object represents a payment transaction. The transaction can occur either on a Bitcoin Network, or over the Lightning Network. You can retrieve this object to receive specific information about a particular transaction tied to your Lightspark Node.
- UpdateFundsRecoveryKitInput
- UpdateFundsRecoveryKitOutput
- Wallet
- WalletDashboard
- WalletToPaymentRequestsConnection
- WalletToTransactionsConnection
- Withdrawal
- This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any L1 withdrawal associated with your Lightspark Node or account.
- WithdrawalRequest
- This object represents a request made for an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any withdrawal request made from your Lightspark account.
Enums
- BitcoinNetwork
- This is an enum identifying a particular Bitcoin Network.
- CurrencyUnit
- This enum identifies the unit of currency associated with a CurrencyAmount.
- InvoiceType
- This is an enum for potential invoice types.
- KeyType
- NodeAddressType
- This is an enum of the potential types of addresses that a node on the Lightning Network can have.
- PaymentFailureReason
- This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed.
- PaymentRequestStatus
- This is an enum of the potential states that a payment request on the Lightning Network can take.
- TransactionStatus
- This is an enum of the potential statuses a transaction associated with your Lightspark Node can take.
- TransactionType
- This is an enum of the potential types of transactions that can be associated with your Lightspark Node.
- WalletStatus
- This is an enum of the potential statuses that your Lightspark wallet can take.
- WithdrawalRequestStatus
- This is an enum of the potential statuses that a Withdrawal can take.
Functions
-
generateRsaKeyPair(
) → Future< KeyPair> -
getNonce(
) → int