walletrpc

package
v0.13.0-beta.rc3 Latest Latest
Warning

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

Go to latest
Published: May 20, 2021 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package walletrpc is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

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",
	}
	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,
	}
)

Enum value maps for WitnessType.

View Source
var File_walletrpc_walletkit_proto protoreflect.FileDescriptor

Functions

func DisableLog

func DisableLog()

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

func RegisterWalletKitHandler

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

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

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

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.

func RegisterWalletKitServer

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

func UseLogger

func UseLogger(logger btclog.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 btclog.

Types

type Account

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

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

Deprecated: Use Account.ProtoReflect.Descriptor instead.

func (*Account) GetAddressType

func (x *Account) GetAddressType() AddressType

func (*Account) GetDerivationPath

func (x *Account) GetDerivationPath() string

func (*Account) GetExtendedPublicKey

func (x *Account) GetExtendedPublicKey() string

func (*Account) GetExternalKeyCount

func (x *Account) GetExternalKeyCount() uint32

func (*Account) GetInternalKeyCount

func (x *Account) GetInternalKeyCount() uint32

func (*Account) GetMasterKeyFingerprint

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

func (*Account) GetName

func (x *Account) GetName() string

func (*Account) GetWatchOnly

func (x *Account) GetWatchOnly() bool

func (*Account) ProtoMessage

func (*Account) ProtoMessage()

func (*Account) ProtoReflect

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

func (*Account) Reset

func (x *Account) Reset()

func (*Account) String

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"`
	// contains filtered or unexported fields
}

func (*AddrRequest) Descriptor deprecated

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

Deprecated: Use AddrRequest.ProtoReflect.Descriptor instead.

func (*AddrRequest) GetAccount

func (x *AddrRequest) GetAccount() string

func (*AddrRequest) ProtoMessage

func (*AddrRequest) ProtoMessage()

func (*AddrRequest) ProtoReflect

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

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

func (*AddrResponse) Reset

func (x *AddrResponse) Reset()

func (*AddrResponse) String

func (x *AddrResponse) String() string

type AddressType

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

func (AddressType) Enum

func (x AddressType) Enum() *AddressType

func (AddressType) EnumDescriptor deprecated

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

Deprecated: Use AddressType.Descriptor instead.

func (AddressType) Number

func (x AddressType) Number() protoreflect.EnumNumber

func (AddressType) String

func (x AddressType) String() string

func (AddressType) Type

type BumpFeeRequest

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"`
	//
	//Deprecated, use sat_per_vbyte.
	//The fee rate, expressed in sat/vbyte, that should be used to spend the input
	//with.
	//
	// Deprecated: Do not use.
	SatPerByte uint32 `protobuf:"varint,3,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_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"`
	//
	//The fee rate, expressed in sat/vbyte, that should be used to spend the input
	//with.
	SatPerVbyte uint64 `protobuf:"varint,5,opt,name=sat_per_vbyte,json=satPerVbyte,proto3" json:"sat_per_vbyte,omitempty"`
	// contains filtered or unexported fields
}

func (*BumpFeeRequest) Descriptor deprecated

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

Deprecated: Use BumpFeeRequest.ProtoReflect.Descriptor instead.

func (*BumpFeeRequest) GetForce

func (x *BumpFeeRequest) GetForce() bool

func (*BumpFeeRequest) GetOutpoint

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

func (*BumpFeeRequest) GetSatPerByte deprecated

func (x *BumpFeeRequest) GetSatPerByte() uint32

Deprecated: Do not use.

func (*BumpFeeRequest) GetSatPerVbyte

func (x *BumpFeeRequest) GetSatPerVbyte() uint64

func (*BumpFeeRequest) GetTargetConf

func (x *BumpFeeRequest) GetTargetConf() uint32

func (*BumpFeeRequest) ProtoMessage

func (*BumpFeeRequest) ProtoMessage()

func (*BumpFeeRequest) ProtoReflect

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

func (*BumpFeeRequest) Reset

func (x *BumpFeeRequest) Reset()

func (*BumpFeeRequest) String

func (x *BumpFeeRequest) String() string

type BumpFeeResponse

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

func (*BumpFeeResponse) Descriptor deprecated

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

Deprecated: Use BumpFeeResponse.ProtoReflect.Descriptor instead.

func (*BumpFeeResponse) ProtoMessage

func (*BumpFeeResponse) ProtoMessage()

func (*BumpFeeResponse) ProtoReflect

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

func (*BumpFeeResponse) Reset

func (x *BumpFeeResponse) Reset()

func (*BumpFeeResponse) String

func (x *BumpFeeResponse) String() string

type Config

type Config struct{}

Config is the primary configuration struct for the WalletKit RPC server. When the server isn't active (via the build flag), callers outside this package will see this shell of a config file.

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

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 satoshis per kw that should be used in order to reach the
	//confirmation target in the request.
	SatPerKw int64 `protobuf:"varint,1,opt,name=sat_per_kw,json=satPerKw,proto3" json:"sat_per_kw,omitempty"`
	// contains filtered or unexported fields
}

func (*EstimateFeeResponse) Descriptor deprecated

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

Deprecated: Use EstimateFeeResponse.ProtoReflect.Descriptor instead.

func (*EstimateFeeResponse) GetSatPerKw

func (x *EstimateFeeResponse) GetSatPerKw() int64

func (*EstimateFeeResponse) ProtoMessage

func (*EstimateFeeResponse) ProtoMessage()

func (*EstimateFeeResponse) ProtoReflect

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

func (*EstimateFeeResponse) Reset

func (x *EstimateFeeResponse) Reset()

func (*EstimateFeeResponse) String

func (x *EstimateFeeResponse) String() string

type FinalizePsbtRequest

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"`
	//
	//The name of the account to finalize the PSBT with. If empty, the default
	//wallet account is used.
	Account string `protobuf:"bytes,5,opt,name=account,proto3" json:"account,omitempty"`
	// contains filtered or unexported fields
}

func (*FinalizePsbtRequest) Descriptor deprecated

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

Deprecated: Use FinalizePsbtRequest.ProtoReflect.Descriptor instead.

func (*FinalizePsbtRequest) GetAccount

func (x *FinalizePsbtRequest) GetAccount() string

func (*FinalizePsbtRequest) GetFundedPsbt

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

func (*FinalizePsbtRequest) ProtoMessage

func (*FinalizePsbtRequest) ProtoMessage()

func (*FinalizePsbtRequest) ProtoReflect

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

func (*FinalizePsbtRequest) Reset

func (x *FinalizePsbtRequest) Reset()

func (*FinalizePsbtRequest) String

func (x *FinalizePsbtRequest) String() string

type FinalizePsbtResponse

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

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

Deprecated: Use FinalizePsbtResponse.ProtoReflect.Descriptor instead.

func (*FinalizePsbtResponse) GetRawFinalTx

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

func (*FinalizePsbtResponse) GetSignedPsbt

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

func (*FinalizePsbtResponse) ProtoMessage

func (*FinalizePsbtResponse) ProtoMessage()

func (*FinalizePsbtResponse) ProtoReflect

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

func (*FinalizePsbtResponse) Reset

func (x *FinalizePsbtResponse) Reset()

func (*FinalizePsbtResponse) String

func (x *FinalizePsbtResponse) String() string

type FundPsbtRequest

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_SatPerVbyte
	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

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

Deprecated: Use FundPsbtRequest.ProtoReflect.Descriptor instead.

func (*FundPsbtRequest) GetAccount

func (x *FundPsbtRequest) GetAccount() string

func (*FundPsbtRequest) GetFees

func (m *FundPsbtRequest) GetFees() isFundPsbtRequest_Fees

func (*FundPsbtRequest) GetMinConfs

func (x *FundPsbtRequest) GetMinConfs() int32

func (*FundPsbtRequest) GetPsbt

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

func (*FundPsbtRequest) GetRaw

func (x *FundPsbtRequest) GetRaw() *TxTemplate

func (*FundPsbtRequest) GetSatPerVbyte

func (x *FundPsbtRequest) GetSatPerVbyte() uint64

func (*FundPsbtRequest) GetSpendUnconfirmed

func (x *FundPsbtRequest) GetSpendUnconfirmed() bool

func (*FundPsbtRequest) GetTargetConf

func (x *FundPsbtRequest) GetTargetConf() uint32

func (*FundPsbtRequest) GetTemplate

func (m *FundPsbtRequest) GetTemplate() isFundPsbtRequest_Template

func (*FundPsbtRequest) ProtoMessage

func (*FundPsbtRequest) ProtoMessage()

func (*FundPsbtRequest) ProtoReflect

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

func (*FundPsbtRequest) Reset

func (x *FundPsbtRequest) Reset()

func (*FundPsbtRequest) String

func (x *FundPsbtRequest) String() string

type FundPsbtRequest_Psbt

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

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_SatPerVbyte

type FundPsbtRequest_SatPerVbyte struct {
	//
	//The fee rate, expressed in sat/vbyte, that should be used to spend the
	//input with.
	SatPerVbyte uint64 `protobuf:"varint,4,opt,name=sat_per_vbyte,json=satPerVbyte,proto3,oneof"`
}

type FundPsbtRequest_TargetConf

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

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

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

Deprecated: Use FundPsbtResponse.ProtoReflect.Descriptor instead.

func (*FundPsbtResponse) GetChangeOutputIndex

func (x *FundPsbtResponse) GetChangeOutputIndex() int32

func (*FundPsbtResponse) GetFundedPsbt

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

func (*FundPsbtResponse) GetLockedUtxos

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

func (*FundPsbtResponse) ProtoMessage

func (*FundPsbtResponse) ProtoMessage()

func (*FundPsbtResponse) ProtoReflect

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

func (*FundPsbtResponse) Reset

func (x *FundPsbtResponse) Reset()

func (*FundPsbtResponse) String

func (x *FundPsbtResponse) String() string

type ImportAccountRequest

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

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

Deprecated: Use ImportAccountRequest.ProtoReflect.Descriptor instead.

func (*ImportAccountRequest) GetAddressType

func (x *ImportAccountRequest) GetAddressType() AddressType

func (*ImportAccountRequest) GetDryRun

func (x *ImportAccountRequest) GetDryRun() bool

func (*ImportAccountRequest) GetExtendedPublicKey

func (x *ImportAccountRequest) GetExtendedPublicKey() string

func (*ImportAccountRequest) GetMasterKeyFingerprint

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

func (*ImportAccountRequest) GetName

func (x *ImportAccountRequest) GetName() string

func (*ImportAccountRequest) ProtoMessage

func (*ImportAccountRequest) ProtoMessage()

func (*ImportAccountRequest) ProtoReflect

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

func (*ImportAccountRequest) Reset

func (x *ImportAccountRequest) Reset()

func (*ImportAccountRequest) String

func (x *ImportAccountRequest) String() string

type ImportAccountResponse

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

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

Deprecated: Use ImportAccountResponse.ProtoReflect.Descriptor instead.

func (*ImportAccountResponse) GetAccount

func (x *ImportAccountResponse) GetAccount() *Account

func (*ImportAccountResponse) GetDryRunExternalAddrs

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

func (*ImportAccountResponse) GetDryRunInternalAddrs

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

func (*ImportAccountResponse) ProtoMessage

func (*ImportAccountResponse) ProtoMessage()

func (*ImportAccountResponse) ProtoReflect

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

func (*ImportAccountResponse) Reset

func (x *ImportAccountResponse) Reset()

func (*ImportAccountResponse) String

func (x *ImportAccountResponse) String() string

type ImportPublicKeyRequest

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

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

Deprecated: Use ImportPublicKeyRequest.ProtoReflect.Descriptor instead.

func (*ImportPublicKeyRequest) GetAddressType

func (x *ImportPublicKeyRequest) GetAddressType() AddressType

func (*ImportPublicKeyRequest) GetPublicKey

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

func (*ImportPublicKeyRequest) ProtoMessage

func (*ImportPublicKeyRequest) ProtoMessage()

func (*ImportPublicKeyRequest) ProtoReflect

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

func (*ImportPublicKeyRequest) Reset

func (x *ImportPublicKeyRequest) Reset()

func (*ImportPublicKeyRequest) String

func (x *ImportPublicKeyRequest) String() string

type ImportPublicKeyResponse

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

func (*ImportPublicKeyResponse) Descriptor deprecated

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

Deprecated: Use ImportPublicKeyResponse.ProtoReflect.Descriptor instead.

func (*ImportPublicKeyResponse) ProtoMessage

func (*ImportPublicKeyResponse) ProtoMessage()

func (*ImportPublicKeyResponse) ProtoReflect

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

func (*ImportPublicKeyResponse) Reset

func (x *ImportPublicKeyResponse) Reset()

func (*ImportPublicKeyResponse) String

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

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

func (*KeyReq) Reset

func (x *KeyReq) Reset()

func (*KeyReq) String

func (x *KeyReq) String() string

type LabelTransactionRequest

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

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

Deprecated: Use LabelTransactionRequest.ProtoReflect.Descriptor instead.

func (*LabelTransactionRequest) GetLabel

func (x *LabelTransactionRequest) GetLabel() string

func (*LabelTransactionRequest) GetOverwrite

func (x *LabelTransactionRequest) GetOverwrite() bool

func (*LabelTransactionRequest) GetTxid

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

func (*LabelTransactionRequest) ProtoMessage

func (*LabelTransactionRequest) ProtoMessage()

func (*LabelTransactionRequest) ProtoReflect

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

func (*LabelTransactionRequest) Reset

func (x *LabelTransactionRequest) Reset()

func (*LabelTransactionRequest) String

func (x *LabelTransactionRequest) String() string

type LabelTransactionResponse

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

func (*LabelTransactionResponse) Descriptor deprecated

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

Deprecated: Use LabelTransactionResponse.ProtoReflect.Descriptor instead.

func (*LabelTransactionResponse) ProtoMessage

func (*LabelTransactionResponse) ProtoMessage()

func (*LabelTransactionResponse) ProtoReflect

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

func (*LabelTransactionResponse) Reset

func (x *LabelTransactionResponse) Reset()

func (*LabelTransactionResponse) String

func (x *LabelTransactionResponse) String() string

type LeaseOutputRequest

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

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

Deprecated: Use LeaseOutputRequest.ProtoReflect.Descriptor instead.

func (*LeaseOutputRequest) GetExpirationSeconds

func (x *LeaseOutputRequest) GetExpirationSeconds() uint64

func (*LeaseOutputRequest) GetId

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

func (*LeaseOutputRequest) GetOutpoint

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

func (*LeaseOutputRequest) ProtoMessage

func (*LeaseOutputRequest) ProtoMessage()

func (*LeaseOutputRequest) ProtoReflect

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

func (*LeaseOutputRequest) Reset

func (x *LeaseOutputRequest) Reset()

func (*LeaseOutputRequest) String

func (x *LeaseOutputRequest) String() string

type LeaseOutputResponse

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

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

Deprecated: Use LeaseOutputResponse.ProtoReflect.Descriptor instead.

func (*LeaseOutputResponse) GetExpiration

func (x *LeaseOutputResponse) GetExpiration() uint64

func (*LeaseOutputResponse) ProtoMessage

func (*LeaseOutputResponse) ProtoMessage()

func (*LeaseOutputResponse) ProtoReflect

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

func (*LeaseOutputResponse) Reset

func (x *LeaseOutputResponse) Reset()

func (*LeaseOutputResponse) String

func (x *LeaseOutputResponse) String() string

type ListAccountsRequest

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

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

Deprecated: Use ListAccountsRequest.ProtoReflect.Descriptor instead.

func (*ListAccountsRequest) GetAddressType

func (x *ListAccountsRequest) GetAddressType() AddressType

func (*ListAccountsRequest) GetName

func (x *ListAccountsRequest) GetName() string

func (*ListAccountsRequest) ProtoMessage

func (*ListAccountsRequest) ProtoMessage()

func (*ListAccountsRequest) ProtoReflect

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

func (*ListAccountsRequest) Reset

func (x *ListAccountsRequest) Reset()

func (*ListAccountsRequest) String

func (x *ListAccountsRequest) String() string

type ListAccountsResponse

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

func (*ListAccountsResponse) Descriptor deprecated

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

Deprecated: Use ListAccountsResponse.ProtoReflect.Descriptor instead.

func (*ListAccountsResponse) GetAccounts

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

func (*ListAccountsResponse) ProtoMessage

func (*ListAccountsResponse) ProtoMessage()

func (*ListAccountsResponse) ProtoReflect

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

func (*ListAccountsResponse) Reset

func (x *ListAccountsResponse) Reset()

func (*ListAccountsResponse) String

func (x *ListAccountsResponse) String() string

type ListLeasesRequest

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

func (*ListLeasesRequest) Descriptor deprecated

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

Deprecated: Use ListLeasesRequest.ProtoReflect.Descriptor instead.

func (*ListLeasesRequest) ProtoMessage

func (*ListLeasesRequest) ProtoMessage()

func (*ListLeasesRequest) ProtoReflect

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

func (*ListLeasesRequest) Reset

func (x *ListLeasesRequest) Reset()

func (*ListLeasesRequest) String

func (x *ListLeasesRequest) String() string

type ListLeasesResponse

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

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

Deprecated: Use ListLeasesResponse.ProtoReflect.Descriptor instead.

func (*ListLeasesResponse) GetLockedUtxos

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

func (*ListLeasesResponse) ProtoMessage

func (*ListLeasesResponse) ProtoMessage()

func (*ListLeasesResponse) ProtoReflect

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

func (*ListLeasesResponse) Reset

func (x *ListLeasesResponse) Reset()

func (*ListLeasesResponse) String

func (x *ListLeasesResponse) String() string

type ListSweepsRequest

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

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

Deprecated: Use ListSweepsRequest.ProtoReflect.Descriptor instead.

func (*ListSweepsRequest) GetVerbose

func (x *ListSweepsRequest) GetVerbose() bool

func (*ListSweepsRequest) ProtoMessage

func (*ListSweepsRequest) ProtoMessage()

func (*ListSweepsRequest) ProtoReflect

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

func (*ListSweepsRequest) Reset

func (x *ListSweepsRequest) Reset()

func (*ListSweepsRequest) String

func (x *ListSweepsRequest) String() string

type ListSweepsResponse

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

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

Deprecated: Use ListSweepsResponse.ProtoReflect.Descriptor instead.

func (*ListSweepsResponse) GetSweeps

func (m *ListSweepsResponse) GetSweeps() isListSweepsResponse_Sweeps

func (*ListSweepsResponse) GetTransactionDetails

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

func (*ListSweepsResponse) GetTransactionIds

func (x *ListSweepsResponse) GetTransactionIds() *ListSweepsResponse_TransactionIDs

func (*ListSweepsResponse) ProtoMessage

func (*ListSweepsResponse) ProtoMessage()

func (*ListSweepsResponse) ProtoReflect

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

func (*ListSweepsResponse) Reset

func (x *ListSweepsResponse) Reset()

func (*ListSweepsResponse) String

func (x *ListSweepsResponse) String() string

type ListSweepsResponse_TransactionDetails

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

type ListSweepsResponse_TransactionIDs

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

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

Deprecated: Use ListSweepsResponse_TransactionIDs.ProtoReflect.Descriptor instead.

func (*ListSweepsResponse_TransactionIDs) GetTransactionIds

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

func (*ListSweepsResponse_TransactionIDs) ProtoMessage

func (*ListSweepsResponse_TransactionIDs) ProtoMessage()

func (*ListSweepsResponse_TransactionIDs) ProtoReflect

func (*ListSweepsResponse_TransactionIDs) Reset

func (*ListSweepsResponse_TransactionIDs) String

type ListSweepsResponse_TransactionIds

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

type ListUnspentRequest

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

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

Deprecated: Use ListUnspentRequest.ProtoReflect.Descriptor instead.

func (*ListUnspentRequest) GetAccount

func (x *ListUnspentRequest) GetAccount() string

func (*ListUnspentRequest) GetMaxConfs

func (x *ListUnspentRequest) GetMaxConfs() int32

func (*ListUnspentRequest) GetMinConfs

func (x *ListUnspentRequest) GetMinConfs() int32

func (*ListUnspentRequest) ProtoMessage

func (*ListUnspentRequest) ProtoMessage()

func (*ListUnspentRequest) ProtoReflect

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

func (*ListUnspentRequest) Reset

func (x *ListUnspentRequest) Reset()

func (*ListUnspentRequest) String

func (x *ListUnspentRequest) String() string

type ListUnspentResponse

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

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

Deprecated: Use ListUnspentResponse.ProtoReflect.Descriptor instead.

func (*ListUnspentResponse) GetUtxos

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

func (*ListUnspentResponse) ProtoMessage

func (*ListUnspentResponse) ProtoMessage()

func (*ListUnspentResponse) ProtoReflect

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

func (*ListUnspentResponse) Reset

func (x *ListUnspentResponse) Reset()

func (*ListUnspentResponse) String

func (x *ListUnspentResponse) String() string

type PendingSweep

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.
	AmountSat uint32 `protobuf:"varint,3,opt,name=amount_sat,json=amountSat,proto3" json:"amount_sat,omitempty"`
	//
	//Deprecated, use sat_per_vbyte.
	//The fee rate we'll use to sweep the output, expressed in sat/vbyte. 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.
	//
	// Deprecated: Do not use.
	SatPerByte uint32 `protobuf:"varint,4,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_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"`
	// Deprecated, use requested_sat_per_vbyte.
	// The requested fee rate, expressed in sat/vbyte, for this output.
	//
	// Deprecated: Do not use.
	RequestedSatPerByte uint32 `protobuf:"varint,9,opt,name=requested_sat_per_byte,json=requestedSatPerByte,proto3" json:"requested_sat_per_byte,omitempty"`
	//
	//The fee rate we'll use to sweep the output, expressed in sat/vbyte. 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.
	SatPerVbyte uint64 `protobuf:"varint,10,opt,name=sat_per_vbyte,json=satPerVbyte,proto3" json:"sat_per_vbyte,omitempty"`
	// The requested fee rate, expressed in sat/vbyte, for this output.
	RequestedSatPerVbyte uint64 `` /* 127-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

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

Deprecated: Use PendingSweep.ProtoReflect.Descriptor instead.

func (*PendingSweep) GetAmountSat

func (x *PendingSweep) GetAmountSat() uint32

func (*PendingSweep) GetBroadcastAttempts

func (x *PendingSweep) GetBroadcastAttempts() uint32

func (*PendingSweep) GetForce

func (x *PendingSweep) GetForce() bool

func (*PendingSweep) GetNextBroadcastHeight

func (x *PendingSweep) GetNextBroadcastHeight() uint32

func (*PendingSweep) GetOutpoint

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

func (*PendingSweep) GetRequestedConfTarget

func (x *PendingSweep) GetRequestedConfTarget() uint32

func (*PendingSweep) GetRequestedSatPerByte deprecated

func (x *PendingSweep) GetRequestedSatPerByte() uint32

Deprecated: Do not use.

func (*PendingSweep) GetRequestedSatPerVbyte

func (x *PendingSweep) GetRequestedSatPerVbyte() uint64

func (*PendingSweep) GetSatPerByte deprecated

func (x *PendingSweep) GetSatPerByte() uint32

Deprecated: Do not use.

func (*PendingSweep) GetSatPerVbyte

func (x *PendingSweep) GetSatPerVbyte() uint64

func (*PendingSweep) GetWitnessType

func (x *PendingSweep) GetWitnessType() WitnessType

func (*PendingSweep) ProtoMessage

func (*PendingSweep) ProtoMessage()

func (*PendingSweep) ProtoReflect

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

func (*PendingSweep) Reset

func (x *PendingSweep) Reset()

func (*PendingSweep) String

func (x *PendingSweep) String() string

type PendingSweepsRequest

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

func (*PendingSweepsRequest) Descriptor deprecated

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

Deprecated: Use PendingSweepsRequest.ProtoReflect.Descriptor instead.

func (*PendingSweepsRequest) ProtoMessage

func (*PendingSweepsRequest) ProtoMessage()

func (*PendingSweepsRequest) ProtoReflect

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

func (*PendingSweepsRequest) Reset

func (x *PendingSweepsRequest) Reset()

func (*PendingSweepsRequest) String

func (x *PendingSweepsRequest) String() string

type PendingSweepsResponse

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

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

Deprecated: Use PendingSweepsResponse.ProtoReflect.Descriptor instead.

func (*PendingSweepsResponse) GetPendingSweeps

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

func (*PendingSweepsResponse) ProtoMessage

func (*PendingSweepsResponse) ProtoMessage()

func (*PendingSweepsResponse) ProtoReflect

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

func (*PendingSweepsResponse) Reset

func (x *PendingSweepsResponse) Reset()

func (*PendingSweepsResponse) String

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

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

func (*PublishResponse) Reset

func (x *PublishResponse) Reset()

func (*PublishResponse) String

func (x *PublishResponse) String() string

type ReleaseOutputRequest

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

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

Deprecated: Use ReleaseOutputRequest.ProtoReflect.Descriptor instead.

func (*ReleaseOutputRequest) GetId

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

func (*ReleaseOutputRequest) GetOutpoint

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

func (*ReleaseOutputRequest) ProtoMessage

func (*ReleaseOutputRequest) ProtoMessage()

func (*ReleaseOutputRequest) ProtoReflect

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

func (*ReleaseOutputRequest) Reset

func (x *ReleaseOutputRequest) Reset()

func (*ReleaseOutputRequest) String

func (x *ReleaseOutputRequest) String() string

type ReleaseOutputResponse

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

func (*ReleaseOutputResponse) Descriptor deprecated

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

Deprecated: Use ReleaseOutputResponse.ProtoReflect.Descriptor instead.

func (*ReleaseOutputResponse) ProtoMessage

func (*ReleaseOutputResponse) ProtoMessage()

func (*ReleaseOutputResponse) ProtoReflect

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

func (*ReleaseOutputResponse) Reset

func (x *ReleaseOutputResponse) Reset()

func (*ReleaseOutputResponse) String

func (x *ReleaseOutputResponse) String() string

type SendOutputsRequest

type SendOutputsRequest struct {

	//
	//The number of satoshis per kilo weight that should be used when crafting
	//this transaction.
	SatPerKw int64 `protobuf:"varint,1,opt,name=sat_per_kw,json=satPerKw,proto3" json:"sat_per_kw,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 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) GetLabel

func (x *SendOutputsRequest) GetLabel() string

func (*SendOutputsRequest) GetMinConfs

func (x *SendOutputsRequest) GetMinConfs() int32

func (*SendOutputsRequest) GetOutputs

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

func (*SendOutputsRequest) GetSatPerKw

func (x *SendOutputsRequest) GetSatPerKw() int64

func (*SendOutputsRequest) GetSpendUnconfirmed

func (x *SendOutputsRequest) GetSpendUnconfirmed() bool

func (*SendOutputsRequest) ProtoMessage

func (*SendOutputsRequest) ProtoMessage()

func (*SendOutputsRequest) ProtoReflect

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

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

func (*SendOutputsResponse) Reset

func (x *SendOutputsResponse) Reset()

func (*SendOutputsResponse) String

func (x *SendOutputsResponse) 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

func (x *Transaction) GetLabel() string

func (*Transaction) GetTxHex

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

func (*Transaction) ProtoMessage

func (*Transaction) ProtoMessage()

func (*Transaction) ProtoReflect

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

func (*Transaction) Reset

func (x *Transaction) Reset()

func (*Transaction) String

func (x *Transaction) String() string

type TxTemplate

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

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

Deprecated: Use TxTemplate.ProtoReflect.Descriptor instead.

func (*TxTemplate) GetInputs

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

func (*TxTemplate) GetOutputs

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

func (*TxTemplate) ProtoMessage

func (*TxTemplate) ProtoMessage()

func (*TxTemplate) ProtoReflect

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

func (*TxTemplate) Reset

func (x *TxTemplate) Reset()

func (*TxTemplate) String

func (x *TxTemplate) String() string

type UnimplementedWalletKitServer

type UnimplementedWalletKitServer struct {
}

UnimplementedWalletKitServer can be embedded to have forward compatible implementations.

func (*UnimplementedWalletKitServer) BumpFee

func (*UnimplementedWalletKitServer) DeriveKey

func (*UnimplementedWalletKitServer) DeriveNextKey

func (*UnimplementedWalletKitServer) EstimateFee

func (*UnimplementedWalletKitServer) FinalizePsbt

func (*UnimplementedWalletKitServer) FundPsbt

func (*UnimplementedWalletKitServer) ImportAccount

func (*UnimplementedWalletKitServer) ImportPublicKey

func (*UnimplementedWalletKitServer) LabelTransaction

func (*UnimplementedWalletKitServer) LeaseOutput

func (*UnimplementedWalletKitServer) ListAccounts

func (*UnimplementedWalletKitServer) ListLeases

func (*UnimplementedWalletKitServer) ListSweeps

func (*UnimplementedWalletKitServer) ListUnspent

func (*UnimplementedWalletKitServer) NextAddr

func (*UnimplementedWalletKitServer) PendingSweeps

func (*UnimplementedWalletKitServer) PublishTransaction

func (*UnimplementedWalletKitServer) ReleaseOutput

func (*UnimplementedWalletKitServer) SendOutputs

type UtxoLease

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

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

Deprecated: Use UtxoLease.ProtoReflect.Descriptor instead.

func (*UtxoLease) GetExpiration

func (x *UtxoLease) GetExpiration() uint64

func (*UtxoLease) GetId

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

func (*UtxoLease) GetOutpoint

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

func (*UtxoLease) ProtoMessage

func (*UtxoLease) ProtoMessage()

func (*UtxoLease) ProtoReflect

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

func (*UtxoLease) Reset

func (x *UtxoLease) Reset()

func (*UtxoLease) String

func (x *UtxoLease) String() string

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 and key scope 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.
	//The master key fingerprint denotes the fingerprint of the root key
	//corresponding to the account public key (also known as the key with
	//derivation path m/). This may be required by some hardware wallets for
	//proper identification and signing.
	//
	//The address type can usually be inferred from the key's version, but may be
	//required for certain keys to map them into the proper scope.
	//
	//For BIP-0044 keys, an address type must be specified as we intend to not
	//support importing BIP-0044 keys into the wallet using the legacy
	//pay-to-pubkey-hash (P2PKH) scheme. A nested witness address type will force
	//the standard BIP-0049 derivation scheme, while a witness address type will
	//force the standard BIP-0084 derivation scheme.
	//
	//For BIP-0049 keys, an address type must also be specified to make a
	//distinction between the standard BIP-0049 address schema (nested witness
	//pubkeys everywhere) and our own BIP-0049Plus address schema (nested pubkeys
	//externally, witness pubkeys internally).
	//
	//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)
	//
	//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)
	//
	//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 and key scope 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.
	//The master key fingerprint denotes the fingerprint of the root key
	//corresponding to the account public key (also known as the key with
	//derivation path m/). This may be required by some hardware wallets for
	//proper identification and signing.
	//
	//The address type can usually be inferred from the key's version, but may be
	//required for certain keys to map them into the proper scope.
	//
	//For BIP-0044 keys, an address type must be specified as we intend to not
	//support importing BIP-0044 keys into the wallet using the legacy
	//pay-to-pubkey-hash (P2PKH) scheme. A nested witness address type will force
	//the standard BIP-0049 derivation scheme, while a witness address type will
	//force the standard BIP-0084 derivation scheme.
	//
	//For BIP-0049 keys, an address type must also be specified to make a
	//distinction between the standard BIP-0049 address schema (nested witness
	//pubkeys everywhere) and our own BIP-0049Plus address schema (nested pubkeys
	//externally, witness pubkeys internally).
	//
	//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)
	//
	//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)
	//
	//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 WitnessType

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
)

func (WitnessType) Descriptor

func (WitnessType) Enum

func (x WitnessType) Enum() *WitnessType

func (WitnessType) EnumDescriptor deprecated

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

Deprecated: Use WitnessType.Descriptor instead.

func (WitnessType) Number

func (x WitnessType) Number() protoreflect.EnumNumber

func (WitnessType) String

func (x WitnessType) String() string

func (WitnessType) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL