walletrpc

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 22, 2024 License: MIT Imports: 51 Imported by: 4

Documentation

Overview

Package walletrpc is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	// SubServerName is the name of the sub rpc server. We'll use this name
	// to register ourselves, and we also require that the main
	// SubServerConfigDispatcher instance recognize as the name of our
	SubServerName = "WalletKitRPC"
)

Variables

View Source 
var (
	AddressType_name = map[int32]string{
		0: "UNKNOWN",
		1: "WITNESS_PUBKEY_HASH",
		2: "NESTED_WITNESS_PUBKEY_HASH",
		3: "HYBRID_NESTED_WITNESS_PUBKEY_HASH",
	}
	AddressType_value = map[string]int32{
		"UNKNOWN":                           0,
		"WITNESS_PUBKEY_HASH":               1,
		"NESTED_WITNESS_PUBKEY_HASH":        2,
		"HYBRID_NESTED_WITNESS_PUBKEY_HASH": 3,
	}
)

Enum value maps for AddressType.

View Source 
var (
	WitnessType_name = map[int32]string{
		0:   "UNKNOWN_WITNESS",
		1:   "COMMITMENT_TIME_LOCK",
		2:   "COMMITMENT_NO_DELAY",
		3:   "COMMITMENT_REVOKE",
		4:   "HTLC_OFFERED_REVOKE",
		5:   "HTLC_ACCEPTED_REVOKE",
		6:   "HTLC_OFFERED_TIMEOUT_SECOND_LEVEL",
		7:   "HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL",
		8:   "HTLC_OFFERED_REMOTE_TIMEOUT",
		9:   "HTLC_ACCEPTED_REMOTE_SUCCESS",
		10:  "HTLC_SECOND_LEVEL_REVOKE",
		11:  "WITNESS_KEY_HASH",
		12:  "NESTED_WITNESS_KEY_HASH",
		13:  "COMMITMENT_ANCHOR",
		128: "PUBKEY_HASH",
	}
	WitnessType_value = map[string]int32{
		"UNKNOWN_WITNESS":                    0,
		"COMMITMENT_TIME_LOCK":               1,
		"COMMITMENT_NO_DELAY":                2,
		"COMMITMENT_REVOKE":                  3,
		"HTLC_OFFERED_REVOKE":                4,
		"HTLC_ACCEPTED_REVOKE":               5,
		"HTLC_OFFERED_TIMEOUT_SECOND_LEVEL":  6,
		"HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL": 7,
		"HTLC_OFFERED_REMOTE_TIMEOUT":        8,
		"HTLC_ACCEPTED_REMOTE_SUCCESS":       9,
		"HTLC_SECOND_LEVEL_REVOKE":           10,
		"WITNESS_KEY_HASH":                   11,
		"NESTED_WITNESS_KEY_HASH":            12,
		"COMMITMENT_ANCHOR":                  13,
		"PUBKEY_HASH":                        128,
	}
)

Enum value maps for WitnessType.

View Source 
var (

	// DefaultWalletKitMacFilename is the default name of the wallet kit
	// macaroon that we expect to find via a file handle within the main
	// configuration file in this package.
	DefaultWalletKitMacFilename = "walletkit.macaroon"

	// LndInternalLockID is the binary representation of the SHA256 hash of
	// the string "lnd-internal-lock-id" and is used for UTXO lock leases to
	// identify that we ourselves are locking an UTXO, for example when
	// giving out a funded PSBT. The ID corresponds to the hex value of
	// ede19a92ed321a4705f8a1cccc1d4f6182545d4bb4fae08bd5937831b7e38f98.
	LndInternalLockID = lnwallet.LockID{
		0xed, 0xe1, 0x9a, 0x92, 0xed, 0x32, 0x1a, 0x47,
		0x05, 0xf8, 0xa1, 0xcc, 0xcc, 0x1d, 0x4f, 0x61,
		0x82, 0x54, 0x5d, 0x4b, 0xb4, 0xfa, 0xe0, 0x8b,
		0xd5, 0x93, 0x78, 0x31, 0xb7, 0xe3, 0x8f, 0x98,
	}
)
View Source 
var (
	// DefaultLockDuration is the default duration used to lock outputs.
	DefaultLockDuration = 10 * time.Minute
)
View Source 
var ErrZeroLabel = errors.New("cannot label transaction with empty label")

ErrZeroLabel is returned when an attempt is made to label a transaction with an empty label.

View Source 
var File_walletrpc_walletkit_proto protoreflect.FileDescriptor

Functions

func AccountsToWatchOnly added in v0.6.0 

func AccountsToWatchOnly(exported []*Account) ([]*lnrpc.WatchOnlyAccount,
	error)

AccountsToWatchOnly converts the accounts returned by the walletkit's ListAccounts RPC into a struct that can be used to create a watch-only wallet.

func DisableLog 

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by by default until UseLogger is called.

func RegisterWalletKitHandler added in v0.3.0 

func RegisterWalletKitHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterWalletKitHandler registers the http handlers for service WalletKit to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterWalletKitHandlerClient added in v0.3.0 

func RegisterWalletKitHandlerClient(ctx context.Context, mux *runtime.ServeMux, client WalletKitClient) error

RegisterWalletKitHandlerClient registers the http handlers for service WalletKit to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "WalletKitClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "WalletKitClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "WalletKitClient" to call the correct interceptors.

func RegisterWalletKitHandlerFromEndpoint added in v0.3.0 

func RegisterWalletKitHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterWalletKitHandlerFromEndpoint is same as RegisterWalletKitHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterWalletKitHandlerServer added in v0.3.0 

func RegisterWalletKitHandlerServer(ctx context.Context, mux *runtime.ServeMux, server WalletKitServer) error

RegisterWalletKitHandlerServer registers the http handlers for service WalletKit to "mux". UnaryRPC :call WalletKitServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterWalletKitHandlerFromEndpoint instead.

func RegisterWalletKitServer 

func RegisterWalletKitServer(s *grpc.Server, srv WalletKitServer)

func UseLogger 

func UseLogger(logger slog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using slog.

Types

type Account added in v0.3.8 

type Account struct {

	// The name used to identify the account.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The type of addresses the account supports.
	// AddressType                       | External Branch | Internal Branch
	// ---------------------------------------------------------------------
	// WITNESS_PUBKEY_HASH               | P2WPKH          | P2WPKH
	// NESTED_WITNESS_PUBKEY_HASH        | NP2WPKH         | NP2WPKH
	// HYBRID_NESTED_WITNESS_PUBKEY_HASH | NP2WPKH         | P2WPKH
	AddressType AddressType `protobuf:"varint,2,opt,name=address_type,json=addressType,proto3,enum=walletrpc.AddressType" json:"address_type,omitempty"`
	// The public key backing the account that all keys are derived from
	// represented as an extended key. This will always be empty for the default
	// imported account in which single public keys are imported into.
	ExtendedPublicKey string `protobuf:"bytes,3,opt,name=extended_public_key,json=extendedPublicKey,proto3" json:"extended_public_key,omitempty"`
	// The fingerprint of the root key from which the account public key was
	// derived from. This will always be zero for the default imported account in
	// which single public keys are imported into. The bytes are in big-endian
	// order.
	MasterKeyFingerprint []byte `protobuf:"bytes,4,opt,name=master_key_fingerprint,json=masterKeyFingerprint,proto3" json:"master_key_fingerprint,omitempty"`
	// The derivation path corresponding to the account public key. This will
	// always be empty for the default imported account in which single public keys
	// are imported into.
	DerivationPath string `protobuf:"bytes,5,opt,name=derivation_path,json=derivationPath,proto3" json:"derivation_path,omitempty"`
	// The number of keys derived from the external branch of the account public
	// key. This will always be zero for the default imported account in which
	// single public keys are imported into.
	ExternalKeyCount uint32 `protobuf:"varint,6,opt,name=external_key_count,json=externalKeyCount,proto3" json:"external_key_count,omitempty"`
	// The number of keys derived from the internal branch of the account public
	// key. This will always be zero for the default imported account in which
	// single public keys are imported into.
	InternalKeyCount uint32 `protobuf:"varint,7,opt,name=internal_key_count,json=internalKeyCount,proto3" json:"internal_key_count,omitempty"`
	// Whether the wallet stores private keys for the account.
	WatchOnly bool `protobuf:"varint,8,opt,name=watch_only,json=watchOnly,proto3" json:"watch_only,omitempty"`
	// contains filtered or unexported fields
}

func (*Account) Descriptor deprecated added in v0.3.8 

func (*Account) Descriptor() ([]byte, []int)

Deprecated: Use Account.ProtoReflect.Descriptor instead.

func (*Account) GetAddressType added in v0.3.8 

func (x *Account) GetAddressType() AddressType

func (*Account) GetDerivationPath added in v0.3.8 

func (x *Account) GetDerivationPath() string

func (*Account) GetExtendedPublicKey added in v0.3.8 

func (x *Account) GetExtendedPublicKey() string

func (*Account) GetExternalKeyCount added in v0.3.8 

func (x *Account) GetExternalKeyCount() uint32

func (*Account) GetInternalKeyCount added in v0.3.8 

func (x *Account) GetInternalKeyCount() uint32

func (*Account) GetMasterKeyFingerprint added in v0.3.8 

func (x *Account) GetMasterKeyFingerprint() []byte

func (*Account) GetName added in v0.3.8 

func (x *Account) GetName() string

func (*Account) GetWatchOnly added in v0.3.8 

func (x *Account) GetWatchOnly() bool

func (*Account) ProtoMessage added in v0.3.8 

func (*Account) ProtoMessage()

func (*Account) ProtoReflect added in v0.3.8 

func (x *Account) ProtoReflect() protoreflect.Message

func (*Account) Reset added in v0.3.8 

func (x *Account) Reset()

func (*Account) String added in v0.3.8 

func (x *Account) String() string

type AddrRequest 

type AddrRequest struct {

	// The name of the account to retrieve the next address of. If empty, the
	// default wallet account is used.
	Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// The type of address to derive.
	Type AddressType `protobuf:"varint,2,opt,name=type,proto3,enum=walletrpc.AddressType" json:"type,omitempty"`
	// Whether a change address should be derived.
	Change bool `protobuf:"varint,3,opt,name=change,proto3" json:"change,omitempty"`
	// contains filtered or unexported fields
}

func (*AddrRequest) Descriptor deprecated 

func (*AddrRequest) Descriptor() ([]byte, []int)

Deprecated: Use AddrRequest.ProtoReflect.Descriptor instead.

func (*AddrRequest) GetAccount added in v0.3.8 

func (x *AddrRequest) GetAccount() string

func (*AddrRequest) GetChange added in v0.6.0 

func (x *AddrRequest) GetChange() bool

func (*AddrRequest) GetType added in v0.6.0 

func (x *AddrRequest) GetType() AddressType

func (*AddrRequest) ProtoMessage 

func (*AddrRequest) ProtoMessage()

func (*AddrRequest) ProtoReflect added in v0.3.0 

func (x *AddrRequest) ProtoReflect() protoreflect.Message

func (*AddrRequest) Reset 

func (x *AddrRequest) Reset()

func (*AddrRequest) String 

func (x *AddrRequest) String() string

type AddrResponse 

type AddrResponse struct {

	// The address encoded using a bech32 format.
	Addr string `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"`
	// contains filtered or unexported fields
}

func (*AddrResponse) Descriptor deprecated 

func (*AddrResponse) Descriptor() ([]byte, []int)

Deprecated: Use AddrResponse.ProtoReflect.Descriptor instead.

func (*AddrResponse) GetAddr 

func (x *AddrResponse) GetAddr() string

func (*AddrResponse) ProtoMessage 

func (*AddrResponse) ProtoMessage()

func (*AddrResponse) ProtoReflect added in v0.3.0 

func (x *AddrResponse) ProtoReflect() protoreflect.Message

func (*AddrResponse) Reset 

func (x *AddrResponse) Reset()

func (*AddrResponse) String 

func (x *AddrResponse) String() string

type AddressType added in v0.3.8 

type AddressType int32
const (
	AddressType_UNKNOWN                           AddressType = 0
	AddressType_WITNESS_PUBKEY_HASH               AddressType = 1
	AddressType_NESTED_WITNESS_PUBKEY_HASH        AddressType = 2
	AddressType_HYBRID_NESTED_WITNESS_PUBKEY_HASH AddressType = 3
)

func (AddressType) Descriptor added in v0.3.8 

func (AddressType) Descriptor() protoreflect.EnumDescriptor

func (AddressType) Enum added in v0.3.8 

func (x AddressType) Enum() *AddressType

func (AddressType) EnumDescriptor deprecated added in v0.3.8 

func (AddressType) EnumDescriptor() ([]byte, []int)

Deprecated: Use AddressType.Descriptor instead.

func (AddressType) Number added in v0.3.8 

func (x AddressType) Number() protoreflect.EnumNumber

func (AddressType) String added in v0.3.8 

func (x AddressType) String() string

func (AddressType) Type added in v0.3.8 

func (AddressType) Type() protoreflect.EnumType

type BumpFeeRequest added in v0.2.0 

type BumpFeeRequest struct {

	// The input we're attempting to bump the fee of.
	Outpoint *lnrpc.OutPoint `protobuf:"bytes,1,opt,name=outpoint,proto3" json:"outpoint,omitempty"`
	// The target number of blocks that the input should be spent within.
	TargetConf uint32 `protobuf:"varint,2,opt,name=target_conf,json=targetConf,proto3" json:"target_conf,omitempty"`
	// The fee rate, expressed in atoms/byte, that should be used to spend the
	// input with.
	AtomsPerByte uint32 `protobuf:"varint,3,opt,name=atoms_per_byte,json=atomsPerByte,proto3" json:"atoms_per_byte,omitempty"`
	// Whether this input must be force-swept. This means that it is swept even
	// if it has a negative yield.
	Force bool `protobuf:"varint,4,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

func (*BumpFeeRequest) Descriptor deprecated added in v0.2.0 

func (*BumpFeeRequest) Descriptor() ([]byte, []int)

Deprecated: Use BumpFeeRequest.ProtoReflect.Descriptor instead.

func (*BumpFeeRequest) GetAtomsPerByte added in v0.2.0 

func (x *BumpFeeRequest) GetAtomsPerByte() uint32

func (*BumpFeeRequest) GetForce added in v0.3.0 

func (x *BumpFeeRequest) GetForce() bool

func (*BumpFeeRequest) GetOutpoint added in v0.2.0 

func (x *BumpFeeRequest) GetOutpoint() *lnrpc.OutPoint

func (*BumpFeeRequest) GetTargetConf added in v0.2.0 

func (x *BumpFeeRequest) GetTargetConf() uint32

func (*BumpFeeRequest) ProtoMessage added in v0.2.0 

func (*BumpFeeRequest) ProtoMessage()

func (*BumpFeeRequest) ProtoReflect added in v0.3.0 

func (x *BumpFeeRequest) ProtoReflect() protoreflect.Message

func (*BumpFeeRequest) Reset added in v0.2.0 

func (x *BumpFeeRequest) Reset()

func (*BumpFeeRequest) String added in v0.2.0 

func (x *BumpFeeRequest) String() string

type BumpFeeResponse added in v0.2.0 

type BumpFeeResponse struct {
	// contains filtered or unexported fields
}

func (*BumpFeeResponse) Descriptor deprecated added in v0.2.0 

func (*BumpFeeResponse) Descriptor() ([]byte, []int)

Deprecated: Use BumpFeeResponse.ProtoReflect.Descriptor instead.

func (*BumpFeeResponse) ProtoMessage added in v0.2.0 

func (*BumpFeeResponse) ProtoMessage()

func (*BumpFeeResponse) ProtoReflect added in v0.3.0 

func (x *BumpFeeResponse) ProtoReflect() protoreflect.Message

func (*BumpFeeResponse) Reset added in v0.2.0 

func (x *BumpFeeResponse) Reset()

func (*BumpFeeResponse) String added in v0.2.0 

func (x *BumpFeeResponse) String() string

type Config 

type Config struct {
	// WalletKitMacPath is the path for the signer macaroon. If unspecified
	// then we assume that the macaroon will be found under the network
	// directory, named DefaultWalletKitMacFilename.
	WalletKitMacPath string `long:"walletkitmacaroonpath" description:"Path to the wallet kit macaroon"`

	// NetworkDir is the main network directory wherein the signer rpc
	// server will find the macaroon named DefaultWalletKitMacFilename.
	NetworkDir string

	// MacService is the main macaroon service that we'll use to handle
	// authentication for the signer rpc server.
	MacService *macaroons.Service

	// FeeEstimator is an instance of the primary fee estimator instance
	// the WalletKit will use to respond to fee estimation requests.
	FeeEstimator chainfee.Estimator

	// Wallet is the primary wallet that the WalletKit will use to proxy
	// any relevant requests to.
	Wallet lnwallet.WalletController

	// CoinSelectionLocker allows the caller to perform an operation, which
	// is synchronized with all coin selection attempts. This can be used
	// when an operation requires that all coin selection operations cease
	// forward progress. Think of this as an exclusive lock on coin
	// selection operations.
	CoinSelectionLocker sweep.CoinSelectionLocker

	// KeyRing is an interface that the WalletKit will use to derive any
	// keys due to incoming client requests.
	KeyRing keychain.KeyRing

	// Sweeper is the central batching engine of lnd. It is responsible for
	// sweeping inputs in batches back into the wallet.
	Sweeper *sweep.UtxoSweeper

	// Chain is an interface that the WalletKit will use to determine state
	// about the backing chain of the wallet.
	Chain lnwallet.BlockChainIO

	// ChainParams are the parameters of the wallet's backing chain.
	ChainParams *chaincfg.Params
}

Config is the primary configuration struct for the WalletKit RPC server. It contains all the items required for the signer rpc server to carry out its duties. The fields with struct tags are meant to be parsed as normal configuration options, while if able to be populated, the latter fields MUST also be specified.

type DeriveNextAccountRequest added in v0.3.8 

type DeriveNextAccountRequest struct {

	// The name for the new account.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*DeriveNextAccountRequest) Descriptor deprecated added in v0.3.8 

func (*DeriveNextAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeriveNextAccountRequest.ProtoReflect.Descriptor instead.

func (*DeriveNextAccountRequest) GetName added in v0.3.8 

func (x *DeriveNextAccountRequest) GetName() string

func (*DeriveNextAccountRequest) ProtoMessage added in v0.3.8 

func (*DeriveNextAccountRequest) ProtoMessage()

func (*DeriveNextAccountRequest) ProtoReflect added in v0.3.8 

func (x *DeriveNextAccountRequest) ProtoReflect() protoreflect.Message

func (*DeriveNextAccountRequest) Reset added in v0.3.8 

func (x *DeriveNextAccountRequest) Reset()

func (*DeriveNextAccountRequest) String added in v0.3.8 

func (x *DeriveNextAccountRequest) String() string

type DeriveNextAccountResponse added in v0.3.8 

type DeriveNextAccountResponse struct {
	// contains filtered or unexported fields
}

func (*DeriveNextAccountResponse) Descriptor deprecated added in v0.3.8 

func (*DeriveNextAccountResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeriveNextAccountResponse.ProtoReflect.Descriptor instead.

func (*DeriveNextAccountResponse) ProtoMessage added in v0.3.8 

func (*DeriveNextAccountResponse) ProtoMessage()

func (*DeriveNextAccountResponse) ProtoReflect added in v0.3.8 

func (x *DeriveNextAccountResponse) ProtoReflect() protoreflect.Message

func (*DeriveNextAccountResponse) Reset added in v0.3.8 

func (x *DeriveNextAccountResponse) Reset()

func (*DeriveNextAccountResponse) String added in v0.3.8 

func (x *DeriveNextAccountResponse) String() string

type EstimateFeeRequest 

type EstimateFeeRequest struct {

	// The number of confirmations to shoot for when estimating the fee.
	ConfTarget int32 `protobuf:"varint,1,opt,name=conf_target,json=confTarget,proto3" json:"conf_target,omitempty"`
	// contains filtered or unexported fields
}

func (*EstimateFeeRequest) Descriptor deprecated 

func (*EstimateFeeRequest) Descriptor() ([]byte, []int)

Deprecated: Use EstimateFeeRequest.ProtoReflect.Descriptor instead.

func (*EstimateFeeRequest) GetConfTarget 

func (x *EstimateFeeRequest) GetConfTarget() int32

func (*EstimateFeeRequest) ProtoMessage 

func (*EstimateFeeRequest) ProtoMessage()

func (*EstimateFeeRequest) ProtoReflect added in v0.3.0 

func (x *EstimateFeeRequest) ProtoReflect() protoreflect.Message

func (*EstimateFeeRequest) Reset 

func (x *EstimateFeeRequest) Reset()

func (*EstimateFeeRequest) String 

func (x *EstimateFeeRequest) String() string

type EstimateFeeResponse 

type EstimateFeeResponse struct {

	// The amount of atoms per kilobyte that should be used in order to reach the
	// confirmation target in the request.
	AtomsPerKb int64 `protobuf:"varint,1,opt,name=atoms_per_kb,json=atomsPerKb,proto3" json:"atoms_per_kb,omitempty"`
	// contains filtered or unexported fields
}

func (*EstimateFeeResponse) Descriptor deprecated 

func (*EstimateFeeResponse) Descriptor() ([]byte, []int)

Deprecated: Use EstimateFeeResponse.ProtoReflect.Descriptor instead.

func (*EstimateFeeResponse) GetAtomsPerKb added in v0.2.0 

func (x *EstimateFeeResponse) GetAtomsPerKb() int64

func (*EstimateFeeResponse) ProtoMessage 

func (*EstimateFeeResponse) ProtoMessage()

func (*EstimateFeeResponse) ProtoReflect added in v0.3.0 

func (x *EstimateFeeResponse) ProtoReflect() protoreflect.Message

func (*EstimateFeeResponse) Reset 

func (x *EstimateFeeResponse) Reset()

func (*EstimateFeeResponse) String 

func (x *EstimateFeeResponse) String() string

type ExportPrivateKeyRequest added in v0.3.8 

type ExportPrivateKeyRequest struct {

	// The public address for which to export the private key.
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportPrivateKeyRequest) Descriptor deprecated added in v0.3.8 

func (*ExportPrivateKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExportPrivateKeyRequest.ProtoReflect.Descriptor instead.

func (*ExportPrivateKeyRequest) GetAddress added in v0.3.8 

func (x *ExportPrivateKeyRequest) GetAddress() string

func (*ExportPrivateKeyRequest) ProtoMessage added in v0.3.8 

func (*ExportPrivateKeyRequest) ProtoMessage()

func (*ExportPrivateKeyRequest) ProtoReflect added in v0.3.8 

func (x *ExportPrivateKeyRequest) ProtoReflect() protoreflect.Message

func (*ExportPrivateKeyRequest) Reset added in v0.3.8 

func (x *ExportPrivateKeyRequest) Reset()

func (*ExportPrivateKeyRequest) String added in v0.3.8 

func (x *ExportPrivateKeyRequest) String() string

type ExportPrivateKeyResponse added in v0.3.8 

type ExportPrivateKeyResponse struct {

	// The private key in WIF format.
	Wif string `protobuf:"bytes,1,opt,name=wif,proto3" json:"wif,omitempty"`
	// contains filtered or unexported fields
}

func (*ExportPrivateKeyResponse) Descriptor deprecated added in v0.3.8 

func (*ExportPrivateKeyResponse) Descriptor() ([]byte, []int)

Deprecated: Use ExportPrivateKeyResponse.ProtoReflect.Descriptor instead.

func (*ExportPrivateKeyResponse) GetWif added in v0.3.8 

func (x *ExportPrivateKeyResponse) GetWif() string

func (*ExportPrivateKeyResponse) ProtoMessage added in v0.3.8 

func (*ExportPrivateKeyResponse) ProtoMessage()

func (*ExportPrivateKeyResponse) ProtoReflect added in v0.3.8 

func (x *ExportPrivateKeyResponse) ProtoReflect() protoreflect.Message

func (*ExportPrivateKeyResponse) Reset added in v0.3.8 

func (x *ExportPrivateKeyResponse) Reset()

func (*ExportPrivateKeyResponse) String added in v0.3.8 

func (x *ExportPrivateKeyResponse) String() string

type FinalizePsbtRequest added in v0.5.0 

type FinalizePsbtRequest struct {

	// A PSBT that should be signed and finalized. The PSBT must contain all
	// required inputs, outputs, UTXO data and partial signatures of all other
	// signers.
	FundedPsbt []byte `protobuf:"bytes,1,opt,name=funded_psbt,json=fundedPsbt,proto3" json:"funded_psbt,omitempty"`
	// contains filtered or unexported fields
}

func (*FinalizePsbtRequest) Descriptor deprecated added in v0.5.0 

func (*FinalizePsbtRequest) Descriptor() ([]byte, []int)

Deprecated: Use FinalizePsbtRequest.ProtoReflect.Descriptor instead.

func (*FinalizePsbtRequest) GetFundedPsbt added in v0.5.0 

func (x *FinalizePsbtRequest) GetFundedPsbt() []byte

func (*FinalizePsbtRequest) ProtoMessage added in v0.5.0 

func (*FinalizePsbtRequest) ProtoMessage()

func (*FinalizePsbtRequest) ProtoReflect added in v0.5.0 

func (x *FinalizePsbtRequest) ProtoReflect() protoreflect.Message

func (*FinalizePsbtRequest) Reset added in v0.5.0 

func (x *FinalizePsbtRequest) Reset()

func (*FinalizePsbtRequest) String added in v0.5.0 

func (x *FinalizePsbtRequest) String() string

type FinalizePsbtResponse added in v0.5.0 

type FinalizePsbtResponse struct {

	// The fully signed and finalized transaction in PSBT format.
	SignedPsbt []byte `protobuf:"bytes,1,opt,name=signed_psbt,json=signedPsbt,proto3" json:"signed_psbt,omitempty"`
	// The fully signed and finalized transaction in the raw wire format.
	RawFinalTx []byte `protobuf:"bytes,2,opt,name=raw_final_tx,json=rawFinalTx,proto3" json:"raw_final_tx,omitempty"`
	// contains filtered or unexported fields
}

func (*FinalizePsbtResponse) Descriptor deprecated added in v0.5.0 

func (*FinalizePsbtResponse) Descriptor() ([]byte, []int)

Deprecated: Use FinalizePsbtResponse.ProtoReflect.Descriptor instead.

func (*FinalizePsbtResponse) GetRawFinalTx added in v0.5.0 

func (x *FinalizePsbtResponse) GetRawFinalTx() []byte

func (*FinalizePsbtResponse) GetSignedPsbt added in v0.5.0 

func (x *FinalizePsbtResponse) GetSignedPsbt() []byte

func (*FinalizePsbtResponse) ProtoMessage added in v0.5.0 

func (*FinalizePsbtResponse) ProtoMessage()

func (*FinalizePsbtResponse) ProtoReflect added in v0.5.0 

func (x *FinalizePsbtResponse) ProtoReflect() protoreflect.Message

func (*FinalizePsbtResponse) Reset added in v0.5.0 

func (x *FinalizePsbtResponse) Reset()

func (*FinalizePsbtResponse) String added in v0.5.0 

func (x *FinalizePsbtResponse) String() string

type FundPsbtRequest added in v0.5.0 

type FundPsbtRequest struct {

	// Types that are assignable to Template:
	//
	//	*FundPsbtRequest_Psbt
	//	*FundPsbtRequest_Raw
	Template isFundPsbtRequest_Template `protobuf_oneof:"template"`
	// Types that are assignable to Fees:
	//
	//	*FundPsbtRequest_TargetConf
	//	*FundPsbtRequest_AtomsPerByte
	Fees isFundPsbtRequest_Fees `protobuf_oneof:"fees"`
	// The name of the account to fund the PSBT with. If empty, the default wallet
	// account is used.
	Account string `protobuf:"bytes,5,opt,name=account,proto3" json:"account,omitempty"`
	// The minimum number of confirmations each one of your outputs used for
	// the transaction must satisfy.
	MinConfs int32 `protobuf:"varint,6,opt,name=min_confs,json=minConfs,proto3" json:"min_confs,omitempty"`
	// Whether unconfirmed outputs should be used as inputs for the transaction.
	SpendUnconfirmed bool `protobuf:"varint,7,opt,name=spend_unconfirmed,json=spendUnconfirmed,proto3" json:"spend_unconfirmed,omitempty"`
	// contains filtered or unexported fields
}

func (*FundPsbtRequest) Descriptor deprecated added in v0.5.0 

func (*FundPsbtRequest) Descriptor() ([]byte, []int)

Deprecated: Use FundPsbtRequest.ProtoReflect.Descriptor instead.

func (*FundPsbtRequest) GetAccount added in v0.5.0 

func (x *FundPsbtRequest) GetAccount() string

func (*FundPsbtRequest) GetAtomsPerByte added in v0.5.0 

func (x *FundPsbtRequest) GetAtomsPerByte() uint64

func (*FundPsbtRequest) GetFees added in v0.5.0 

func (m *FundPsbtRequest) GetFees() isFundPsbtRequest_Fees

func (*FundPsbtRequest) GetMinConfs added in v0.5.0 

func (x *FundPsbtRequest) GetMinConfs() int32

func (*FundPsbtRequest) GetPsbt added in v0.5.0 

func (x *FundPsbtRequest) GetPsbt() []byte

func (*FundPsbtRequest) GetRaw added in v0.5.0 

func (x *FundPsbtRequest) GetRaw() *TxTemplate

func (*FundPsbtRequest) GetSpendUnconfirmed added in v0.5.0 

func (x *FundPsbtRequest) GetSpendUnconfirmed() bool

func (*FundPsbtRequest) GetTargetConf added in v0.5.0 

func (x *FundPsbtRequest) GetTargetConf() uint32

func (*FundPsbtRequest) GetTemplate added in v0.5.0 

func (m *FundPsbtRequest) GetTemplate() isFundPsbtRequest_Template

func (*FundPsbtRequest) ProtoMessage added in v0.5.0 

func (*FundPsbtRequest) ProtoMessage()

func (*FundPsbtRequest) ProtoReflect added in v0.5.0 

func (x *FundPsbtRequest) ProtoReflect() protoreflect.Message

func (*FundPsbtRequest) Reset added in v0.5.0 

func (x *FundPsbtRequest) Reset()

func (*FundPsbtRequest) String added in v0.5.0 

func (x *FundPsbtRequest) String() string

type FundPsbtRequest_AtomsPerByte added in v0.5.0 

type FundPsbtRequest_AtomsPerByte struct {
	// The fee rate, expressed in atoms/byte, that should be used to spend the
	// input with.
	AtomsPerByte uint64 `protobuf:"varint,4,opt,name=atoms_per_byte,json=atomsPerByte,proto3,oneof"`
}

type FundPsbtRequest_Psbt added in v0.5.0 

type FundPsbtRequest_Psbt struct {
	// Use an existing PSBT packet as the template for the funded PSBT.
	//
	// The packet must contain at least one non-dust output. If one or more
	// inputs are specified, no coin selection is performed. In that case every
	// input must be an UTXO known to the wallet that has not been locked
	// before. The sum of all inputs must be sufficiently greater than the sum
	// of all outputs to pay a miner fee with the specified fee rate. A change
	// output is added to the PSBT if necessary.
	Psbt []byte `protobuf:"bytes,1,opt,name=psbt,proto3,oneof"`
}

type FundPsbtRequest_Raw added in v0.5.0 

type FundPsbtRequest_Raw struct {
	// Use the outputs and optional inputs from this raw template.
	Raw *TxTemplate `protobuf:"bytes,2,opt,name=raw,proto3,oneof"`
}

type FundPsbtRequest_TargetConf added in v0.5.0 

type FundPsbtRequest_TargetConf struct {
	// The target number of blocks that the transaction should be confirmed in.
	TargetConf uint32 `protobuf:"varint,3,opt,name=target_conf,json=targetConf,proto3,oneof"`
}

type FundPsbtResponse added in v0.5.0 

type FundPsbtResponse struct {

	// The funded but not yet signed PSBT packet.
	FundedPsbt []byte `protobuf:"bytes,1,opt,name=funded_psbt,json=fundedPsbt,proto3" json:"funded_psbt,omitempty"`
	// The index of the added change output or -1 if no change was left over.
	ChangeOutputIndex int32 `protobuf:"varint,2,opt,name=change_output_index,json=changeOutputIndex,proto3" json:"change_output_index,omitempty"`
	// The list of lock leases that were acquired for the inputs in the funded PSBT
	// packet.
	LockedUtxos []*UtxoLease `protobuf:"bytes,3,rep,name=locked_utxos,json=lockedUtxos,proto3" json:"locked_utxos,omitempty"`
	// contains filtered or unexported fields
}

func (*FundPsbtResponse) Descriptor deprecated added in v0.5.0 

func (*FundPsbtResponse) Descriptor() ([]byte, []int)

Deprecated: Use FundPsbtResponse.ProtoReflect.Descriptor instead.

func (*FundPsbtResponse) GetChangeOutputIndex added in v0.5.0 

func (x *FundPsbtResponse) GetChangeOutputIndex() int32

func (*FundPsbtResponse) GetFundedPsbt added in v0.5.0 

func (x *FundPsbtResponse) GetFundedPsbt() []byte

func (*FundPsbtResponse) GetLockedUtxos added in v0.5.0 

func (x *FundPsbtResponse) GetLockedUtxos() []*UtxoLease

func (*FundPsbtResponse) ProtoMessage added in v0.5.0 

func (*FundPsbtResponse) ProtoMessage()

func (*FundPsbtResponse) ProtoReflect added in v0.5.0 

func (x *FundPsbtResponse) ProtoReflect() protoreflect.Message

func (*FundPsbtResponse) Reset added in v0.5.0 

func (x *FundPsbtResponse) Reset()

func (*FundPsbtResponse) String added in v0.5.0 

func (x *FundPsbtResponse) String() string

type GetWalletTxRequest added in v0.4.0 

type GetWalletTxRequest struct {
	Txid []byte `protobuf:"bytes,1,opt,name=txid,proto3" json:"txid,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWalletTxRequest) Descriptor deprecated added in v0.4.0 

func (*GetWalletTxRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetWalletTxRequest.ProtoReflect.Descriptor instead.

func (*GetWalletTxRequest) GetTxid added in v0.4.0 

func (x *GetWalletTxRequest) GetTxid() []byte

func (*GetWalletTxRequest) ProtoMessage added in v0.4.0 

func (*GetWalletTxRequest) ProtoMessage()

func (*GetWalletTxRequest) ProtoReflect added in v0.4.0 

func (x *GetWalletTxRequest) ProtoReflect() protoreflect.Message

func (*GetWalletTxRequest) Reset added in v0.4.0 

func (x *GetWalletTxRequest) Reset()

func (*GetWalletTxRequest) String added in v0.4.0 

func (x *GetWalletTxRequest) String() string

type GetWalletTxResponse added in v0.4.0 

type GetWalletTxResponse struct {
	RawTx         []byte `protobuf:"bytes,1,opt,name=raw_tx,json=rawTx,proto3" json:"raw_tx,omitempty"`
	Confirmations int32  `protobuf:"varint,2,opt,name=confirmations,proto3" json:"confirmations,omitempty"`
	BlockHash     []byte `protobuf:"bytes,3,opt,name=block_hash,json=blockHash,proto3" json:"block_hash,omitempty"`
	// contains filtered or unexported fields
}

func (*GetWalletTxResponse) Descriptor deprecated added in v0.4.0 

func (*GetWalletTxResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetWalletTxResponse.ProtoReflect.Descriptor instead.

func (*GetWalletTxResponse) GetBlockHash added in v0.4.0 

func (x *GetWalletTxResponse) GetBlockHash() []byte

func (*GetWalletTxResponse) GetConfirmations added in v0.4.0 

func (x *GetWalletTxResponse) GetConfirmations() int32

func (*GetWalletTxResponse) GetRawTx added in v0.4.0 

func (x *GetWalletTxResponse) GetRawTx() []byte

func (*GetWalletTxResponse) ProtoMessage added in v0.4.0 

func (*GetWalletTxResponse) ProtoMessage()

func (*GetWalletTxResponse) ProtoReflect added in v0.4.0 

func (x *GetWalletTxResponse) ProtoReflect() protoreflect.Message

func (*GetWalletTxResponse) Reset added in v0.4.0 

func (x *GetWalletTxResponse) Reset()

func (*GetWalletTxResponse) String added in v0.4.0 

func (x *GetWalletTxResponse) String() string

type ImportAccountRequest added in v0.3.8 

type ImportAccountRequest struct {

	// A name to identify the account with.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// A public key that corresponds to a wallet account represented as an extended
	// key. It must conform to a derivation path of the form
	// m/purpose'/coin_type'/account'.
	ExtendedPublicKey string `protobuf:"bytes,2,opt,name=extended_public_key,json=extendedPublicKey,proto3" json:"extended_public_key,omitempty"`
	// The fingerprint of the root key (also known as the key with derivation path
	// m/) from which the account public key was derived from. This may be required
	// by some hardware wallets for proper identification and signing. The bytes
	// must be in big-endian order.
	MasterKeyFingerprint []byte `protobuf:"bytes,3,opt,name=master_key_fingerprint,json=masterKeyFingerprint,proto3" json:"master_key_fingerprint,omitempty"`
	// An address type is only required when the extended account public key has a
	// legacy version (xpub, tpub, etc.), such that the wallet cannot detect what
	// address scheme it belongs to.
	AddressType AddressType `protobuf:"varint,4,opt,name=address_type,json=addressType,proto3,enum=walletrpc.AddressType" json:"address_type,omitempty"`
	// Whether a dry run should be attempted when importing the account. This
	// serves as a way to confirm whether the account is being imported correctly
	// by returning the first N addresses for the external and internal branches of
	// the account. If these addresses match as expected, then it should be safe to
	// import the account as is.
	DryRun bool `protobuf:"varint,5,opt,name=dry_run,json=dryRun,proto3" json:"dry_run,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportAccountRequest) Descriptor deprecated added in v0.3.8 

func (*ImportAccountRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportAccountRequest.ProtoReflect.Descriptor instead.

func (*ImportAccountRequest) GetAddressType added in v0.3.8 

func (x *ImportAccountRequest) GetAddressType() AddressType

func (*ImportAccountRequest) GetDryRun added in v0.5.0 

func (x *ImportAccountRequest) GetDryRun() bool

func (*ImportAccountRequest) GetExtendedPublicKey added in v0.3.8 

func (x *ImportAccountRequest) GetExtendedPublicKey() string

func (*ImportAccountRequest) GetMasterKeyFingerprint added in v0.3.8 

func (x *ImportAccountRequest) GetMasterKeyFingerprint() []byte

func (*ImportAccountRequest) GetName added in v0.3.8 

func (x *ImportAccountRequest) GetName() string

func (*ImportAccountRequest) ProtoMessage added in v0.3.8 

func (*ImportAccountRequest) ProtoMessage()

func (*ImportAccountRequest) ProtoReflect added in v0.3.8 

func (x *ImportAccountRequest) ProtoReflect() protoreflect.Message

func (*ImportAccountRequest) Reset added in v0.3.8 

func (x *ImportAccountRequest) Reset()

func (*ImportAccountRequest) String added in v0.3.8 

func (x *ImportAccountRequest) String() string

type ImportAccountResponse added in v0.3.8 

type ImportAccountResponse struct {

	// The details of the imported account.
	Account *Account `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// The first N addresses that belong to the external branch of the account.
	// The external branch is typically used for external non-change addresses.
	// These are only returned if a dry run was specified within the request.
	DryRunExternalAddrs []string `protobuf:"bytes,2,rep,name=dry_run_external_addrs,json=dryRunExternalAddrs,proto3" json:"dry_run_external_addrs,omitempty"`
	// The first N addresses that belong to the internal branch of the account.
	// The internal branch is typically used for change addresses. These are only
	// returned if a dry run was specified within the request.
	DryRunInternalAddrs []string `protobuf:"bytes,3,rep,name=dry_run_internal_addrs,json=dryRunInternalAddrs,proto3" json:"dry_run_internal_addrs,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportAccountResponse) Descriptor deprecated added in v0.3.8 

func (*ImportAccountResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportAccountResponse.ProtoReflect.Descriptor instead.

func (*ImportAccountResponse) GetAccount added in v0.5.0 

func (x *ImportAccountResponse) GetAccount() *Account

func (*ImportAccountResponse) GetDryRunExternalAddrs added in v0.5.0 

func (x *ImportAccountResponse) GetDryRunExternalAddrs() []string

func (*ImportAccountResponse) GetDryRunInternalAddrs added in v0.5.0 

func (x *ImportAccountResponse) GetDryRunInternalAddrs() []string

func (*ImportAccountResponse) ProtoMessage added in v0.3.8 

func (*ImportAccountResponse) ProtoMessage()

func (*ImportAccountResponse) ProtoReflect added in v0.3.8 

func (x *ImportAccountResponse) ProtoReflect() protoreflect.Message

func (*ImportAccountResponse) Reset added in v0.3.8 

func (x *ImportAccountResponse) Reset()

func (*ImportAccountResponse) String added in v0.3.8 

func (x *ImportAccountResponse) String() string

type ImportPublicKeyRequest added in v0.3.8 

type ImportPublicKeyRequest struct {

	// A compressed public key represented as raw bytes.
	PublicKey []byte `protobuf:"bytes,1,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// The type of address that will be generated from the public key.
	AddressType AddressType `protobuf:"varint,2,opt,name=address_type,json=addressType,proto3,enum=walletrpc.AddressType" json:"address_type,omitempty"`
	// contains filtered or unexported fields
}

func (*ImportPublicKeyRequest) Descriptor deprecated added in v0.3.8 

func (*ImportPublicKeyRequest) Descriptor() ([]byte, []int)

Deprecated: Use ImportPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*ImportPublicKeyRequest) GetAddressType added in v0.3.8 

func (x *ImportPublicKeyRequest) GetAddressType() AddressType

func (*ImportPublicKeyRequest) GetPublicKey added in v0.3.8 

func (x *ImportPublicKeyRequest) GetPublicKey() []byte

func (*ImportPublicKeyRequest) ProtoMessage added in v0.3.8 

func (*ImportPublicKeyRequest) ProtoMessage()

func (*ImportPublicKeyRequest) ProtoReflect added in v0.3.8 

func (x *ImportPublicKeyRequest) ProtoReflect() protoreflect.Message

func (*ImportPublicKeyRequest) Reset added in v0.3.8 

func (x *ImportPublicKeyRequest) Reset()

func (*ImportPublicKeyRequest) String added in v0.3.8 

func (x *ImportPublicKeyRequest) String() string

type ImportPublicKeyResponse added in v0.3.8 

type ImportPublicKeyResponse struct {
	// contains filtered or unexported fields
}

func (*ImportPublicKeyResponse) Descriptor deprecated added in v0.3.8 

func (*ImportPublicKeyResponse) Descriptor() ([]byte, []int)

Deprecated: Use ImportPublicKeyResponse.ProtoReflect.Descriptor instead.

func (*ImportPublicKeyResponse) ProtoMessage added in v0.3.8 

func (*ImportPublicKeyResponse) ProtoMessage()

func (*ImportPublicKeyResponse) ProtoReflect added in v0.3.8 

func (x *ImportPublicKeyResponse) ProtoReflect() protoreflect.Message

func (*ImportPublicKeyResponse) Reset added in v0.3.8 

func (x *ImportPublicKeyResponse) Reset()

func (*ImportPublicKeyResponse) String added in v0.3.8 

func (x *ImportPublicKeyResponse) String() string

type KeyReq 

type KeyReq struct {

	// Is the key finger print of the root pubkey that this request is targeting.
	// This allows the WalletKit to possibly serve out keys for multiple HD chains
	// via public derivation.
	KeyFingerPrint int32 `protobuf:"varint,1,opt,name=key_finger_print,json=keyFingerPrint,proto3" json:"key_finger_print,omitempty"`
	// The target key family to derive a key from. In other contexts, this is
	// known as the "account".
	KeyFamily int32 `protobuf:"varint,2,opt,name=key_family,json=keyFamily,proto3" json:"key_family,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyReq) Descriptor deprecated 

func (*KeyReq) Descriptor() ([]byte, []int)

Deprecated: Use KeyReq.ProtoReflect.Descriptor instead.

func (*KeyReq) GetKeyFamily 

func (x *KeyReq) GetKeyFamily() int32

func (*KeyReq) GetKeyFingerPrint 

func (x *KeyReq) GetKeyFingerPrint() int32

func (*KeyReq) ProtoMessage 

func (*KeyReq) ProtoMessage()

func (*KeyReq) ProtoReflect added in v0.3.0 

func (x *KeyReq) ProtoReflect() protoreflect.Message

func (*KeyReq) Reset 

func (x *KeyReq) Reset()

func (*KeyReq) String 

func (x *KeyReq) String() string

type LabelTransactionRequest added in v0.3.0 

type LabelTransactionRequest struct {

	// The txid of the transaction to label.
	Txid []byte `protobuf:"bytes,1,opt,name=txid,proto3" json:"txid,omitempty"`
	// The label to add to the transaction, limited to 500 characters.
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// Whether to overwrite the existing label, if it is present.
	Overwrite bool `protobuf:"varint,3,opt,name=overwrite,proto3" json:"overwrite,omitempty"`
	// contains filtered or unexported fields
}

func (*LabelTransactionRequest) Descriptor deprecated added in v0.3.0 

func (*LabelTransactionRequest) Descriptor() ([]byte, []int)

Deprecated: Use LabelTransactionRequest.ProtoReflect.Descriptor instead.

func (*LabelTransactionRequest) GetLabel added in v0.3.0 

func (x *LabelTransactionRequest) GetLabel() string

func (*LabelTransactionRequest) GetOverwrite added in v0.3.0 

func (x *LabelTransactionRequest) GetOverwrite() bool

func (*LabelTransactionRequest) GetTxid added in v0.3.0 

func (x *LabelTransactionRequest) GetTxid() []byte

func (*LabelTransactionRequest) ProtoMessage added in v0.3.0 

func (*LabelTransactionRequest) ProtoMessage()

func (*LabelTransactionRequest) ProtoReflect added in v0.3.0 

func (x *LabelTransactionRequest) ProtoReflect() protoreflect.Message

func (*LabelTransactionRequest) Reset added in v0.3.0 

func (x *LabelTransactionRequest) Reset()

func (*LabelTransactionRequest) String added in v0.3.0 

func (x *LabelTransactionRequest) String() string

type LabelTransactionResponse added in v0.3.0 

type LabelTransactionResponse struct {
	// contains filtered or unexported fields
}

func (*LabelTransactionResponse) Descriptor deprecated added in v0.3.0 

func (*LabelTransactionResponse) Descriptor() ([]byte, []int)

Deprecated: Use LabelTransactionResponse.ProtoReflect.Descriptor instead.

func (*LabelTransactionResponse) ProtoMessage added in v0.3.0 

func (*LabelTransactionResponse) ProtoMessage()

func (*LabelTransactionResponse) ProtoReflect added in v0.3.0 

func (x *LabelTransactionResponse) ProtoReflect() protoreflect.Message

func (*LabelTransactionResponse) Reset added in v0.3.0 

func (x *LabelTransactionResponse) Reset()

func (*LabelTransactionResponse) String added in v0.3.0 

func (x *LabelTransactionResponse) String() string

type LeaseOutputRequest added in v0.3.0 

type LeaseOutputRequest struct {

	// An ID of 32 random bytes that must be unique for each distinct application
	// using this RPC which will be used to bound the output lease to.
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The identifying outpoint of the output being leased.
	Outpoint *lnrpc.OutPoint `protobuf:"bytes,2,opt,name=outpoint,proto3" json:"outpoint,omitempty"`
	// The time in seconds before the lock expires. If set to zero, the default
	// lock duration is used.
	ExpirationSeconds uint64 `protobuf:"varint,3,opt,name=expiration_seconds,json=expirationSeconds,proto3" json:"expiration_seconds,omitempty"`
	// contains filtered or unexported fields
}

func (*LeaseOutputRequest) Descriptor deprecated added in v0.3.0 

func (*LeaseOutputRequest) Descriptor() ([]byte, []int)

Deprecated: Use LeaseOutputRequest.ProtoReflect.Descriptor instead.

func (*LeaseOutputRequest) GetExpirationSeconds added in v0.5.0 

func (x *LeaseOutputRequest) GetExpirationSeconds() uint64

func (*LeaseOutputRequest) GetId added in v0.3.0 

func (x *LeaseOutputRequest) GetId() []byte

func (*LeaseOutputRequest) GetOutpoint added in v0.3.0 

func (x *LeaseOutputRequest) GetOutpoint() *lnrpc.OutPoint

func (*LeaseOutputRequest) ProtoMessage added in v0.3.0 

func (*LeaseOutputRequest) ProtoMessage()

func (*LeaseOutputRequest) ProtoReflect added in v0.3.0 

func (x *LeaseOutputRequest) ProtoReflect() protoreflect.Message

func (*LeaseOutputRequest) Reset added in v0.3.0 

func (x *LeaseOutputRequest) Reset()

func (*LeaseOutputRequest) String added in v0.3.0 

func (x *LeaseOutputRequest) String() string

type LeaseOutputResponse added in v0.3.0 

type LeaseOutputResponse struct {

	// The absolute expiration of the output lease represented as a unix timestamp.
	Expiration uint64 `protobuf:"varint,1,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// contains filtered or unexported fields
}

func (*LeaseOutputResponse) Descriptor deprecated added in v0.3.0 

func (*LeaseOutputResponse) Descriptor() ([]byte, []int)

Deprecated: Use LeaseOutputResponse.ProtoReflect.Descriptor instead.

func (*LeaseOutputResponse) GetExpiration added in v0.3.0 

func (x *LeaseOutputResponse) GetExpiration() uint64

func (*LeaseOutputResponse) ProtoMessage added in v0.3.0 

func (*LeaseOutputResponse) ProtoMessage()

func (*LeaseOutputResponse) ProtoReflect added in v0.3.0 

func (x *LeaseOutputResponse) ProtoReflect() protoreflect.Message

func (*LeaseOutputResponse) Reset added in v0.3.0 

func (x *LeaseOutputResponse) Reset()

func (*LeaseOutputResponse) String added in v0.3.0 

func (x *LeaseOutputResponse) String() string

type ListAccountsRequest added in v0.3.8 

type ListAccountsRequest struct {

	// An optional filter to only return accounts matching this name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// An optional filter to only return accounts matching this address type.
	AddressType AddressType `protobuf:"varint,2,opt,name=address_type,json=addressType,proto3,enum=walletrpc.AddressType" json:"address_type,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAccountsRequest) Descriptor deprecated added in v0.3.8 

func (*ListAccountsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountsRequest.ProtoReflect.Descriptor instead.

func (*ListAccountsRequest) GetAddressType added in v0.3.8 

func (x *ListAccountsRequest) GetAddressType() AddressType

func (*ListAccountsRequest) GetName added in v0.3.8 

func (x *ListAccountsRequest) GetName() string

func (*ListAccountsRequest) ProtoMessage added in v0.3.8 

func (*ListAccountsRequest) ProtoMessage()

func (*ListAccountsRequest) ProtoReflect added in v0.3.8 

func (x *ListAccountsRequest) ProtoReflect() protoreflect.Message

func (*ListAccountsRequest) Reset added in v0.3.8 

func (x *ListAccountsRequest) Reset()

func (*ListAccountsRequest) String added in v0.3.8 

func (x *ListAccountsRequest) String() string

type ListAccountsResponse added in v0.3.8 

type ListAccountsResponse struct {
	Accounts []*Account `protobuf:"bytes,1,rep,name=accounts,proto3" json:"accounts,omitempty"`
	// contains filtered or unexported fields
}

func (*ListAccountsResponse) Descriptor deprecated added in v0.3.8 

func (*ListAccountsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountsResponse.ProtoReflect.Descriptor instead.

func (*ListAccountsResponse) GetAccounts added in v0.3.8 

func (x *ListAccountsResponse) GetAccounts() []*Account

func (*ListAccountsResponse) ProtoMessage added in v0.3.8 

func (*ListAccountsResponse) ProtoMessage()

func (*ListAccountsResponse) ProtoReflect added in v0.3.8 

func (x *ListAccountsResponse) ProtoReflect() protoreflect.Message

func (*ListAccountsResponse) Reset added in v0.3.8 

func (x *ListAccountsResponse) Reset()

func (*ListAccountsResponse) String added in v0.3.8 

func (x *ListAccountsResponse) String() string

type ListLeasesRequest added in v0.5.0 

type ListLeasesRequest struct {
	// contains filtered or unexported fields
}

func (*ListLeasesRequest) Descriptor deprecated added in v0.5.0 

func (*ListLeasesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListLeasesRequest.ProtoReflect.Descriptor instead.

func (*ListLeasesRequest) ProtoMessage added in v0.5.0 

func (*ListLeasesRequest) ProtoMessage()

func (*ListLeasesRequest) ProtoReflect added in v0.5.0 

func (x *ListLeasesRequest) ProtoReflect() protoreflect.Message

func (*ListLeasesRequest) Reset added in v0.5.0 

func (x *ListLeasesRequest) Reset()

func (*ListLeasesRequest) String added in v0.5.0 

func (x *ListLeasesRequest) String() string

type ListLeasesResponse added in v0.5.0 

type ListLeasesResponse struct {

	// The list of currently leased utxos.
	LockedUtxos []*UtxoLease `protobuf:"bytes,1,rep,name=locked_utxos,json=lockedUtxos,proto3" json:"locked_utxos,omitempty"`
	// contains filtered or unexported fields
}

func (*ListLeasesResponse) Descriptor deprecated added in v0.5.0 

func (*ListLeasesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListLeasesResponse.ProtoReflect.Descriptor instead.

func (*ListLeasesResponse) GetLockedUtxos added in v0.5.0 

func (x *ListLeasesResponse) GetLockedUtxos() []*UtxoLease

func (*ListLeasesResponse) ProtoMessage added in v0.5.0 

func (*ListLeasesResponse) ProtoMessage()

func (*ListLeasesResponse) ProtoReflect added in v0.5.0 

func (x *ListLeasesResponse) ProtoReflect() protoreflect.Message

func (*ListLeasesResponse) Reset added in v0.5.0 

func (x *ListLeasesResponse) Reset()

func (*ListLeasesResponse) String added in v0.5.0 

func (x *ListLeasesResponse) String() string

type ListSweepsRequest added in v0.3.0 

type ListSweepsRequest struct {

	// Retrieve the full sweep transaction details. If false, only the sweep txids
	// will be returned. Note that some sweeps that LND publishes will have been
	// replaced-by-fee, so will not be included in this output.
	Verbose bool `protobuf:"varint,1,opt,name=verbose,proto3" json:"verbose,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSweepsRequest) Descriptor deprecated added in v0.3.0 

func (*ListSweepsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListSweepsRequest.ProtoReflect.Descriptor instead.

func (*ListSweepsRequest) GetVerbose added in v0.3.0 

func (x *ListSweepsRequest) GetVerbose() bool

func (*ListSweepsRequest) ProtoMessage added in v0.3.0 

func (*ListSweepsRequest) ProtoMessage()

func (*ListSweepsRequest) ProtoReflect added in v0.3.0 

func (x *ListSweepsRequest) ProtoReflect() protoreflect.Message

func (*ListSweepsRequest) Reset added in v0.3.0 

func (x *ListSweepsRequest) Reset()

func (*ListSweepsRequest) String added in v0.3.0 

func (x *ListSweepsRequest) String() string

type ListSweepsResponse added in v0.3.0 

type ListSweepsResponse struct {

	// Types that are assignable to Sweeps:
	//
	//	*ListSweepsResponse_TransactionDetails
	//	*ListSweepsResponse_TransactionIds
	Sweeps isListSweepsResponse_Sweeps `protobuf_oneof:"sweeps"`
	// contains filtered or unexported fields
}

func (*ListSweepsResponse) Descriptor deprecated added in v0.3.0 

func (*ListSweepsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListSweepsResponse.ProtoReflect.Descriptor instead.

func (*ListSweepsResponse) GetSweeps added in v0.3.0 

func (m *ListSweepsResponse) GetSweeps() isListSweepsResponse_Sweeps

func (*ListSweepsResponse) GetTransactionDetails added in v0.3.0 

func (x *ListSweepsResponse) GetTransactionDetails() *lnrpc.TransactionDetails

func (*ListSweepsResponse) GetTransactionIds added in v0.3.0 

func (x *ListSweepsResponse) GetTransactionIds() *ListSweepsResponse_TransactionIDs

func (*ListSweepsResponse) ProtoMessage added in v0.3.0 

func (*ListSweepsResponse) ProtoMessage()

func (*ListSweepsResponse) ProtoReflect added in v0.3.0 

func (x *ListSweepsResponse) ProtoReflect() protoreflect.Message

func (*ListSweepsResponse) Reset added in v0.3.0 

func (x *ListSweepsResponse) Reset()

func (*ListSweepsResponse) String added in v0.3.0 

func (x *ListSweepsResponse) String() string

type ListSweepsResponse_TransactionDetails added in v0.3.0 

type ListSweepsResponse_TransactionDetails struct {
	TransactionDetails *lnrpc.TransactionDetails `protobuf:"bytes,1,opt,name=transaction_details,json=transactionDetails,proto3,oneof"`
}

type ListSweepsResponse_TransactionIDs added in v0.3.0 

type ListSweepsResponse_TransactionIDs struct {

	// Reversed, hex-encoded string representing the transaction ids of the
	// sweeps that our node has broadcast. Note that these transactions may
	// not have confirmed yet, we record sweeps on broadcast, not confirmation.
	TransactionIds []string `protobuf:"bytes,1,rep,name=transaction_ids,json=transactionIds,proto3" json:"transaction_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSweepsResponse_TransactionIDs) Descriptor deprecated added in v0.3.0 

func (*ListSweepsResponse_TransactionIDs) Descriptor() ([]byte, []int)

Deprecated: Use ListSweepsResponse_TransactionIDs.ProtoReflect.Descriptor instead.

func (*ListSweepsResponse_TransactionIDs) GetTransactionIds added in v0.3.0 

func (x *ListSweepsResponse_TransactionIDs) GetTransactionIds() []string

func (*ListSweepsResponse_TransactionIDs) ProtoMessage added in v0.3.0 

func (*ListSweepsResponse_TransactionIDs) ProtoMessage()

func (*ListSweepsResponse_TransactionIDs) ProtoReflect added in v0.3.0 

func (x *ListSweepsResponse_TransactionIDs) ProtoReflect() protoreflect.Message

func (*ListSweepsResponse_TransactionIDs) Reset added in v0.3.0 

func (x *ListSweepsResponse_TransactionIDs) Reset()

func (*ListSweepsResponse_TransactionIDs) String added in v0.3.0 

func (x *ListSweepsResponse_TransactionIDs) String() string

type ListSweepsResponse_TransactionIds added in v0.3.0 

type ListSweepsResponse_TransactionIds struct {
	TransactionIds *ListSweepsResponse_TransactionIDs `protobuf:"bytes,2,opt,name=transaction_ids,json=transactionIds,proto3,oneof"`
}

type ListUnspentRequest added in v0.3.0 

type ListUnspentRequest struct {

	// The minimum number of confirmations to be included.
	MinConfs int32 `protobuf:"varint,1,opt,name=min_confs,json=minConfs,proto3" json:"min_confs,omitempty"`
	// The maximum number of confirmations to be included.
	MaxConfs int32 `protobuf:"varint,2,opt,name=max_confs,json=maxConfs,proto3" json:"max_confs,omitempty"`
	// An optional filter to only include outputs belonging to an account.
	Account string `protobuf:"bytes,3,opt,name=account,proto3" json:"account,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUnspentRequest) Descriptor deprecated added in v0.3.0 

func (*ListUnspentRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListUnspentRequest.ProtoReflect.Descriptor instead.

func (*ListUnspentRequest) GetAccount added in v0.3.8 

func (x *ListUnspentRequest) GetAccount() string

func (*ListUnspentRequest) GetMaxConfs added in v0.3.0 

func (x *ListUnspentRequest) GetMaxConfs() int32

func (*ListUnspentRequest) GetMinConfs added in v0.3.0 

func (x *ListUnspentRequest) GetMinConfs() int32

func (*ListUnspentRequest) ProtoMessage added in v0.3.0 

func (*ListUnspentRequest) ProtoMessage()

func (*ListUnspentRequest) ProtoReflect added in v0.3.0 

func (x *ListUnspentRequest) ProtoReflect() protoreflect.Message

func (*ListUnspentRequest) Reset added in v0.3.0 

func (x *ListUnspentRequest) Reset()

func (*ListUnspentRequest) String added in v0.3.0 

func (x *ListUnspentRequest) String() string

type ListUnspentResponse added in v0.3.0 

type ListUnspentResponse struct {

	// A list of utxos satisfying the specified number of confirmations.
	Utxos []*lnrpc.Utxo `protobuf:"bytes,1,rep,name=utxos,proto3" json:"utxos,omitempty"`
	// contains filtered or unexported fields
}

func (*ListUnspentResponse) Descriptor deprecated added in v0.3.0 

func (*ListUnspentResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListUnspentResponse.ProtoReflect.Descriptor instead.

func (*ListUnspentResponse) GetUtxos added in v0.3.0 

func (x *ListUnspentResponse) GetUtxos() []*lnrpc.Utxo

func (*ListUnspentResponse) ProtoMessage added in v0.3.0 

func (*ListUnspentResponse) ProtoMessage()

func (*ListUnspentResponse) ProtoReflect added in v0.3.0 

func (x *ListUnspentResponse) ProtoReflect() protoreflect.Message

func (*ListUnspentResponse) Reset added in v0.3.0 

func (x *ListUnspentResponse) Reset()

func (*ListUnspentResponse) String added in v0.3.0 

func (x *ListUnspentResponse) String() string

type PendingSweep added in v0.2.0 

type PendingSweep struct {

	// The outpoint of the output we're attempting to sweep.
	Outpoint *lnrpc.OutPoint `protobuf:"bytes,1,opt,name=outpoint,proto3" json:"outpoint,omitempty"`
	// The witness type of the output we're attempting to sweep.
	WitnessType WitnessType `protobuf:"varint,2,opt,name=witness_type,json=witnessType,proto3,enum=walletrpc.WitnessType" json:"witness_type,omitempty"`
	// The value of the output we're attempting to sweep.
	AmountAtoms uint32 `protobuf:"varint,3,opt,name=amount_atoms,json=amountAtoms,proto3" json:"amount_atoms,omitempty"`
	// The fee rate we'll use to sweep the output. The fee rate is only determined
	// once a sweeping transaction for the output is created, so it's possible for
	// this to be 0 before this.
	AtomsPerByte uint32 `protobuf:"varint,4,opt,name=atoms_per_byte,json=atomsPerByte,proto3" json:"atoms_per_byte,omitempty"`
	// The number of broadcast attempts we've made to sweep the output.
	BroadcastAttempts uint32 `protobuf:"varint,5,opt,name=broadcast_attempts,json=broadcastAttempts,proto3" json:"broadcast_attempts,omitempty"`
	// The next height of the chain at which we'll attempt to broadcast the
	// sweep transaction of the output.
	NextBroadcastHeight uint32 `protobuf:"varint,6,opt,name=next_broadcast_height,json=nextBroadcastHeight,proto3" json:"next_broadcast_height,omitempty"`
	// The requested confirmation target for this output.
	RequestedConfTarget uint32 `protobuf:"varint,8,opt,name=requested_conf_target,json=requestedConfTarget,proto3" json:"requested_conf_target,omitempty"`
	// The requested fee rate, expressed in atoms/byte, for this output.
	RequestedAtomsPerByte uint32 `` /* 129-byte string literal not displayed */
	// Whether this input must be force-swept. This means that it is swept even
	// if it has a negative yield.
	Force bool `protobuf:"varint,7,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

func (*PendingSweep) Descriptor deprecated added in v0.2.0 

func (*PendingSweep) Descriptor() ([]byte, []int)

Deprecated: Use PendingSweep.ProtoReflect.Descriptor instead.

func (*PendingSweep) GetAmountAtoms added in v0.2.0 

func (x *PendingSweep) GetAmountAtoms() uint32

func (*PendingSweep) GetAtomsPerByte added in v0.2.0 

func (x *PendingSweep) GetAtomsPerByte() uint32

func (*PendingSweep) GetBroadcastAttempts added in v0.2.0 

func (x *PendingSweep) GetBroadcastAttempts() uint32

func (*PendingSweep) GetForce added in v0.3.0 

func (x *PendingSweep) GetForce() bool

func (*PendingSweep) GetNextBroadcastHeight added in v0.2.0 

func (x *PendingSweep) GetNextBroadcastHeight() uint32

func (*PendingSweep) GetOutpoint added in v0.2.0 

func (x *PendingSweep) GetOutpoint() *lnrpc.OutPoint

func (*PendingSweep) GetRequestedAtomsPerByte added in v0.3.0 

func (x *PendingSweep) GetRequestedAtomsPerByte() uint32

func (*PendingSweep) GetRequestedConfTarget added in v0.3.0 

func (x *PendingSweep) GetRequestedConfTarget() uint32

func (*PendingSweep) GetWitnessType added in v0.2.0 

func (x *PendingSweep) GetWitnessType() WitnessType

func (*PendingSweep) ProtoMessage added in v0.2.0 

func (*PendingSweep) ProtoMessage()

func (*PendingSweep) ProtoReflect added in v0.3.0 

func (x *PendingSweep) ProtoReflect() protoreflect.Message

func (*PendingSweep) Reset added in v0.2.0 

func (x *PendingSweep) Reset()

func (*PendingSweep) String added in v0.2.0 

func (x *PendingSweep) String() string

type PendingSweepsRequest added in v0.2.0 

type PendingSweepsRequest struct {
	// contains filtered or unexported fields
}

func (*PendingSweepsRequest) Descriptor deprecated added in v0.2.0 

func (*PendingSweepsRequest) Descriptor() ([]byte, []int)

Deprecated: Use PendingSweepsRequest.ProtoReflect.Descriptor instead.

func (*PendingSweepsRequest) ProtoMessage added in v0.2.0 

func (*PendingSweepsRequest) ProtoMessage()

func (*PendingSweepsRequest) ProtoReflect added in v0.3.0 

func (x *PendingSweepsRequest) ProtoReflect() protoreflect.Message

func (*PendingSweepsRequest) Reset added in v0.2.0 

func (x *PendingSweepsRequest) Reset()

func (*PendingSweepsRequest) String added in v0.2.0 

func (x *PendingSweepsRequest) String() string

type PendingSweepsResponse added in v0.2.0 

type PendingSweepsResponse struct {

	// The set of outputs currently being swept by lnd's central batching engine.
	PendingSweeps []*PendingSweep `protobuf:"bytes,1,rep,name=pending_sweeps,json=pendingSweeps,proto3" json:"pending_sweeps,omitempty"`
	// contains filtered or unexported fields
}

func (*PendingSweepsResponse) Descriptor deprecated added in v0.2.0 

func (*PendingSweepsResponse) Descriptor() ([]byte, []int)

Deprecated: Use PendingSweepsResponse.ProtoReflect.Descriptor instead.

func (*PendingSweepsResponse) GetPendingSweeps added in v0.2.0 

func (x *PendingSweepsResponse) GetPendingSweeps() []*PendingSweep

func (*PendingSweepsResponse) ProtoMessage added in v0.2.0 

func (*PendingSweepsResponse) ProtoMessage()

func (*PendingSweepsResponse) ProtoReflect added in v0.3.0 

func (x *PendingSweepsResponse) ProtoReflect() protoreflect.Message

func (*PendingSweepsResponse) Reset added in v0.2.0 

func (x *PendingSweepsResponse) Reset()

func (*PendingSweepsResponse) String added in v0.2.0 

func (x *PendingSweepsResponse) String() string

type PublishResponse 

type PublishResponse struct {

	// If blank, then no error occurred and the transaction was successfully
	// published. If not the empty string, then a string representation of the
	// broadcast error.
	//
	// TODO(roasbeef): map to a proper enum type
	PublishError string `protobuf:"bytes,1,opt,name=publish_error,json=publishError,proto3" json:"publish_error,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishResponse) Descriptor deprecated 

func (*PublishResponse) Descriptor() ([]byte, []int)

Deprecated: Use PublishResponse.ProtoReflect.Descriptor instead.

func (*PublishResponse) GetPublishError 

func (x *PublishResponse) GetPublishError() string

func (*PublishResponse) ProtoMessage 

func (*PublishResponse) ProtoMessage()

func (*PublishResponse) ProtoReflect added in v0.3.0 

func (x *PublishResponse) ProtoReflect() protoreflect.Message

func (*PublishResponse) Reset 

func (x *PublishResponse) Reset()

func (*PublishResponse) String 

func (x *PublishResponse) String() string

type ReleaseOutputRequest added in v0.3.0 

type ReleaseOutputRequest struct {

	// The unique ID that was used to lock the output.
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The identifying outpoint of the output being released.
	Outpoint *lnrpc.OutPoint `protobuf:"bytes,2,opt,name=outpoint,proto3" json:"outpoint,omitempty"`
	// contains filtered or unexported fields
}

func (*ReleaseOutputRequest) Descriptor deprecated added in v0.3.0 

func (*ReleaseOutputRequest) Descriptor() ([]byte, []int)

Deprecated: Use ReleaseOutputRequest.ProtoReflect.Descriptor instead.

func (*ReleaseOutputRequest) GetId added in v0.3.0 

func (x *ReleaseOutputRequest) GetId() []byte

func (*ReleaseOutputRequest) GetOutpoint added in v0.3.0 

func (x *ReleaseOutputRequest) GetOutpoint() *lnrpc.OutPoint

func (*ReleaseOutputRequest) ProtoMessage added in v0.3.0 

func (*ReleaseOutputRequest) ProtoMessage()

func (*ReleaseOutputRequest) ProtoReflect added in v0.3.0 

func (x *ReleaseOutputRequest) ProtoReflect() protoreflect.Message

func (*ReleaseOutputRequest) Reset added in v0.3.0 

func (x *ReleaseOutputRequest) Reset()

func (*ReleaseOutputRequest) String added in v0.3.0 

func (x *ReleaseOutputRequest) String() string

type ReleaseOutputResponse added in v0.3.0 

type ReleaseOutputResponse struct {
	// contains filtered or unexported fields
}

func (*ReleaseOutputResponse) Descriptor deprecated added in v0.3.0 

func (*ReleaseOutputResponse) Descriptor() ([]byte, []int)

Deprecated: Use ReleaseOutputResponse.ProtoReflect.Descriptor instead.

func (*ReleaseOutputResponse) ProtoMessage added in v0.3.0 

func (*ReleaseOutputResponse) ProtoMessage()

func (*ReleaseOutputResponse) ProtoReflect added in v0.3.0 

func (x *ReleaseOutputResponse) ProtoReflect() protoreflect.Message

func (*ReleaseOutputResponse) Reset added in v0.3.0 

func (x *ReleaseOutputResponse) Reset()

func (*ReleaseOutputResponse) String added in v0.3.0 

func (x *ReleaseOutputResponse) String() string

type RescanWalletRequest added in v0.3.8 

type RescanWalletRequest struct {

	// The height where to begin the rescan process;
	BeginHeight int32 `protobuf:"varint,1,opt,name=begin_height,json=beginHeight,proto3" json:"begin_height,omitempty"`
	// contains filtered or unexported fields
}

func (*RescanWalletRequest) Descriptor deprecated added in v0.3.8 

func (*RescanWalletRequest) Descriptor() ([]byte, []int)

Deprecated: Use RescanWalletRequest.ProtoReflect.Descriptor instead.

func (*RescanWalletRequest) GetBeginHeight added in v0.3.8 

func (x *RescanWalletRequest) GetBeginHeight() int32

func (*RescanWalletRequest) ProtoMessage added in v0.3.8 

func (*RescanWalletRequest) ProtoMessage()

func (*RescanWalletRequest) ProtoReflect added in v0.3.8 

func (x *RescanWalletRequest) ProtoReflect() protoreflect.Message

func (*RescanWalletRequest) Reset added in v0.3.8 

func (x *RescanWalletRequest) Reset()

func (*RescanWalletRequest) String added in v0.3.8 

func (x *RescanWalletRequest) String() string

type RescanWalletResponse added in v0.3.8 

type RescanWalletResponse struct {

	// The height up to which the wallet was rescanned through.
	ScannedThroughHeight int32 `protobuf:"varint,1,opt,name=scanned_through_height,json=scannedThroughHeight,proto3" json:"scanned_through_height,omitempty"`
	// contains filtered or unexported fields
}

func (*RescanWalletResponse) Descriptor deprecated added in v0.3.8 

func (*RescanWalletResponse) Descriptor() ([]byte, []int)

Deprecated: Use RescanWalletResponse.ProtoReflect.Descriptor instead.

func (*RescanWalletResponse) GetScannedThroughHeight added in v0.3.8 

func (x *RescanWalletResponse) GetScannedThroughHeight() int32

func (*RescanWalletResponse) ProtoMessage added in v0.3.8 

func (*RescanWalletResponse) ProtoMessage()

func (*RescanWalletResponse) ProtoReflect added in v0.3.8 

func (x *RescanWalletResponse) ProtoReflect() protoreflect.Message

func (*RescanWalletResponse) Reset added in v0.3.8 

func (x *RescanWalletResponse) Reset()

func (*RescanWalletResponse) String added in v0.3.8 

func (x *RescanWalletResponse) String() string

type SendOutputsRequest 

type SendOutputsRequest struct {

	// The number of atoms per kilobyte that should be used when crafting
	// this transaction.
	AtomsPerKb int64 `protobuf:"varint,1,opt,name=atoms_per_kb,json=atomsPerKb,proto3" json:"atoms_per_kb,omitempty"`
	// A slice of the outputs that should be created in the transaction produced.
	Outputs []*signrpc.TxOut `protobuf:"bytes,2,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// An optional label for the transaction, limited to 500 characters.
	Label string `protobuf:"bytes,3,opt,name=label,proto3" json:"label,omitempty"`
	// The account from which to send funds. If empty, funds are sent from the
	// default account.
	Account string `protobuf:"bytes,100,opt,name=account,proto3" json:"account,omitempty"`
	// The minimum number of confirmations each one of your outputs used for
	// the transaction must satisfy.
	MinConfs int32 `protobuf:"varint,4,opt,name=min_confs,json=minConfs,proto3" json:"min_confs,omitempty"`
	// Whether unconfirmed outputs should be used as inputs for the transaction.
	SpendUnconfirmed bool `protobuf:"varint,5,opt,name=spend_unconfirmed,json=spendUnconfirmed,proto3" json:"spend_unconfirmed,omitempty"`
	// contains filtered or unexported fields
}

func (*SendOutputsRequest) Descriptor deprecated 

func (*SendOutputsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SendOutputsRequest.ProtoReflect.Descriptor instead.

func (*SendOutputsRequest) GetAccount added in v0.3.8 

func (x *SendOutputsRequest) GetAccount() string

func (*SendOutputsRequest) GetAtomsPerKb added in v0.2.0 

func (x *SendOutputsRequest) GetAtomsPerKb() int64

func (*SendOutputsRequest) GetLabel added in v0.3.0 

func (x *SendOutputsRequest) GetLabel() string

func (*SendOutputsRequest) GetMinConfs added in v0.5.0 

func (x *SendOutputsRequest) GetMinConfs() int32

func (*SendOutputsRequest) GetOutputs 

func (x *SendOutputsRequest) GetOutputs() []*signrpc.TxOut

func (*SendOutputsRequest) GetSpendUnconfirmed added in v0.5.0 

func (x *SendOutputsRequest) GetSpendUnconfirmed() bool

func (*SendOutputsRequest) ProtoMessage 

func (*SendOutputsRequest) ProtoMessage()

func (*SendOutputsRequest) ProtoReflect added in v0.3.0 

func (x *SendOutputsRequest) ProtoReflect() protoreflect.Message

func (*SendOutputsRequest) Reset 

func (x *SendOutputsRequest) Reset()

func (*SendOutputsRequest) String 

func (x *SendOutputsRequest) String() string

type SendOutputsResponse 

type SendOutputsResponse struct {

	// The serialized transaction sent out on the network.
	RawTx []byte `protobuf:"bytes,1,opt,name=raw_tx,json=rawTx,proto3" json:"raw_tx,omitempty"`
	// contains filtered or unexported fields
}

func (*SendOutputsResponse) Descriptor deprecated 

func (*SendOutputsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SendOutputsResponse.ProtoReflect.Descriptor instead.

func (*SendOutputsResponse) GetRawTx 

func (x *SendOutputsResponse) GetRawTx() []byte

func (*SendOutputsResponse) ProtoMessage 

func (*SendOutputsResponse) ProtoMessage()

func (*SendOutputsResponse) ProtoReflect added in v0.3.0 

func (x *SendOutputsResponse) ProtoReflect() protoreflect.Message

func (*SendOutputsResponse) Reset 

func (x *SendOutputsResponse) Reset()

func (*SendOutputsResponse) String 

func (x *SendOutputsResponse) String() string

type ServerShell added in v0.5.0 

type ServerShell struct {
	WalletKitServer
}

ServerShell is a shell struct holding a reference to the actual sub-server. It is used to register the gRPC sub-server with the root server before we have the necessary dependencies to populate the actual sub-server.

func (*ServerShell) CreateSubServer added in v0.5.0 

func (r *ServerShell) CreateSubServer(configRegistry lnrpc.SubServerConfigDispatcher) (
	lnrpc.SubServer, lnrpc.MacaroonPerms, error)

CreateSubServer populates the subserver's dependencies using the passed SubServerConfigDispatcher. This method should fully initialize the sub-server instance, making it ready for action. It returns the macaroon permissions that the sub-server wishes to pass on to the root server for all methods routed towards it.

NOTE: This is part of the lnrpc.GrpcHandler interface.

func (*ServerShell) RegisterWithRestServer added in v0.5.0 

func (r *ServerShell) RegisterWithRestServer(ctx context.Context,
	mux *runtime.ServeMux, dest string, opts []grpc.DialOption) error

RegisterWithRestServer will be called by the root REST mux to direct a sub RPC server to register itself with the main REST mux server. Until this is called, each sub-server won't be able to have requests routed towards it.

NOTE: This is part of the lnrpc.GrpcHandler interface.

func (*ServerShell) RegisterWithRootServer added in v0.5.0 

func (r *ServerShell) RegisterWithRootServer(grpcServer *grpc.Server) error

RegisterWithRootServer will be called by the root gRPC server to direct a sub RPC server to register itself with the main gRPC root server. Until this is called, each sub-server won't be able to have requests routed towards it.

NOTE: This is part of the lnrpc.GrpcHandler interface.

type SignPsbtRequest added in v0.6.0 

type SignPsbtRequest struct {

	// The PSBT that should be signed. The PSBT must contain all required inputs,
	// outputs, UTXO data and custom fields required to identify the signing key.
	FundedPsbt []byte `protobuf:"bytes,1,opt,name=funded_psbt,json=fundedPsbt,proto3" json:"funded_psbt,omitempty"`
	// contains filtered or unexported fields
}

func (*SignPsbtRequest) Descriptor deprecated added in v0.6.0 

func (*SignPsbtRequest) Descriptor() ([]byte, []int)

Deprecated: Use SignPsbtRequest.ProtoReflect.Descriptor instead.

func (*SignPsbtRequest) GetFundedPsbt added in v0.6.0 

func (x *SignPsbtRequest) GetFundedPsbt() []byte

func (*SignPsbtRequest) ProtoMessage added in v0.6.0 

func (*SignPsbtRequest) ProtoMessage()

func (*SignPsbtRequest) ProtoReflect added in v0.6.0 

func (x *SignPsbtRequest) ProtoReflect() protoreflect.Message

func (*SignPsbtRequest) Reset added in v0.6.0 

func (x *SignPsbtRequest) Reset()

func (*SignPsbtRequest) String added in v0.6.0 

func (x *SignPsbtRequest) String() string

type SignPsbtResponse added in v0.6.0 

type SignPsbtResponse struct {

	// The signed transaction in PSBT format.
	SignedPsbt []byte `protobuf:"bytes,1,opt,name=signed_psbt,json=signedPsbt,proto3" json:"signed_psbt,omitempty"`
	// contains filtered or unexported fields
}

func (*SignPsbtResponse) Descriptor deprecated added in v0.6.0 

func (*SignPsbtResponse) Descriptor() ([]byte, []int)

Deprecated: Use SignPsbtResponse.ProtoReflect.Descriptor instead.

func (*SignPsbtResponse) GetSignedPsbt added in v0.6.0 

func (x *SignPsbtResponse) GetSignedPsbt() []byte

func (*SignPsbtResponse) ProtoMessage added in v0.6.0 

func (*SignPsbtResponse) ProtoMessage()

func (*SignPsbtResponse) ProtoReflect added in v0.6.0 

func (x *SignPsbtResponse) ProtoReflect() protoreflect.Message

func (*SignPsbtResponse) Reset added in v0.6.0 

func (x *SignPsbtResponse) Reset()

func (*SignPsbtResponse) String added in v0.6.0 

func (x *SignPsbtResponse) String() string

type SpendUTXOsRequest added in v0.3.8 

type SpendUTXOsRequest struct {

	// The inputs/utxos to spend.
	Utxos []*SpendUTXOsRequest_UTXOAndKey `protobuf:"bytes,1,rep,name=utxos,proto3" json:"utxos,omitempty"`
	// The output to send to. If there's any non-dust change left unsent, then
	// that change is sent back to the wallet.
	Outputs []*SpendUTXOsRequest_Output `protobuf:"bytes,2,rep,name=outputs,proto3" json:"outputs,omitempty"`
	// contains filtered or unexported fields
}

func (*SpendUTXOsRequest) Descriptor deprecated added in v0.3.8 

func (*SpendUTXOsRequest) Descriptor() ([]byte, []int)

Deprecated: Use SpendUTXOsRequest.ProtoReflect.Descriptor instead.

func (*SpendUTXOsRequest) GetOutputs added in v0.3.8 

func (x *SpendUTXOsRequest) GetOutputs() []*SpendUTXOsRequest_Output

func (*SpendUTXOsRequest) GetUtxos added in v0.3.8 

func (x *SpendUTXOsRequest) GetUtxos() []*SpendUTXOsRequest_UTXOAndKey

func (*SpendUTXOsRequest) ProtoMessage added in v0.3.8 

func (*SpendUTXOsRequest) ProtoMessage()

func (*SpendUTXOsRequest) ProtoReflect added in v0.3.8 

func (x *SpendUTXOsRequest) ProtoReflect() protoreflect.Message

func (*SpendUTXOsRequest) Reset added in v0.3.8 

func (x *SpendUTXOsRequest) Reset()

func (*SpendUTXOsRequest) String added in v0.3.8 

func (x *SpendUTXOsRequest) String() string

type SpendUTXOsRequest_Output added in v0.3.8 

type SpendUTXOsRequest_Output struct {

	// The address to send to.
	Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// The amount to send.
	Amount int64 `protobuf:"varint,2,opt,name=amount,proto3" json:"amount,omitempty"`
	// contains filtered or unexported fields
}

func (*SpendUTXOsRequest_Output) Descriptor deprecated added in v0.3.8 

func (*SpendUTXOsRequest_Output) Descriptor() ([]byte, []int)

Deprecated: Use SpendUTXOsRequest_Output.ProtoReflect.Descriptor instead.

func (*SpendUTXOsRequest_Output) GetAddress added in v0.3.8 

func (x *SpendUTXOsRequest_Output) GetAddress() string

func (*SpendUTXOsRequest_Output) GetAmount added in v0.3.8 

func (x *SpendUTXOsRequest_Output) GetAmount() int64

func (*SpendUTXOsRequest_Output) ProtoMessage added in v0.3.8 

func (*SpendUTXOsRequest_Output) ProtoMessage()

func (*SpendUTXOsRequest_Output) ProtoReflect added in v0.3.8 

func (x *SpendUTXOsRequest_Output) ProtoReflect() protoreflect.Message

func (*SpendUTXOsRequest_Output) Reset added in v0.3.8 

func (x *SpendUTXOsRequest_Output) Reset()

func (*SpendUTXOsRequest_Output) String added in v0.3.8 

func (x *SpendUTXOsRequest_Output) String() string

type SpendUTXOsRequest_UTXOAndKey added in v0.3.8 

type SpendUTXOsRequest_UTXOAndKey struct {

	// The transaction has of the UTXO outpoint.
	Txid []byte `protobuf:"bytes,1,opt,name=txid,proto3" json:"txid,omitempty"`
	// The transaction index.
	Index uint32 `protobuf:"varint,2,opt,name=index,proto3" json:"index,omitempty"`
	// The transaction tree.
	Tree uint32 `protobuf:"varint,3,opt,name=tree,proto3" json:"tree,omitempty"`
	// The private key that corresponds to the address in the utxo.
	PrivateKeyWif string `protobuf:"bytes,4,opt,name=private_key_wif,json=privateKeyWif,proto3" json:"private_key_wif,omitempty"`
	// The height hint of where to look for the UTXO on the utxo set.
	HeightHint uint32 `protobuf:"varint,5,opt,name=height_hint,json=heightHint,proto3" json:"height_hint,omitempty"`
	// The address in the UTXO.
	Address string `protobuf:"bytes,6,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

func (*SpendUTXOsRequest_UTXOAndKey) Descriptor deprecated added in v0.3.8 

func (*SpendUTXOsRequest_UTXOAndKey) Descriptor() ([]byte, []int)

Deprecated: Use SpendUTXOsRequest_UTXOAndKey.ProtoReflect.Descriptor instead.

func (*SpendUTXOsRequest_UTXOAndKey) GetAddress added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) GetAddress() string

func (*SpendUTXOsRequest_UTXOAndKey) GetHeightHint added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) GetHeightHint() uint32

func (*SpendUTXOsRequest_UTXOAndKey) GetIndex added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) GetIndex() uint32

func (*SpendUTXOsRequest_UTXOAndKey) GetPrivateKeyWif added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) GetPrivateKeyWif() string

func (*SpendUTXOsRequest_UTXOAndKey) GetTree added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) GetTree() uint32

func (*SpendUTXOsRequest_UTXOAndKey) GetTxid added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) GetTxid() []byte

func (*SpendUTXOsRequest_UTXOAndKey) ProtoMessage added in v0.3.8 

func (*SpendUTXOsRequest_UTXOAndKey) ProtoMessage()

func (*SpendUTXOsRequest_UTXOAndKey) ProtoReflect added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) ProtoReflect() protoreflect.Message

func (*SpendUTXOsRequest_UTXOAndKey) Reset added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) Reset()

func (*SpendUTXOsRequest_UTXOAndKey) String added in v0.3.8 

func (x *SpendUTXOsRequest_UTXOAndKey) String() string

type SpendUTXOsResponse added in v0.3.8 

type SpendUTXOsResponse struct {
	Txid  []byte `protobuf:"bytes,1,opt,name=txid,proto3" json:"txid,omitempty"`
	RawTx []byte `protobuf:"bytes,2,opt,name=raw_tx,json=rawTx,proto3" json:"raw_tx,omitempty"`
	// contains filtered or unexported fields
}

func (*SpendUTXOsResponse) Descriptor deprecated added in v0.3.8 

func (*SpendUTXOsResponse) Descriptor() ([]byte, []int)

Deprecated: Use SpendUTXOsResponse.ProtoReflect.Descriptor instead.

func (*SpendUTXOsResponse) GetRawTx added in v0.3.8 

func (x *SpendUTXOsResponse) GetRawTx() []byte

func (*SpendUTXOsResponse) GetTxid added in v0.3.8 

func (x *SpendUTXOsResponse) GetTxid() []byte

func (*SpendUTXOsResponse) ProtoMessage added in v0.3.8 

func (*SpendUTXOsResponse) ProtoMessage()

func (*SpendUTXOsResponse) ProtoReflect added in v0.3.8 

func (x *SpendUTXOsResponse) ProtoReflect() protoreflect.Message

func (*SpendUTXOsResponse) Reset added in v0.3.8 

func (x *SpendUTXOsResponse) Reset()

func (*SpendUTXOsResponse) String added in v0.3.8 

func (x *SpendUTXOsResponse) String() string

type Transaction 

type Transaction struct {

	// The raw serialized transaction.
	TxHex []byte `protobuf:"bytes,1,opt,name=tx_hex,json=txHex,proto3" json:"tx_hex,omitempty"`
	// An optional label to save with the transaction. Limited to 500 characters.
	Label string `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*Transaction) Descriptor deprecated 

func (*Transaction) Descriptor() ([]byte, []int)

Deprecated: Use Transaction.ProtoReflect.Descriptor instead.

func (*Transaction) GetLabel added in v0.3.0 

func (x *Transaction) GetLabel() string

func (*Transaction) GetTxHex 

func (x *Transaction) GetTxHex() []byte

func (*Transaction) ProtoMessage 

func (*Transaction) ProtoMessage()

func (*Transaction) ProtoReflect added in v0.3.0 

func (x *Transaction) ProtoReflect() protoreflect.Message

func (*Transaction) Reset 

func (x *Transaction) Reset()

func (*Transaction) String 

func (x *Transaction) String() string

type TxTemplate added in v0.5.0 

type TxTemplate struct {

	// An optional list of inputs to use. Every input must be an UTXO known to the
	// wallet that has not been locked before. The sum of all inputs must be
	// sufficiently greater than the sum of all outputs to pay a miner fee with the
	// fee rate specified in the parent message.
	//
	// If no inputs are specified, coin selection will be performed instead and
	// inputs of sufficient value will be added to the resulting PSBT.
	Inputs []*lnrpc.OutPoint `protobuf:"bytes,1,rep,name=inputs,proto3" json:"inputs,omitempty"`
	// A map of all addresses and the amounts to send to in the funded PSBT.
	Outputs map[string]uint64 `` /* 156-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*TxTemplate) Descriptor deprecated added in v0.5.0 

func (*TxTemplate) Descriptor() ([]byte, []int)

Deprecated: Use TxTemplate.ProtoReflect.Descriptor instead.

func (*TxTemplate) GetInputs added in v0.5.0 

func (x *TxTemplate) GetInputs() []*lnrpc.OutPoint

func (*TxTemplate) GetOutputs added in v0.5.0 

func (x *TxTemplate) GetOutputs() map[string]uint64

func (*TxTemplate) ProtoMessage added in v0.5.0 

func (*TxTemplate) ProtoMessage()

func (*TxTemplate) ProtoReflect added in v0.5.0 

func (x *TxTemplate) ProtoReflect() protoreflect.Message

func (*TxTemplate) Reset added in v0.5.0 

func (x *TxTemplate) Reset()

func (*TxTemplate) String added in v0.5.0 

func (x *TxTemplate) String() string

type UnimplementedWalletKitServer added in v0.3.0 

type UnimplementedWalletKitServer struct {
}

UnimplementedWalletKitServer can be embedded to have forward compatible implementations.

func (*UnimplementedWalletKitServer) BumpFee added in v0.3.0 

func (*UnimplementedWalletKitServer) BumpFee(context.Context, *BumpFeeRequest) (*BumpFeeResponse, error)

func (*UnimplementedWalletKitServer) DeriveKey added in v0.3.0 

func (*UnimplementedWalletKitServer) DeriveKey(context.Context, *signrpc.KeyLocator) (*signrpc.KeyDescriptor, error)

func (*UnimplementedWalletKitServer) DeriveNextAccount added in v0.3.8 

func (*UnimplementedWalletKitServer) DeriveNextAccount(context.Context, *DeriveNextAccountRequest) (*DeriveNextAccountResponse, error)

func (*UnimplementedWalletKitServer) DeriveNextKey added in v0.3.0 

func (*UnimplementedWalletKitServer) DeriveNextKey(context.Context, *KeyReq) (*signrpc.KeyDescriptor, error)

func (*UnimplementedWalletKitServer) EstimateFee added in v0.3.0 

func (*UnimplementedWalletKitServer) EstimateFee(context.Context, *EstimateFeeRequest) (*EstimateFeeResponse, error)

func (*UnimplementedWalletKitServer) ExportPrivateKey added in v0.3.8 

func (*UnimplementedWalletKitServer) ExportPrivateKey(context.Context, *ExportPrivateKeyRequest) (*ExportPrivateKeyResponse, error)

func (*UnimplementedWalletKitServer) FinalizePsbt added in v0.5.0 

func (*UnimplementedWalletKitServer) FinalizePsbt(context.Context, *FinalizePsbtRequest) (*FinalizePsbtResponse, error)

func (*UnimplementedWalletKitServer) FundPsbt added in v0.5.0 

func (*UnimplementedWalletKitServer) FundPsbt(context.Context, *FundPsbtRequest) (*FundPsbtResponse, error)

func (*UnimplementedWalletKitServer) GetWalletTx added in v0.4.0 

func (*UnimplementedWalletKitServer) GetWalletTx(context.Context, *GetWalletTxRequest) (*GetWalletTxResponse, error)

func (*UnimplementedWalletKitServer) ImportAccount added in v0.3.8 

func (*UnimplementedWalletKitServer) ImportAccount(context.Context, *ImportAccountRequest) (*ImportAccountResponse, error)

func (*UnimplementedWalletKitServer) ImportPublicKey added in v0.3.8 

func (*UnimplementedWalletKitServer) ImportPublicKey(context.Context, *ImportPublicKeyRequest) (*ImportPublicKeyResponse, error)

func (*UnimplementedWalletKitServer) LabelTransaction added in v0.3.0 

func (*UnimplementedWalletKitServer) LabelTransaction(context.Context, *LabelTransactionRequest) (*LabelTransactionResponse, error)

func (*UnimplementedWalletKitServer) LeaseOutput added in v0.3.0 

func (*UnimplementedWalletKitServer) LeaseOutput(context.Context, *LeaseOutputRequest) (*LeaseOutputResponse, error)

func (*UnimplementedWalletKitServer) ListAccounts added in v0.3.8 

func (*UnimplementedWalletKitServer) ListAccounts(context.Context, *ListAccountsRequest) (*ListAccountsResponse, error)

func (*UnimplementedWalletKitServer) ListLeases added in v0.5.0 

func (*UnimplementedWalletKitServer) ListLeases(context.Context, *ListLeasesRequest) (*ListLeasesResponse, error)

func (*UnimplementedWalletKitServer) ListSweeps added in v0.3.0 

func (*UnimplementedWalletKitServer) ListSweeps(context.Context, *ListSweepsRequest) (*ListSweepsResponse, error)

func (*UnimplementedWalletKitServer) ListUnspent added in v0.3.0 

func (*UnimplementedWalletKitServer) ListUnspent(context.Context, *ListUnspentRequest) (*ListUnspentResponse, error)

func (*UnimplementedWalletKitServer) NextAddr added in v0.3.0 

func (*UnimplementedWalletKitServer) NextAddr(context.Context, *AddrRequest) (*AddrResponse, error)

func (*UnimplementedWalletKitServer) PendingSweeps added in v0.3.0 

func (*UnimplementedWalletKitServer) PendingSweeps(context.Context, *PendingSweepsRequest) (*PendingSweepsResponse, error)

func (*UnimplementedWalletKitServer) PublishTransaction added in v0.3.0 

func (*UnimplementedWalletKitServer) PublishTransaction(context.Context, *Transaction) (*PublishResponse, error)

func (*UnimplementedWalletKitServer) ReleaseOutput added in v0.3.0 

func (*UnimplementedWalletKitServer) ReleaseOutput(context.Context, *ReleaseOutputRequest) (*ReleaseOutputResponse, error)

func (*UnimplementedWalletKitServer) RescanWallet added in v0.3.8 

func (*UnimplementedWalletKitServer) RescanWallet(*RescanWalletRequest, WalletKit_RescanWalletServer) error

func (*UnimplementedWalletKitServer) SendOutputs added in v0.3.0 

func (*UnimplementedWalletKitServer) SendOutputs(context.Context, *SendOutputsRequest) (*SendOutputsResponse, error)

func (*UnimplementedWalletKitServer) SignPsbt added in v0.6.0 

func (*UnimplementedWalletKitServer) SignPsbt(context.Context, *SignPsbtRequest) (*SignPsbtResponse, error)

func (*UnimplementedWalletKitServer) SpendUTXOs added in v0.3.8 

func (*UnimplementedWalletKitServer) SpendUTXOs(context.Context, *SpendUTXOsRequest) (*SpendUTXOsResponse, error)

type UtxoLease added in v0.5.0 

type UtxoLease struct {

	// A 32 byte random ID that identifies the lease.
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The identifying outpoint of the output being leased.
	Outpoint *lnrpc.OutPoint `protobuf:"bytes,2,opt,name=outpoint,proto3" json:"outpoint,omitempty"`
	// The absolute expiration of the output lease represented as a unix timestamp.
	Expiration uint64 `protobuf:"varint,3,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// contains filtered or unexported fields
}

func (*UtxoLease) Descriptor deprecated added in v0.5.0 

func (*UtxoLease) Descriptor() ([]byte, []int)

Deprecated: Use UtxoLease.ProtoReflect.Descriptor instead.

func (*UtxoLease) GetExpiration added in v0.5.0 

func (x *UtxoLease) GetExpiration() uint64

func (*UtxoLease) GetId added in v0.5.0 

func (x *UtxoLease) GetId() []byte

func (*UtxoLease) GetOutpoint added in v0.5.0 

func (x *UtxoLease) GetOutpoint() *lnrpc.OutPoint

func (*UtxoLease) ProtoMessage added in v0.5.0 

func (*UtxoLease) ProtoMessage()

func (*UtxoLease) ProtoReflect added in v0.5.0 

func (x *UtxoLease) ProtoReflect() protoreflect.Message

func (*UtxoLease) Reset added in v0.5.0 

func (x *UtxoLease) Reset()

func (*UtxoLease) String added in v0.5.0 

func (x *UtxoLease) String() string

type WalletKit added in v0.3.0 

type WalletKit struct {
	// contains filtered or unexported fields
}

WalletKit is a sub-RPC server that exposes a tool kit which allows clients to execute common wallet operations. This includes requesting new addresses, keys (for contracts!), and publishing transactions.

func New added in v0.3.0 

func New(cfg *Config) (*WalletKit, lnrpc.MacaroonPerms, error)

New creates a new instance of the WalletKit sub-RPC server.

func (*WalletKit) BumpFee added in v0.3.0 

func (w *WalletKit) BumpFee(ctx context.Context,
	in *BumpFeeRequest) (*BumpFeeResponse, error)

BumpFee allows bumping the fee rate of an arbitrary input. A fee preference can be expressed either as a specific fee rate or a delta of blocks in which the output should be swept on-chain within. If a fee preference is not explicitly specified, then an error is returned. The status of the input sweep can be checked through the PendingSweeps RPC.

func (*WalletKit) DeriveKey added in v0.3.0 

func (w *WalletKit) DeriveKey(ctx context.Context,
	req *signrpc.KeyLocator) (*signrpc.KeyDescriptor, error)

DeriveKey attempts to derive an arbitrary key specified by the passed KeyLocator.

func (*WalletKit) DeriveNextAccount added in v0.3.8 

func (w *WalletKit) DeriveNextAccount(_ context.Context, req *DeriveNextAccountRequest) (*DeriveNextAccountResponse, error)

DeriveNextAccount generates the next account of the wallet.

func (*WalletKit) DeriveNextKey added in v0.3.0 

func (w *WalletKit) DeriveNextKey(ctx context.Context,
	req *KeyReq) (*signrpc.KeyDescriptor, error)

DeriveNextKey attempts to derive the *next* key within the key family (account in BIP43) specified. This method should return the next external child within this branch.

func (*WalletKit) EstimateFee added in v0.3.0 

func (w *WalletKit) EstimateFee(ctx context.Context,
	req *EstimateFeeRequest) (*EstimateFeeResponse, error)

EstimateFee attempts to query the internal fee estimator of the wallet to determine the fee (in atom/kB) to attach to a transaction in order to achieve the confirmation target.

func (*WalletKit) ExportPrivateKey added in v0.3.8 

func (w *WalletKit) ExportPrivateKey(_ context.Context, req *ExportPrivateKeyRequest) (*ExportPrivateKeyResponse, error)

ExportPrivateKey exports a private key that is derived from a wallet address.

func (*WalletKit) FinalizePsbt added in v0.5.0 

func (w *WalletKit) FinalizePsbt(_ context.Context,
	req *FinalizePsbtRequest) (*FinalizePsbtResponse, error)

FinalizePsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all inputs that belong to the wallet. Lnd must be the last signer of the transaction. That means, if there are any unsigned non-witness inputs or inputs without UTXO information attached or inputs without witness data that do not belong to lnd's wallet, this method will fail. If no error is returned, the PSBT is ready to be extracted and the final TX within to be broadcast.

NOTE: This method does NOT publish the transaction once finalized. It is the caller's responsibility to either publish the transaction on success or unlock/release any locked UTXOs in case of an error in this method.

func (*WalletKit) FundPsbt added in v0.5.0 

func (w *WalletKit) FundPsbt(_ context.Context,
	req *FundPsbtRequest) (*FundPsbtResponse, error)

FundPsbt creates a fully populated PSBT that contains enough inputs to fund the outputs specified in the template. There are two ways of specifying a template: Either by passing in a PSBT with at least one output declared or by passing in a raw TxTemplate message. If there are no inputs specified in the template, coin selection is performed automatically. If the template does contain any inputs, it is assumed that full coin selection happened externally and no additional inputs are added. If the specified inputs aren't enough to fund the outputs with the given fee rate, an error is returned. After either selecting or verifying the inputs, all input UTXOs are locked with an internal app ID.

NOTE: If this method returns without an error, it is the caller's responsibility to either spend the locked UTXOs (by finalizing and then publishing the transaction) or to unlock/release the locked UTXOs in case of an error on the caller's side.

func (*WalletKit) GetWalletTx added in v0.4.0 

func (w *WalletKit) GetWalletTx(ctx context.Context, req *GetWalletTxRequest) (
	*GetWalletTxResponse, error)

func (*WalletKit) ImportAccount added in v0.3.8 

func (w *WalletKit) ImportAccount(ctx context.Context,
	req *ImportAccountRequest) (*ImportAccountResponse, error)

ImportAccount imports an account backed by an account extended public key.

func (*WalletKit) ImportPublicKey added in v0.3.8 

func (w *WalletKit) ImportPublicKey(ctx context.Context,
	req *ImportPublicKeyRequest) (*ImportPublicKeyResponse, error)

ImportPublicKey imports a single derived public key into the wallet.

func (*WalletKit) LabelTransaction added in v0.3.0 

func (w *WalletKit) LabelTransaction(ctx context.Context,
	req *LabelTransactionRequest) (*LabelTransactionResponse, error)

LabelTransaction adds a label to a transaction.

func (*WalletKit) LeaseOutput added in v0.3.0 

func (w *WalletKit) LeaseOutput(ctx context.Context,
	req *LeaseOutputRequest) (*LeaseOutputResponse, error)

LeaseOutput locks an output to the given ID, preventing it from being available for any future coin selection attempts. The absolute time of the lock's expiration is returned. The expiration of the lock can be extended by successive invocations of this call. Outputs can be unlocked before their expiration through `ReleaseOutput`.

If the output is not known, wtxmgr.ErrUnknownOutput is returned. If the output has already been locked to a different ID, then wtxmgr.ErrOutputAlreadyLocked is returned.

func (*WalletKit) ListAccounts added in v0.3.8 

func (w *WalletKit) ListAccounts(ctx context.Context,
	req *ListAccountsRequest) (*ListAccountsResponse, error)

ListAccounts retrieves all accounts belonging to the wallet by default. A name and key scope filter can be provided to filter through all of the wallet accounts and return only those matching.

func (*WalletKit) ListLeases added in v0.5.0 

func (w *WalletKit) ListLeases(ctx context.Context,
	req *ListLeasesRequest) (*ListLeasesResponse, error)

ListLeases returns a list of all currently locked utxos.

func (*WalletKit) ListSweeps added in v0.3.0 

func (w *WalletKit) ListSweeps(ctx context.Context,
	in *ListSweepsRequest) (*ListSweepsResponse, error)

ListSweeps returns a list of the sweeps that our node has published.

func (*WalletKit) ListUnspent added in v0.3.0 

func (w *WalletKit) ListUnspent(ctx context.Context,
	req *ListUnspentRequest) (*ListUnspentResponse, error)

ListUnspent returns useful information about each unspent output owned by the wallet, as reported by the underlying `ListUnspentWitness`; the information returned is: outpoint, amount in satoshis, address, address type, scriptPubKey in hex and number of confirmations. The result is filtered to contain outputs whose number of confirmations is between a minimum and maximum number of confirmations specified by the user, with 0 meaning unconfirmed.

func (*WalletKit) Name added in v0.3.0 

func (w *WalletKit) Name() string

Name returns a unique string representation of the sub-server. This can be used to identify the sub-server and also de-duplicate them.

NOTE: This is part of the lnrpc.SubServer interface.

func (*WalletKit) NextAddr added in v0.3.0 

func (w *WalletKit) NextAddr(ctx context.Context,
	req *AddrRequest) (*AddrResponse, error)

NextAddr returns the next unused address within the wallet.

func (*WalletKit) PendingSweeps added in v0.3.0 

func (w *WalletKit) PendingSweeps(ctx context.Context,
	in *PendingSweepsRequest) (*PendingSweepsResponse, error)

PendingSweeps returns lists of on-chain outputs that lnd is currently attempting to sweep within its central batching engine. Outputs with similar fee rates are batched together in order to sweep them within a single transaction. The fee rate of each sweeping transaction is determined by taking the average fee rate of all the outputs it's trying to sweep.

func (*WalletKit) PublishTransaction added in v0.3.0 

func (w *WalletKit) PublishTransaction(ctx context.Context,
	req *Transaction) (*PublishResponse, error)

Attempts to publish the passed transaction to the network. Once this returns without an error, the wallet will continually attempt to re-broadcast the transaction on start up, until it enters the chain.

func (*WalletKit) ReleaseOutput added in v0.3.0 

func (w *WalletKit) ReleaseOutput(ctx context.Context,
	req *ReleaseOutputRequest) (*ReleaseOutputResponse, error)

ReleaseOutput unlocks an output, allowing it to be available for coin selection if it remains unspent. The ID should match the one used to originally lock the output.

func (*WalletKit) RescanWallet added in v0.3.8 

func (w *WalletKit) RescanWallet(req *RescanWalletRequest,
	server WalletKit_RescanWalletServer) error

func (*WalletKit) SendOutputs added in v0.3.0 

func (w *WalletKit) SendOutputs(ctx context.Context,
	req *SendOutputsRequest) (*SendOutputsResponse, error)

SendOutputs is similar to the existing sendmany call in Bitcoind, and allows the caller to create a transaction that sends to several outputs at once. This is ideal when wanting to batch create a set of transactions.

func (*WalletKit) SignPsbt added in v0.6.0 

func (w *WalletKit) SignPsbt(_ context.Context, req *SignPsbtRequest) (
	*SignPsbtResponse, error)

SignPsbt expects a partial transaction with all inputs and outputs fully declared and tries to sign all unsigned inputs that have all required fields (UTXO information, BIP32 derivation information, witness or sig scripts) set. If no error is returned, the PSBT is ready to be given to the next signer or to be finalized if lnd was the last signer.

NOTE: This RPC only signs inputs (and only those it can sign), it does not perform any other tasks (such as coin selection, UTXO locking or input/output/fee value validation, PSBT finalization). Any input that is incomplete will be skipped.

func (*WalletKit) SpendUTXOs added in v0.3.8 

func (w *WalletKit) SpendUTXOs(ctx context.Context, req *SpendUTXOsRequest) (*SpendUTXOsResponse, error)

SpendUTXOs performs a custom on-chain spend of UTXOs.

func (*WalletKit) Start added in v0.3.0 

func (w *WalletKit) Start() error

Start launches any helper goroutines required for the sub-server to function.

NOTE: This is part of the lnrpc.SubServer interface.

func (*WalletKit) Stop added in v0.3.0 

func (w *WalletKit) Stop() error

Stop signals any active goroutines for a graceful closure.

NOTE: This is part of the lnrpc.SubServer interface.

type WalletKitClient 

type WalletKitClient interface {
	// ListUnspent returns a list of all utxos spendable by the wallet with a
	// number of confirmations between the specified minimum and maximum.
	ListUnspent(ctx context.Context, in *ListUnspentRequest, opts ...grpc.CallOption) (*ListUnspentResponse, error)
	// LeaseOutput locks an output to the given ID, preventing it from being
	// available for any future coin selection attempts. The absolute time of the
	// lock's expiration is returned. The expiration of the lock can be extended by
	// successive invocations of this RPC. Outputs can be unlocked before their
	// expiration through `ReleaseOutput`.
	LeaseOutput(ctx context.Context, in *LeaseOutputRequest, opts ...grpc.CallOption) (*LeaseOutputResponse, error)
	// ReleaseOutput unlocks an output, allowing it to be available for coin
	// selection if it remains unspent. The ID should match the one used to
	// originally lock the output.
	ReleaseOutput(ctx context.Context, in *ReleaseOutputRequest, opts ...grpc.CallOption) (*ReleaseOutputResponse, error)
	// ListLeases lists all currently locked utxos.
	ListLeases(ctx context.Context, in *ListLeasesRequest, opts ...grpc.CallOption) (*ListLeasesResponse, error)
	// DeriveNextKey attempts to derive the *next* key within the key family
	// (account in BIP43) specified. This method should return the next external
	// child within this branch.
	DeriveNextKey(ctx context.Context, in *KeyReq, opts ...grpc.CallOption) (*signrpc.KeyDescriptor, error)
	// DeriveKey attempts to derive an arbitrary key specified by the passed
	// KeyLocator.
	DeriveKey(ctx context.Context, in *signrpc.KeyLocator, opts ...grpc.CallOption) (*signrpc.KeyDescriptor, error)
	// NextAddr returns the next unused address within the wallet.
	NextAddr(ctx context.Context, in *AddrRequest, opts ...grpc.CallOption) (*AddrResponse, error)
	// ListAccounts retrieves all accounts belonging to the wallet by default. A
	// name  filter can be provided to filter through all of the wallet accounts
	// and return only those matching.
	ListAccounts(ctx context.Context, in *ListAccountsRequest, opts ...grpc.CallOption) (*ListAccountsResponse, error)
	// ImportAccount imports an account backed by an account extended public key.
	//
	// NOTE: Events (deposits/spends) for keys derived from an account will only be
	// detected by lnd if they happen after the import. Rescans to detect past
	// events will be supported later on.
	ImportAccount(ctx context.Context, in *ImportAccountRequest, opts ...grpc.CallOption) (*ImportAccountResponse, error)
	// ImportPublicKey imports a public key as watch-only into the wallet.
	//
	// NOTE: Events (deposits/spends) for a key will only be detected by lnd if
	// they happen after the import. Rescans to detect past events will be
	// supported later on.
	ImportPublicKey(ctx context.Context, in *ImportPublicKeyRequest, opts ...grpc.CallOption) (*ImportPublicKeyResponse, error)
	// PublishTransaction attempts to publish the passed transaction to the
	// network. Once this returns without an error, the wallet will continually
	// attempt to re-broadcast the transaction on start up, until it enters the
	// chain.
	PublishTransaction(ctx context.Context, in *Transaction, opts ...grpc.CallOption) (*PublishResponse, error)
	// SendOutputs is similar to the existing sendmany call in Bitcoind, and
	// allows the caller to create a transaction that sends to several outputs at
	// once. This is ideal when wanting to batch create a set of transactions.
	SendOutputs(ctx context.Context, in *SendOutputsRequest, opts ...grpc.CallOption) (*SendOutputsResponse, error)
	// EstimateFee attempts to query the internal fee estimator of the wallet to
	// determine the fee (in sat/kw) to attach to a transaction in order to
	// achieve the confirmation target.
	EstimateFee(ctx context.Context, in *EstimateFeeRequest, opts ...grpc.CallOption) (*EstimateFeeResponse, error)
	// PendingSweeps returns lists of on-chain outputs that lnd is currently
	// attempting to sweep within its central batching engine. Outputs with similar
	// fee rates are batched together in order to sweep them within a single
	// transaction.
	//
	// NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to
	// remain supported. This is an advanced API that depends on the internals of
	// the UtxoSweeper, so things may change.
	PendingSweeps(ctx context.Context, in *PendingSweepsRequest, opts ...grpc.CallOption) (*PendingSweepsResponse, error)
	// BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
	// takes a different approach than bitcoind's bumpfee command. lnd has a
	// central batching engine in which inputs with similar fee rates are batched
	// together to save on transaction fees. Due to this, we cannot rely on
	// bumping the fee on a specific transaction, since transactions can change at
	// any point with the addition of new inputs. The list of inputs that
	// currently exist within lnd's central batching engine can be retrieved
	// through the PendingSweeps RPC.
	//
	// When bumping the fee of an input that currently exists within lnd's central
	// batching engine, a higher fee transaction will be created that replaces the
	// lower fee transaction through the Replace-By-Fee (RBF) policy. If it
	//
	// This RPC also serves useful when wanting to perform a Child-Pays-For-Parent
	// (CPFP), where the child transaction pays for its parent's fee. This can be
	// done by specifying an outpoint within the low fee transaction that is under
	// the control of the wallet.
	//
	// The fee preference can be expressed either as a specific fee rate or a delta
	// of blocks in which the output should be swept on-chain within. If a fee
	// preference is not explicitly specified, then an error is returned.
	//
	// Note that this RPC currently doesn't perform any validation checks on the
	// fee preference being provided. For now, the responsibility of ensuring that
	// the new fee preference is sufficient is delegated to the user.
	BumpFee(ctx context.Context, in *BumpFeeRequest, opts ...grpc.CallOption) (*BumpFeeResponse, error)
	// ListSweeps returns a list of the sweep transactions our node has produced.
	// Note that these sweeps may not be confirmed yet, as we record sweeps on
	// broadcast, not confirmation.
	ListSweeps(ctx context.Context, in *ListSweepsRequest, opts ...grpc.CallOption) (*ListSweepsResponse, error)
	// DeriveNextAccount generates the next account of the wallet.
	DeriveNextAccount(ctx context.Context, in *DeriveNextAccountRequest, opts ...grpc.CallOption) (*DeriveNextAccountResponse, error)
	// ExportPrivateKey exports a private key that is derived from a wallet
	// address.
	ExportPrivateKey(ctx context.Context, in *ExportPrivateKeyRequest, opts ...grpc.CallOption) (*ExportPrivateKeyResponse, error)
	// RescanWallet performs an on-chain rescan for wallet transactions.
	RescanWallet(ctx context.Context, in *RescanWalletRequest, opts ...grpc.CallOption) (WalletKit_RescanWalletClient, error)
	// SpendUTXOs performs a custom on-chain spend of UTXOs.
	SpendUTXOs(ctx context.Context, in *SpendUTXOsRequest, opts ...grpc.CallOption) (*SpendUTXOsResponse, error)
	// GetWalletTx returns information about an existing wallet transaction.
	GetWalletTx(ctx context.Context, in *GetWalletTxRequest, opts ...grpc.CallOption) (*GetWalletTxResponse, error)
	// LabelTransaction adds a label to a transaction. If the transaction already
	// has a label the call will fail unless the overwrite bool is set. This will
	// overwrite the exiting transaction label. Labels must not be empty, and
	// cannot exceed 500 characters.
	LabelTransaction(ctx context.Context, in *LabelTransactionRequest, opts ...grpc.CallOption) (*LabelTransactionResponse, error)
	// FundPsbt creates a fully populated PSBT that contains enough inputs to fund
	// the outputs specified in the template. There are two ways of specifying a
	// template: Either by passing in a PSBT with at least one output declared or
	// by passing in a raw TxTemplate message.
	//
	// If there are no inputs specified in the template, coin selection is
	// performed automatically. If the template does contain any inputs, it is
	// assumed that full coin selection happened externally and no additional
	// inputs are added. If the specified inputs aren't enough to fund the outputs
	// with the given fee rate, an error is returned.
	//
	// After either selecting or verifying the inputs, all input UTXOs are locked
	// with an internal app ID.
	//
	// NOTE: If this method returns without an error, it is the caller's
	// responsibility to either spend the locked UTXOs (by finalizing and then
	// publishing the transaction) or to unlock/release the locked UTXOs in case of
	// an error on the caller's side.
	FundPsbt(ctx context.Context, in *FundPsbtRequest, opts ...grpc.CallOption) (*FundPsbtResponse, error)
	// SignPsbt expects a partial transaction with all inputs and outputs fully
	// declared and tries to sign all unsigned inputs that have all required fields
	// (UTXO information, BIP32 derivation information, witness or sig scripts)
	// set.
	// If no error is returned, the PSBT is ready to be given to the next signer or
	// to be finalized if lnd was the last signer.
	//
	// NOTE: This RPC only signs inputs (and only those it can sign), it does not
	// perform any other tasks (such as coin selection, UTXO locking or
	// input/output/fee value validation, PSBT finalization). Any input that is
	// incomplete will be skipped.
	SignPsbt(ctx context.Context, in *SignPsbtRequest, opts ...grpc.CallOption) (*SignPsbtResponse, error)
	// FinalizePsbt expects a partial transaction with all inputs and outputs fully
	// declared and tries to sign all inputs that belong to the wallet. Lnd must be
	// the last signer of the transaction. That means, if there are any unsigned
	// non-witness inputs or inputs without UTXO information attached or inputs
	// without witness data that do not belong to lnd's wallet, this method will
	// fail. If no error is returned, the PSBT is ready to be extracted and the
	// final TX within to be broadcast.
	//
	// NOTE: This method does NOT publish the transaction once finalized. It is the
	// caller's responsibility to either publish the transaction on success or
	// unlock/release any locked UTXOs in case of an error in this method.
	FinalizePsbt(ctx context.Context, in *FinalizePsbtRequest, opts ...grpc.CallOption) (*FinalizePsbtResponse, error)
}

WalletKitClient is the client API for WalletKit service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewWalletKitClient 

func NewWalletKitClient(cc grpc.ClientConnInterface) WalletKitClient

type WalletKitServer 

type WalletKitServer interface {
	// ListUnspent returns a list of all utxos spendable by the wallet with a
	// number of confirmations between the specified minimum and maximum.
	ListUnspent(context.Context, *ListUnspentRequest) (*ListUnspentResponse, error)
	// LeaseOutput locks an output to the given ID, preventing it from being
	// available for any future coin selection attempts. The absolute time of the
	// lock's expiration is returned. The expiration of the lock can be extended by
	// successive invocations of this RPC. Outputs can be unlocked before their
	// expiration through `ReleaseOutput`.
	LeaseOutput(context.Context, *LeaseOutputRequest) (*LeaseOutputResponse, error)
	// ReleaseOutput unlocks an output, allowing it to be available for coin
	// selection if it remains unspent. The ID should match the one used to
	// originally lock the output.
	ReleaseOutput(context.Context, *ReleaseOutputRequest) (*ReleaseOutputResponse, error)
	// ListLeases lists all currently locked utxos.
	ListLeases(context.Context, *ListLeasesRequest) (*ListLeasesResponse, error)
	// DeriveNextKey attempts to derive the *next* key within the key family
	// (account in BIP43) specified. This method should return the next external
	// child within this branch.
	DeriveNextKey(context.Context, *KeyReq) (*signrpc.KeyDescriptor, error)
	// DeriveKey attempts to derive an arbitrary key specified by the passed
	// KeyLocator.
	DeriveKey(context.Context, *signrpc.KeyLocator) (*signrpc.KeyDescriptor, error)
	// NextAddr returns the next unused address within the wallet.
	NextAddr(context.Context, *AddrRequest) (*AddrResponse, error)
	// ListAccounts retrieves all accounts belonging to the wallet by default. A
	// name  filter can be provided to filter through all of the wallet accounts
	// and return only those matching.
	ListAccounts(context.Context, *ListAccountsRequest) (*ListAccountsResponse, error)
	// ImportAccount imports an account backed by an account extended public key.
	//
	// NOTE: Events (deposits/spends) for keys derived from an account will only be
	// detected by lnd if they happen after the import. Rescans to detect past
	// events will be supported later on.
	ImportAccount(context.Context, *ImportAccountRequest) (*ImportAccountResponse, error)
	// ImportPublicKey imports a public key as watch-only into the wallet.
	//
	// NOTE: Events (deposits/spends) for a key will only be detected by lnd if
	// they happen after the import. Rescans to detect past events will be
	// supported later on.
	ImportPublicKey(context.Context, *ImportPublicKeyRequest) (*ImportPublicKeyResponse, error)
	// PublishTransaction attempts to publish the passed transaction to the
	// network. Once this returns without an error, the wallet will continually
	// attempt to re-broadcast the transaction on start up, until it enters the
	// chain.
	PublishTransaction(context.Context, *Transaction) (*PublishResponse, error)
	// SendOutputs is similar to the existing sendmany call in Bitcoind, and
	// allows the caller to create a transaction that sends to several outputs at
	// once. This is ideal when wanting to batch create a set of transactions.
	SendOutputs(context.Context, *SendOutputsRequest) (*SendOutputsResponse, error)
	// EstimateFee attempts to query the internal fee estimator of the wallet to
	// determine the fee (in sat/kw) to attach to a transaction in order to
	// achieve the confirmation target.
	EstimateFee(context.Context, *EstimateFeeRequest) (*EstimateFeeResponse, error)
	// PendingSweeps returns lists of on-chain outputs that lnd is currently
	// attempting to sweep within its central batching engine. Outputs with similar
	// fee rates are batched together in order to sweep them within a single
	// transaction.
	//
	// NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to
	// remain supported. This is an advanced API that depends on the internals of
	// the UtxoSweeper, so things may change.
	PendingSweeps(context.Context, *PendingSweepsRequest) (*PendingSweepsResponse, error)
	// BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
	// takes a different approach than bitcoind's bumpfee command. lnd has a
	// central batching engine in which inputs with similar fee rates are batched
	// together to save on transaction fees. Due to this, we cannot rely on
	// bumping the fee on a specific transaction, since transactions can change at
	// any point with the addition of new inputs. The list of inputs that
	// currently exist within lnd's central batching engine can be retrieved
	// through the PendingSweeps RPC.
	//
	// When bumping the fee of an input that currently exists within lnd's central
	// batching engine, a higher fee transaction will be created that replaces the
	// lower fee transaction through the Replace-By-Fee (RBF) policy. If it
	//
	// This RPC also serves useful when wanting to perform a Child-Pays-For-Parent
	// (CPFP), where the child transaction pays for its parent's fee. This can be
	// done by specifying an outpoint within the low fee transaction that is under
	// the control of the wallet.
	//
	// The fee preference can be expressed either as a specific fee rate or a delta
	// of blocks in which the output should be swept on-chain within. If a fee
	// preference is not explicitly specified, then an error is returned.
	//
	// Note that this RPC currently doesn't perform any validation checks on the
	// fee preference being provided. For now, the responsibility of ensuring that
	// the new fee preference is sufficient is delegated to the user.
	BumpFee(context.Context, *BumpFeeRequest) (*BumpFeeResponse, error)
	// ListSweeps returns a list of the sweep transactions our node has produced.
	// Note that these sweeps may not be confirmed yet, as we record sweeps on
	// broadcast, not confirmation.
	ListSweeps(context.Context, *ListSweepsRequest) (*ListSweepsResponse, error)
	// DeriveNextAccount generates the next account of the wallet.
	DeriveNextAccount(context.Context, *DeriveNextAccountRequest) (*DeriveNextAccountResponse, error)
	// ExportPrivateKey exports a private key that is derived from a wallet
	// address.
	ExportPrivateKey(context.Context, *ExportPrivateKeyRequest) (*ExportPrivateKeyResponse, error)
	// RescanWallet performs an on-chain rescan for wallet transactions.
	RescanWallet(*RescanWalletRequest, WalletKit_RescanWalletServer) error
	// SpendUTXOs performs a custom on-chain spend of UTXOs.
	SpendUTXOs(context.Context, *SpendUTXOsRequest) (*SpendUTXOsResponse, error)
	// GetWalletTx returns information about an existing wallet transaction.
	GetWalletTx(context.Context, *GetWalletTxRequest) (*GetWalletTxResponse, error)
	// LabelTransaction adds a label to a transaction. If the transaction already
	// has a label the call will fail unless the overwrite bool is set. This will
	// overwrite the exiting transaction label. Labels must not be empty, and
	// cannot exceed 500 characters.
	LabelTransaction(context.Context, *LabelTransactionRequest) (*LabelTransactionResponse, error)
	// FundPsbt creates a fully populated PSBT that contains enough inputs to fund
	// the outputs specified in the template. There are two ways of specifying a
	// template: Either by passing in a PSBT with at least one output declared or
	// by passing in a raw TxTemplate message.
	//
	// If there are no inputs specified in the template, coin selection is
	// performed automatically. If the template does contain any inputs, it is
	// assumed that full coin selection happened externally and no additional
	// inputs are added. If the specified inputs aren't enough to fund the outputs
	// with the given fee rate, an error is returned.
	//
	// After either selecting or verifying the inputs, all input UTXOs are locked
	// with an internal app ID.
	//
	// NOTE: If this method returns without an error, it is the caller's
	// responsibility to either spend the locked UTXOs (by finalizing and then
	// publishing the transaction) or to unlock/release the locked UTXOs in case of
	// an error on the caller's side.
	FundPsbt(context.Context, *FundPsbtRequest) (*FundPsbtResponse, error)
	// SignPsbt expects a partial transaction with all inputs and outputs fully
	// declared and tries to sign all unsigned inputs that have all required fields
	// (UTXO information, BIP32 derivation information, witness or sig scripts)
	// set.
	// If no error is returned, the PSBT is ready to be given to the next signer or
	// to be finalized if lnd was the last signer.
	//
	// NOTE: This RPC only signs inputs (and only those it can sign), it does not
	// perform any other tasks (such as coin selection, UTXO locking or
	// input/output/fee value validation, PSBT finalization). Any input that is
	// incomplete will be skipped.
	SignPsbt(context.Context, *SignPsbtRequest) (*SignPsbtResponse, error)
	// FinalizePsbt expects a partial transaction with all inputs and outputs fully
	// declared and tries to sign all inputs that belong to the wallet. Lnd must be
	// the last signer of the transaction. That means, if there are any unsigned
	// non-witness inputs or inputs without UTXO information attached or inputs
	// without witness data that do not belong to lnd's wallet, this method will
	// fail. If no error is returned, the PSBT is ready to be extracted and the
	// final TX within to be broadcast.
	//
	// NOTE: This method does NOT publish the transaction once finalized. It is the
	// caller's responsibility to either publish the transaction on success or
	// unlock/release any locked UTXOs in case of an error in this method.
	FinalizePsbt(context.Context, *FinalizePsbtRequest) (*FinalizePsbtResponse, error)
}

WalletKitServer is the server API for WalletKit service.

type WalletKit_RescanWalletClient added in v0.3.8 

type WalletKit_RescanWalletClient interface {
	Recv() (*RescanWalletResponse, error)
	grpc.ClientStream
}

type WalletKit_RescanWalletServer added in v0.3.8 

type WalletKit_RescanWalletServer interface {
	Send(*RescanWalletResponse) error
	grpc.ServerStream
}

type WitnessType added in v0.2.0 

type WitnessType int32
const (
	WitnessType_UNKNOWN_WITNESS WitnessType = 0
	// A witness that allows us to spend the output of a commitment transaction
	// after a relative lock-time lockout.
	WitnessType_COMMITMENT_TIME_LOCK WitnessType = 1
	// A witness that allows us to spend a settled no-delay output immediately on a
	// counterparty's commitment transaction.
	WitnessType_COMMITMENT_NO_DELAY WitnessType = 2
	// A witness that allows us to sweep the settled output of a malicious
	// counterparty's who broadcasts a revoked commitment transaction.
	WitnessType_COMMITMENT_REVOKE WitnessType = 3
	// A witness that allows us to sweep an HTLC which we offered to the remote
	// party in the case that they broadcast a revoked commitment state.
	WitnessType_HTLC_OFFERED_REVOKE WitnessType = 4
	// A witness that allows us to sweep an HTLC output sent to us in the case that
	// the remote party broadcasts a revoked commitment state.
	WitnessType_HTLC_ACCEPTED_REVOKE WitnessType = 5
	// A witness that allows us to sweep an HTLC output that we extended to a
	// party, but was never fulfilled.  This HTLC output isn't directly on the
	// commitment transaction, but is the result of a confirmed second-level HTLC
	// transaction. As a result, we can only spend this after a CSV delay.
	WitnessType_HTLC_OFFERED_TIMEOUT_SECOND_LEVEL WitnessType = 6
	// A witness that allows us to sweep an HTLC output that was offered to us, and
	// for which we have a payment preimage. This HTLC output isn't directly on our
	// commitment transaction, but is the result of confirmed second-level HTLC
	// transaction. As a result, we can only spend this after a CSV delay.
	WitnessType_HTLC_ACCEPTED_SUCCESS_SECOND_LEVEL WitnessType = 7
	// A witness that allows us to sweep an HTLC that we offered to the remote
	// party which lies in the commitment transaction of the remote party. We can
	// spend this output after the absolute CLTV timeout of the HTLC as passed.
	WitnessType_HTLC_OFFERED_REMOTE_TIMEOUT WitnessType = 8
	// A witness that allows us to sweep an HTLC that was offered to us by the
	// remote party. We use this witness in the case that the remote party goes to
	// chain, and we know the pre-image to the HTLC. We can sweep this without any
	// additional timeout.
	WitnessType_HTLC_ACCEPTED_REMOTE_SUCCESS WitnessType = 9
	// A witness that allows us to sweep an HTLC from the remote party's commitment
	// transaction in the case that the broadcast a revoked commitment, but then
	// also immediately attempt to go to the second level to claim the HTLC.
	WitnessType_HTLC_SECOND_LEVEL_REVOKE WitnessType = 10
	// A witness type that allows us to spend a regular p2wkh output that's sent to
	// an output which is under complete control of the backing wallet.
	WitnessType_WITNESS_KEY_HASH WitnessType = 11
	// A witness type that allows us to sweep an output that sends to a nested P2SH
	// script that pays to a key solely under our control.
	WitnessType_NESTED_WITNESS_KEY_HASH WitnessType = 12
	// A witness type that allows us to spend our anchor on the commitment
	// transaction.
	WitnessType_COMMITMENT_ANCHOR WitnessType = 13
	// A witness type that allows us to sweep an output that sends to a P2PKH
	// script.
	WitnessType_PUBKEY_HASH WitnessType = 128
)

func (WitnessType) Descriptor added in v0.3.0 

func (WitnessType) Descriptor() protoreflect.EnumDescriptor

func (WitnessType) Enum added in v0.3.0 

func (x WitnessType) Enum() *WitnessType

func (WitnessType) EnumDescriptor deprecated added in v0.2.0 

func (WitnessType) EnumDescriptor() ([]byte, []int)

Deprecated: Use WitnessType.Descriptor instead.

func (WitnessType) Number added in v0.3.0 

func (x WitnessType) Number() protoreflect.EnumNumber

func (WitnessType) String added in v0.2.0 

func (x WitnessType) String() string

func (WitnessType) Type added in v0.3.0 

func (WitnessType) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.