boltzrpc

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

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
}

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
}

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
}

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
}

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
}

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
}

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

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
}

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
}

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
}

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
}

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

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
}

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

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
}

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

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
}

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
}

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

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
}

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
}

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
}

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
}

type SwapState int32

type UnimplementedBoltzServer struct {
}

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