boltzrpc

package
v1.2.7 Latest Latest
Warning

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

 Go to latest Published: Apr 3, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

Package boltzrpc is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	SwapState_name = map[int32]string{
		0: "PENDING",
		1: "SUCCESSFUL",
		2: "ERROR",
		3: "SERVER_ERROR",
		4: "REFUNDED",
		5: "ABANDONED",
	}
	SwapState_value = map[string]int32{
		"PENDING":      0,
		"SUCCESSFUL":   1,
		"ERROR":        2,
		"SERVER_ERROR": 3,
		"REFUNDED":     4,
		"ABANDONED":    5,
	}
)

Enum value maps for SwapState.

View Source 
var Boltz_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "boltzrpc.Boltz",
	HandlerType: (*BoltzServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInfo",
			Handler:    _Boltz_GetInfo_Handler,
		},
		{
			MethodName: "GetServiceInfo",
			Handler:    _Boltz_GetServiceInfo_Handler,
		},
		{
			MethodName: "ListSwaps",
			Handler:    _Boltz_ListSwaps_Handler,
		},
		{
			MethodName: "GetSwapInfo",
			Handler:    _Boltz_GetSwapInfo_Handler,
		},
		{
			MethodName: "Deposit",
			Handler:    _Boltz_Deposit_Handler,
		},
		{
			MethodName: "CreateSwap",
			Handler:    _Boltz_CreateSwap_Handler,
		},
		{
			MethodName: "CreateChannel",
			Handler:    _Boltz_CreateChannel_Handler,
		},
		{
			MethodName: "CreateReverseSwap",
			Handler:    _Boltz_CreateReverseSwap_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "boltzrpc.proto",
}

Boltz_ServiceDesc is the grpc.ServiceDesc for Boltz service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_boltzrpc_proto protoreflect.FileDescriptor

Functions

func RegisterBoltzHandler added in v1.2.0 

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

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

func RegisterBoltzHandlerClient added in v1.2.0 

func RegisterBoltzHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BoltzClient) error

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

func RegisterBoltzHandlerFromEndpoint added in v1.2.0 

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

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

func RegisterBoltzHandlerServer added in v1.2.0 

func RegisterBoltzHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BoltzServer) error

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

func RegisterBoltzServer 

func RegisterBoltzServer(s grpc.ServiceRegistrar, srv BoltzServer)

Types

type BoltzClient 

type BoltzClient interface {
	//
	//Gets general information about the daemon like the chain of the LND node it is connected to
	//and the IDs of pending swaps.
	GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
	//
	//Fetches the latest limits and fees from the Boltz backend API it is connected to.
	GetServiceInfo(ctx context.Context, in *GetServiceInfoRequest, opts ...grpc.CallOption) (*GetServiceInfoResponse, error)
	//
	//Returns a list of all swaps, reverse swaps and channel creations in the database.
	ListSwaps(ctx context.Context, in *ListSwapsRequest, opts ...grpc.CallOption) (*ListSwapsResponse, error)
	//
	//Gets all available information about a swap from the database.
	GetSwapInfo(ctx context.Context, in *GetSwapInfoRequest, opts ...grpc.CallOption) (*GetSwapInfoResponse, error)
	//
	//This is a wrapper for channel creation swaps. The daemon only returns the ID, timeout block height and lockup address.
	//The Boltz backend takes care of the rest. When an amount of onchain coins that is in the limits is sent to the address
	//before the timeout block height, the daemon creates a new lightning invoice, sends it to the Boltz backend which
	//will try to pay it and if that is not possible, create a new channel to make the swap succeed.
	Deposit(ctx context.Context, in *DepositRequest, opts ...grpc.CallOption) (*DepositResponse, error)
	//
	//Creates a new swap from onchain to lightning.
	CreateSwap(ctx context.Context, in *CreateSwapRequest, opts ...grpc.CallOption) (*CreateSwapResponse, error)
	//
	//Create a new swap from onchain to a new lightning channel. The daemon will only accept the invoice payment if the HTLCs
	//is coming trough a new channel channel opened by Boltz.
	CreateChannel(ctx context.Context, in *CreateChannelRequest, opts ...grpc.CallOption) (*CreateSwapResponse, error)
	//
	//Creates a new reverse swap from lightning to onchain. If `accept_zero_conf` is set to true in the request, the daemon
	//will not wait until the lockup transaction from Boltz is confirmed in a block, but will claim it instantly.
	CreateReverseSwap(ctx context.Context, in *CreateReverseSwapRequest, opts ...grpc.CallOption) (*CreateReverseSwapResponse, error)
}

BoltzClient is the client API for Boltz service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewBoltzClient 

func NewBoltzClient(cc grpc.ClientConnInterface) BoltzClient

type BoltzServer 

type BoltzServer interface {
	//
	//Gets general information about the daemon like the chain of the LND node it is connected to
	//and the IDs of pending swaps.
	GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
	//
	//Fetches the latest limits and fees from the Boltz backend API it is connected to.
	GetServiceInfo(context.Context, *GetServiceInfoRequest) (*GetServiceInfoResponse, error)
	//
	//Returns a list of all swaps, reverse swaps and channel creations in the database.
	ListSwaps(context.Context, *ListSwapsRequest) (*ListSwapsResponse, error)
	//
	//Gets all available information about a swap from the database.
	GetSwapInfo(context.Context, *GetSwapInfoRequest) (*GetSwapInfoResponse, error)
	//
	//This is a wrapper for channel creation swaps. The daemon only returns the ID, timeout block height and lockup address.
	//The Boltz backend takes care of the rest. When an amount of onchain coins that is in the limits is sent to the address
	//before the timeout block height, the daemon creates a new lightning invoice, sends it to the Boltz backend which
	//will try to pay it and if that is not possible, create a new channel to make the swap succeed.
	Deposit(context.Context, *DepositRequest) (*DepositResponse, error)
	//
	//Creates a new swap from onchain to lightning.
	CreateSwap(context.Context, *CreateSwapRequest) (*CreateSwapResponse, error)
	//
	//Create a new swap from onchain to a new lightning channel. The daemon will only accept the invoice payment if the HTLCs
	//is coming trough a new channel channel opened by Boltz.
	CreateChannel(context.Context, *CreateChannelRequest) (*CreateSwapResponse, error)
	//
	//Creates a new reverse swap from lightning to onchain. If `accept_zero_conf` is set to true in the request, the daemon
	//will not wait until the lockup transaction from Boltz is confirmed in a block, but will claim it instantly.
	CreateReverseSwap(context.Context, *CreateReverseSwapRequest) (*CreateReverseSwapResponse, error)
	// contains filtered or unexported methods
}

BoltzServer is the server API for Boltz service. All implementations must embed UnimplementedBoltzServer for forward compatibility

type ChannelCreationInfo 

type ChannelCreationInfo struct {

	// ID of the swap to which this channel channel belongs
	SwapId                 string `protobuf:"bytes,1,opt,name=swap_id,json=swapId,proto3" json:"swap_id,omitempty"`
	Status                 string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	InboundLiquidity       uint32 `protobuf:"varint,3,opt,name=inbound_liquidity,json=inboundLiquidity,proto3" json:"inbound_liquidity,omitempty"`
	Private                bool   `protobuf:"varint,4,opt,name=private,proto3" json:"private,omitempty"`
	FundingTransactionId   string `protobuf:"bytes,5,opt,name=funding_transaction_id,json=fundingTransactionId,proto3" json:"funding_transaction_id,omitempty"`
	FundingTransactionVout uint32 `` /* 130-byte string literal not displayed */
	// contains filtered or unexported fields
}

Channel creations are an optional extension to a submarine swap in the data types of boltz-lnd.

func (*ChannelCreationInfo) Descriptor deprecated 

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

Deprecated: Use ChannelCreationInfo.ProtoReflect.Descriptor instead.

func (*ChannelCreationInfo) GetFundingTransactionId 

func (x *ChannelCreationInfo) GetFundingTransactionId() string

func (*ChannelCreationInfo) GetFundingTransactionVout 

func (x *ChannelCreationInfo) GetFundingTransactionVout() uint32

func (*ChannelCreationInfo) GetInboundLiquidity 

func (x *ChannelCreationInfo) GetInboundLiquidity() uint32

func (*ChannelCreationInfo) GetPrivate 

func (x *ChannelCreationInfo) GetPrivate() bool

func (*ChannelCreationInfo) GetStatus 

func (x *ChannelCreationInfo) GetStatus() string

func (*ChannelCreationInfo) GetSwapId 

func (x *ChannelCreationInfo) GetSwapId() string

func (*ChannelCreationInfo) ProtoMessage 

func (*ChannelCreationInfo) ProtoMessage()

func (*ChannelCreationInfo) ProtoReflect added in v1.2.0 

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

func (*ChannelCreationInfo) Reset 

func (x *ChannelCreationInfo) Reset()

func (*ChannelCreationInfo) String 

func (x *ChannelCreationInfo) String() string

type CombinedChannelSwapInfo 

type CombinedChannelSwapInfo struct {
	Swap            *SwapInfo            `protobuf:"bytes,1,opt,name=swap,proto3" json:"swap,omitempty"`
	ChannelCreation *ChannelCreationInfo `protobuf:"bytes,2,opt,name=channel_creation,json=channelCreation,proto3" json:"channel_creation,omitempty"`
	// contains filtered or unexported fields
}

func (*CombinedChannelSwapInfo) Descriptor deprecated 

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

Deprecated: Use CombinedChannelSwapInfo.ProtoReflect.Descriptor instead.

func (*CombinedChannelSwapInfo) GetChannelCreation 

func (x *CombinedChannelSwapInfo) GetChannelCreation() *ChannelCreationInfo

func (*CombinedChannelSwapInfo) GetSwap 

func (x *CombinedChannelSwapInfo) GetSwap() *SwapInfo

func (*CombinedChannelSwapInfo) ProtoMessage 

func (*CombinedChannelSwapInfo) ProtoMessage()

func (*CombinedChannelSwapInfo) ProtoReflect added in v1.2.0 

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

func (*CombinedChannelSwapInfo) Reset 

func (x *CombinedChannelSwapInfo) Reset()

func (*CombinedChannelSwapInfo) String 

func (x *CombinedChannelSwapInfo) String() string

type CreateChannelRequest 

type CreateChannelRequest struct {
	Amount int64 `protobuf:"varint,1,opt,name=amount,proto3" json:"amount,omitempty"`
	//
	//Percentage of inbound liquidity the channel that is opened should have.
	//25 by default.
	InboundLiquidity uint32 `protobuf:"varint,2,opt,name=inbound_liquidity,json=inboundLiquidity,proto3" json:"inbound_liquidity,omitempty"`
	Private          bool   `protobuf:"varint,3,opt,name=private,proto3" json:"private,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateChannelRequest) Descriptor deprecated 

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

Deprecated: Use CreateChannelRequest.ProtoReflect.Descriptor instead.

func (*CreateChannelRequest) GetAmount 

func (x *CreateChannelRequest) GetAmount() int64

func (*CreateChannelRequest) GetInboundLiquidity 

func (x *CreateChannelRequest) GetInboundLiquidity() uint32

func (*CreateChannelRequest) GetPrivate 

func (x *CreateChannelRequest) GetPrivate() bool

func (*CreateChannelRequest) ProtoMessage 

func (*CreateChannelRequest) ProtoMessage()

func (*CreateChannelRequest) ProtoReflect added in v1.2.0 

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

func (*CreateChannelRequest) Reset 

func (x *CreateChannelRequest) Reset()

func (*CreateChannelRequest) String 

func (x *CreateChannelRequest) String() string

type CreateReverseSwapRequest 

type CreateReverseSwapRequest struct {
	Amount int64 `protobuf:"varint,1,opt,name=amount,proto3" json:"amount,omitempty"`
	// If no value is set, the daemon will query a new P2WKH address from LND
	Address        string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	AcceptZeroConf bool   `protobuf:"varint,3,opt,name=accept_zero_conf,json=acceptZeroConf,proto3" json:"accept_zero_conf,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateReverseSwapRequest) Descriptor deprecated 

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

Deprecated: Use CreateReverseSwapRequest.ProtoReflect.Descriptor instead.

func (*CreateReverseSwapRequest) GetAcceptZeroConf 

func (x *CreateReverseSwapRequest) GetAcceptZeroConf() bool

func (*CreateReverseSwapRequest) GetAddress 

func (x *CreateReverseSwapRequest) GetAddress() string

func (*CreateReverseSwapRequest) GetAmount 

func (x *CreateReverseSwapRequest) GetAmount() int64

func (*CreateReverseSwapRequest) ProtoMessage 

func (*CreateReverseSwapRequest) ProtoMessage()

func (*CreateReverseSwapRequest) ProtoReflect added in v1.2.0 

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

func (*CreateReverseSwapRequest) Reset 

func (x *CreateReverseSwapRequest) Reset()

func (*CreateReverseSwapRequest) String 

func (x *CreateReverseSwapRequest) String() string

type CreateReverseSwapResponse 

type CreateReverseSwapResponse struct {
	Id                 string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	LockupAddress      string `protobuf:"bytes,2,opt,name=lockup_address,json=lockupAddress,proto3" json:"lockup_address,omitempty"`
	RoutingFeeMilliSat uint32 `protobuf:"varint,3,opt,name=routing_fee_milli_sat,json=routingFeeMilliSat,proto3" json:"routing_fee_milli_sat,omitempty"`
	// Only populated when 0-conf is accepted
	ClaimTransactionId string `protobuf:"bytes,4,opt,name=claim_transaction_id,json=claimTransactionId,proto3" json:"claim_transaction_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateReverseSwapResponse) Descriptor deprecated 

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

Deprecated: Use CreateReverseSwapResponse.ProtoReflect.Descriptor instead.

func (*CreateReverseSwapResponse) GetClaimTransactionId 

func (x *CreateReverseSwapResponse) GetClaimTransactionId() string

func (*CreateReverseSwapResponse) GetId 

func (x *CreateReverseSwapResponse) GetId() string

func (*CreateReverseSwapResponse) GetLockupAddress 

func (x *CreateReverseSwapResponse) GetLockupAddress() string

func (*CreateReverseSwapResponse) GetRoutingFeeMilliSat 

func (x *CreateReverseSwapResponse) GetRoutingFeeMilliSat() uint32

func (*CreateReverseSwapResponse) ProtoMessage 

func (*CreateReverseSwapResponse) ProtoMessage()

func (*CreateReverseSwapResponse) ProtoReflect added in v1.2.0 

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

func (*CreateReverseSwapResponse) Reset 

func (x *CreateReverseSwapResponse) Reset()

func (*CreateReverseSwapResponse) String 

func (x *CreateReverseSwapResponse) String() string

type CreateSwapRequest 

type CreateSwapRequest struct {
	Amount int64 `protobuf:"varint,1,opt,name=amount,proto3" json:"amount,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSwapRequest) Descriptor deprecated 

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

Deprecated: Use CreateSwapRequest.ProtoReflect.Descriptor instead.

func (*CreateSwapRequest) GetAmount 

func (x *CreateSwapRequest) GetAmount() int64

func (*CreateSwapRequest) ProtoMessage 

func (*CreateSwapRequest) ProtoMessage()

func (*CreateSwapRequest) ProtoReflect added in v1.2.0 

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

func (*CreateSwapRequest) Reset 

func (x *CreateSwapRequest) Reset()

func (*CreateSwapRequest) String 

func (x *CreateSwapRequest) String() string

type CreateSwapResponse 

type CreateSwapResponse struct {
	Id             string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Address        string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	ExpectedAmount int64  `protobuf:"varint,3,opt,name=expected_amount,json=expectedAmount,proto3" json:"expected_amount,omitempty"`
	Bip21          string `protobuf:"bytes,4,opt,name=bip21,proto3" json:"bip21,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSwapResponse) Descriptor deprecated 

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

Deprecated: Use CreateSwapResponse.ProtoReflect.Descriptor instead.

func (*CreateSwapResponse) GetAddress 

func (x *CreateSwapResponse) GetAddress() string

func (*CreateSwapResponse) GetBip21 

func (x *CreateSwapResponse) GetBip21() string

func (*CreateSwapResponse) GetExpectedAmount 

func (x *CreateSwapResponse) GetExpectedAmount() int64

func (*CreateSwapResponse) GetId 

func (x *CreateSwapResponse) GetId() string

func (*CreateSwapResponse) ProtoMessage 

func (*CreateSwapResponse) ProtoMessage()

func (*CreateSwapResponse) ProtoReflect added in v1.2.0 

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

func (*CreateSwapResponse) Reset 

func (x *CreateSwapResponse) Reset()

func (*CreateSwapResponse) String 

func (x *CreateSwapResponse) String() string

type DepositRequest 

type DepositRequest struct {

	//
	//Percentage of inbound liquidity the channel that is opened in case the invoice cannot be paid should have.
	//25 by default.
	InboundLiquidity uint32 `protobuf:"varint,1,opt,name=inbound_liquidity,json=inboundLiquidity,proto3" json:"inbound_liquidity,omitempty"`
	// contains filtered or unexported fields
}

func (*DepositRequest) Descriptor deprecated 

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

Deprecated: Use DepositRequest.ProtoReflect.Descriptor instead.

func (*DepositRequest) GetInboundLiquidity 

func (x *DepositRequest) GetInboundLiquidity() uint32

func (*DepositRequest) ProtoMessage 

func (*DepositRequest) ProtoMessage()

func (*DepositRequest) ProtoReflect added in v1.2.0 

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

func (*DepositRequest) Reset 

func (x *DepositRequest) Reset()

func (*DepositRequest) String 

func (x *DepositRequest) String() string

type DepositResponse 

type DepositResponse struct {
	Id                 string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Address            string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	TimeoutBlockHeight uint32 `protobuf:"varint,3,opt,name=timeout_block_height,json=timeoutBlockHeight,proto3" json:"timeout_block_height,omitempty"`
	// contains filtered or unexported fields
}

func (*DepositResponse) Descriptor deprecated 

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

Deprecated: Use DepositResponse.ProtoReflect.Descriptor instead.

func (*DepositResponse) GetAddress 

func (x *DepositResponse) GetAddress() string

func (*DepositResponse) GetId added in v1.1.2 

func (x *DepositResponse) GetId() string

func (*DepositResponse) GetTimeoutBlockHeight 

func (x *DepositResponse) GetTimeoutBlockHeight() uint32

func (*DepositResponse) ProtoMessage 

func (*DepositResponse) ProtoMessage()

func (*DepositResponse) ProtoReflect added in v1.2.0 

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

func (*DepositResponse) Reset 

func (x *DepositResponse) Reset()

func (*DepositResponse) String 

func (x *DepositResponse) String() string

type Fees 

type Fees struct {
	Percentage float32    `protobuf:"fixed32,1,opt,name=percentage,proto3" json:"percentage,omitempty"`
	Miner      *MinerFees `protobuf:"bytes,2,opt,name=miner,proto3" json:"miner,omitempty"`
	// contains filtered or unexported fields
}

func (*Fees) Descriptor deprecated 

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

Deprecated: Use Fees.ProtoReflect.Descriptor instead.

func (*Fees) GetMiner 

func (x *Fees) GetMiner() *MinerFees

func (*Fees) GetPercentage 

func (x *Fees) GetPercentage() float32

func (*Fees) ProtoMessage 

func (*Fees) ProtoMessage()

func (*Fees) ProtoReflect added in v1.2.0 

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

func (*Fees) Reset 

func (x *Fees) Reset()

func (*Fees) String 

func (x *Fees) String() string

type GetInfoRequest 

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

func (*GetInfoRequest) Descriptor deprecated 

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

Deprecated: Use GetInfoRequest.ProtoReflect.Descriptor instead.

func (*GetInfoRequest) ProtoMessage 

func (*GetInfoRequest) ProtoMessage()

func (*GetInfoRequest) ProtoReflect added in v1.2.0 

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

func (*GetInfoRequest) Reset 

func (x *GetInfoRequest) Reset()

func (*GetInfoRequest) String 

func (x *GetInfoRequest) String() string

type GetInfoResponse 

type GetInfoResponse struct {
	Symbol              string   `protobuf:"bytes,1,opt,name=symbol,proto3" json:"symbol,omitempty"`
	Network             string   `protobuf:"bytes,2,opt,name=network,proto3" json:"network,omitempty"`
	LndPubkey           string   `protobuf:"bytes,3,opt,name=lnd_pubkey,json=lndPubkey,proto3" json:"lnd_pubkey,omitempty"`
	BlockHeight         uint32   `protobuf:"varint,4,opt,name=block_height,json=blockHeight,proto3" json:"block_height,omitempty"`
	PendingSwaps        []string `protobuf:"bytes,5,rep,name=pending_swaps,json=pendingSwaps,proto3" json:"pending_swaps,omitempty"`
	PendingReverseSwaps []string `protobuf:"bytes,6,rep,name=pending_reverse_swaps,json=pendingReverseSwaps,proto3" json:"pending_reverse_swaps,omitempty"`
	// contains filtered or unexported fields
}

func (*GetInfoResponse) Descriptor deprecated 

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

Deprecated: Use GetInfoResponse.ProtoReflect.Descriptor instead.

func (*GetInfoResponse) GetBlockHeight 

func (x *GetInfoResponse) GetBlockHeight() uint32

func (*GetInfoResponse) GetLndPubkey 

func (x *GetInfoResponse) GetLndPubkey() string

func (*GetInfoResponse) GetNetwork added in v1.2.0 

func (x *GetInfoResponse) GetNetwork() string

func (*GetInfoResponse) GetPendingReverseSwaps 

func (x *GetInfoResponse) GetPendingReverseSwaps() []string

func (*GetInfoResponse) GetPendingSwaps 

func (x *GetInfoResponse) GetPendingSwaps() []string

func (*GetInfoResponse) GetSymbol 

func (x *GetInfoResponse) GetSymbol() string

func (*GetInfoResponse) ProtoMessage 

func (*GetInfoResponse) ProtoMessage()

func (*GetInfoResponse) ProtoReflect added in v1.2.0 

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

func (*GetInfoResponse) Reset 

func (x *GetInfoResponse) Reset()

func (*GetInfoResponse) String 

func (x *GetInfoResponse) String() string

type GetServiceInfoRequest 

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

func (*GetServiceInfoRequest) Descriptor deprecated 

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

Deprecated: Use GetServiceInfoRequest.ProtoReflect.Descriptor instead.

func (*GetServiceInfoRequest) ProtoMessage 

func (*GetServiceInfoRequest) ProtoMessage()

func (*GetServiceInfoRequest) ProtoReflect added in v1.2.0 

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

func (*GetServiceInfoRequest) Reset 

func (x *GetServiceInfoRequest) Reset()

func (*GetServiceInfoRequest) String 

func (x *GetServiceInfoRequest) String() string

type GetServiceInfoResponse 

type GetServiceInfoResponse struct {
	Fees   *Fees   `protobuf:"bytes,1,opt,name=fees,proto3" json:"fees,omitempty"`
	Limits *Limits `protobuf:"bytes,2,opt,name=limits,proto3" json:"limits,omitempty"`
	// contains filtered or unexported fields
}

func (*GetServiceInfoResponse) Descriptor deprecated 

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

Deprecated: Use GetServiceInfoResponse.ProtoReflect.Descriptor instead.

func (*GetServiceInfoResponse) GetFees 

func (x *GetServiceInfoResponse) GetFees() *Fees

func (*GetServiceInfoResponse) GetLimits 

func (x *GetServiceInfoResponse) GetLimits() *Limits

func (*GetServiceInfoResponse) ProtoMessage 

func (*GetServiceInfoResponse) ProtoMessage()

func (*GetServiceInfoResponse) ProtoReflect added in v1.2.0 

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

func (*GetServiceInfoResponse) Reset 

func (x *GetServiceInfoResponse) Reset()

func (*GetServiceInfoResponse) String 

func (x *GetServiceInfoResponse) String() string

type GetSwapInfoRequest 

type GetSwapInfoRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSwapInfoRequest) Descriptor deprecated 

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

Deprecated: Use GetSwapInfoRequest.ProtoReflect.Descriptor instead.

func (*GetSwapInfoRequest) GetId 

func (x *GetSwapInfoRequest) GetId() string

func (*GetSwapInfoRequest) ProtoMessage 

func (*GetSwapInfoRequest) ProtoMessage()

func (*GetSwapInfoRequest) ProtoReflect added in v1.2.0 

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

func (*GetSwapInfoRequest) Reset 

func (x *GetSwapInfoRequest) Reset()

func (*GetSwapInfoRequest) String 

func (x *GetSwapInfoRequest) String() string

type GetSwapInfoResponse 

type GetSwapInfoResponse struct {
	Swap            *SwapInfo            `protobuf:"bytes,1,opt,name=swap,proto3" json:"swap,omitempty"`
	ChannelCreation *ChannelCreationInfo `protobuf:"bytes,2,opt,name=channel_creation,json=channelCreation,proto3" json:"channel_creation,omitempty"`
	ReverseSwap     *ReverseSwapInfo     `protobuf:"bytes,3,opt,name=reverse_swap,json=reverseSwap,proto3" json:"reverse_swap,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSwapInfoResponse) Descriptor deprecated 

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

Deprecated: Use GetSwapInfoResponse.ProtoReflect.Descriptor instead.

func (*GetSwapInfoResponse) GetChannelCreation 

func (x *GetSwapInfoResponse) GetChannelCreation() *ChannelCreationInfo

func (*GetSwapInfoResponse) GetReverseSwap 

func (x *GetSwapInfoResponse) GetReverseSwap() *ReverseSwapInfo

func (*GetSwapInfoResponse) GetSwap 

func (x *GetSwapInfoResponse) GetSwap() *SwapInfo

func (*GetSwapInfoResponse) ProtoMessage 

func (*GetSwapInfoResponse) ProtoMessage()

func (*GetSwapInfoResponse) ProtoReflect added in v1.2.0 

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

func (*GetSwapInfoResponse) Reset 

func (x *GetSwapInfoResponse) Reset()

func (*GetSwapInfoResponse) String 

func (x *GetSwapInfoResponse) String() string

type Limits 

type Limits struct {
	Minimal int64 `protobuf:"varint,1,opt,name=minimal,proto3" json:"minimal,omitempty"`
	Maximal int64 `protobuf:"varint,2,opt,name=maximal,proto3" json:"maximal,omitempty"`
	// contains filtered or unexported fields
}

func (*Limits) Descriptor deprecated 

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

Deprecated: Use Limits.ProtoReflect.Descriptor instead.

func (*Limits) GetMaximal 

func (x *Limits) GetMaximal() int64

func (*Limits) GetMinimal 

func (x *Limits) GetMinimal() int64

func (*Limits) ProtoMessage 

func (*Limits) ProtoMessage()

func (*Limits) ProtoReflect added in v1.2.0 

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

func (*Limits) Reset 

func (x *Limits) Reset()

func (*Limits) String 

func (x *Limits) String() string

type ListSwapsRequest 

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

func (*ListSwapsRequest) Descriptor deprecated 

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

Deprecated: Use ListSwapsRequest.ProtoReflect.Descriptor instead.

func (*ListSwapsRequest) ProtoMessage 

func (*ListSwapsRequest) ProtoMessage()

func (*ListSwapsRequest) ProtoReflect added in v1.2.0 

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

func (*ListSwapsRequest) Reset 

func (x *ListSwapsRequest) Reset()

func (*ListSwapsRequest) String 

func (x *ListSwapsRequest) String() string

type ListSwapsResponse 

type ListSwapsResponse struct {
	Swaps            []*SwapInfo                `protobuf:"bytes,1,rep,name=swaps,proto3" json:"swaps,omitempty"`
	ChannelCreations []*CombinedChannelSwapInfo `protobuf:"bytes,2,rep,name=channel_creations,json=channelCreations,proto3" json:"channel_creations,omitempty"`
	ReverseSwaps     []*ReverseSwapInfo         `protobuf:"bytes,3,rep,name=reverse_swaps,json=reverseSwaps,proto3" json:"reverse_swaps,omitempty"`
	// contains filtered or unexported fields
}

func (*ListSwapsResponse) Descriptor deprecated 

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

Deprecated: Use ListSwapsResponse.ProtoReflect.Descriptor instead.

func (*ListSwapsResponse) GetChannelCreations 

func (x *ListSwapsResponse) GetChannelCreations() []*CombinedChannelSwapInfo

func (*ListSwapsResponse) GetReverseSwaps 

func (x *ListSwapsResponse) GetReverseSwaps() []*ReverseSwapInfo

func (*ListSwapsResponse) GetSwaps 

func (x *ListSwapsResponse) GetSwaps() []*SwapInfo

func (*ListSwapsResponse) ProtoMessage 

func (*ListSwapsResponse) ProtoMessage()

func (*ListSwapsResponse) ProtoReflect added in v1.2.0 

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

func (*ListSwapsResponse) Reset 

func (x *ListSwapsResponse) Reset()

func (*ListSwapsResponse) String 

func (x *ListSwapsResponse) String() string

type MinerFees 

type MinerFees struct {
	Normal  uint32 `protobuf:"varint,1,opt,name=normal,proto3" json:"normal,omitempty"`
	Reverse uint32 `protobuf:"varint,2,opt,name=reverse,proto3" json:"reverse,omitempty"`
	// contains filtered or unexported fields
}

func (*MinerFees) Descriptor deprecated 

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

Deprecated: Use MinerFees.ProtoReflect.Descriptor instead.

func (*MinerFees) GetNormal 

func (x *MinerFees) GetNormal() uint32

func (*MinerFees) GetReverse 

func (x *MinerFees) GetReverse() uint32

func (*MinerFees) ProtoMessage 

func (*MinerFees) ProtoMessage()

func (*MinerFees) ProtoReflect added in v1.2.0 

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

func (*MinerFees) Reset 

func (x *MinerFees) Reset()

func (*MinerFees) String 

func (x *MinerFees) String() string

type ReverseSwapInfo 

type ReverseSwapInfo struct {
	Id    string    `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	State SwapState `protobuf:"varint,2,opt,name=state,proto3,enum=boltzrpc.SwapState" json:"state,omitempty"`
	Error string    `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// Latest status message of the Boltz backend
	Status              string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	PrivateKey          string `protobuf:"bytes,5,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	Preimage            string `protobuf:"bytes,6,opt,name=preimage,proto3" json:"preimage,omitempty"`
	RedeemScript        string `protobuf:"bytes,7,opt,name=redeem_script,json=redeemScript,proto3" json:"redeem_script,omitempty"`
	Invoice             string `protobuf:"bytes,8,opt,name=invoice,proto3" json:"invoice,omitempty"`
	ClaimAddress        string `protobuf:"bytes,9,opt,name=claim_address,json=claimAddress,proto3" json:"claim_address,omitempty"`
	OnchainAmount       int64  `protobuf:"varint,10,opt,name=onchain_amount,json=onchainAmount,proto3" json:"onchain_amount,omitempty"`
	TimeoutBlockHeight  uint32 `protobuf:"varint,11,opt,name=timeout_block_height,json=timeoutBlockHeight,proto3" json:"timeout_block_height,omitempty"`
	LockupTransactionId string `protobuf:"bytes,12,opt,name=lockup_transaction_id,json=lockupTransactionId,proto3" json:"lockup_transaction_id,omitempty"`
	ClaimTransactionId  string `protobuf:"bytes,13,opt,name=claim_transaction_id,json=claimTransactionId,proto3" json:"claim_transaction_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ReverseSwapInfo) Descriptor deprecated 

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

Deprecated: Use ReverseSwapInfo.ProtoReflect.Descriptor instead.

func (*ReverseSwapInfo) GetClaimAddress 

func (x *ReverseSwapInfo) GetClaimAddress() string

func (*ReverseSwapInfo) GetClaimTransactionId 

func (x *ReverseSwapInfo) GetClaimTransactionId() string

func (*ReverseSwapInfo) GetError added in v1.2.3 

func (x *ReverseSwapInfo) GetError() string

func (*ReverseSwapInfo) GetId 

func (x *ReverseSwapInfo) GetId() string

func (*ReverseSwapInfo) GetInvoice 

func (x *ReverseSwapInfo) GetInvoice() string

func (*ReverseSwapInfo) GetLockupTransactionId 

func (x *ReverseSwapInfo) GetLockupTransactionId() string

func (*ReverseSwapInfo) GetOnchainAmount 

func (x *ReverseSwapInfo) GetOnchainAmount() int64

func (*ReverseSwapInfo) GetPreimage 

func (x *ReverseSwapInfo) GetPreimage() string

func (*ReverseSwapInfo) GetPrivateKey 

func (x *ReverseSwapInfo) GetPrivateKey() string

func (*ReverseSwapInfo) GetRedeemScript 

func (x *ReverseSwapInfo) GetRedeemScript() string

func (*ReverseSwapInfo) GetState added in v1.2.3 

func (x *ReverseSwapInfo) GetState() SwapState

func (*ReverseSwapInfo) GetStatus 

func (x *ReverseSwapInfo) GetStatus() string

func (*ReverseSwapInfo) GetTimeoutBlockHeight 

func (x *ReverseSwapInfo) GetTimeoutBlockHeight() uint32

func (*ReverseSwapInfo) ProtoMessage 

func (*ReverseSwapInfo) ProtoMessage()

func (*ReverseSwapInfo) ProtoReflect added in v1.2.0 

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

func (*ReverseSwapInfo) Reset 

func (x *ReverseSwapInfo) Reset()

func (*ReverseSwapInfo) String 

func (x *ReverseSwapInfo) String() string

type SwapInfo 

type SwapInfo struct {
	Id    string    `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	State SwapState `protobuf:"varint,2,opt,name=state,proto3,enum=boltzrpc.SwapState" json:"state,omitempty"`
	Error string    `protobuf:"bytes,3,opt,name=error,proto3" json:"error,omitempty"`
	// Latest status message of the Boltz backend
	Status              string `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"`
	PrivateKey          string `protobuf:"bytes,5,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	Preimage            string `protobuf:"bytes,6,opt,name=preimage,proto3" json:"preimage,omitempty"`
	RedeemScript        string `protobuf:"bytes,7,opt,name=redeem_script,json=redeemScript,proto3" json:"redeem_script,omitempty"`
	Invoice             string `protobuf:"bytes,8,opt,name=invoice,proto3" json:"invoice,omitempty"`
	LockupAddress       string `protobuf:"bytes,9,opt,name=lockup_address,json=lockupAddress,proto3" json:"lockup_address,omitempty"`
	ExpectedAmount      int64  `protobuf:"varint,10,opt,name=expected_amount,json=expectedAmount,proto3" json:"expected_amount,omitempty"`
	TimeoutBlockHeight  uint32 `protobuf:"varint,11,opt,name=timeout_block_height,json=timeoutBlockHeight,proto3" json:"timeout_block_height,omitempty"`
	LockupTransactionId string `protobuf:"bytes,12,opt,name=lockup_transaction_id,json=lockupTransactionId,proto3" json:"lockup_transaction_id,omitempty"`
	//
	//If the swap times out or fails for some other reason, the damon will automatically refund the coins sent to the
	//`lockup_address` back to the LND wallet and save the refund transaction id to the database.
	RefundTransactionId string `protobuf:"bytes,13,opt,name=refund_transaction_id,json=refundTransactionId,proto3" json:"refund_transaction_id,omitempty"`
	// contains filtered or unexported fields
}

func (*SwapInfo) Descriptor deprecated 

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

Deprecated: Use SwapInfo.ProtoReflect.Descriptor instead.

func (*SwapInfo) GetError added in v1.2.3 

func (x *SwapInfo) GetError() string

func (*SwapInfo) GetExpectedAmount 

func (x *SwapInfo) GetExpectedAmount() int64

func (*SwapInfo) GetId 

func (x *SwapInfo) GetId() string

func (*SwapInfo) GetInvoice 

func (x *SwapInfo) GetInvoice() string

func (*SwapInfo) GetLockupAddress 

func (x *SwapInfo) GetLockupAddress() string

func (*SwapInfo) GetLockupTransactionId 

func (x *SwapInfo) GetLockupTransactionId() string

func (*SwapInfo) GetPreimage 

func (x *SwapInfo) GetPreimage() string

func (*SwapInfo) GetPrivateKey 

func (x *SwapInfo) GetPrivateKey() string

func (*SwapInfo) GetRedeemScript 

func (x *SwapInfo) GetRedeemScript() string

func (*SwapInfo) GetRefundTransactionId 

func (x *SwapInfo) GetRefundTransactionId() string

func (*SwapInfo) GetState added in v1.2.3 

func (x *SwapInfo) GetState() SwapState

func (*SwapInfo) GetStatus 

func (x *SwapInfo) GetStatus() string

func (*SwapInfo) GetTimeoutBlockHeight 

func (x *SwapInfo) GetTimeoutBlockHeight() uint32

func (*SwapInfo) ProtoMessage 

func (*SwapInfo) ProtoMessage()

func (*SwapInfo) ProtoReflect added in v1.2.0 

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

func (*SwapInfo) Reset 

func (x *SwapInfo) Reset()

func (*SwapInfo) String 

func (x *SwapInfo) String() string

type SwapState added in v1.2.3 

type SwapState int32
const (
	SwapState_PENDING    SwapState = 0
	SwapState_SUCCESSFUL SwapState = 1
	// Unknown client error. Check the error field of the message for more information
	SwapState_ERROR SwapState = 2
	// Unknown server error. Check the status field of the message for more information
	SwapState_SERVER_ERROR SwapState = 3
	// Client refunded locked coins after the HTLC timed out
	SwapState_REFUNDED SwapState = 4
	// Client noticed that the HTLC timed out but didn't find any outputs to refund
	SwapState_ABANDONED SwapState = 5
)

func (SwapState) Descriptor added in v1.2.3 

func (SwapState) Descriptor() protoreflect.EnumDescriptor

func (SwapState) Enum added in v1.2.3 

func (x SwapState) Enum() *SwapState

func (SwapState) EnumDescriptor deprecated added in v1.2.3 

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

Deprecated: Use SwapState.Descriptor instead.

func (SwapState) Number added in v1.2.3 

func (x SwapState) Number() protoreflect.EnumNumber

func (SwapState) String added in v1.2.3 

func (x SwapState) String() string

func (SwapState) Type added in v1.2.3 

func (SwapState) Type() protoreflect.EnumType

type UnimplementedBoltzServer added in v1.2.0 

type UnimplementedBoltzServer struct {
}

UnimplementedBoltzServer must be embedded to have forward compatible implementations.

func (UnimplementedBoltzServer) CreateChannel added in v1.2.0 

func (UnimplementedBoltzServer) CreateChannel(context.Context, *CreateChannelRequest) (*CreateSwapResponse, error)

func (UnimplementedBoltzServer) CreateReverseSwap added in v1.2.0 

func (UnimplementedBoltzServer) CreateReverseSwap(context.Context, *CreateReverseSwapRequest) (*CreateReverseSwapResponse, error)

func (UnimplementedBoltzServer) CreateSwap added in v1.2.0 

func (UnimplementedBoltzServer) CreateSwap(context.Context, *CreateSwapRequest) (*CreateSwapResponse, error)

func (UnimplementedBoltzServer) Deposit added in v1.2.0 

func (UnimplementedBoltzServer) Deposit(context.Context, *DepositRequest) (*DepositResponse, error)

func (UnimplementedBoltzServer) GetInfo added in v1.2.0 

func (UnimplementedBoltzServer) GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)

func (UnimplementedBoltzServer) GetServiceInfo added in v1.2.0 

func (UnimplementedBoltzServer) GetServiceInfo(context.Context, *GetServiceInfoRequest) (*GetServiceInfoResponse, error)

func (UnimplementedBoltzServer) GetSwapInfo added in v1.2.0 

func (UnimplementedBoltzServer) GetSwapInfo(context.Context, *GetSwapInfoRequest) (*GetSwapInfoResponse, error)

func (UnimplementedBoltzServer) ListSwaps added in v1.2.0 

func (UnimplementedBoltzServer) ListSwaps(context.Context, *ListSwapsRequest) (*ListSwapsResponse, error)

type UnsafeBoltzServer added in v1.2.0 

type UnsafeBoltzServer interface {
	// contains filtered or unexported methods
}

UnsafeBoltzServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to BoltzServer will result in compilation errors.

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.