🤖gRPC API

This page was automatically generated.

Paths for the REST proxy of the gRPC interface can be found here.

boltzrpc.Boltz

Methods

GetInfo

Gets general information about the daemon like the chain of the lightning node it is connected to and the IDs of pending swaps.

GetServiceInfo

Fetches the latest limits and fees from the Boltz backend API it is connected to.

GetPairInfo

Fetches information about a specific pair for a chain swap.

GetPairs

Fetches all available pairs for submarine and reverse swaps.

ListSwaps

Returns a list of all swaps, reverse swaps, and chain swaps in the database.

RefundSwap

Refund a failed swap manually. This is only required when no refund address has been set or the swap does not have an associated wallet.

GetSwapInfo

Gets all available information about a swap from the database.

GetSwapInfoStream

Returns the entire history of the swap if is still pending and streams updates in real time. If the swap id is empty or "*" updates for all swaps will be streamed.

Deposit

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.

CreateSwap

Creates a new swap from onchain to lightning.

CreateChannel

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.

CreateReverseSwap

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.

CreateChainSwap

Creates a new chain swap from one chain to another. 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.

CreateWallet

Creates a new liquid wallet and returns the mnemonic.

ImportWallet

Imports an existing wallet.

SetSubaccount

Sets the subaccount of a wallet. Not supported for readonly wallets.

GetSubaccounts

Returns all subaccounts for a given wallet. Not supported for readonly wallets.

GetWallets

Returns all available wallets.

GetWallet

Returns the current balance and subaccount of a wallet.

RequestResponse

GetWalletCredentials

Returns the credentials of a wallet. The password will be required if the wallet is encrypted.

RemoveWallet

Removes a wallet.

Stop

Gracefully stops the daemon.

Unlock

Unlocks the server. This will be required on startup if there are any encrypted wallets.

VerifyWalletPassword

Check if the password is correct.

ChangeWalletPassword

Changes the password for wallet encryption.

CreateEntity

Creates a new entity which can be used to bake restricted macaroons.

ListEntities

Returns all entities.

GetEntity

Get a specifiy entity.

RequestResponse

BakeMacaroon

Bakes a new macaroon with the specified permissions. The macaroon can also be restricted to a specific entity. In this case, - any swap or wallet created with the returned macaroon will belong to this entity and can not be accessed by other entities. - the lightning node connected to the daemon can not be used to pay or create invoices for swaps.

Messages

BakeMacaroonRequest

FieldTypeLabelDescription

entity_id

optional

permissions

repeated

BakeMacaroonResponse

FieldTypeLabelDescription

macaroon

Balance

FieldTypeLabelDescription

total

confirmed

unconfirmed

BlockHeights

FieldTypeLabelDescription

btc

liquid

optional

Budget

FieldTypeLabelDescription

total

remaining

start_date

end_date

ChainSwapData

FieldTypeLabelDescription

id

currency

private_key

their_public_key

amount

timeout_block_height

lockup_transaction_id

optional

transaction_id

optional

wallet_id

optional

address

optional

blinding_key

optional

lockup_address

ChainSwapInfo

FieldTypeLabelDescription

id

pair

state

error

status

preimage

is_auto

service_fee

optional

service_fee_percent

onchain_fee

optional

created_at

entity_id

from_data

to_data

ChangeWalletPasswordRequest

FieldTypeLabelDescription

old

new

ChannelCreationInfo

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

FieldTypeLabelDescription

swap_id

ID of the swap to which this channel channel belongs

status

inbound_liquidity

private

funding_transaction_id

funding_transaction_vout

ChannelId

FieldTypeLabelDescription

cln

cln style: 832347x2473x1

lnd

lnd style: 915175205006540801

CombinedChannelSwapInfo

FieldTypeLabelDescription

swap

channel_creation

CreateChainSwapRequest

FieldTypeLabelDescription

amount

Amount of satoshis to swap. It is the amount expected to be sent to the lockup address.

pair

to_address

optional

Address where funds will be swept to if the swap succeeds

refund_address

optional

Address where the coins should be refunded to if the swap fails.

from_wallet_id

optional

Wallet from which the swap should be paid from. Ignored if external_pay is set to true. If the swap fails, funds will be refunded to this wallet aswell.

to_wallet_id

optional

Wallet where the the funds will go if the swap succeeds.

accept_zero_conf

optional

Whether the daemon should broadcast the claim transaction immediately after the lockup transaction is in the mempool. Should only be used for smaller amounts as it involves trust in Boltz.

external_pay

optional

If set, the daemon will not pay the swap from an internal wallet.

CreateChannelRequest

FieldTypeLabelDescription

amount

inbound_liquidity

Percentage of inbound liquidity the channel that is opened should have. 25 by default.

private

CreateEntityRequest

FieldTypeLabelDescription

name

CreateReverseSwapRequest

FieldTypeLabelDescription

amount

amount of satoshis to swap

address

If no value is set, the daemon will query a new address from the lightning node

accept_zero_conf

Whether the daemon should broadcast the claim transaction immediately after the lockup transaction is in the mempool. Should only be used for smaller amounts as it involves trust in boltz.

pair

chan_ids

repeated

a list of channel ids which are allowed for paying the invoice. can be in either cln or lnd style.

wallet_id

optional

wallet from which the onchain address should be generated - only considered if address is not set

return_immediately

optional

Whether the daemon should return immediately after creating the swap or wait until the swap is successful or failed. It will always return immediately if accept_zero_conf is not set.

external_pay

optional

If set, the daemon will not pay the invoice of the swap and return the invoice to be paid. This implicitly sets return_immediately to true.

CreateReverseSwapResponse

FieldTypeLabelDescription

id

lockup_address

routing_fee_milli_sat

optional

Only populated when zero-conf is accepted and return_immediately is set to false

claim_transaction_id

optional

Only populated when zero-conf is accepted and return_immediately is set to false

invoice

optional

Invoice to be paid. Only populated when external_pay is set to true

CreateSwapRequest

FieldTypeLabelDescription

amount

pair

not yet supported repeated string chan_ids = 3;

send_from_internal

the daemon will pay the swap using the onchain wallet specified in the wallet field or any wallet otherwise.

refund_address

optional

address where the coins should go if the swap fails. Refunds will go to any of the daemons wallets otherwise.

wallet_id

optional

wallet to pay swap from. only used if send_from_internal is set to true

invoice

optional

invoice to use for the swap. if not set, the daemon will get a new invoice from the lightning node

CreateSwapResponse

FieldTypeLabelDescription

id

address

expected_amount

bip21

tx_id

lockup transaction id. Only populated when send_from_internal was specified in the request

timeout_block_height

timeout_hours

CreateWalletRequest

FieldTypeLabelDescription

params

CreateWalletResponse

FieldTypeLabelDescription

mnemonic

wallet

DepositRequest

FieldTypeLabelDescription

inbound_liquidity

Percentage of inbound liquidity the channel that is opened in case the invoice cannot be paid should have. 25 by default.

DepositResponse

FieldTypeLabelDescription

id

address

timeout_block_height

Entity

FieldTypeLabelDescription

id

name

Fees

FieldTypeLabelDescription

percentage

miner

GetEntityRequest

FieldTypeLabelDescription

name

GetInfoRequest

GetInfoResponse

FieldTypeLabelDescription

version

node

network

node_pubkey

auto_swap_status

one of: running, disabled, error

block_heights

mapping of the currency to the latest block height.

refundable_swaps

repeated

swaps that need a manual interaction to refund

entity

optional

the currently authenticated entity

symbol

Deprecated.

lnd_pubkey

Deprecated.

block_height

Deprecated.

pending_swaps

repeated

Deprecated.

pending_reverse_swaps

repeated

Deprecated.

GetPairInfoRequest

FieldTypeLabelDescription

type

pair

GetPairsResponse

FieldTypeLabelDescription

submarine

repeated

reverse

repeated

chain

repeated

GetServiceInfoRequest

GetServiceInfoResponse

FieldTypeLabelDescription

fees

limits

GetSubaccountsRequest

FieldTypeLabelDescription

wallet_id

GetSubaccountsResponse

FieldTypeLabelDescription

current

optional

subaccounts

repeated

GetSwapInfoRequest

FieldTypeLabelDescription

id

GetSwapInfoResponse

FieldTypeLabelDescription

swap

channel_creation

reverse_swap

chain_swap

GetWalletCredentialsRequest

FieldTypeLabelDescription

id

password

optional

GetWalletRequest

FieldTypeLabelDescription

name

optional

id

optional

GetWalletsRequest

FieldTypeLabelDescription

currency

optional

include_readonly

optional

ImportWalletRequest

FieldTypeLabelDescription

credentials

params

ImportWalletResponse

LightningChannel

FieldTypeLabelDescription

id

capacity

local_sat

remote_sat

peer_id

Limits

FieldTypeLabelDescription

minimal

maximal

maximal_zero_conf_amount

ListEntitiesRequest

ListEntitiesResponse

FieldTypeLabelDescription

entities

repeated

ListSwapsRequest

FieldTypeLabelDescription

from

optional

to

optional

is_auto

optional

state

optional

ListSwapsResponse

FieldTypeLabelDescription

swaps

repeated

channel_creations

repeated

reverse_swaps

repeated

chain_swaps

repeated

MacaroonPermissions

FieldTypeLabelDescription

action

MinerFees

FieldTypeLabelDescription

normal

reverse

Pair

FieldTypeLabelDescription

from

to

PairInfo

FieldTypeLabelDescription

pair

fees

limits

hash

RefundSwapRequest

FieldTypeLabelDescription

id

address

RemoveWalletRequest

FieldTypeLabelDescription

id

RemoveWalletResponse

ReverseSwapInfo

FieldTypeLabelDescription

id

state

error

status

Latest status message of the Boltz backend

private_key

preimage

redeem_script

invoice

claim_address

onchain_amount

timeout_block_height

lockup_transaction_id

claim_transaction_id

pair

chan_ids

repeated

blinding_key

optional

created_at

service_fee

optional

onchain_fee

optional

routing_fee_msat

optional

external_pay

entity_id

SetSubaccountRequest

FieldTypeLabelDescription

wallet_id

subaccount

optional

The subaccount to use. If not set, a new one will be created.

Subaccount

FieldTypeLabelDescription

balance

pointer

type

SwapFees

FieldTypeLabelDescription

percentage

miner_fees

SwapInfo

FieldTypeLabelDescription

id

pair

state

error

status

Latest status message of the Boltz backend

private_key

preimage

redeem_script

invoice

lockup_address

expected_amount

timeout_block_height

lockup_transaction_id

refund_transaction_id

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 configured wallet or the address specified in the refund_address field.

refund_address

optional

chan_ids

repeated

blinding_key

optional

created_at

service_fee

optional

onchain_fee

optional

wallet_id

optional

internal wallet which was used to pay the swap

entity_id

SwapStats

FieldTypeLabelDescription

total_fees

total_amount

avg_fees

avg_amount

count

UnlockRequest

FieldTypeLabelDescription

password

VerifyWalletPasswordRequest

FieldTypeLabelDescription

password

VerifyWalletPasswordResponse

FieldTypeLabelDescription

correct

Wallet

FieldTypeLabelDescription

id

name

currency

readonly

balance

entity_id

WalletCredentials

FieldTypeLabelDescription

mnemonic

optional

only one of these is allowed to be present

xpub

optional

core_descriptor

optional

subaccount

optional

only used in combination with mnemonic

WalletParams

FieldTypeLabelDescription

name

currency

password

optional

the password to encrypt the wallet with. If there are existing encrypted wallets, the same password has to be used.

Wallets

FieldTypeLabelDescription

wallets

repeated

Enums

Currency

NameNumberDescription

BTC

0

LBTC

1

MacaroonAction

NameNumberDescription

READ

0

WRITE

1

SwapState

NameNumberDescription

PENDING

0

SUCCESSFUL

1

ERROR

2

Unknown client error. Check the error field of the message for more information

SERVER_ERROR

3

Unknown server error. Check the status field of the message for more information

REFUNDED

4

Client refunded locked coins after the HTLC timed out

ABANDONED

5

Client noticed that the HTLC timed out but didn't find any outputs to refund

SwapType

NameNumberDescription

SUBMARINE

0

REVERSE

1

CHAIN

2

autoswaprpc.AutoSwap

Methods

GetSwapRecommendations

Returns a list of swaps which are currently recommended by autoswap. Also works when autoswap is not running.

GetStatus

Returns the current budget of autoswap and some relevant stats.

ResetConfig

Resets the configuration to default values.

SetConfig

Allows setting multiple json-encoded config values at once. Autoswap will reload the configuration after this call.

RequestResponse

SetConfigValue

Allows setting a specific value in the configuration. Autoswap will reload the configuration after this call.

GetConfig

Returns the currently used configurationencoded as json. If a key is specfied, only the value of that key will be returned.

RequestResponse

ReloadConfig

Reloads the configuration from disk.

Messages

Budget

FieldTypeLabelDescription

total

remaining

start_date

end_date

Config

FieldTypeLabelDescription

enabled

channel_poll_interval

static_address

max_balance

min_balance

max_balance_percent

min_balance_percent

max_fee_percent

accept_zero_conf

failure_backoff

budget

budget_interval

currency

swap_type

per_channel

wallet

max_swap_amount

GetConfigRequest

FieldTypeLabelDescription

key

optional

GetStatusRequest

GetStatusResponse

FieldTypeLabelDescription

running

strategy

error

stats

optional

budget

optional

GetSwapRecommendationsRequest

FieldTypeLabelDescription

no_dismissed

optional

Do not return any dismissed recommendations

GetSwapRecommendationsResponse

FieldTypeLabelDescription

swaps

repeated

SetConfigValueRequest

FieldTypeLabelDescription

key

value

SwapRecommendation

FieldTypeLabelDescription

type

amount

channel

fee_estimate

dismissed_reasons

repeated

Enums

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby

double

double

double

float

float64

double

float

Float

float

float

float

float

float32

float

float

Float

int32

Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.

int32

int

int

int32

int

integer

Bignum or Fixnum (as required)

int64

Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.

int64

long

int/long

int64

long

integer/string

Bignum

uint32

Uses variable-length encoding.

uint32

int

int/long

uint32

uint

integer

Bignum or Fixnum (as required)

uint64

Uses variable-length encoding.

uint64

long

int/long

uint64

ulong

integer/string

Bignum or Fixnum (as required)

sint32

Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.

int32

int

int

int32

int

integer

Bignum or Fixnum (as required)

sint64

Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.

int64

long

int/long

int64

long

integer/string

Bignum

fixed32

Always four bytes. More efficient than uint32 if values are often greater than 2^28.

uint32

int

int

uint32

uint

integer

Bignum or Fixnum (as required)

fixed64

Always eight bytes. More efficient than uint64 if values are often greater than 2^56.

uint64

long

int/long

uint64

ulong

integer/string

Bignum

sfixed32

Always four bytes.

int32

int

int

int32

int

integer

Bignum or Fixnum (as required)

sfixed64

Always eight bytes.

int64

long

int/long

int64

long

integer/string

Bignum

bool

bool

boolean

boolean

bool

bool

boolean

TrueClass/FalseClass

string

A string must always contain UTF-8 encoded or 7-bit ASCII text.

string

String

str/unicode

string

string

string

String (UTF-8)

bytes

May contain any arbitrary sequence of bytes.

string

ByteString

str

[]byte

ByteString

string

String (ASCII-8BIT)

Last updated