public static final class Walletunlocker.InitWalletRequest extends com.google.protobuf.GeneratedMessageV3 implements Walletunlocker.InitWalletRequestOrBuilder
lnrpc.InitWalletRequest
Modifier and Type | Class and Description |
---|---|
static class |
Walletunlocker.InitWalletRequest.Builder
Protobuf type
lnrpc.InitWalletRequest |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
AEZEED_PASSPHRASE_FIELD_NUMBER |
static int |
CHANNEL_BACKUPS_FIELD_NUMBER |
static int |
CIPHER_SEED_MNEMONIC_FIELD_NUMBER |
static int |
EXTENDED_MASTER_KEY_BIRTHDAY_TIMESTAMP_FIELD_NUMBER |
static int |
EXTENDED_MASTER_KEY_FIELD_NUMBER |
static int |
MACAROON_ROOT_KEY_FIELD_NUMBER |
static int |
RECOVERY_WINDOW_FIELD_NUMBER |
static int |
STATELESS_INIT_FIELD_NUMBER |
static int |
WALLET_PASSWORD_FIELD_NUMBER |
static int |
WATCH_ONLY_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
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.
|
com.google.protobuf.ProtocolStringList |
getCipherSeedMnemonicList()
cipher_seed_mnemonic is a 24-word mnemonic that encodes a prior aezeed
cipher seed obtained by the user.
|
static Walletunlocker.InitWalletRequest |
getDefaultInstance() |
Walletunlocker.InitWalletRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
com.google.protobuf.Parser<Walletunlocker.InitWalletRequest> |
getParserForType() |
int |
getRecoveryWindow()
recovery_window is an optional argument specifying the address lookahead
when restoring a wallet seed.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Walletunlocker.InitWalletRequest.Builder |
newBuilder() |
static Walletunlocker.InitWalletRequest.Builder |
newBuilder(Walletunlocker.InitWalletRequest prototype) |
Walletunlocker.InitWalletRequest.Builder |
newBuilderForType() |
protected Walletunlocker.InitWalletRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected java.lang.Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Walletunlocker.InitWalletRequest |
parseDelimitedFrom(java.io.InputStream input) |
static Walletunlocker.InitWalletRequest |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Walletunlocker.InitWalletRequest |
parseFrom(byte[] data) |
static Walletunlocker.InitWalletRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Walletunlocker.InitWalletRequest |
parseFrom(java.nio.ByteBuffer data) |
static Walletunlocker.InitWalletRequest |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Walletunlocker.InitWalletRequest |
parseFrom(com.google.protobuf.ByteString data) |
static Walletunlocker.InitWalletRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Walletunlocker.InitWalletRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Walletunlocker.InitWalletRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Walletunlocker.InitWalletRequest |
parseFrom(java.io.InputStream input) |
static Walletunlocker.InitWalletRequest |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Walletunlocker.InitWalletRequest> |
parser() |
Walletunlocker.InitWalletRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int WALLET_PASSWORD_FIELD_NUMBER
public static final int CIPHER_SEED_MNEMONIC_FIELD_NUMBER
public static final int AEZEED_PASSPHRASE_FIELD_NUMBER
public static final int RECOVERY_WINDOW_FIELD_NUMBER
public static final int CHANNEL_BACKUPS_FIELD_NUMBER
public static final int STATELESS_INIT_FIELD_NUMBER
public static final int EXTENDED_MASTER_KEY_FIELD_NUMBER
public static final int EXTENDED_MASTER_KEY_BIRTHDAY_TIMESTAMP_FIELD_NUMBER
public static final int WATCH_ONLY_FIELD_NUMBER
public static final int MACAROON_ROOT_KEY_FIELD_NUMBER
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public com.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;
getWalletPassword
in interface Walletunlocker.InitWalletRequestOrBuilder
public com.google.protobuf.ProtocolStringList 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;
getCipherSeedMnemonicList
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getCipherSeedMnemonicCount
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getCipherSeedMnemonic
in interface Walletunlocker.InitWalletRequestOrBuilder
index
- The index of the element to return.public 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;
getCipherSeedMnemonicBytes
in interface Walletunlocker.InitWalletRequestOrBuilder
index
- The index of the value to return.public 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;
getAezeedPassphrase
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getRecoveryWindow
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
hasChannelBackups
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getChannelBackups
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getChannelBackupsOrBuilder
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getStatelessInit
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getExtendedMasterKey
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getExtendedMasterKeyBytes
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getExtendedMasterKeyBirthdayTimestamp
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
hasWatchOnly
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getWatchOnly
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getWatchOnlyOrBuilder
in interface Walletunlocker.InitWalletRequestOrBuilder
public 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;
getMacaroonRootKey
in interface Walletunlocker.InitWalletRequestOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Walletunlocker.InitWalletRequest parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Walletunlocker.InitWalletRequest parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Walletunlocker.InitWalletRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Walletunlocker.InitWalletRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Walletunlocker.InitWalletRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Walletunlocker.InitWalletRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Walletunlocker.InitWalletRequest parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Walletunlocker.InitWalletRequest parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Walletunlocker.InitWalletRequest parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Walletunlocker.InitWalletRequest parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Walletunlocker.InitWalletRequest parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Walletunlocker.InitWalletRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Walletunlocker.InitWalletRequest.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Walletunlocker.InitWalletRequest.Builder newBuilder()
public static Walletunlocker.InitWalletRequest.Builder newBuilder(Walletunlocker.InitWalletRequest prototype)
public Walletunlocker.InitWalletRequest.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Walletunlocker.InitWalletRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Walletunlocker.InitWalletRequest getDefaultInstance()
public static com.google.protobuf.Parser<Walletunlocker.InitWalletRequest> parser()
public com.google.protobuf.Parser<Walletunlocker.InitWalletRequest> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Walletunlocker.InitWalletRequest getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder