Packages

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()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InitWalletRequest
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllCipherSeedMnemonic(__vs: Iterable[String]): InitWalletRequest
  5. def addCipherSeedMnemonic(__vs: String*): InitWalletRequest
  6. val aezeedPassphrase: ByteString
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val channelBackups: Option[ChanBackupSnapshot]
  9. val cipherSeedMnemonic: Seq[String]
  10. def clearChannelBackups: InitWalletRequest
  11. def clearCipherSeedMnemonic: InitWalletRequest
  12. def clearWatchOnly: InitWalletRequest
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  14. def companion: InitWalletRequest.type
    Definition Classes
    InitWalletRequest → GeneratedMessage
  15. def discardUnknownFields: InitWalletRequest
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val extendedMasterKey: String
  18. val extendedMasterKeyBirthdayTimestamp: UInt64
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  20. def getChannelBackups: ChanBackupSnapshot
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    InitWalletRequest → GeneratedMessage
  23. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    InitWalletRequest → GeneratedMessage
  24. def getWatchOnly: WatchOnly
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. val macaroonRootKey: ByteString
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def productElementNames: Iterator[String]
    Definition Classes
    Product
  31. val recoveryWindow: Int
  32. def serializedSize: Int
    Definition Classes
    InitWalletRequest → GeneratedMessage
  33. val statelessInit: Boolean
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  36. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  37. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  38. def toProtoString: String
    Definition Classes
    InitWalletRequest → GeneratedMessage
  39. val unknownFields: UnknownFieldSet
  40. def update(ms: (Lens[InitWalletRequest, InitWalletRequest]) => Mutation[InitWalletRequest]*): InitWalletRequest
    Definition Classes
    Updatable
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  43. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  44. val walletPassword: ByteString
  45. val watchOnly: Option[WatchOnly]
  46. def withAezeedPassphrase(__v: ByteString): InitWalletRequest
  47. def withChannelBackups(__v: ChanBackupSnapshot): InitWalletRequest
  48. def withCipherSeedMnemonic(__v: Seq[String]): InitWalletRequest
  49. def withExtendedMasterKey(__v: String): InitWalletRequest
  50. def withExtendedMasterKeyBirthdayTimestamp(__v: UInt64): InitWalletRequest
  51. def withMacaroonRootKey(__v: ByteString): InitWalletRequest
  52. def withRecoveryWindow(__v: Int): InitWalletRequest
  53. def withStatelessInit(__v: Boolean): InitWalletRequest
  54. def withUnknownFields(__v: UnknownFieldSet): InitWalletRequest
  55. def withWalletPassword(__v: ByteString): InitWalletRequest
  56. def withWatchOnly(__v: WatchOnly): InitWalletRequest
  57. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  58. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    InitWalletRequest → GeneratedMessage
  59. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped