org.lightningj.lnd.walletunlocker.proto

Class WalletUnlockerGrpc.WalletUnlockerBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<WalletUnlockerGrpc.WalletUnlockerBlockingStub>

org.lightningj.lnd.walletunlocker.proto.WalletUnlockerGrpc.WalletUnlockerBlockingStub

Enclosing class:

WalletUnlockerGrpc

public static final class WalletUnlockerGrpc.WalletUnlockerBlockingStub
extends io.grpc.stub.AbstractBlockingStub<WalletUnlockerGrpc.WalletUnlockerBlockingStub>

A stub to allow clients to do synchronous rpc calls to service WalletUnlocker.

 WalletUnlocker is a service that is used to set up a wallet password for
 lnd at first startup, and unlock a previously set up wallet.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected WalletUnlockerGrpc.WalletUnlockerBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Walletunlocker.ChangePasswordResponse	changePassword(Walletunlocker.ChangePasswordRequest request) lncli: `changepassword` ChangePassword changes the password of the encrypted wallet.
Walletunlocker.GenSeedResponse	genSeed(Walletunlocker.GenSeedRequest request) GenSeed is the first method that should be used to instantiate a new lnd instance.
Walletunlocker.InitWalletResponse	initWallet(Walletunlocker.InitWalletRequest request) InitWallet is used when lnd is starting up for the first time to fully initialize the daemon and its internal wallet.
Walletunlocker.UnlockWalletResponse	unlockWallet(Walletunlocker.UnlockWalletRequest request) lncli: `unlock` UnlockWallet is used at startup of lnd to provide a password to unlock the wallet database.

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

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

Method Detail

build

protected WalletUnlockerGrpc.WalletUnlockerBlockingStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<WalletUnlockerGrpc.WalletUnlockerBlockingStub>

genSeed

public Walletunlocker.GenSeedResponse genSeed(Walletunlocker.GenSeedRequest request)

GenSeed is the first method that should be used to instantiate a new lnd
instance. This method allows a caller to generate a new aezeed cipher seed
given an optional passphrase. If provided, the passphrase will be necessary
to decrypt the cipherseed to expose the internal wallet seed.
Once the cipherseed is obtained and verified by the user, the InitWallet
method should be used to commit the newly generated seed, and create the
wallet.
 

initWallet

public Walletunlocker.InitWalletResponse initWallet(Walletunlocker.InitWalletRequest request)

InitWallet is used when lnd is starting up for the first time to fully
initialize the daemon and its internal wallet. At the very least a wallet
password must be provided. This will be used to encrypt sensitive material
on disk.
In the case of a recovery scenario, the user can also specify their aezeed
mnemonic and passphrase. If set, then the daemon will use this prior state
to initialize its internal wallet.
Alternatively, this can be used along with the GenSeed RPC to obtain a
seed, then present it to the user. Once it has been verified by the user,
the seed can be fed into this RPC in order to commit the new wallet.
 

unlockWallet

public Walletunlocker.UnlockWalletResponse unlockWallet(Walletunlocker.UnlockWalletRequest request)

 lncli: `unlock`
UnlockWallet is used at startup of lnd to provide a password to unlock
the wallet database.
 

changePassword

public Walletunlocker.ChangePasswordResponse changePassword(Walletunlocker.ChangePasswordRequest request)

 lncli: `changepassword`
ChangePassword changes the password of the encrypted wallet. This will
automatically unlock the wallet database if successful.