public static interface Walletunlocker.InitWalletRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
com.google.protobuf.ByteString |
getAezeedPassphrase()
aezeed_passphrase is an optional user provided passphrase that will be used
to encrypt the generated aezeed cipher seed.
|
LightningApi.ChanBackupSnapshot |
getChannelBackups()
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels.
|
LightningApi.ChanBackupSnapshotOrBuilder |
getChannelBackupsOrBuilder()
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels.
|
java.lang.String |
getCipherSeedMnemonic(int index)
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user.
|
com.google.protobuf.ByteString |
getCipherSeedMnemonicBytes(int index)
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user.
|
int |
getCipherSeedMnemonicCount()
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user.
|
java.util.List<java.lang.String> |
getCipherSeedMnemonicList()
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user.
|
java.lang.String |
getExtendedMasterKey()
extended_master_key is an alternative to specifying cipher_seed_mnemonic and
aezeed_passphrase.
|
long |
getExtendedMasterKeyBirthdayTimestamp()
extended_master_key_birthday_timestamp is the optional unix timestamp in
seconds to use as the wallet's birthday when using an extended master key
to restore the wallet.
|
com.google.protobuf.ByteString |
getExtendedMasterKeyBytes()
extended_master_key is an alternative to specifying cipher_seed_mnemonic and
aezeed_passphrase.
|
com.google.protobuf.ByteString |
getMacaroonRootKey()
macaroon_root_key is an optional 32 byte macaroon root key that can be
provided when initializing the wallet rather than letting lnd generate one
on its own.
|
int |
getRecoveryWindow()
recovery_window is an optional argument specifying the address lookahead
when restoring a wallet seed.
|
boolean |
getStatelessInit()
stateless_init is an optional argument instructing the daemon NOT to create
any *.macaroon files in its filesystem.
|
com.google.protobuf.ByteString |
getWalletPassword()
wallet_password is the passphrase that should be used to encrypt the
wallet.
|
Walletunlocker.WatchOnly |
getWatchOnly()
watch_only is the third option of initializing a wallet: by importing
account xpubs only and therefore creating a watch-only wallet that does not
contain any private keys.
|
Walletunlocker.WatchOnlyOrBuilder |
getWatchOnlyOrBuilder()
watch_only is the third option of initializing a wallet: by importing
account xpubs only and therefore creating a watch-only wallet that does not
contain any private keys.
|
boolean |
hasChannelBackups()
channel_backups is an optional argument that allows clients to recover the
settled funds within a set of channels.
|
boolean |
hasWatchOnly()
watch_only is the third option of initializing a wallet: by importing
account xpubs only and therefore creating a watch-only wallet that does not
contain any private keys.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofcom.google.protobuf.ByteString getWalletPassword()
wallet_password is the passphrase that should be used to encrypt the wallet. This MUST be at least 8 chars in length. After creation, this password is required to unlock the daemon. When using REST, this field must be encoded as base64.
bytes wallet_password = 1;java.util.List<java.lang.String> getCipherSeedMnemonicList()
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed.
repeated string cipher_seed_mnemonic = 2;int getCipherSeedMnemonicCount()
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed.
repeated string cipher_seed_mnemonic = 2;java.lang.String getCipherSeedMnemonic(int index)
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed.
repeated string cipher_seed_mnemonic = 2;index - The index of the element to return.com.google.protobuf.ByteString getCipherSeedMnemonicBytes(int index)
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed cipher seed obtained by the user. This may have been generated by the GenSeed method, or be an existing seed.
repeated string cipher_seed_mnemonic = 2;index - The index of the value to return.com.google.protobuf.ByteString getAezeedPassphrase()
aezeed_passphrase is an optional user provided passphrase that will be used to encrypt the generated aezeed cipher seed. When using REST, this field must be encoded as base64.
bytes aezeed_passphrase = 3;int getRecoveryWindow()
recovery_window is an optional argument specifying the address lookahead when restoring a wallet seed. The recovery window applies to each individual branch of the BIP44 derivation paths. Supplying a recovery window of zero indicates that no addresses should be recovered, such after the first initialization of the wallet.
int32 recovery_window = 4;boolean hasChannelBackups()
channel_backups is an optional argument that allows clients to recover the settled funds within a set of channels. This should be populated if the user was unable to close out all channels and sweep funds before partial or total data loss occurred. If specified, then after on-chain recovery of funds, lnd begin to carry out the data loss recovery protocol in order to recover the funds in each channel from a remote force closed transaction.
.lnrpc.ChanBackupSnapshot channel_backups = 5;LightningApi.ChanBackupSnapshot getChannelBackups()
channel_backups is an optional argument that allows clients to recover the settled funds within a set of channels. This should be populated if the user was unable to close out all channels and sweep funds before partial or total data loss occurred. If specified, then after on-chain recovery of funds, lnd begin to carry out the data loss recovery protocol in order to recover the funds in each channel from a remote force closed transaction.
.lnrpc.ChanBackupSnapshot channel_backups = 5;LightningApi.ChanBackupSnapshotOrBuilder getChannelBackupsOrBuilder()
channel_backups is an optional argument that allows clients to recover the settled funds within a set of channels. This should be populated if the user was unable to close out all channels and sweep funds before partial or total data loss occurred. If specified, then after on-chain recovery of funds, lnd begin to carry out the data loss recovery protocol in order to recover the funds in each channel from a remote force closed transaction.
.lnrpc.ChanBackupSnapshot channel_backups = 5;boolean getStatelessInit()
stateless_init is an optional argument instructing the daemon NOT to create any *.macaroon files in its filesystem. If this parameter is set, then the admin macaroon returned in the response MUST be stored by the caller of the RPC as otherwise all access to the daemon will be lost!
bool stateless_init = 6;java.lang.String getExtendedMasterKey()
extended_master_key is an alternative to specifying cipher_seed_mnemonic and aezeed_passphrase. Instead of deriving the master root key from the entropy of an aezeed cipher seed, the given extended master root key is used directly as the wallet's master key. This allows users to import/use a master key from another wallet. When doing so, lnd still uses its default SegWit only (BIP49/84) derivation paths and funds from custom/non-default derivation paths will not automatically appear in the on-chain wallet. Using an 'xprv' instead of an aezeed also has the disadvantage that the wallet's birthday is not known as that is an information that's only encoded in the aezeed, not the xprv. Therefore a birthday needs to be specified in extended_master_key_birthday_timestamp or a "safe" default value will be used.
string extended_master_key = 7;com.google.protobuf.ByteString getExtendedMasterKeyBytes()
extended_master_key is an alternative to specifying cipher_seed_mnemonic and aezeed_passphrase. Instead of deriving the master root key from the entropy of an aezeed cipher seed, the given extended master root key is used directly as the wallet's master key. This allows users to import/use a master key from another wallet. When doing so, lnd still uses its default SegWit only (BIP49/84) derivation paths and funds from custom/non-default derivation paths will not automatically appear in the on-chain wallet. Using an 'xprv' instead of an aezeed also has the disadvantage that the wallet's birthday is not known as that is an information that's only encoded in the aezeed, not the xprv. Therefore a birthday needs to be specified in extended_master_key_birthday_timestamp or a "safe" default value will be used.
string extended_master_key = 7;long getExtendedMasterKeyBirthdayTimestamp()
extended_master_key_birthday_timestamp is the optional unix timestamp in seconds to use as the wallet's birthday when using an extended master key to restore the wallet. lnd will only start scanning for funds in blocks that are after the birthday which can speed up the process significantly. If the birthday is not known, this should be left at its default value of 0 in which case lnd will start scanning from the first SegWit block (481824 on mainnet).
uint64 extended_master_key_birthday_timestamp = 8;boolean hasWatchOnly()
watch_only is the third option of initializing a wallet: by importing account xpubs only and therefore creating a watch-only wallet that does not contain any private keys. That means the wallet won't be able to sign for any of the keys and _needs_ to be run with a remote signer that has the corresponding private keys and can serve signing RPC requests.
.lnrpc.WatchOnly watch_only = 9;Walletunlocker.WatchOnly getWatchOnly()
watch_only is the third option of initializing a wallet: by importing account xpubs only and therefore creating a watch-only wallet that does not contain any private keys. That means the wallet won't be able to sign for any of the keys and _needs_ to be run with a remote signer that has the corresponding private keys and can serve signing RPC requests.
.lnrpc.WatchOnly watch_only = 9;Walletunlocker.WatchOnlyOrBuilder getWatchOnlyOrBuilder()
watch_only is the third option of initializing a wallet: by importing account xpubs only and therefore creating a watch-only wallet that does not contain any private keys. That means the wallet won't be able to sign for any of the keys and _needs_ to be run with a remote signer that has the corresponding private keys and can serve signing RPC requests.
.lnrpc.WatchOnly watch_only = 9;com.google.protobuf.ByteString getMacaroonRootKey()
macaroon_root_key is an optional 32 byte macaroon root key that can be provided when initializing the wallet rather than letting lnd generate one on its own.
bytes macaroon_root_key = 10;