final case class InitWalletRequest(walletPassword: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cipherSeedMnemonic: Seq[String] = _root_.scala.Seq.empty, aezeedPassphrase: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, recoveryWindow: Int = 0, channelBackups: Option[ChanBackupSnapshot] = _root_.scala.None, statelessInit: Boolean = false, extendedMasterKey: String = "", extendedMasterKeyBirthdayTimestamp: UInt64 = lnrpc.InitWalletRequest._typemapper_extendedMasterKeyBirthdayTimestamp.toCustom(0L), watchOnly: Option[WatchOnly] = _root_.scala.None, macaroonRootKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[InitWalletRequest] with Product with Serializable
- walletPassword
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.
- cipherSeedMnemonic
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.
- aezeedPassphrase
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.
- recoveryWindow
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.
- channelBackups
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.
- statelessInit
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!
- extendedMasterKey
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.
- extendedMasterKeyBirthdayTimestamp
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).
- watchOnly
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.
- macaroonRootKey
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.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- InitWalletRequest
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new InitWalletRequest(walletPassword: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, cipherSeedMnemonic: Seq[String] = _root_.scala.Seq.empty, aezeedPassphrase: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, recoveryWindow: Int = 0, channelBackups: Option[ChanBackupSnapshot] = _root_.scala.None, statelessInit: Boolean = false, extendedMasterKey: String = "", extendedMasterKeyBirthdayTimestamp: UInt64 = lnrpc.InitWalletRequest._typemapper_extendedMasterKeyBirthdayTimestamp.toCustom(0L), watchOnly: Option[WatchOnly] = _root_.scala.None, macaroonRootKey: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- walletPassword
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.
- cipherSeedMnemonic
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.
- aezeedPassphrase
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.
- recoveryWindow
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.
- channelBackups
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.
- statelessInit
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!
- extendedMasterKey
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.
- extendedMasterKeyBirthdayTimestamp
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).
- watchOnly
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.
- macaroonRootKey
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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllCipherSeedMnemonic(__vs: Iterable[String]): InitWalletRequest
- def addCipherSeedMnemonic(__vs: String*): InitWalletRequest
- val aezeedPassphrase: ByteString
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val channelBackups: Option[ChanBackupSnapshot]
- val cipherSeedMnemonic: Seq[String]
- def clearChannelBackups: InitWalletRequest
- def clearCipherSeedMnemonic: InitWalletRequest
- def clearWatchOnly: InitWalletRequest
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: InitWalletRequest.type
- Definition Classes
- InitWalletRequest → GeneratedMessage
- def discardUnknownFields: InitWalletRequest
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val extendedMasterKey: String
- val extendedMasterKeyBirthdayTimestamp: UInt64
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getChannelBackups: ChanBackupSnapshot
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- InitWalletRequest → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- InitWalletRequest → GeneratedMessage
- def getWatchOnly: WatchOnly
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val macaroonRootKey: ByteString
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val recoveryWindow: Int
- def serializedSize: Int
- Definition Classes
- InitWalletRequest → GeneratedMessage
- val statelessInit: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- InitWalletRequest → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[InitWalletRequest, InitWalletRequest]) => Mutation[InitWalletRequest]*): InitWalletRequest
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- val walletPassword: ByteString
- val watchOnly: Option[WatchOnly]
- def withAezeedPassphrase(__v: ByteString): InitWalletRequest
- def withChannelBackups(__v: ChanBackupSnapshot): InitWalletRequest
- def withCipherSeedMnemonic(__v: Seq[String]): InitWalletRequest
- def withExtendedMasterKey(__v: String): InitWalletRequest
- def withExtendedMasterKeyBirthdayTimestamp(__v: UInt64): InitWalletRequest
- def withMacaroonRootKey(__v: ByteString): InitWalletRequest
- def withRecoveryWindow(__v: Int): InitWalletRequest
- def withStatelessInit(__v: Boolean): InitWalletRequest
- def withUnknownFields(__v: UnknownFieldSet): InitWalletRequest
- def withWalletPassword(__v: ByteString): InitWalletRequest
- def withWatchOnly(__v: WatchOnly): InitWalletRequest
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- InitWalletRequest → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage