walletrpc

package
v0.10.0-beta Latest Latest
Warning

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

 Go to latest Published: Apr 29, 2020 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

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",
}
View Source 
var 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,
}

Functions

func DisableLog 

func DisableLog()

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

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 AddrRequest 

type AddrRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AddrRequest) Descriptor 

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

func (*AddrRequest) ProtoMessage 

func (*AddrRequest) ProtoMessage()

func (*AddrRequest) Reset 

func (m *AddrRequest) Reset()

func (*AddrRequest) String 

func (m *AddrRequest) String() string

func (*AddrRequest) XXX_DiscardUnknown 

func (m *AddrRequest) XXX_DiscardUnknown()

func (*AddrRequest) XXX_Marshal 

func (m *AddrRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AddrRequest) XXX_Merge 

func (m *AddrRequest) XXX_Merge(src proto.Message)

func (*AddrRequest) XXX_Size 

func (m *AddrRequest) XXX_Size() int

func (*AddrRequest) XXX_Unmarshal 

func (m *AddrRequest) XXX_Unmarshal(b []byte) error

type AddrResponse 

type AddrResponse struct {
	//*
	//The address encoded using a bech32 format.
	Addr                 string   `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*AddrResponse) Descriptor 

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

func (*AddrResponse) GetAddr 

func (m *AddrResponse) GetAddr() string

func (*AddrResponse) ProtoMessage 

func (*AddrResponse) ProtoMessage()

func (*AddrResponse) Reset 

func (m *AddrResponse) Reset()

func (*AddrResponse) String 

func (m *AddrResponse) String() string

func (*AddrResponse) XXX_DiscardUnknown 

func (m *AddrResponse) XXX_DiscardUnknown()

func (*AddrResponse) XXX_Marshal 

func (m *AddrResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*AddrResponse) XXX_Merge 

func (m *AddrResponse) XXX_Merge(src proto.Message)

func (*AddrResponse) XXX_Size 

func (m *AddrResponse) XXX_Size() int

func (*AddrResponse) XXX_Unmarshal 

func (m *AddrResponse) XXX_Unmarshal(b []byte) error

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"`
	//
	//The fee rate, expressed in sat/byte, that should be used to spend the input
	//with.
	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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*BumpFeeRequest) Descriptor 

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

func (*BumpFeeRequest) GetForce 

func (m *BumpFeeRequest) GetForce() bool

func (*BumpFeeRequest) GetOutpoint 

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

func (*BumpFeeRequest) GetSatPerByte 

func (m *BumpFeeRequest) GetSatPerByte() uint32

func (*BumpFeeRequest) GetTargetConf 

func (m *BumpFeeRequest) GetTargetConf() uint32

func (*BumpFeeRequest) ProtoMessage 

func (*BumpFeeRequest) ProtoMessage()

func (*BumpFeeRequest) Reset 

func (m *BumpFeeRequest) Reset()

func (*BumpFeeRequest) String 

func (m *BumpFeeRequest) String() string

func (*BumpFeeRequest) XXX_DiscardUnknown 

func (m *BumpFeeRequest) XXX_DiscardUnknown()

func (*BumpFeeRequest) XXX_Marshal 

func (m *BumpFeeRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BumpFeeRequest) XXX_Merge 

func (m *BumpFeeRequest) XXX_Merge(src proto.Message)

func (*BumpFeeRequest) XXX_Size 

func (m *BumpFeeRequest) XXX_Size() int

func (*BumpFeeRequest) XXX_Unmarshal 

func (m *BumpFeeRequest) XXX_Unmarshal(b []byte) error

type BumpFeeResponse 

type BumpFeeResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*BumpFeeResponse) Descriptor 

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

func (*BumpFeeResponse) ProtoMessage 

func (*BumpFeeResponse) ProtoMessage()

func (*BumpFeeResponse) Reset 

func (m *BumpFeeResponse) Reset()

func (*BumpFeeResponse) String 

func (m *BumpFeeResponse) String() string

func (*BumpFeeResponse) XXX_DiscardUnknown 

func (m *BumpFeeResponse) XXX_DiscardUnknown()

func (*BumpFeeResponse) XXX_Marshal 

func (m *BumpFeeResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BumpFeeResponse) XXX_Merge 

func (m *BumpFeeResponse) XXX_Merge(src proto.Message)

func (*BumpFeeResponse) XXX_Size 

func (m *BumpFeeResponse) XXX_Size() int

func (*BumpFeeResponse) XXX_Unmarshal 

func (m *BumpFeeResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*EstimateFeeRequest) Descriptor 

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

func (*EstimateFeeRequest) GetConfTarget 

func (m *EstimateFeeRequest) GetConfTarget() int32

func (*EstimateFeeRequest) ProtoMessage 

func (*EstimateFeeRequest) ProtoMessage()

func (*EstimateFeeRequest) Reset 

func (m *EstimateFeeRequest) Reset()

func (*EstimateFeeRequest) String 

func (m *EstimateFeeRequest) String() string

func (*EstimateFeeRequest) XXX_DiscardUnknown 

func (m *EstimateFeeRequest) XXX_DiscardUnknown()

func (*EstimateFeeRequest) XXX_Marshal 

func (m *EstimateFeeRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EstimateFeeRequest) XXX_Merge 

func (m *EstimateFeeRequest) XXX_Merge(src proto.Message)

func (*EstimateFeeRequest) XXX_Size 

func (m *EstimateFeeRequest) XXX_Size() int

func (*EstimateFeeRequest) XXX_Unmarshal 

func (m *EstimateFeeRequest) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*EstimateFeeResponse) Descriptor 

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

func (*EstimateFeeResponse) GetSatPerKw 

func (m *EstimateFeeResponse) GetSatPerKw() int64

func (*EstimateFeeResponse) ProtoMessage 

func (*EstimateFeeResponse) ProtoMessage()

func (*EstimateFeeResponse) Reset 

func (m *EstimateFeeResponse) Reset()

func (*EstimateFeeResponse) String 

func (m *EstimateFeeResponse) String() string

func (*EstimateFeeResponse) XXX_DiscardUnknown 

func (m *EstimateFeeResponse) XXX_DiscardUnknown()

func (*EstimateFeeResponse) XXX_Marshal 

func (m *EstimateFeeResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*EstimateFeeResponse) XXX_Merge 

func (m *EstimateFeeResponse) XXX_Merge(src proto.Message)

func (*EstimateFeeResponse) XXX_Size 

func (m *EstimateFeeResponse) XXX_Size() int

func (*EstimateFeeResponse) XXX_Unmarshal 

func (m *EstimateFeeResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*KeyReq) Descriptor 

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

func (*KeyReq) GetKeyFamily 

func (m *KeyReq) GetKeyFamily() int32

func (*KeyReq) GetKeyFingerPrint 

func (m *KeyReq) GetKeyFingerPrint() int32

func (*KeyReq) ProtoMessage 

func (*KeyReq) ProtoMessage()

func (*KeyReq) Reset 

func (m *KeyReq) Reset()

func (*KeyReq) String 

func (m *KeyReq) String() string

func (*KeyReq) XXX_DiscardUnknown 

func (m *KeyReq) XXX_DiscardUnknown()

func (*KeyReq) XXX_Marshal 

func (m *KeyReq) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*KeyReq) XXX_Merge 

func (m *KeyReq) XXX_Merge(src proto.Message)

func (*KeyReq) XXX_Size 

func (m *KeyReq) XXX_Size() int

func (*KeyReq) XXX_Unmarshal 

func (m *KeyReq) XXX_Unmarshal(b []byte) error

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"`
	//
	//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.
	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"`
	// The requested fee rate, expressed in sat/byte, for this output.
	RequestedSatPerByte uint32 `protobuf:"varint,9,opt,name=requested_sat_per_byte,json=requestedSatPerByte,proto3" json:"requested_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,7,opt,name=force,proto3" json:"force,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*PendingSweep) Descriptor 

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

func (*PendingSweep) GetAmountSat 

func (m *PendingSweep) GetAmountSat() uint32

func (*PendingSweep) GetBroadcastAttempts 

func (m *PendingSweep) GetBroadcastAttempts() uint32

func (*PendingSweep) GetForce 

func (m *PendingSweep) GetForce() bool

func (*PendingSweep) GetNextBroadcastHeight 

func (m *PendingSweep) GetNextBroadcastHeight() uint32

func (*PendingSweep) GetOutpoint 

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

func (*PendingSweep) GetRequestedConfTarget 

func (m *PendingSweep) GetRequestedConfTarget() uint32

func (*PendingSweep) GetRequestedSatPerByte 

func (m *PendingSweep) GetRequestedSatPerByte() uint32

func (*PendingSweep) GetSatPerByte 

func (m *PendingSweep) GetSatPerByte() uint32

func (*PendingSweep) GetWitnessType 

func (m *PendingSweep) GetWitnessType() WitnessType

func (*PendingSweep) ProtoMessage 

func (*PendingSweep) ProtoMessage()

func (*PendingSweep) Reset 

func (m *PendingSweep) Reset()

func (*PendingSweep) String 

func (m *PendingSweep) String() string

func (*PendingSweep) XXX_DiscardUnknown 

func (m *PendingSweep) XXX_DiscardUnknown()

func (*PendingSweep) XXX_Marshal 

func (m *PendingSweep) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PendingSweep) XXX_Merge 

func (m *PendingSweep) XXX_Merge(src proto.Message)

func (*PendingSweep) XXX_Size 

func (m *PendingSweep) XXX_Size() int

func (*PendingSweep) XXX_Unmarshal 

func (m *PendingSweep) XXX_Unmarshal(b []byte) error

type PendingSweepsRequest 

type PendingSweepsRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*PendingSweepsRequest) Descriptor 

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

func (*PendingSweepsRequest) ProtoMessage 

func (*PendingSweepsRequest) ProtoMessage()

func (*PendingSweepsRequest) Reset 

func (m *PendingSweepsRequest) Reset()

func (*PendingSweepsRequest) String 

func (m *PendingSweepsRequest) String() string

func (*PendingSweepsRequest) XXX_DiscardUnknown 

func (m *PendingSweepsRequest) XXX_DiscardUnknown()

func (*PendingSweepsRequest) XXX_Marshal 

func (m *PendingSweepsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PendingSweepsRequest) XXX_Merge 

func (m *PendingSweepsRequest) XXX_Merge(src proto.Message)

func (*PendingSweepsRequest) XXX_Size 

func (m *PendingSweepsRequest) XXX_Size() int

func (*PendingSweepsRequest) XXX_Unmarshal 

func (m *PendingSweepsRequest) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*PendingSweepsResponse) Descriptor 

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

func (*PendingSweepsResponse) GetPendingSweeps 

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

func (*PendingSweepsResponse) ProtoMessage 

func (*PendingSweepsResponse) ProtoMessage()

func (*PendingSweepsResponse) Reset 

func (m *PendingSweepsResponse) Reset()

func (*PendingSweepsResponse) String 

func (m *PendingSweepsResponse) String() string

func (*PendingSweepsResponse) XXX_DiscardUnknown 

func (m *PendingSweepsResponse) XXX_DiscardUnknown()

func (*PendingSweepsResponse) XXX_Marshal 

func (m *PendingSweepsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PendingSweepsResponse) XXX_Merge 

func (m *PendingSweepsResponse) XXX_Merge(src proto.Message)

func (*PendingSweepsResponse) XXX_Size 

func (m *PendingSweepsResponse) XXX_Size() int

func (*PendingSweepsResponse) XXX_Unmarshal 

func (m *PendingSweepsResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*PublishResponse) Descriptor 

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

func (*PublishResponse) GetPublishError 

func (m *PublishResponse) GetPublishError() string

func (*PublishResponse) ProtoMessage 

func (*PublishResponse) ProtoMessage()

func (*PublishResponse) Reset 

func (m *PublishResponse) Reset()

func (*PublishResponse) String 

func (m *PublishResponse) String() string

func (*PublishResponse) XXX_DiscardUnknown 

func (m *PublishResponse) XXX_DiscardUnknown()

func (*PublishResponse) XXX_Marshal 

func (m *PublishResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*PublishResponse) XXX_Merge 

func (m *PublishResponse) XXX_Merge(src proto.Message)

func (*PublishResponse) XXX_Size 

func (m *PublishResponse) XXX_Size() int

func (*PublishResponse) XXX_Unmarshal 

func (m *PublishResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*SendOutputsRequest) Descriptor 

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

func (*SendOutputsRequest) GetOutputs 

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

func (*SendOutputsRequest) GetSatPerKw 

func (m *SendOutputsRequest) GetSatPerKw() int64

func (*SendOutputsRequest) ProtoMessage 

func (*SendOutputsRequest) ProtoMessage()

func (*SendOutputsRequest) Reset 

func (m *SendOutputsRequest) Reset()

func (*SendOutputsRequest) String 

func (m *SendOutputsRequest) String() string

func (*SendOutputsRequest) XXX_DiscardUnknown 

func (m *SendOutputsRequest) XXX_DiscardUnknown()

func (*SendOutputsRequest) XXX_Marshal 

func (m *SendOutputsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SendOutputsRequest) XXX_Merge 

func (m *SendOutputsRequest) XXX_Merge(src proto.Message)

func (*SendOutputsRequest) XXX_Size 

func (m *SendOutputsRequest) XXX_Size() int

func (*SendOutputsRequest) XXX_Unmarshal 

func (m *SendOutputsRequest) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*SendOutputsResponse) Descriptor 

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

func (*SendOutputsResponse) GetRawTx 

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

func (*SendOutputsResponse) ProtoMessage 

func (*SendOutputsResponse) ProtoMessage()

func (*SendOutputsResponse) Reset 

func (m *SendOutputsResponse) Reset()

func (*SendOutputsResponse) String 

func (m *SendOutputsResponse) String() string

func (*SendOutputsResponse) XXX_DiscardUnknown 

func (m *SendOutputsResponse) XXX_DiscardUnknown()

func (*SendOutputsResponse) XXX_Marshal 

func (m *SendOutputsResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SendOutputsResponse) XXX_Merge 

func (m *SendOutputsResponse) XXX_Merge(src proto.Message)

func (*SendOutputsResponse) XXX_Size 

func (m *SendOutputsResponse) XXX_Size() int

func (*SendOutputsResponse) XXX_Unmarshal 

func (m *SendOutputsResponse) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*Transaction) Descriptor 

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

func (*Transaction) GetTxHex 

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

func (*Transaction) ProtoMessage 

func (*Transaction) ProtoMessage()

func (*Transaction) Reset 

func (m *Transaction) Reset()

func (*Transaction) String 

func (m *Transaction) String() string

func (*Transaction) XXX_DiscardUnknown 

func (m *Transaction) XXX_DiscardUnknown()

func (*Transaction) XXX_Marshal 

func (m *Transaction) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Transaction) XXX_Merge 

func (m *Transaction) XXX_Merge(src proto.Message)

func (*Transaction) XXX_Size 

func (m *Transaction) XXX_Size() int

func (*Transaction) XXX_Unmarshal 

func (m *Transaction) XXX_Unmarshal(b []byte) error

type WalletKitClient 

type WalletKitClient interface {
	//*
	//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)
	//*
	//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)
}

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.ClientConn) WalletKitClient

type WalletKitServer 

type WalletKitServer interface {
	//*
	//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)
	//*
	//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)
}

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) EnumDescriptor 

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

func (WitnessType) String 

func (x WitnessType) String() string

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.