org.lightningj.lnd.wrapper.walletkit

Class SynchronousWalletKitAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.walletkit.SynchronousWalletKitAPI

public class SynchronousWalletKitAPI
extends SynchronousAPI

API Class for generating synchronous API calls to LDN server using wrapped objects. Created by Philip Vendil.

Field Summary

Fields inherited from class org.lightningj.lnd.wrapper.API

channel, DEFAULT_MAX_INBOUND_MESSAGE_SIZE, log, performValidation, statusExceptionWrapper, wrapperFactory

Constructor Summary

Constructors

Constructor and Description
SynchronousWalletKitAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousWalletKitAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousWalletKitAPI(java.lang.String host, int port, io.grpc.netty.shaded.io.netty.handler.ssl.SslContext sslContext, MacaroonContext macaroonContext) Constructor for setting up a connection with LND Application with more flexible SSL context parameters.

Method Summary

Modifier and Type	Method and Description
BumpFeeResponse	bumpFee(BumpFeeRequest request) Method to send a bumpFee request.
BumpFeeResponse	bumpFee(OutPoint outpoint, java.lang.Integer targetConf, java.lang.Integer satPerByte, java.lang.Boolean force, java.lang.Long satPerVbyte) Method to generate a bumpFee request.
KeyDescriptor	deriveKey(java.lang.Integer keyFamily, java.lang.Integer keyIndex) Method to generate a deriveKey request.
KeyDescriptor	deriveKey(KeyLocator request) Method to send a deriveKey request.
KeyDescriptor	deriveNextKey(java.lang.Integer keyFingerPrint, java.lang.Integer keyFamily) Method to generate a deriveNextKey request.
KeyDescriptor	deriveNextKey(KeyReq request) Method to send a deriveNextKey request.
EstimateFeeResponse	estimateFee(EstimateFeeRequest request) Method to send a estimateFee request.
EstimateFeeResponse	estimateFee(java.lang.Integer confTarget) Method to generate a estimateFee request.
FinalizePsbtResponse	finalizePsbt(byte[] fundedPsbt, java.lang.String account) Method to generate a finalizePsbt request.
FinalizePsbtResponse	finalizePsbt(FinalizePsbtRequest request) Method to send a finalizePsbt request.
FundPsbtResponse	fundPsbt(byte[] psbt, TxTemplate raw, java.lang.Integer targetConf, java.lang.Long satPerVbyte, java.lang.String account, java.lang.Integer minConfs, java.lang.Boolean spendUnconfirmed, ChangeAddressType changeType) Method to generate a fundPsbt request.
FundPsbtResponse	fundPsbt(FundPsbtRequest request) Method to send a fundPsbt request.
protected WalletKitGrpc.WalletKitBlockingStub	getStub()
ImportAccountResponse	importAccount(ImportAccountRequest request) Method to send a importAccount request.
ImportAccountResponse	importAccount(java.lang.String name, java.lang.String extendedPublicKey, byte[] masterKeyFingerprint, AddressType addressType, java.lang.Boolean dryRun) Method to generate a importAccount request.
ImportPublicKeyResponse	importPublicKey(byte[] publicKey, AddressType addressType) Method to generate a importPublicKey request.
ImportPublicKeyResponse	importPublicKey(ImportPublicKeyRequest request) Method to send a importPublicKey request.
ImportTapscriptResponse	importTapscript(byte[] internalPublicKey, TapscriptFullTree fullTree, TapscriptPartialReveal partialReveal, byte[] rootHashOnly, java.lang.Boolean fullKeyOnly) Method to generate a importTapscript request.
ImportTapscriptResponse	importTapscript(ImportTapscriptRequest request) Method to send a importTapscript request.
LabelTransactionResponse	labelTransaction(byte[] txid, java.lang.String label, java.lang.Boolean overwrite) Method to generate a labelTransaction request.
LabelTransactionResponse	labelTransaction(LabelTransactionRequest request) Method to send a labelTransaction request.
LeaseOutputResponse	leaseOutput(byte[] id, OutPoint outpoint, java.lang.Long expirationSeconds) Method to generate a leaseOutput request.
LeaseOutputResponse	leaseOutput(LeaseOutputRequest request) Method to send a leaseOutput request.
ListAccountsResponse	listAccounts(ListAccountsRequest request) Method to send a listAccounts request.
ListAccountsResponse	listAccounts(java.lang.String name, AddressType addressType) Method to generate a listAccounts request.
ListAddressesResponse	listAddresses(ListAddressesRequest request) Method to send a listAddresses request.
ListAddressesResponse	listAddresses(java.lang.String accountName, java.lang.Boolean showCustomAccounts) Method to generate a listAddresses request.
ListLeasesResponse	listLeases() Method to generate a listLeases request.
ListLeasesResponse	listLeases(ListLeasesRequest request) Method to send a listLeases request.
ListSweepsResponse	listSweeps(java.lang.Boolean verbose, java.lang.Integer startHeight) Method to generate a listSweeps request.
ListSweepsResponse	listSweeps(ListSweepsRequest request) Method to send a listSweeps request.
ListUnspentResponse	listUnspent(java.lang.Integer minConfs, java.lang.Integer maxConfs, java.lang.String account, java.lang.Boolean unconfirmedOnly) Method to generate a listUnspent request.
ListUnspentResponse	listUnspent(ListUnspentRequest request) Method to send a listUnspent request.
AddrResponse	nextAddr(AddrRequest request) Method to send a nextAddr request.
AddrResponse	nextAddr(java.lang.String account, AddressType type, java.lang.Boolean change) Method to generate a nextAddr request.
PendingSweepsResponse	pendingSweeps() Method to generate a pendingSweeps request.
PendingSweepsResponse	pendingSweeps(PendingSweepsRequest request) Method to send a pendingSweeps request.
PublishResponse	publishTransaction(byte[] txHex, java.lang.String label) Method to generate a publishTransaction request.
PublishResponse	publishTransaction(Transaction request) Method to send a publishTransaction request.
ReleaseOutputResponse	releaseOutput(byte[] id, OutPoint outpoint) Method to generate a releaseOutput request.
ReleaseOutputResponse	releaseOutput(ReleaseOutputRequest request) Method to send a releaseOutput request.
RequiredReserveResponse	requiredReserve(java.lang.Integer additionalPublicChannels) Method to generate a requiredReserve request.
RequiredReserveResponse	requiredReserve(RequiredReserveRequest request) Method to send a requiredReserve request.
SendOutputsResponse	sendOutputs(java.lang.Long satPerKw, java.util.List<TxOut> outputs, java.lang.String label, java.lang.Integer minConfs, java.lang.Boolean spendUnconfirmed) Method to generate a sendOutputs request.
SendOutputsResponse	sendOutputs(SendOutputsRequest request) Method to send a sendOutputs request.
SignMessageWithAddrResponse	signMessageWithAddr(byte[] msg, java.lang.String addr) Method to generate a signMessageWithAddr request.
SignMessageWithAddrResponse	signMessageWithAddr(SignMessageWithAddrRequest request) Method to send a signMessageWithAddr request.
SignPsbtResponse	signPsbt(byte[] fundedPsbt) Method to generate a signPsbt request.
SignPsbtResponse	signPsbt(SignPsbtRequest request) Method to send a signPsbt request.
VerifyMessageWithAddrResponse	verifyMessageWithAddr(byte[] msg, java.lang.String signature, java.lang.String addr) Method to generate a verifyMessageWithAddr request.
VerifyMessageWithAddrResponse	verifyMessageWithAddr(VerifyMessageWithAddrRequest request) Method to send a verifyMessageWithAddr request.

Methods inherited from class org.lightningj.lnd.wrapper.SynchronousAPI

processRepeatableResponse, processResponse

Methods inherited from class org.lightningj.lnd.wrapper.API

close, isPerformValidation, processRequest, setPerformValidation, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SynchronousWalletKitAPI

public SynchronousWalletKitAPI(java.lang.String host,
                               int port,
                               java.io.File trustedServerCertificate,
                               java.io.File macaroonFile)
                        throws javax.net.ssl.SSLException,
                               ClientSideException

Minimal constructor for setting up a connection with LND Application.

Parameters:

host - the hostname of ldn application

port - the port of the application.

trustedServerCertificate - a link of the SSL certificate used by the LND Application.

macaroonFile - the file pointing to the macaroon to use, or null if no macaroons are used.

Throws:

javax.net.ssl.SSLException - if problems occurred setting up the SSL Connection.

ClientSideException - if problems occurred reading the macaroon file.

SynchronousWalletKitAPI

public SynchronousWalletKitAPI(java.lang.String host,
                               int port,
                               io.grpc.netty.shaded.io.netty.handler.ssl.SslContext sslContext,
                               MacaroonContext macaroonContext)

Constructor for setting up a connection with LND Application with more flexible SSL context parameters.

Parameters:

host - the hostname of ldn application

port - the port of the application.

sslContext - the SSL Context used when connecting the LND Application.

macaroonContext - the macaroon context to use.

SynchronousWalletKitAPI

public SynchronousWalletKitAPI(io.grpc.ManagedChannel channel)

Constructor used for setting up a connection using a GRPC managed channel that can be customized.

Parameters:

channel - the managed channel to use.

Method Detail

leaseOutput

public LeaseOutputResponse leaseOutput(byte[] id,
                                       OutPoint outpoint,
                                       java.lang.Long expirationSeconds)
                                throws StatusException,
                                       ValidationException

Method to generate a leaseOutput request.

Returns:

a wrapped LeaseOutputResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.leaseOutput(WalletKitOuterClass.LeaseOutputRequest)

leaseOutput

public LeaseOutputResponse leaseOutput(LeaseOutputRequest request)
                                throws StatusException,
                                       ValidationException

Method to send a leaseOutput request.

Returns:

a wrapped LeaseOutputResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.leaseOutput(WalletKitOuterClass.LeaseOutputRequest)

releaseOutput

public ReleaseOutputResponse releaseOutput(byte[] id,
                                           OutPoint outpoint)
                                    throws StatusException,
                                           ValidationException

Method to generate a releaseOutput request.

Returns:

a wrapped ReleaseOutputResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.releaseOutput(WalletKitOuterClass.ReleaseOutputRequest)

releaseOutput

public ReleaseOutputResponse releaseOutput(ReleaseOutputRequest request)
                                    throws StatusException,
                                           ValidationException

Method to send a releaseOutput request.

Returns:

a wrapped ReleaseOutputResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.releaseOutput(WalletKitOuterClass.ReleaseOutputRequest)

listLeases

public ListLeasesResponse listLeases()
                              throws StatusException,
                                     ValidationException

Method to generate a listLeases request.

Returns:

a wrapped ListLeasesResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listLeases(WalletKitOuterClass.ListLeasesRequest)

listLeases

public ListLeasesResponse listLeases(ListLeasesRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a listLeases request.

Returns:

a wrapped ListLeasesResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listLeases(WalletKitOuterClass.ListLeasesRequest)

listAccounts

public ListAccountsResponse listAccounts(java.lang.String name,
                                         AddressType addressType)
                                  throws StatusException,
                                         ValidationException

Method to generate a listAccounts request.

Returns:

a wrapped ListAccountsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listAccounts(WalletKitOuterClass.ListAccountsRequest)

listAccounts

public ListAccountsResponse listAccounts(ListAccountsRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a listAccounts request.

Returns:

a wrapped ListAccountsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listAccounts(WalletKitOuterClass.ListAccountsRequest)

requiredReserve

public RequiredReserveResponse requiredReserve(java.lang.Integer additionalPublicChannels)
                                        throws StatusException,
                                               ValidationException

Method to generate a requiredReserve request.

Returns:

a wrapped RequiredReserveResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.requiredReserve(WalletKitOuterClass.RequiredReserveRequest)

requiredReserve

public RequiredReserveResponse requiredReserve(RequiredReserveRequest request)
                                        throws StatusException,
                                               ValidationException

Method to send a requiredReserve request.

Returns:

a wrapped RequiredReserveResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.requiredReserve(WalletKitOuterClass.RequiredReserveRequest)

listAddresses

public ListAddressesResponse listAddresses(java.lang.String accountName,
                                           java.lang.Boolean showCustomAccounts)
                                    throws StatusException,
                                           ValidationException

Method to generate a listAddresses request.

Returns:

a wrapped ListAddressesResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listAddresses(WalletKitOuterClass.ListAddressesRequest)

listAddresses

public ListAddressesResponse listAddresses(ListAddressesRequest request)
                                    throws StatusException,
                                           ValidationException

Method to send a listAddresses request.

Returns:

a wrapped ListAddressesResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listAddresses(WalletKitOuterClass.ListAddressesRequest)

signMessageWithAddr

public SignMessageWithAddrResponse signMessageWithAddr(byte[] msg,
                                                       java.lang.String addr)
                                                throws StatusException,
                                                       ValidationException

Method to generate a signMessageWithAddr request.

Returns:

a wrapped SignMessageWithAddrResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.signMessageWithAddr(WalletKitOuterClass.SignMessageWithAddrRequest)

signMessageWithAddr

public SignMessageWithAddrResponse signMessageWithAddr(SignMessageWithAddrRequest request)
                                                throws StatusException,
                                                       ValidationException

Method to send a signMessageWithAddr request.

Returns:

a wrapped SignMessageWithAddrResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.signMessageWithAddr(WalletKitOuterClass.SignMessageWithAddrRequest)

verifyMessageWithAddr

public VerifyMessageWithAddrResponse verifyMessageWithAddr(byte[] msg,
                                                           java.lang.String signature,
                                                           java.lang.String addr)
                                                    throws StatusException,
                                                           ValidationException

Method to generate a verifyMessageWithAddr request.

Returns:

a wrapped VerifyMessageWithAddrResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.verifyMessageWithAddr(WalletKitOuterClass.VerifyMessageWithAddrRequest)

verifyMessageWithAddr

public VerifyMessageWithAddrResponse verifyMessageWithAddr(VerifyMessageWithAddrRequest request)
                                                    throws StatusException,
                                                           ValidationException

Method to send a verifyMessageWithAddr request.

Returns:

a wrapped VerifyMessageWithAddrResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.verifyMessageWithAddr(WalletKitOuterClass.VerifyMessageWithAddrRequest)

importAccount

public ImportAccountResponse importAccount(java.lang.String name,
                                           java.lang.String extendedPublicKey,
                                           byte[] masterKeyFingerprint,
                                           AddressType addressType,
                                           java.lang.Boolean dryRun)
                                    throws StatusException,
                                           ValidationException

Method to generate a importAccount request.

Returns:

a wrapped ImportAccountResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.importAccount(WalletKitOuterClass.ImportAccountRequest)

importAccount

public ImportAccountResponse importAccount(ImportAccountRequest request)
                                    throws StatusException,
                                           ValidationException

Method to send a importAccount request.

Returns:

a wrapped ImportAccountResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.importAccount(WalletKitOuterClass.ImportAccountRequest)

importPublicKey

public ImportPublicKeyResponse importPublicKey(byte[] publicKey,
                                               AddressType addressType)
                                        throws StatusException,
                                               ValidationException

Method to generate a importPublicKey request.

Returns:

a wrapped ImportPublicKeyResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.importPublicKey(WalletKitOuterClass.ImportPublicKeyRequest)

importPublicKey

public ImportPublicKeyResponse importPublicKey(ImportPublicKeyRequest request)
                                        throws StatusException,
                                               ValidationException

Method to send a importPublicKey request.

Returns:

a wrapped ImportPublicKeyResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.importPublicKey(WalletKitOuterClass.ImportPublicKeyRequest)

importTapscript

public ImportTapscriptResponse importTapscript(byte[] internalPublicKey,
                                               TapscriptFullTree fullTree,
                                               TapscriptPartialReveal partialReveal,
                                               byte[] rootHashOnly,
                                               java.lang.Boolean fullKeyOnly)
                                        throws StatusException,
                                               ValidationException

Method to generate a importTapscript request.

Returns:

a wrapped ImportTapscriptResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.importTapscript(WalletKitOuterClass.ImportTapscriptRequest)

importTapscript

public ImportTapscriptResponse importTapscript(ImportTapscriptRequest request)
                                        throws StatusException,
                                               ValidationException

Method to send a importTapscript request.

Returns:

a wrapped ImportTapscriptResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.importTapscript(WalletKitOuterClass.ImportTapscriptRequest)

publishTransaction

public PublishResponse publishTransaction(byte[] txHex,
                                          java.lang.String label)
                                   throws StatusException,
                                          ValidationException

Method to generate a publishTransaction request.

Returns:

a wrapped PublishResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.publishTransaction(WalletKitOuterClass.Transaction)

publishTransaction

public PublishResponse publishTransaction(Transaction request)
                                   throws StatusException,
                                          ValidationException

Method to send a publishTransaction request.

Returns:

a wrapped PublishResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.publishTransaction(WalletKitOuterClass.Transaction)

sendOutputs

public SendOutputsResponse sendOutputs(java.lang.Long satPerKw,
                                       java.util.List<TxOut> outputs,
                                       java.lang.String label,
                                       java.lang.Integer minConfs,
                                       java.lang.Boolean spendUnconfirmed)
                                throws StatusException,
                                       ValidationException

Method to generate a sendOutputs request.

Returns:

a wrapped SendOutputsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.sendOutputs(WalletKitOuterClass.SendOutputsRequest)

sendOutputs

public SendOutputsResponse sendOutputs(SendOutputsRequest request)
                                throws StatusException,
                                       ValidationException

Method to send a sendOutputs request.

Returns:

a wrapped SendOutputsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.sendOutputs(WalletKitOuterClass.SendOutputsRequest)

pendingSweeps

public PendingSweepsResponse pendingSweeps()
                                    throws StatusException,
                                           ValidationException

Method to generate a pendingSweeps request.

Returns:

a wrapped PendingSweepsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.pendingSweeps(WalletKitOuterClass.PendingSweepsRequest)

pendingSweeps

public PendingSweepsResponse pendingSweeps(PendingSweepsRequest request)
                                    throws StatusException,
                                           ValidationException

Method to send a pendingSweeps request.

Returns:

a wrapped PendingSweepsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.pendingSweeps(WalletKitOuterClass.PendingSweepsRequest)

listSweeps

public ListSweepsResponse listSweeps(java.lang.Boolean verbose,
                                     java.lang.Integer startHeight)
                              throws StatusException,
                                     ValidationException

Method to generate a listSweeps request.

Returns:

a wrapped ListSweepsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listSweeps(WalletKitOuterClass.ListSweepsRequest)

listSweeps

public ListSweepsResponse listSweeps(ListSweepsRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a listSweeps request.

Returns:

a wrapped ListSweepsResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listSweeps(WalletKitOuterClass.ListSweepsRequest)

labelTransaction

public LabelTransactionResponse labelTransaction(byte[] txid,
                                                 java.lang.String label,
                                                 java.lang.Boolean overwrite)
                                          throws StatusException,
                                                 ValidationException

Method to generate a labelTransaction request.

Returns:

a wrapped LabelTransactionResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.labelTransaction(WalletKitOuterClass.LabelTransactionRequest)

labelTransaction

public LabelTransactionResponse labelTransaction(LabelTransactionRequest request)
                                          throws StatusException,
                                                 ValidationException

Method to send a labelTransaction request.

Returns:

a wrapped LabelTransactionResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.labelTransaction(WalletKitOuterClass.LabelTransactionRequest)

finalizePsbt

public FinalizePsbtResponse finalizePsbt(byte[] fundedPsbt,
                                         java.lang.String account)
                                  throws StatusException,
                                         ValidationException

Method to generate a finalizePsbt request.

Returns:

a wrapped FinalizePsbtResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.finalizePsbt(WalletKitOuterClass.FinalizePsbtRequest)

finalizePsbt

public FinalizePsbtResponse finalizePsbt(FinalizePsbtRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a finalizePsbt request.

Returns:

a wrapped FinalizePsbtResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.finalizePsbt(WalletKitOuterClass.FinalizePsbtRequest)

estimateFee

public EstimateFeeResponse estimateFee(java.lang.Integer confTarget)
                                throws StatusException,
                                       ValidationException

Method to generate a estimateFee request.

Returns:

a wrapped EstimateFeeResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.estimateFee(WalletKitOuterClass.EstimateFeeRequest)

estimateFee

public EstimateFeeResponse estimateFee(EstimateFeeRequest request)
                                throws StatusException,
                                       ValidationException

Method to send a estimateFee request.

Returns:

a wrapped EstimateFeeResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.estimateFee(WalletKitOuterClass.EstimateFeeRequest)

listUnspent

public ListUnspentResponse listUnspent(java.lang.Integer minConfs,
                                       java.lang.Integer maxConfs,
                                       java.lang.String account,
                                       java.lang.Boolean unconfirmedOnly)
                                throws StatusException,
                                       ValidationException

Method to generate a listUnspent request.

Returns:

a wrapped ListUnspentResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listUnspent(WalletKitOuterClass.ListUnspentRequest)

listUnspent

public ListUnspentResponse listUnspent(ListUnspentRequest request)
                                throws StatusException,
                                       ValidationException

Method to send a listUnspent request.

Returns:

a wrapped ListUnspentResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.listUnspent(WalletKitOuterClass.ListUnspentRequest)

nextAddr

public AddrResponse nextAddr(java.lang.String account,
                             AddressType type,
                             java.lang.Boolean change)
                      throws StatusException,
                             ValidationException

Method to generate a nextAddr request.

Returns:

a wrapped AddrResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.nextAddr(WalletKitOuterClass.AddrRequest)

nextAddr

public AddrResponse nextAddr(AddrRequest request)
                      throws StatusException,
                             ValidationException

Method to send a nextAddr request.

Returns:

a wrapped AddrResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.nextAddr(WalletKitOuterClass.AddrRequest)

fundPsbt

public FundPsbtResponse fundPsbt(byte[] psbt,
                                 TxTemplate raw,
                                 java.lang.Integer targetConf,
                                 java.lang.Long satPerVbyte,
                                 java.lang.String account,
                                 java.lang.Integer minConfs,
                                 java.lang.Boolean spendUnconfirmed,
                                 ChangeAddressType changeType)
                          throws StatusException,
                                 ValidationException

Method to generate a fundPsbt request.

Returns:

a wrapped FundPsbtResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.fundPsbt(WalletKitOuterClass.FundPsbtRequest)

fundPsbt

public FundPsbtResponse fundPsbt(FundPsbtRequest request)
                          throws StatusException,
                                 ValidationException

Method to send a fundPsbt request.

Returns:

a wrapped FundPsbtResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.fundPsbt(WalletKitOuterClass.FundPsbtRequest)

signPsbt

public SignPsbtResponse signPsbt(byte[] fundedPsbt)
                          throws StatusException,
                                 ValidationException

Method to generate a signPsbt request.

Returns:

a wrapped SignPsbtResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.signPsbt(WalletKitOuterClass.SignPsbtRequest)

signPsbt

public SignPsbtResponse signPsbt(SignPsbtRequest request)
                          throws StatusException,
                                 ValidationException

Method to send a signPsbt request.

Returns:

a wrapped SignPsbtResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.signPsbt(WalletKitOuterClass.SignPsbtRequest)

bumpFee

public BumpFeeResponse bumpFee(OutPoint outpoint,
                               java.lang.Integer targetConf,
                               java.lang.Integer satPerByte,
                               java.lang.Boolean force,
                               java.lang.Long satPerVbyte)
                        throws StatusException,
                               ValidationException

Method to generate a bumpFee request.

Returns:

a wrapped BumpFeeResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.bumpFee(WalletKitOuterClass.BumpFeeRequest)

bumpFee

public BumpFeeResponse bumpFee(BumpFeeRequest request)
                        throws StatusException,
                               ValidationException

Method to send a bumpFee request.

Returns:

a wrapped BumpFeeResponse

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.bumpFee(WalletKitOuterClass.BumpFeeRequest)

deriveKey

public KeyDescriptor deriveKey(java.lang.Integer keyFamily,
                               java.lang.Integer keyIndex)
                        throws StatusException,
                               ValidationException

Method to generate a deriveKey request.

Returns:

a wrapped KeyDescriptor

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.deriveKey(org.lightningj.lnd.signer.proto.SignerOuterClass.KeyLocator)

deriveKey

public KeyDescriptor deriveKey(KeyLocator request)
                        throws StatusException,
                               ValidationException

Method to send a deriveKey request.

Returns:

a wrapped KeyDescriptor

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.deriveKey(org.lightningj.lnd.signer.proto.SignerOuterClass.KeyLocator)

deriveNextKey

public KeyDescriptor deriveNextKey(java.lang.Integer keyFingerPrint,
                                   java.lang.Integer keyFamily)
                            throws StatusException,
                                   ValidationException

Method to generate a deriveNextKey request.

Returns:

a wrapped KeyDescriptor

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.deriveNextKey(WalletKitOuterClass.KeyReq)

deriveNextKey

public KeyDescriptor deriveNextKey(KeyReq request)
                            throws StatusException,
                                   ValidationException

Method to send a deriveNextKey request.

Returns:

a wrapped KeyDescriptor

Throws:

StatusException - if problems occurred in underlying GRPC call. Can be of one of three sub exceptions

ClientSideException: if problems was found in the request data, such as invalid or unexpected data.

ServerSideException: if server side problems was detected when processing the request.

CommunicationException: if communication related problems occurred during the call.

ValidationException - if validation problems found in request or response data.

See Also:

WalletKitGrpc.WalletKitBlockingStub.deriveNextKey(WalletKitOuterClass.KeyReq)

getStub

protected WalletKitGrpc.WalletKitBlockingStub getStub()