package boltzrpc
Get desktop application:
View/edit binary Protocol Buffers messages
service Boltz
boltzrpc.proto:7rpc AddReferral (, )
boltzrpc.proto:29Adds a new referral ID to the database
message
boltzrpc.proto:200string id = 1
uint32 fee_share = 2
string routing_node = 3
message
boltzrpc.proto:205string api_key = 1
string api_secret = 2
rpc AllowRefund (, )
boltzrpc.proto:35Disables safety checks to allow for a cooperative refund for a swap
message
boltzrpc.proto:255string id = 1
message
boltzrpc.proto:259(message has no fields)
message
boltzrpc.proto:363string symbol = 1
string transaction_id = 2
message
boltzrpc.proto:368uint64 absolute = 1
oneof relative
double sat_per_vbyte = 2
double gwei = 3
rpc CheckTransaction (, )
boltzrpc.proto:48message
boltzrpc.proto:242string symbol = 1
string id = 2
message
boltzrpc.proto:246(message has no fields)
rpc DeriveBlindingKeys (, )
boltzrpc.proto:19message
boltzrpc.proto:145string address = 1
message
boltzrpc.proto:149string public_key = 1
string private_key = 2
rpc DeriveKeys (, )
boltzrpc.proto:17Derives a keypair from the index of an HD wallet
message
boltzrpc.proto:135string symbol = 1
uint32 index = 2
message
boltzrpc.proto:140string public_key = 1
string private_key = 2
message
boltzrpc.proto:467optional string id = 1
message
boltzrpc.proto:470(message has no fields)
message
boltzrpc.proto:472bool disabled = 1
message
boltzrpc.proto:476(message has no fields)
rpc DevHeapDump (, )
boltzrpc.proto:67message
boltzrpc.proto:321optional string path = 1
message
boltzrpc.proto:325(message has no fields)
rpc GetAddress (, )
boltzrpc.proto:23Gets an address of a specified wallet
message
boltzrpc.proto:175string symbol = 1
string label = 2
message
boltzrpc.proto:180string address = 1
rpc GetBalance (, )
boltzrpc.proto:14Gets the balance of all wallets
message
boltzrpc.proto:116(message has no fields)
message
boltzrpc.proto:117map<string, > balances = 1
rpc GetInfo (, )
boltzrpc.proto:11Gets general information about this Boltz instance and the nodes it is connected to
message
boltzrpc.proto:82(message has no fields)
message
boltzrpc.proto:83string version = 1
map<string, > chains = 2
rpc GetLabel (, )
boltzrpc.proto:50message
boltzrpc.proto:261string tx_id = 1
message
boltzrpc.proto:265string symbol = 1
string label = 2
rpc GetLockedFunds (, )
boltzrpc.proto:38Gets funds locked by the server for swaps
message
boltzrpc.proto:337(message has no fields)
message
boltzrpc.proto:338map<string, > locked_funds = 1
message
boltzrpc.proto:270(message has no fields)
message
boltzrpc.proto:272repeated transactions = 1
rpc GetPendingSweeps (, )
boltzrpc.proto:41Gets funds pending for sweep by the server
message
boltzrpc.proto:462(message has no fields)
message
boltzrpc.proto:463map<string, > pending_sweeps = 1
rpc GetReferrals (, )
boltzrpc.proto:54message
boltzrpc.proto:288optional string id = 1
When not specified, all referrals are returned
message
boltzrpc.proto:293repeated referral = 1
rpc InvoiceClnThreshold (, )
boltzrpc.proto:57message
boltzrpc.proto:309repeated thresholds = 1
message
boltzrpc.proto:319(message has no fields)
rpc InvoicePaymentHook (stream , stream )
boltzrpc.proto:63message
boltzrpc.proto:437string id = 1
optional Node action = 2
optional double time_preference = 3
Only applies to LND -1 to optimize for fees, 1 to optimize for reliability; value between for a mix
message
boltzrpc.proto:446string id = 1
string invoice = 2
optional decoded = 3
rpc ListSwaps (, )
boltzrpc.proto:45message
boltzrpc.proto:221optional string status = 1
optional uint64 limit = 2
message
boltzrpc.proto:226repeated string submarine_swaps = 1
repeated string reverse_swaps = 2
repeated string chain_swaps = 3
rpc Rescan (, )
boltzrpc.proto:47message
boltzrpc.proto:232string symbol = 1
uint64 start_height = 2
optional bool include_mempool = 3
message
boltzrpc.proto:237uint64 start_height = 1
uint64 end_height = 2
rpc SendCoins (, )
boltzrpc.proto:26Sends onchain coins to a specified address
message
boltzrpc.proto:184string symbol = 1
string address = 2
uint64 amount = 3
uint32 fee = 4
sat/vbyte for UTXO based chains or gas price in GWEI for account based ones
bool send_all = 5
string label = 6
message
boltzrpc.proto:195string transaction_id = 1
optional uint32 vout = 2
rpc SetLogLevel (, )
boltzrpc.proto:65message
boltzrpc.proto:452LogLevel level = 1
message
boltzrpc.proto:456(message has no fields)
rpc SetReferral (, )
boltzrpc.proto:56message
boltzrpc.proto:302string id = 1
optional string config = 2
message
boltzrpc.proto:307(message has no fields)
rpc SetSwapStatus (, )
boltzrpc.proto:32Modifies the status of a swap
message
boltzrpc.proto:248string id = 1
string status = 2
message
boltzrpc.proto:253(message has no fields)
rpc Stop (, )
boltzrpc.proto:8message
boltzrpc.proto:79(message has no fields)
message
boltzrpc.proto:80(message has no fields)
rpc SwapCreationHook (stream , stream )
boltzrpc.proto:61message
boltzrpc.proto:382string id = 1
Action action = 2
message
boltzrpc.proto:387string id = 1
string symbol_sending = 2
string symbol_receiving = 3
optional string referral = 4
oneof swap
submarine = 5
reverse = 6
chain = 7
rpc SweepSwaps (, )
boltzrpc.proto:43message
boltzrpc.proto:210optional string symbol = 1
message
boltzrpc.proto:213map<string, > claimed_symbols = 1
rpc TransactionHook (stream , stream )
boltzrpc.proto:62message
boltzrpc.proto:413string id = 1
Swap ID
Action action = 2
message
boltzrpc.proto:419string id = 1
Swap ID
SwapType swap_type = 2
string symbol = 3
bytes tx = 4
string tx_id = 5
bool confirmed = 6
optional uint64 vout = 7
Set for UTXO based chains
rpc UnblindOutputs (, )
boltzrpc.proto:20message
boltzrpc.proto:154oneof transaction
string id = 1
string hex = 2
message
boltzrpc.proto:161repeated outputs = 1
Used in: ,
ACCEPT = 0
REJECT = 1
HOLD = 2
message
boltzrpc.proto:121Used in:
map<string, > wallets = 1
map<string, > lightning = 2
message
boltzrpc.proto:126Used in:
uint64 local = 1
uint64 remote = 2
message
boltzrpc.proto:122Used in:
uint64 confirmed = 1
uint64 unconfirmed = 2
message
boltzrpc.proto:93Used in:
uint32 version = 1
uint64 blocks = 2
uint64 scanned_blocks = 3
uint64 connections = 4
string error = 5
message
boltzrpc.proto:88Used in:
optional chain = 1
map<string, > lightning = 2
message
boltzrpc.proto:273Used in:
string symbol = 1
bytes hash = 2
bytes hex = 3
optional string label = 4
uint64 nonce = 5
string amount_sent = 6
In wei
optional string amount_received = 7
In wei
message
boltzrpc.proto:294Used in:
string id = 1
optional string config = 2
message
boltzrpc.proto:310Used in:
SwapType type = 1
uint64 threshold = 2
In satoshis
message
boltzrpc.proto:102Used in:
string version = 1
optional channels = 2
uint64 block_height = 3
string error = 4
message
boltzrpc.proto:103Used in:
uint32 active = 1
uint32 inactive = 2
uint32 pending = 3
message
boltzrpc.proto:327Used in:
string swap_id = 1
uint64 onchain_amount = 2
message
boltzrpc.proto:332Used in:
repeated reverse_swaps = 1
repeated chain_swaps = 2
Used in:
ERROR = 0
WARN = 1
INFO = 2
VERBOSE = 3
DEBUG = 4
SILLY = 5
Used in:
LND = 0
CLN = 1
BECH32 = 0
COMPATIBILITY = 1
LEGACY = 2
message
boltzrpc.proto:342Used in:
string swap_id = 1
uint64 onchain_amount = 2
string type = 3
message
boltzrpc.proto:458Used in:
repeated pending_sweeps = 1
message
boltzrpc.proto:397Used in:
uint64 user_lock_amount = 1
message
boltzrpc.proto:393Used in:
uint64 invoice_amount = 1
message
boltzrpc.proto:388Used in:
uint64 invoice_amount = 1
string invoice = 2
Used in: ,
SUBMARINE = 0
REVERSE = 1
CHAIN = 2
message
boltzrpc.proto:214Used in:
repeated string claimed_ids = 1
message
boltzrpc.proto:162Used in:
uint64 value = 1
bytes asset = 2
bool is_lbtc = 3
bytes script = 4
bytes nonce = 5
optional bytes range_proof = 6
optional bytes surjection_proof = 7