org.lightningj.lnd.wrapper.walletunlocker

Class SynchronousWalletUnlockerAPI

java.lang.Object

org.lightningj.lnd.wrapper.API

org.lightningj.lnd.wrapper.SynchronousAPI

org.lightningj.lnd.wrapper.walletunlocker.SynchronousWalletUnlockerAPI

public class SynchronousWalletUnlockerAPI
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
SynchronousWalletUnlockerAPI(io.grpc.ManagedChannel channel) Constructor used for setting up a connection using a GRPC managed channel that can be customized.
SynchronousWalletUnlockerAPI(java.lang.String host, int port, java.io.File trustedServerCertificate, java.io.File macaroonFile) Minimal constructor for setting up a connection with LND Application.
SynchronousWalletUnlockerAPI(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
ChangePasswordResponse	changePassword(byte[] currentPassword, byte[] newPassword, java.lang.Boolean statelessInit, java.lang.Boolean newMacaroonRootKey) Method to generate a changePassword request.
ChangePasswordResponse	changePassword(ChangePasswordRequest request) Method to send a changePassword request.
GenSeedResponse	genSeed(byte[] aezeedPassphrase, byte[] seedEntropy) Method to generate a genSeed request.
GenSeedResponse	genSeed(GenSeedRequest request) Method to send a genSeed request.
protected WalletUnlockerGrpc.WalletUnlockerBlockingStub	getStub()
InitWalletResponse	initWallet(byte[] walletPassword, java.util.List<java.lang.String> cipherSeedMnemonic, byte[] aezeedPassphrase, java.lang.Integer recoveryWindow, ChanBackupSnapshot channelBackups, java.lang.Boolean statelessInit, java.lang.String extendedMasterKey, java.lang.Long extendedMasterKeyBirthdayTimestamp, WatchOnly watchOnly, byte[] macaroonRootKey) Method to generate a initWallet request.
InitWalletResponse	initWallet(InitWalletRequest request) Method to send a initWallet request.
UnlockWalletResponse	unlockWallet(byte[] walletPassword, java.lang.Integer recoveryWindow, ChanBackupSnapshot channelBackups, java.lang.Boolean statelessInit) Method to generate a unlockWallet request.
UnlockWalletResponse	unlockWallet(UnlockWalletRequest request) Method to send a unlockWallet 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

SynchronousWalletUnlockerAPI

public SynchronousWalletUnlockerAPI(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.

SynchronousWalletUnlockerAPI

public SynchronousWalletUnlockerAPI(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.

SynchronousWalletUnlockerAPI

public SynchronousWalletUnlockerAPI(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

initWallet

public InitWalletResponse initWallet(byte[] walletPassword,
                                     java.util.List<java.lang.String> cipherSeedMnemonic,
                                     byte[] aezeedPassphrase,
                                     java.lang.Integer recoveryWindow,
                                     ChanBackupSnapshot channelBackups,
                                     java.lang.Boolean statelessInit,
                                     java.lang.String extendedMasterKey,
                                     java.lang.Long extendedMasterKeyBirthdayTimestamp,
                                     WatchOnly watchOnly,
                                     byte[] macaroonRootKey)
                              throws StatusException,
                                     ValidationException

Method to generate a initWallet request.

Returns:

a wrapped InitWalletResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.initWallet(Walletunlocker.InitWalletRequest)

initWallet

public InitWalletResponse initWallet(InitWalletRequest request)
                              throws StatusException,
                                     ValidationException

Method to send a initWallet request.

Returns:

a wrapped InitWalletResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.initWallet(Walletunlocker.InitWalletRequest)

unlockWallet

public UnlockWalletResponse unlockWallet(byte[] walletPassword,
                                         java.lang.Integer recoveryWindow,
                                         ChanBackupSnapshot channelBackups,
                                         java.lang.Boolean statelessInit)
                                  throws StatusException,
                                         ValidationException

Method to generate a unlockWallet request.

Returns:

a wrapped UnlockWalletResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.unlockWallet(Walletunlocker.UnlockWalletRequest)

unlockWallet

public UnlockWalletResponse unlockWallet(UnlockWalletRequest request)
                                  throws StatusException,
                                         ValidationException

Method to send a unlockWallet request.

Returns:

a wrapped UnlockWalletResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.unlockWallet(Walletunlocker.UnlockWalletRequest)

changePassword

public ChangePasswordResponse changePassword(byte[] currentPassword,
                                             byte[] newPassword,
                                             java.lang.Boolean statelessInit,
                                             java.lang.Boolean newMacaroonRootKey)
                                      throws StatusException,
                                             ValidationException

Method to generate a changePassword request.

Returns:

a wrapped ChangePasswordResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.changePassword(Walletunlocker.ChangePasswordRequest)

changePassword

public ChangePasswordResponse changePassword(ChangePasswordRequest request)
                                      throws StatusException,
                                             ValidationException

Method to send a changePassword request.

Returns:

a wrapped ChangePasswordResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.changePassword(Walletunlocker.ChangePasswordRequest)

genSeed

public GenSeedResponse genSeed(byte[] aezeedPassphrase,
                               byte[] seedEntropy)
                        throws StatusException,
                               ValidationException

Method to generate a genSeed request.

Returns:

a wrapped GenSeedResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.genSeed(Walletunlocker.GenSeedRequest)

genSeed

public GenSeedResponse genSeed(GenSeedRequest request)
                        throws StatusException,
                               ValidationException

Method to send a genSeed request.

Returns:

a wrapped GenSeedResponse

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:

WalletUnlockerGrpc.WalletUnlockerBlockingStub.genSeed(Walletunlocker.GenSeedRequest)

getStub

protected WalletUnlockerGrpc.WalletUnlockerBlockingStub getStub()