wallet-sdk/com.lightspark.sdk.wallet/LightsparkFuturesWalletClient

LightsparkFuturesWalletClient

class LightsparkFuturesWalletClient(config: ClientConfig)

Main entry point for the Lightspark SDK using the Java Futures API.

This client is meant to be used in Java codebases that do not support Kotlin coroutines.

// Initialize the client with oauth:
OAuthHelper oAuthHelper = new OAuthHelper(applicationContext);
LightsparkFuturesWalletClient lightsparkClient = new LightsparkFuturesWalletClient(new ClientConfig(
    authProvider = new OAuthProvider(oAuthHelper)
));

// An example API call fetching the dashboard info for the active account:
WalletDashboard dashboard = lightsparkClient.getWalletDashboard().get(5, TimeUnit.SECONDS);

Note: This client object keeps a local cache in-memory, so a single instance should be reused throughout the lifetime of your app.

Constructors

LightsparkFuturesWalletClient

constructor(config: ClientConfig)

Functions

createBitcoinFundingAddress

fun createBitcoinFundingAddress(): <Error class: unknown class><String>

Creates an L1 Bitcoin wallet address which can be used to deposit or withdraw funds from the Lightning wallet.

createInvoice

fun createInvoice(amountMsats: Long, memo: String? = null, type: InvoiceType = InvoiceType.STANDARD): <Error class: unknown class><InvoiceData>

Creates a lightning invoice for the current wallet.

decodeInvoice

fun decodeInvoice(encodedInvoice: String): <Error class: unknown class><InvoiceData>

Decode a lightning invoice to get its details included payment amount, destination, etc.

deployWallet

suspend fun deployWallet(): <Error class: unknown class><Wallet>

Deploys a wallet in the Lightspark infrastructure. This is an asynchronous operation, the caller should then poll the wallet frequently (or subscribe to its modifications). When this process is over, the Wallet status will change to DEPLOYED (or FAILED).

executeQuery

fun <T> executeQuery(query: Query<T>): <Error class: unknown class><T>

Executes a raw graphql query against the server.

getBitcoinFeeEstimate

fun getBitcoinFeeEstimate(): <Error class: unknown class><FeeEstimate>

Get the L1 fee estimate for a deposit or withdrawal.

getCurrentWallet

fun getCurrentWallet(): <Error class: unknown class><Wallet?>

getLightningFeeEstimateForInvoice

suspend fun getLightningFeeEstimateForInvoice(encodedPaymentRequest: String, amountMsats: Long? = null): <Error class: unknown class><CurrencyAmount>

Gets an estimate of the fees that will be paid for a Lightning invoice.

getLightningFeeEstimateForNode

suspend fun getLightningFeeEstimateForNode(destinationNodePublicKey: String, amountMsats: Long): <Error class: unknown class><CurrencyAmount>

Returns an estimate of the fees that will be paid to send a payment to another Lightning node.

getWalletDashboard

fun getWalletDashboard(numTransactions: Int = 20, numPaymentRequests: Int = 20): <Error class: unknown class><WalletDashboard?>

Get the dashboard overview for a Lightning wallet. Includes balance info and the most recent transactions and payment requests.

initializeWallet

suspend fun initializeWallet(keyType: KeyType, signingPublicKey: String): <Error class: unknown class><Wallet>

Initializes a wallet in the Lightspark infrastructure and syncs it to the Bitcoin network. This is an asynchronous operation, the caller should then poll the wallet frequently (or subscribe to its modifications). When this process is over, the Wallet status will change to READY (or FAILED).

isWalletUnlocked

fun isWalletUnlocked(): <Error class: unknown class><Boolean>

loadWalletSigningKey

fun loadWalletSigningKey(signingKeyBytesPEM: ByteArray)

Unlocks the wallet for use with the SDK for the current application session. This function must be called before any other functions that require wallet signing keys, including payInvoice.

loginWithJWT

fun loginWithJWT(accountId: String, jwt: String, storage: JwtStorage): <Error class: unknown class><LoginWithJWTOutput>

payInvoice

fun payInvoice(encodedInvoice: String, maxFeesMsats: Long, amountMsats: Long? = null, timeoutSecs: Int = 60): <Error class: unknown class><OutgoingPayment>

Pay a lightning invoice from the current wallet.

requestWithdrawal

fun requestWithdrawal(amountSats: Long, bitcoinAddress: String): <Error class: unknown class><WithdrawalRequest>

Withdraws funds from the account and sends it to the requested bitcoin address.

sendPayment

fun sendPayment(destinationPublicKey: String, amountMsats: Long, maxFeesMsats: Long, timeoutSecs: Int = 60): <Error class: unknown class><OutgoingPayment>

Sends a payment directly to a node on the Lightning Network through the public key of the node without an invoice.

setAuthProvider

fun setAuthProvider(authProvider: AuthProvider)

Override the auth token provider for this client to provide custom headers on all API calls.

terminateWallet

suspend fun terminateWallet(): <Error class: unknown class><Wallet>

Removes the wallet from Lightspark infrastructure. It won't be connected to the Lightning network anymore and its funds won't be accessible outside of the Funds Recovery Kit process.