Documentation ¶
Index ¶
- Variables
- func RegisterWalletUnlockerServer(s grpc.ServiceRegistrar, srv WalletUnlockerServer)
- type InitWalletRequest
- func (*InitWalletRequest) Descriptor() ([]byte, []int)deprecated
- func (x *InitWalletRequest) GetWalletPassword() []byte
- func (x *InitWalletRequest) GetWatchOnly() *WatchOnly
- func (*InitWalletRequest) ProtoMessage()
- func (x *InitWalletRequest) ProtoReflect() protoreflect.Message
- func (x *InitWalletRequest) Reset()
- func (x *InitWalletRequest) String() string
- type InitWalletResponse
- func (*InitWalletResponse) Descriptor() ([]byte, []int)deprecated
- func (x *InitWalletResponse) GetAdminMacaroon() []byte
- func (*InitWalletResponse) ProtoMessage()
- func (x *InitWalletResponse) ProtoReflect() protoreflect.Message
- func (x *InitWalletResponse) Reset()
- func (x *InitWalletResponse) String() string
- type UnimplementedWalletUnlockerServer
- type UnsafeWalletUnlockerServer
- type WalletUnlockerClient
- type WalletUnlockerServer
- type WatchOnly
- type WatchOnlyAccount
- func (*WatchOnlyAccount) Descriptor() ([]byte, []int)deprecated
- func (x *WatchOnlyAccount) GetAccount() uint32
- func (x *WatchOnlyAccount) GetCoinType() uint32
- func (x *WatchOnlyAccount) GetPurpose() uint32
- func (x *WatchOnlyAccount) GetXpub() string
- func (*WatchOnlyAccount) ProtoMessage()
- func (x *WatchOnlyAccount) ProtoReflect() protoreflect.Message
- func (x *WatchOnlyAccount) Reset()
- func (x *WatchOnlyAccount) String() string
Constants ¶
This section is empty.
Variables ¶
var File_walletunlocker_proto protoreflect.FileDescriptor
var WalletUnlocker_ServiceDesc = grpc.ServiceDesc{ ServiceName: "lnrpc.WalletUnlocker", HandlerType: (*WalletUnlockerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "InitWallet", Handler: _WalletUnlocker_InitWallet_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "walletunlocker.proto", }
WalletUnlocker_ServiceDesc is the grpc.ServiceDesc for WalletUnlocker service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterWalletUnlockerServer ¶
func RegisterWalletUnlockerServer(s grpc.ServiceRegistrar, srv WalletUnlockerServer)
Types ¶
type InitWalletRequest ¶
type InitWalletRequest struct { // //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. WalletPassword []byte `protobuf:"bytes,1,opt,name=wallet_password,json=walletPassword,proto3" json:"wallet_password,omitempty"` // //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. WatchOnly *WatchOnly `protobuf:"bytes,9,opt,name=watch_only,json=watchOnly,proto3" json:"watch_only,omitempty"` // contains filtered or unexported fields }
func (*InitWalletRequest) Descriptor
deprecated
func (*InitWalletRequest) Descriptor() ([]byte, []int)
Deprecated: Use InitWalletRequest.ProtoReflect.Descriptor instead.
func (*InitWalletRequest) GetWalletPassword ¶
func (x *InitWalletRequest) GetWalletPassword() []byte
func (*InitWalletRequest) GetWatchOnly ¶
func (x *InitWalletRequest) GetWatchOnly() *WatchOnly
func (*InitWalletRequest) ProtoMessage ¶
func (*InitWalletRequest) ProtoMessage()
func (*InitWalletRequest) ProtoReflect ¶
func (x *InitWalletRequest) ProtoReflect() protoreflect.Message
func (*InitWalletRequest) Reset ¶
func (x *InitWalletRequest) Reset()
func (*InitWalletRequest) String ¶
func (x *InitWalletRequest) String() string
type InitWalletResponse ¶
type InitWalletResponse struct { // //The binary serialized admin macaroon that can be used to access the daemon //after creating the wallet. If the stateless_init parameter was set to true, //this is the ONLY copy of the macaroon and MUST be stored safely by the //caller. Otherwise a copy of this macaroon is also persisted on disk by the //daemon, together with other macaroon files. AdminMacaroon []byte `protobuf:"bytes,1,opt,name=admin_macaroon,json=adminMacaroon,proto3" json:"admin_macaroon,omitempty"` // contains filtered or unexported fields }
func (*InitWalletResponse) Descriptor
deprecated
func (*InitWalletResponse) Descriptor() ([]byte, []int)
Deprecated: Use InitWalletResponse.ProtoReflect.Descriptor instead.
func (*InitWalletResponse) GetAdminMacaroon ¶
func (x *InitWalletResponse) GetAdminMacaroon() []byte
func (*InitWalletResponse) ProtoMessage ¶
func (*InitWalletResponse) ProtoMessage()
func (*InitWalletResponse) ProtoReflect ¶
func (x *InitWalletResponse) ProtoReflect() protoreflect.Message
func (*InitWalletResponse) Reset ¶
func (x *InitWalletResponse) Reset()
func (*InitWalletResponse) String ¶
func (x *InitWalletResponse) String() string
type UnimplementedWalletUnlockerServer ¶
type UnimplementedWalletUnlockerServer struct { }
UnimplementedWalletUnlockerServer must be embedded to have forward compatible implementations.
func (UnimplementedWalletUnlockerServer) InitWallet ¶
func (UnimplementedWalletUnlockerServer) InitWallet(context.Context, *InitWalletRequest) (*InitWalletResponse, error)
type UnsafeWalletUnlockerServer ¶
type UnsafeWalletUnlockerServer interface {
// contains filtered or unexported methods
}
UnsafeWalletUnlockerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WalletUnlockerServer will result in compilation errors.
type WalletUnlockerClient ¶
type WalletUnlockerClient interface { // //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. InitWallet(ctx context.Context, in *InitWalletRequest, opts ...grpc.CallOption) (*InitWalletResponse, error) }
WalletUnlockerClient is the client API for WalletUnlocker service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewWalletUnlockerClient ¶
func NewWalletUnlockerClient(cc grpc.ClientConnInterface) WalletUnlockerClient
type WalletUnlockerServer ¶
type WalletUnlockerServer interface { // //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. InitWallet(context.Context, *InitWalletRequest) (*InitWalletResponse, error) // contains filtered or unexported methods }
WalletUnlockerServer is the server API for WalletUnlocker service. All implementations must embed UnimplementedWalletUnlockerServer for forward compatibility
type WatchOnly ¶
type WatchOnly struct { // //The list of accounts to import. There _must_ be an account for all of lnd's //main key scopes: BIP49/BIP84 (m/49'/0'/0', m/84'/0'/0', note that the //coin type is always 0, even for testnet/regtest) and lnd's internal key //scope (m/1017'/<coin_type>'/<account>'), where account is the key family as //defined in `keychain/derivation.go` (currently indices 0 to 9). Accounts []*WatchOnlyAccount `protobuf:"bytes,3,rep,name=accounts,proto3" json:"accounts,omitempty"` // contains filtered or unexported fields }
func (*WatchOnly) Descriptor
deprecated
func (*WatchOnly) GetAccounts ¶
func (x *WatchOnly) GetAccounts() []*WatchOnlyAccount
func (*WatchOnly) ProtoMessage ¶
func (*WatchOnly) ProtoMessage()
func (*WatchOnly) ProtoReflect ¶
func (x *WatchOnly) ProtoReflect() protoreflect.Message
type WatchOnlyAccount ¶
type WatchOnlyAccount struct { // //Purpose is the first number in the derivation path, must be either 49, 84 //or 1017. Purpose uint32 `protobuf:"varint,1,opt,name=purpose,proto3" json:"purpose,omitempty"` // //Coin type is the second number in the derivation path, this is _always_ 0 //for purposes 49 and 84. It only needs to be set to 1 for purpose 1017 on //testnet or regtest. CoinType uint32 `protobuf:"varint,2,opt,name=coin_type,json=coinType,proto3" json:"coin_type,omitempty"` // //Account is the third number in the derivation path. For purposes 49 and 84 //at least the default account (index 0) needs to be created but optional //additional accounts are allowed. For purpose 1017 there needs to be exactly //one account for each of the key families defined in `keychain/derivation.go` //(currently indices 0 to 9) Account uint32 `protobuf:"varint,3,opt,name=account,proto3" json:"account,omitempty"` // //The extended public key at depth 3 for the given account. Xpub string `protobuf:"bytes,4,opt,name=xpub,proto3" json:"xpub,omitempty"` // contains filtered or unexported fields }
func (*WatchOnlyAccount) Descriptor
deprecated
func (*WatchOnlyAccount) Descriptor() ([]byte, []int)
Deprecated: Use WatchOnlyAccount.ProtoReflect.Descriptor instead.
func (*WatchOnlyAccount) GetAccount ¶
func (x *WatchOnlyAccount) GetAccount() uint32
func (*WatchOnlyAccount) GetCoinType ¶
func (x *WatchOnlyAccount) GetCoinType() uint32
func (*WatchOnlyAccount) GetPurpose ¶
func (x *WatchOnlyAccount) GetPurpose() uint32
func (*WatchOnlyAccount) GetXpub ¶
func (x *WatchOnlyAccount) GetXpub() string
func (*WatchOnlyAccount) ProtoMessage ¶
func (*WatchOnlyAccount) ProtoMessage()
func (*WatchOnlyAccount) ProtoReflect ¶
func (x *WatchOnlyAccount) ProtoReflect() protoreflect.Message
func (*WatchOnlyAccount) Reset ¶
func (x *WatchOnlyAccount) Reset()
func (*WatchOnlyAccount) String ¶
func (x *WatchOnlyAccount) String() string