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.
GetStats
Returns stats 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 and the swap does not have an associated wallet.
ClaimSwaps
Claim swaps manually. This is only required when no claim address has been set and 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.
GetWalletSendFee
Calculates the fee for an equivalent WalletSend request. If address is left empty, a dummy swap address will be used, allowing for a fee estimation of a swap lockup transaction.
ListWalletTransactions
Returns recent transactions from a wallet.
GetWalletCredentials
Returns the credentials of a wallet. The password will be required if the wallet is encrypted.
RemoveWallet
Removes a wallet.
WalletSend
Send coins from a wallet. Only the confirmed balance can be spent.
WalletReceive
Get a new address of the 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.
CreateTenant
Creates a new tenant which can be used to bake restricted macaroons.
ListTenants
Returns all tenants.
GetTenant
Get a specifiy tenant.
BakeMacaroon
Bakes a new macaroon with the specified permissions. The macaroon can also be restricted to a specific tenant. In this case, - any swap or wallet created with the returned macaroon will belong to this tenant and can not be accessed by other tenants. - the lightning node connected to the daemon can not be used to pay or create invoices for swaps.
Messages
AnySwapInfo
id
type
pair
state
error
optional
status
from_amount
The expected amount to be sent to the lockup address for submarine and chain swaps and the invoice amount for reverse swaps.
to_amount
from_amount minus the service and network fee.
created_at
service_fee
optional
onchain_fee
optional
inclues the routing fee for reverse swaps
is_auto
tenant_id
BakeMacaroonRequest
tenant_id
optional
permissions
repeated
BakeMacaroonResponse
macaroon
Balance
total
confirmed
unconfirmed
BlockHeights
btc
liquid
optional
Budget
total
remaining
start_date
end_date
ChainSwapData
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
id
pair
state
error
status
preimage
is_auto
service_fee
optional
service_fee_percent
onchain_fee
optional
created_at
tenant_id
from_data
to_data
ChangeWalletPasswordRequest
old
new
ChannelCreationInfo
Channel creations are an optional extension to a submarine swap in the data types of boltz-client.
swap_id
ID of the swap to which this channel channel belongs
status
inbound_liquidity
private
funding_transaction_id
funding_transaction_vout
ChannelId
cln
cln style: 832347x2473x1
lnd
lnd style: 915175205006540801
ClaimSwapsRequest
swap_ids
repeated
address
wallet_id
ClaimSwapsResponse
transaction_id