package io.bisq.protobuffer
Get desktop application:
View/edit binary Protocol Buffers messages
service DisputeAgents
grpc.proto:27The DisputeAgents service is provided for development only; it can only be used when running in regtest mode.
rpc RegisterDisputeAgent (, )
grpc.proto:29Register regtest / dev mode dispute agents. Does not work when running on mainnet.
message
grpc.proto:33string dispute_agent_type = 1
One of "mediator" or "refundagent". Development / test arbitrators can only be registered in the UI.
string registration_key = 2
Private developer (only) registration key.
message
grpc.proto:40(message has no fields)
service GetVersion
grpc.proto:1009rpc GetVersion (, )
grpc.proto:1011Get the current Bisq version number.
message
grpc.proto:1015(message has no fields)
message
grpc.proto:1018string version = 1
The version of the Bisq software release.
service Help
grpc.proto:43rpc GetMethodHelp (, )
grpc.proto:45Returns a CLI command man page.
message
grpc.proto:49string method_name = 1
The CLI command name.
message
grpc.proto:53string method_help = 1
The man page for the CLI command.
service Offers
grpc.proto:60The Offers service provides rpc methods for creating, editing, listing, and cancelling Bisq offers.
rpc GetOfferCategory (, )
grpc.proto:64Get an offer's category, one of FIAT, ALTCOIN, or BSQ_SWAP. This information is needed before an offer can be taken, and is used by a client to determine what kind of offer to take: a v1 FIAT or ALTCOIN offer, or a BSQ swap offer. V1 and BSQ swap trades are handled differently in the API daemon.
message
grpc.proto:107string id = 1
The offer's unique identifier.
bool is_my_offer = 2
Whether the offer was created by the user or not.
message
grpc.proto:112GetOfferCategoryReply.OfferCategory offer_category = 1
rpc GetBsqSwapOffer (, )
grpc.proto:67Get the available BSQ swap offer with offer-id.
message
grpc.proto:122optional bsq_swap_offer = 1
The returned BSQ swap offer.
rpc GetOffer (, )
grpc.proto:71Get the v1 protocol offer with an offer-id. Your node must have a payment account with the same payment method as the offer's associated payment method, e,g., ACH_TRANSFER, CASH_DEPOSIT, etc.
message
grpc.proto:130optional offer = 1
The returned v1 protocol offer.
rpc GetMyBsqSwapOffer (, )
grpc.proto:74Get user's BSQ swap offer with offer-id.
message
grpc.proto:134optional bsq_swap_offer = 1
The returned BSQ swap offer.
rpc GetMyOffer (, )
grpc.proto:77Get my open v1 protocol offer with offer-id. Deprecated since 27-Dec-2021 (v1.8.0). Use GetOffer.
message
grpc.proto:144Deprecated with rpc method GetMyOffer since 27-Dec-2021 (v1.8.0).
optional offer = 1
The returned v1 protocol offer.
rpc GetBsqSwapOffers (, )
grpc.proto:80Get all available BSQ swap offers with a BUY (BTC) or SELL (BTC) direction.
message
grpc.proto:162repeated bsq_swap_offers = 1
The returned list of available BSQ swap offers.
rpc GetOffers (, )
grpc.proto:85Get all available v1 protocol offers with a BUY (BTC) or SELL (BTC) direction. The returned offers are restricted to those associated with payment methods matching the payment methods you have set up on your node, e,g., NATIONAL_BANK, US_POSTAL_MONEY_ORDER, etc.
message
grpc.proto:148string direction = 1
The offer's BUY (BTC) or SELL (BTC) direction.
string currency_code = 2
The offer's fiat or altcoin currency code.
message
grpc.proto:154repeated offers = 1
The returned list of available offers.
rpc GetMyBsqSwapOffers (, )
grpc.proto:88Get all user's BSQ swap offers with a BUY (BTC) or SELL (BTC) direction.
message
grpc.proto:175repeated bsq_swap_offers = 1
The returned list of user's open BSQ swap offers.
rpc GetMyOffers (, )
grpc.proto:91Get all user's open v1 protocol offers with a BUY (BTC) or SELL (BTC) direction.
message
grpc.proto:166string direction = 1
The offers' BUY (BTC) or SELL (BTC) direction.
string currency_code = 2
The offer's fiat or altcoin currency code.
message
grpc.proto:171repeated offers = 1
The returned list of user's open offers.
rpc CreateBsqSwapOffer (, )
grpc.proto:94Create a BSQ swap offer.
message
grpc.proto:179string direction = 1
The new BSQ swap offer's BUY (BTC) or SELL (BTC) direction.
uint64 amount = 2
The amount of BTC to be traded as a long representing satoshi units.
uint64 min_amount = 3
The minimum amount of BTC to be traded as a long representing satoshi units.
string price = 4
The fixed price of the offer as a string representing BTC units, e.g., "0.00005" or "0.00005000".
message
grpc.proto:190optional bsq_swap_offer = 1
The newly created BSQ swap offer.
rpc CreateOffer (, )
grpc.proto:97Create a v1 protocol offer.
message
grpc.proto:194string currency_code = 1
The new offer's fiat or altcoin currency code.
string direction = 2
The new v1 protocol offer's BUY (BTC) or SELL (BTC) direction.
string price = 3
For fiat offers: a string representing the rounded, fixed fiat price of the offer, e.g., "45000", not "45000". For altcoin offers: a string representing the fixed BTC price of the offer, e.g., "0.00005".
bool use_market_based_price = 4
Whether the offer price is fixed, or market price margin based.
double market_price_margin_pct = 5
The offer's market price margin as a percentage above or below the current market BTC price, e.g., 2.50 represents 2.5%.
uint64 amount = 6
The amount of BTC to be traded, in satoshis.
uint64 min_amount = 7
The minimum amount of BTC to be traded, in satoshis.
double buyer_security_deposit_pct = 8
A BUY BTC offer maker's security deposit as a percentage of the BTC amount to be traded, e.g., 15.00 represents 15%.
string trigger_price = 9
A market price margin based offer's trigger price is the market BTC price at which the offer is automatically disabled. Disabled offers are never automatically enabled, they must be manually re-enabled. A zero value indicates trigger price is not set. Trigger price does not apply to fixed price offers.
string payment_account_id = 10
The unique identifier of the payment account used to create the new offer, and send or receive trade payment.
string maker_fee_currency_code = 11
The offer maker's trade fee currency: BTC or BSQ.
message
grpc.proto:222optional offer = 1
The newly created v1 protocol offer.
rpc EditOffer (, )
grpc.proto:100Edit an open offer.
message
grpc.proto:226string id = 1
The edited offer's unique identifier.
string price = 2
For fiat offers: a string representing the new rounded, fixed fiat price of the offer, e.g., "45000", not "45000". For altcoin offers: a string representing the new fixed BTC price of the offer, e.g., "0.00005".
bool use_market_based_price = 3
Whether the offer price is fixed, or market price margin based.
double market_price_margin_pct = 4
An offer's new market price margin as a percentage above or below the current market BTC price.
string trigger_price = 5
A market price margin based offer's trigger price is the market BTC price at which the offer is automatically disabled. Disabled offers are never automatically enabled, they must be manually re-enabled. A zero value indicates trigger price is not set. Trigger price does not apply to fixed price offers.
sint32 enable = 6
Whether the offer's activation state should be changed (disable or enable), or left alone. Send a signed int, not a bool (with default=false). -1 = do not change activation state 0 = disable 1 = enable
EditOfferRequest.EditType edit_type = 7
Tell the daemon precisely what is being edited.
message
grpc.proto:272(message has no fields)
rpc CancelOffer (, )
grpc.proto:103Cancel an open offer; remove it from the offer book.
message
grpc.proto:275string id = 1
The canceled offer's unique identifier.
message
grpc.proto:279(message has no fields)
service PaymentAccounts
grpc.proto:367The PaymentAccounts service provides rpc methods for creating fiat and crypto currency payment accounts.
rpc CreatePaymentAccount (, )
grpc.proto:369Create a fiat payment account, providing details in a json form generated by rpc method GetPaymentAccountForm.
message
grpc.proto:388string payment_account_form = 1
File path of filled json payment account form.
message
grpc.proto:392optional payment_account = 1
The new payment account.
rpc GetPaymentAccounts (, )
grpc.proto:372Get list of all saved fiat payment accounts.
message
grpc.proto:396(message has no fields)
message
grpc.proto:399repeated payment_accounts = 1
All user's saved payment accounts.
rpc GetPaymentMethods (, )
grpc.proto:375Get list of all supported Bisq payment methods.
message
grpc.proto:403(message has no fields)
message
grpc.proto:406repeated payment_methods = 1
Ids of all supported Bisq fiat payment methods.
rpc GetPaymentAccountForm (, )
grpc.proto:378Get a json template file for a supported Bisq payment method. Fill in the form and call rpc method CreatePaymentAccount.
message
grpc.proto:410string payment_method_id = 1
Payment method id determining content of the requested payment account form.
message
grpc.proto:414string payment_account_form_json = 1
An empty payment account json form to be filled out and passed to rpc method CreatePaymentAccount.
Create a crypto currency (altcoin) payment account.
message
grpc.proto:419string account_name = 1
The name of the altcoin payment account. Uniqueness is not enforced.
string currency_code = 2
The altcoin currency code.
string address = 3
The altcoin receiving address.
bool trade_instant = 4
Whether the altcoin payment account is an instant account or not.
message
grpc.proto:426optional payment_account = 1
The new altcoin payment account.
Get list of all supported Bisq crypto currency (altcoin) payment methods.
message
grpc.proto:430(message has no fields)
message
grpc.proto:433repeated payment_methods = 1
Ids of all supported Bisq altcoin payment methods.
service Price
grpc.proto:437rpc GetMarketPrice (, )
grpc.proto:439Get the current market price for a crypto currency.
message
grpc.proto:447string currency_code = 1
The three letter currency code.
message
grpc.proto:451double price = 1
The most recently available market price.
Get the volume weighted average trade price for BSQ, calculated over N days. The response contains the average BSQ trade price in USD to 4 decimal places, and in BTC to 8 decimal places.
message
grpc.proto:455sint32 days = 1
The number of days used in the average BSQ trade price calculations.
message
grpc.proto:459optional price = 1
The average BSQ trade price in USD to 4 decimal places, and in BTC to 8 decimal places.
service ShutdownServer
grpc.proto:470rpc Stop (, )
grpc.proto:472Shut down a local Bisq daemon.
message
grpc.proto:476(message has no fields)
message
grpc.proto:479(message has no fields)
service Trades
grpc.proto:485The Trades service provides rpc methods for taking, executing, and listing trades.
rpc GetTrade (, )
grpc.proto:487Get a currently open trade.
message
grpc.proto:560string trade_id = 1
The unique identifier of the trade.
message
grpc.proto:564optional trade = 1
The unique identifier of the trade.
rpc GetTrades (, )
grpc.proto:490Get currently open, or historical trades (closed or failed).
message
grpc.proto:568GetTradesRequest.Category category = 1
message
grpc.proto:578repeated trades = 1
All trades for GetTradesRequest.Category.
rpc TakeOffer (, )
grpc.proto:494Take an available offer. Your node must have a payment account with the same payment method as the offer's payment method, e.g., NATIONAL_BANK, SEPA, SWIFT, etc.
message
grpc.proto:519string offer_id = 1
The unique identifier of the offer being taken.
string payment_account_id = 2
The unique identifier of the payment account used to take a Bisq v1 protocol offer. This payment_account_id request param is not used when taking a BSQ Swap offer; all BSQ Swap transactions use the daemon's default BsqSwapAccount.
string taker_fee_currency_code = 3
The code of the currency (BSQ or BTC) used to pay the taker's Bisq v1 protocol trade fee. This taker_fee_currency_code request param is not used when taking a BSQ Swap offer; all BSQ Swap trade fees are paid in BSQ.
uint64 amount = 4
The trade's intended BTC amount in satoshis. Ten million satoshis is represented as 10000000. If set, the takeoffer amount value must be >= offer.min_amount and <= offer.amount. If not set (0 default), the taken offer's (max) amount becomes the intended trade amount.
message
grpc.proto:535optional trade = 1
The new trade.
optional failure_reason = 2
The reason the offer could not be taken.
rpc ConfirmPaymentStarted (, )
grpc.proto:497Send a 'payment started' message to a trading peer (the BTC seller).
message
grpc.proto:540string trade_id = 1
The unique identifier of the open trade.
Send a 'payment started' message with optional XMR specific parameters to a trading peer (the BTC seller).
message
grpc.proto:544string trade_id = 1
The unique identifier of the open trade.
string tx_id = 2
XMR txId for payment proof
string tx_key = 3
XMR txKey for payment proof
rpc ConfirmPaymentReceived (, )
grpc.proto:503Send a 'payment received' message to a trading peer (the BTC buyer).
message
grpc.proto:553string trade_id = 1
The unique identifier of the open trade.
message
grpc.proto:557(message has no fields)
rpc CloseTrade (, )
grpc.proto:506Close a completed trade; move it to trade history.
message
grpc.proto:582string trade_id = 1
The unique identifier of the trade.
message
grpc.proto:586(message has no fields)
rpc FailTrade (, )
grpc.proto:509Fail an open trade.
message
grpc.proto:589string trade_id = 1
The unique identifier of the trade.
message
grpc.proto:593(message has no fields)
rpc UnFailTrade (, )
grpc.proto:512Unfail a failed trade.
message
grpc.proto:596string trade_id = 1
The unique identifier of the trade.
message
grpc.proto:600(message has no fields)
rpc WithdrawFunds (, )
grpc.proto:515Withdraw trade proceeds to an external bitcoin wallet address.
message
grpc.proto:603string trade_id = 1
The unique identifier of the trade.
string address = 2
The receiver's bitcoin wallet address.
string memo = 3
An optional memo saved with the sent btc transaction.
message
grpc.proto:609(message has no fields)
service Wallets
grpc.proto:748The Wallets service provides rpc methods for basic wallet operations such as checking balances, sending BTC or BSQ to external wallets, checking transaction fee rates, setting or unsetting an encryption password on a a wallet, and unlocking / locking an encrypted wallet.
rpc GetNetwork (, )
grpc.proto:750Get the name of the BTC / BSQ network (mainnet, testnet3, or regtest).
message
grpc.proto:811(message has no fields)
message
grpc.proto:814string network = 1
The BTC network name (mainnet, testnet3, or regtest).
rpc GetDaoStatus (, )
grpc.proto:753Get status of the DAO.
message
grpc.proto:818(message has no fields)
message
grpc.proto:821bool is_dao_state_ready_and_in_sync = 1
rpc GetBalances (, )
grpc.proto:756Get the Bisq wallet's current BSQ and BTC balances.
message
grpc.proto:825string currency_code = 1
The Bisq wallet currency (BSQ or BTC) for the balances request.
message
grpc.proto:829optional balances = 1
The summary of Bisq wallet's BSQ and BTC balances.
rpc GetAddressBalance (, )
grpc.proto:759Get BTC balance for a wallet address.
message
grpc.proto:833string address = 1
The BTC wallet address being queried.
message
grpc.proto:837optional address_balance_info = 1
The BTC wallet address with its balance summary.
rpc GetUnusedBsqAddress (, )
grpc.proto:762Get an unused BSQ wallet address.
message
grpc.proto:841(message has no fields)
message
grpc.proto:844string address = 1
The BSQ wallet's unused address.
rpc SendBsq (, )
grpc.proto:765Send an amount of BSQ to an external address.
message
grpc.proto:848string address = 1
The external BSQ wallet address.
string amount = 2
The amount being sent to the external BSQ wallet address, as a string in "#######,##" format.
string tx_fee_rate = 3
An optional bitcoin miner transaction fee rate, in sats/byte. If not defined, Bisq will revert to the custom transaction fee rate preference, if set, else the common Bisq network fee rate.
message
grpc.proto:858optional tx_info = 1
The summary of a bitcoin transaction. (BSQ is a colored coin, and transacted on the bitcoin blockchain.)
rpc SendBtc (, )
grpc.proto:768Send an amount of BTC to an external address.
message
grpc.proto:863string address = 1
The external bitcoin address.
string amount = 2
The amount of BTC to send to the external address, as a string in "##.########" (BTC unit) format.
string tx_fee_rate = 3
An optional bitcoin miner transaction fee rate, in sats/byte. If not defined, Bisq will revert to the custom transaction fee rate preference, if set, else the common Bisq network fee rate.
string memo = 4
An optional memo associated with the bitcoin transaction.
message
grpc.proto:875optional tx_info = 1
The summary of a bitcoin transaction.
rpc VerifyBsqSentToAddress (, )
grpc.proto:773Verify a specific amount of BSQ was received by a BSQ wallet address. This is a problematic way of verifying BSQ payment has been received for a v1 trade protocol BSQ-BTC trade, which has been solved by the introduction of BSQ swap trades, which use a different, unused BSQ address for each trade.
message
grpc.proto:879string address = 1
The internal BSQ wallet address.
string amount = 2
The amount supposedly sent to the BSQ wallet address, as a string in "#######,##" format.
message
grpc.proto:884bool is_amount_received = 1
Whether a specific BSQ wallet address has received a specific amount of BSQ. If the same address has received the same amount of BSQ more than once, a true value does not indicate payment has been made for a v1 protocol BSQ-BTC trade. This BSQ payment verification problem is solved with BSQ swaps, which use a different BSQ address for each swap transaction.
rpc GetTxFeeRate (, )
grpc.proto:776Get the Bisq network's most recently available bitcoin miner transaction fee rate, or custom fee rate if set.
message
grpc.proto:892(message has no fields)
message
grpc.proto:895optional tx_fee_rate_info = 1
The summary of the most recently available bitcoin transaction fee rates.
rpc SetTxFeeRatePreference (, )
grpc.proto:779Set the Bisq daemon's custom bitcoin miner transaction fee rate, in sats/byte.
message
grpc.proto:899uint64 tx_fee_rate_preference = 1
message
grpc.proto:903optional tx_fee_rate_info = 1
The summary of the most recently available bitcoin transaction fee rates.
Remove the custom bitcoin miner transaction fee rate; revert to the Bisq network's bitcoin miner transaction fee rate.
message
grpc.proto:907(message has no fields)
message
grpc.proto:910optional tx_fee_rate_info = 1
The summary of the most recently available bitcoin transaction fee rates.
rpc GetTransactions (, )
grpc.proto:785Get a bitcoin transactions.
message
grpc.proto:914(message has no fields)
message
grpc.proto:917repeated tx_info = 1
List of Bitcoin transactions.
rpc GetTransaction (, )
grpc.proto:789Get a bitcoin transaction summary.
message
grpc.proto:921string tx_id = 1
message
grpc.proto:925optional tx_info = 1
The summary of a bitcoin transaction.
rpc GetFundingAddresses (, )
grpc.proto:792Get all bitcoin receiving addresses in the Bisq BTC wallet.
message
grpc.proto:929(message has no fields)
message
grpc.proto:932repeated address_balance_info = 1
The list of BTC wallet addresses with their balances.
rpc SetWalletPassword (, )
grpc.proto:795Set the Bisq wallet's encryption password.
message
grpc.proto:936string password = 1
The new password for encrypting an unencrypted Bisq wallet.
string new_password = 2
The new password for encrypting an already encrypted Bisq wallet (a password override).
message
grpc.proto:941(message has no fields)
rpc RemoveWalletPassword (, )
grpc.proto:798Remove the encryption password from the Bisq wallet.
message
grpc.proto:944string password = 1
The Bisq wallet's current encryption password.
message
grpc.proto:948(message has no fields)
rpc LockWallet (, )
grpc.proto:801Lock an encrypted Bisq wallet before the UnlockWallet rpc method's timeout period has expired.
message
grpc.proto:951(message has no fields)
message
grpc.proto:954(message has no fields)
rpc UnlockWallet (, )
grpc.proto:807Unlock a Bisq encrypted wallet before calling wallet sensitive rpc methods: CreateOffer, TakeOffer, GetBalances, etc., for a timeout period in seconds. An unlocked wallet will automatically lock itself after the timeout period has expired, or a LockWallet request has been made, whichever is first. An unlocked wallet's timeout setting can be overridden by subsequent UnlockWallet calls.
message
grpc.proto:957string password = 1
The Bisq wallet's encryption password.
uint64 timeout = 2
The Bisq wallet's unlock time period, in seconds.
message
grpc.proto:962(message has no fields)
message
pb.proto:888Used in: ,
bytes hash = 1
int64 date = 2
message
pb.proto:1546We use a list not a hash map to save disc space. The hash can be calculated from the payload anyway.
Used in:
repeated items = 1
message
pb.proto:2042Used in: , ,
uint32 height = 1
uint32 time_in_sec = 2
bytes truncated_hash = 3
bytes truncated_previous_block_hash = 4
repeated txs = 5
message
pb.proto:2036Used in:
uint32 type = 1
repeated outputs = 2
bytes truncated_tx_id = 3
message
pb.proto:2031Burningman accounting data
Used in:
uint32 value = 1
string name = 2
message
pb.proto:1171Used in:
string holder_address = 1
message
pb.proto:221Used in:
string uid = 1
optional sender_node_address = 2
string source_type = 3
enum name. e.g. TradeMessage, DisputeMessage,...
string source_msg_class_name = 4
string source_uid = 5
uid of source (TradeMessage)
string source_id = 6
id of source (tradeId, disputeId)
bool success = 7
true if source message was processed successfully
string error_message = 8
optional error message if source message processing failed
message
pb.proto:201Used in:
optional entry = 1
message
pb.proto:213Used in:
optional payload = 1
message
grpc.proto:1002Used in: ,
string address = 1
The bitcoin wallet address.
int64 balance = 2
The address' BTC balance in satoshis.
int64 num_confirmations = 3
The number of confirmations for the most recent transaction referencing the output address.
bool is_address_unused = 4
Whether the bitcoin address has ever been used, or not.
message
pb.proto:1573Used in:
string offer_id = 7
AddressEntry.Context context = 8
bytes pub_key = 9
bytes pub_key_hash = 10
int64 coin_locked_in_multi_sig = 11
bool segwit = 12
Used in:
PB_ERROR = 0
ARBITRATOR = 1
AVAILABLE = 2
OFFER_FUNDING = 3
RESERVED_FOR_TRADE = 4
MULTI_SIG = 5
TRADE_PAYOUT = 6
message
pb.proto:1569Used in:
repeated address_entry = 1
message
pb.proto:1372Used in:
string account_nr = 1
message
pb.proto:685Used in: ,
string message = 1
string version = 2
bool is_update_info = 3
string signature_as_base64 = 4
bytes owner_pub_key_bytes = 5
map<string, string> extra_data = 6
bool is_pre_release_info = 7
message
pb.proto:1111Used in:
string account_nr = 1
message
pb.proto:1235Used in:
string email_or_mobile_nr = 1
string country_code = 2
message
pb.proto:1886Used in:
repeated dispute = 1
message
pb.proto:695Used in: ,
optional node_address = 1
repeated string language_codes = 2
int64 registration_date = 3
string registration_signature = 4
bytes registration_pub_key = 5
optional pub_key_ring = 6
bytes btc_pub_key = 7
string btc_address = 8
string email_address = 9
string info = 10
map<string, string> extra_data = 11
message
pb.proto:952Used in:
string file_name = 1
bytes bytes = 2
message
pb.proto:1195Used in:
string bank_account_name = 1
string payid = 2
message
pb.proto:1997Used in:
bool enabled = 1
int32 required_confirmations = 2
int64 trade_limit = 3
repeated string service_addresses = 4
string currency_code = 5
Used in: ,
PB_ERROR = 0
UNKNOWN_FAILURE = 1
AVAILABLE = 2
OFFER_TAKEN = 3
PRICE_OUT_OF_TOLERANCE = 4
MARKET_PRICE_NOT_AVAILABLE = 5
NO_ARBITRATORS = 6
NO_MEDIATORS = 7
USER_IGNORED = 8
MISSING_MANDATORY_CAPABILITY = 9
NO_REFUND_AGENTS = 10
UNCONF_TX_LIMIT_HIT = 11
MAKER_DENIED_API_USER = 12
PRICE_CHECK_FAILED = 13
INVALID_SNAPSHOT_HEIGHT = 14
message
grpc.proto:357An offer's current availability status.
Used in:
AvailabilityResult availability_result = 1
An offer's current status as an eum.
string description = 2
A user friendly description of an offer's current availability status.
message
grpc.proto:465The average BSQ trade price in USD and BTC.
Used in:
string usd_price = 1
The average BSQ trade price in USD to 4 decimal places.
string btc_price = 2
The average BSQ trade price in BTC to 8 decimal places.
message
grpc.proto:965Used in:
optional bsq = 1
BSQ wallet balance information.
optional btc = 2
BTC wallet balance information.
message
pb.proto:2363Used in:
optional proposal = 1
optional vote = 2
message
pb.proto:2372Used in: , ,
repeated ballot = 1
message
pb.proto:1152Used in:
string holder_name = 1
string bank_name = 2
string bank_id = 3
string branch_id = 4
string account_nr = 5
string account_type = 6
string holder_tax_id = 7
string email = 8
oneof message
national_bank_account_payload = 9
same_bank_accont_payload = 10
specific_banks_account_payload = 11
ach_transfer_account_payload = 13
domestic_wire_transfer_account_payload = 14
string national_account_id = 12
message
pb.proto:2075DAO
Used in: , , ,
int32 height = 1
int64 time = 2
string hash = 3
string previous_block_hash = 4
oneof message
raw_block = 5
block = 6
message
pb.proto:2100Used in: ,
string tx_version = 1
string id = 2
int32 block_height = 3
string block_hash = 4
int64 time = 5
repeated tx_inputs = 6
oneof message
raw_tx = 7
tx = 8
message
pb.proto:2151Used in: , ,
int32 index = 1
int64 value = 2
string tx_id = 3
optional pub_key_script = 4
string address = 5
bytes op_return_data = 6
int32 block_height = 7
oneof message
raw_tx_output = 8
tx_output = 9
message
pb.proto:1406Used in:
string mobile_nr = 1
message
pb.proto:2408Used in: , ,
bytes encrypted_votes = 1
string tx_id = 2
int64 stake = 3
bytes encrypted_merit_list = 4
int64 date = 5
map<string, string> extra_data = 6
message
pb.proto:2425Used in: ,
optional blind_vote = 1
bytes hash = 2
message
pb.proto:2485Used in: ,
int32 height = 1
bytes hash = 2
bytes prev_hash = 3
int32 num_blind_votes = 4
message
pb.proto:2421Used in:
repeated items = 1
message
pb.proto:2095Used in:
repeated txs = 1
Because of the way how PB implements inheritance we need to use the super class as type.
message
pb.proto:2492Used in:
string name = 1
string tx_url = 2
string address_url = 3
message
grpc.proto:970Used in:
uint64 available_confirmed_balance = 1
The BSQ amount currently available to send to other addresses at the user's discretion, in satoshis.
uint64 unverified_balance = 2
The BSQ amount currently being used in send transactions, in satoshis. Unverified BSQ balances are not spendable until returned to the available_confirmed_balance when send transactions have been confirmed.
uint64 unconfirmed_change_balance = 3
The BSQ transaction change amount tied up in unconfirmed transactions, remaining unspendable until transactions have been confirmed and the change returned to the available_confirmed_balance.
uint64 locked_for_voting_balance = 4
The locked BSQ amount held by DAO voting transaction.
uint64 lockup_bonds_balance = 5
The locked BSQ amount held by DAO bonding transaction.
uint64 unlocking_bonds_balance = 6
The BSQ bonding amount in unlocking state, awaiting a lockup transaction's lock time expiry before the funds can be spent in normal transactions.
message
pb.proto:2086Used in:
repeated blocks = 1
message
pb.proto:1263Used in:
(message has no fields)
message
pb.proto:1804Used in:
optional bsq_swap_trade = 1
message
pb.proto:1808Used in:
optional bsq_swap_trade = 1
message
pb.proto:429Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
bytes tx = 4
repeated btc_inputs = 5
int64 btc_change = 6
string bsq_payout_address = 7
string btc_change_address = 8
message
pb.proto:440Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
bytes tx = 4
message
pb.proto:863Used in: ,
string id = 1
int64 date = 2
optional owner_node_address = 3
optional pub_key_ring = 4
OfferDirection direction = 5
int64 price = 6
int64 amount = 7
int64 min_amount = 8
optional proof_of_work = 9
map<string, string> extra_data = 10
string version_nr = 11
int32 protocol_version = 12
message
pb.proto:1864Used in:
optional trade_peer = 1
optional pub_key_ring = 2
string btc_address = 3
string bsq_address = 4
repeated inputs = 5
int64 change = 6
int64 payout = 7
bytes tx = 8
int64 tx_fee = 9
message
pb.proto:1812Used in:
optional bsq_swap_trade = 1
message
pb.proto:1816Used in:
optional bsq_swap_trade = 1
message
pb.proto:1782Used in: , , ,
string uid = 1
optional offer = 2
int64 amount = 3
int64 take_offer_date = 4
optional peer_node_address = 5
int64 mining_fee_per_byte = 6
int64 maker_fee = 7
int64 taker_fee = 8
optional bsq_swap_protocol_model = 9
string tx_id = 10
string error_message = 11
BsqSwapTrade.State state = 12
Used in:
PB_ERROR_STATE = 0
PREPARATION = 1
COMPLETED = 2
FAILED = 3
message
grpc.proto:700BSQ Swap protocol specific fields not common to Bisq v1 trade protocol fields.
Used in:
string tx_id = 1
The BSQ swap's bitcoin transaction id.
uint64 bsq_trade_amount = 2
The amount of BSQ swapped in satoshis.
uint64 btc_trade_amount = 3
The amount of BTC swapped in satoshis.
uint64 bsq_maker_trade_fee = 4
The swap offer maker's BSQ trade fee.
uint64 bsq_taker_trade_fee = 5
The swap offer taker's BSQ trade fee.
uint64 tx_fee_per_vbyte = 6
The swap transaction's bitcoin transaction id.
string maker_bsq_address = 7
The swap offer maker's BSQ wallet address.
string maker_btc_address = 8
The swap offer maker's BTC wallet address.
string taker_bsq_address = 9
The swap offer taker's BSQ wallet address.
string taker_btc_address = 10
The swap offer taker's BTC wallet address.
uint64 num_confirmations = 11
The confirmations count for the completed swap's bitcoin transaction.
string error_message = 12
An explanation for a failure to complete the swap.
uint64 payout = 13
The amount of the user's trade payout in satoshis.
uint64 swap_peer_payout = 14
The amount of the peer's trade payout in satoshis.
message
pb.proto:1876Used in:
optional pub_key_ring = 1
string btc_address = 2
string bsq_address = 3
repeated inputs = 4
int64 change = 5
int64 payout = 6
bytes tx = 7
message
pb.proto:419Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
repeated bsq_inputs = 4
int64 bsq_change = 5
string buyers_btc_payout_address = 6
string buyers_bsq_change_address = 7
message
grpc.proto:988Used in:
uint64 available_balance = 1
The BTC amount currently available to send to other addresses at the user's discretion, in satoshis.
uint64 reserved_balance = 2
The BTC amount currently reserved to cover open offers' security deposits, and BTC sellers' payout amounts, in satoshis. Reserved funds are not spendable, but are recoverable by users. When a user cancels an offer funds reserved for that offer are returned to the available_balance.
uint64 total_available_balance = 3
The sum of available_balance + reserved_balance, in satoshis.
uint64 locked_balance = 4
The BTC amount being locked to cover the security deposits and BTC seller's pending trade payouts. Locked funds are not recoverable until a trade is completed, when security deposits are returned to the available_balance.
message
pb.proto:108Used in:
repeated envelopes = 1
message
pb.proto:2050Used in:
repeated blocks = 1
message
pb.proto:1766Used in:
optional trade = 1
message
pb.proto:1770Used in:
optional trade = 1
message
pb.proto:403Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
optional taker_pub_key_ring = 4
int64 trade_amount = 5
int64 tx_fee_per_vbyte = 6
int64 maker_fee = 7
int64 taker_fee = 8
int64 trade_date = 9
repeated bsq_inputs = 10
int64 bsq_change = 11
string buyers_btc_payout_address = 12
string buyers_bsq_change_address = 13
message
pb.proto:1531Used in:
bytes bytes = 1
message
pb.proto:1394Used in:
string account_nr = 1
message
pb.proto:1290Deprecated, not used.
Used in:
string cash_tag = 1
message
pb.proto:1362Used in:
string postal_address = 1
string contact = 2
string extra_info = 3
message
pb.proto:1204Used in:
string holder_name = 1
string holder_email = 2
string bank_name = 3
string bank_id = 4
string branch_id = 5
string account_nr = 6
string account_type = 7
string requirements = 8
string holder_tax_id = 9
string national_account_id = 10
message
pb.proto:1398Used in:
string email = 1
message
pb.proto:2293Used in:
string param = 1
Name of enum.
string param_value = 2
message
pb.proto:1119Used in:
string email = 1
string holder_name = 2
message
pb.proto:469Used in: , , ,
int64 date = 1
string trade_id = 2
int32 trader_id = 3
bool sender_is_trader = 4
string message = 5
repeated attachments = 6
bool arrived = 7
bool stored_in_mailbox = 8
bool is_system_message = 9
optional sender_node_address = 10
string uid = 11
string send_message_error = 12
bool acknowledged = 13
string ack_error = 14
SupportType type = 15
bool was_displayed = 16
message
pb.proto:1124Used in:
string holder_name = 1
string email_or_mobile_nr = 2
message
pb.proto:217Used in:
string reason = 1
message
pb.proto:2283Used in:
int64 requested_bsq = 1
string bsq_address = 2
message
grpc.proto:550Used as response type in: Trades.ConfirmPaymentStarted, Trades.ConfirmPaymentStartedXmr
(message has no fields)
message
pb.proto:2382string lockup_tx_id = 1
message
pb.proto:2304Used in:
string lockup_tx_id = 1
message
pb.proto:1009Used in: ,
optional offer_payload = 1
int64 trade_amount = 2
int64 trade_price = 3
string taker_fee_tx_id = 4
bool is_buyer_maker_and_seller_taker = 6
string maker_account_id = 7
string taker_account_id = 8
optional maker_payment_account_payload = 9
Not used anymore from 1.7.0 but kept for backward compatibility.
optional taker_payment_account_payload = 10
Not used anymore from 1.7.0 but kept for backward compatibility.
optional maker_pub_key_ring = 11
optional taker_pub_key_ring = 12
optional buyer_node_address = 13
optional seller_node_address = 14
string maker_payout_address_string = 15
string taker_payout_address_string = 16
bytes maker_multi_sig_pub_key = 17
bytes taker_multi_sig_pub_key = 18
optional mediator_node_address = 19
int64 lock_time = 20
optional refund_agent_node_address = 21
bytes hash_of_makers_payment_account_payload = 22
bytes hash_of_takers_payment_account_payload = 23
string maker_payment_method_id = 24
string taker_payment_method_id = 25
message
grpc.proto:682Used in:
string buyer_node_address = 1
The BTC buyer peer's node address.
string seller_node_address = 2
The BTC seller peer's node address.
string mediator_node_address = 3
If the trade was disputed, the Bisq mediator's node address.
string refund_agent_node_address = 4
If a trade refund was requested, the Bisq refund agent's node address.
bool is_buyer_maker_and_seller_taker = 5
Whether the BTC buyer created the original offer, or not.
string maker_account_id = 6
The offer maker's payment account id.
string taker_account_id = 7
The offer taker's payment account id.
optional maker_payment_account_payload = 8
A summary of the offer maker's payment account.
optional taker_payment_account_payload = 9
A summary of the offer taker's payment account.
string maker_payout_address_string = 10
The offer maker's BTC payout address.
string taker_payout_address_string = 11
The offer taker's BTC payout address.
uint64 lock_time = 12
The earliest time a transaction can be added to the block chain.
message
pb.proto:336Used in:
string trade_id = 1
string buyer_payout_address = 2
optional sender_node_address = 3
bytes buyer_signature = 4
string counter_currency_tx_id = 5
string uid = 6
string counter_currency_extra_data = 7
message
pb.proto:2536Used in:
string code = 1
string name = 2
optional region = 3
message
pb.proto:1129Used in:
string countryCode = 1
oneof message
bank_account_payload = 2
cash_deposit_account_payload = 3
sepa_account_payload = 4
western_union_account_payload = 5
sepa_instant_account_payload = 6
f2f_account_payload = 7
upi_account_payload = 9
paytm_account_payload = 10
ifsc_based_account_payload = 11
nequi_account_payload = 12
bizum_account_payload = 13
pix_account_payload = 14
satispay_account_payload = 15
strike_account_payload = 16
tikkie_account_payload = 17
transferwise_usd_account_payload = 18
mercado_pago_account_payload = 19
message
pb.proto:2528Used in:
bool is_asset = 1
message
pb.proto:1255Used in:
string address = 1
message
pb.proto:2515Used in:
string currency_code = 1
message
pb.proto:2236Used in:
int32 height_of_first_lock = 1
repeated dao_phase = 2
message
pb.proto:2231Used in:
int32 phase_ordinal = 1
int32 duration = 2
message
pb.proto:2241Used in:
int32 chain_height = 1
repeated blocks = 2
Because of the way how PB implements inheritance we need to use the super class as type.
repeated cycles = 3
map<string, > unspent_tx_output_map = 4
Because of the way how PB implements inheritance we need to use the super class as type.
map<string, > issuance_map = 5
repeated string confiscated_lockup_tx_list = 6
map<string, > spent_info_map = 7
repeated param_change_list = 8
repeated evaluated_proposal_list = 9
repeated decrypted_ballots_with_merits_list = 10
message
pb.proto:2471Used in: , ,
int32 height = 1
bytes hash = 2
bytes prev_hash = 3
bool is_self_created = 4
message
pb.proto:2466Used in:
optional dao_state = 1
repeated dao_state_hash = 2
message
pb.proto:646optional payload = 1
int32 sequence_number = 2
message
pb.proto:2457Used in:
bytes hash_of_blind_vote_list = 1
string blind_vote_tx_id = 2
string vote_reveal_tx_id = 3
int64 stake = 4
optional ballot_list = 5
optional merit_list = 6
message
pb.proto:668Used in:
optional network_envelope = 1
bytes signature_pub_key_bytes = 2
message
pb.proto:291Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
bytes delayed_payout_tx = 4
bytes delayed_payout_tx_seller_signature = 5
message
pb.proto:299Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
bytes delayed_payout_tx_buyer_signature = 4
bytes deposit_tx = 5
message
pb.proto:307Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
bytes deposit_tx = 4
bytes delayed_payout_tx = 5
optional seller_payment_account_payload = 6
message
pb.proto:323Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
bytes deposit_tx_without_witnesses = 4
message
pb.proto:909Used in: , , , ,
string trade_id = 1
string id = 2
int32 trader_id = 3
bool dispute_opener_is_buyer = 4
bool dispute_opener_is_maker = 5
int64 opening_date = 6
optional trader_pub_key_ring = 7
int64 trade_date = 8
optional contract = 9
bytes contract_hash = 10
bytes deposit_tx_serialized = 11
bytes payout_tx_serialized = 12
string deposit_tx_id = 13
string payout_tx_id = 14
string contract_as_json = 15
string maker_contract_signature = 16
string taker_contract_signature = 17
optional agent_pub_key_ring = 18
bool is_support_ticket = 19
repeated chat_message = 20
bool is_closed = 21
optional dispute_result = 22
string dispute_payout_tx_id = 23
SupportType support_type = 24
string mediators_dispute_result = 25
string delayed_payout_tx_id = 26
string donation_address_of_delayed_payout_tx = 27
Dispute.State state = 28
int64 trade_period_end = 29
map<string, string> extra_data = 30
int32 burning_man_selection_height = 31
Added in v 1.9.7
int64 trade_tx_fee = 32
Added in v 1.9.7
Used in:
NEEDS_UPGRADE = 0
NEW = 1
OPEN = 2
REOPENED = 3
CLOSED = 4
RESULT_PROPOSED = 5
message
pb.proto:957Used in: ,
string trade_id = 1
int32 trader_id = 2
DisputeResult.Winner winner = 3
int32 reason_ordinal = 4
bool tamper_proof_evidence = 5
bool id_verification = 6
bool screen_cast = 7
string summary_notes = 8
optional chat_message = 9
bytes arbitrator_signature = 10
int64 buyer_payout_amount = 11
int64 seller_payout_amount = 12
bytes arbitrator_pub_key = 13
int64 close_date = 14
bool is_loser_publisher = 15
string payout_adjustment_percent = 16
DisputeResult.PayoutSuggestion payout_suggestion = 17
Used in:
CUSTOM_PAYOUT = 0
BUYER_GETS_TRADE_AMOUNT = 1
BUYER_GETS_TRADE_AMOUNT_PLUS_COMPENSATION = 2
BUYER_GETS_TRADE_AMOUNT_MINUS_PENALTY = 3
SELLER_GETS_TRADE_AMOUNT = 4
SELLER_GETS_TRADE_AMOUNT_PLUS_COMPENSATION = 5
SELLER_GETS_TRADE_AMOUNT_MINUS_PENALTY = 6
PB_ERROR_REASON = 0
OTHER = 1
BUG = 2
USABILITY = 3
SCAM = 4
PROTOCOL_VIOLATION = 5
NO_REPLY = 6
BANK_PROBLEMS = 7
OPTION_TRADE = 8
SELLER_NOT_RESPONDING = 9
WRONG_SENDER_ACCOUNT = 10
TRADE_ALREADY_SETTLED = 11
PEER_WAS_LATE = 12
Used in:
PB_ERROR_WINNER = 0
BUYER = 1
SELLER = 2
message
pb.proto:488Used in:
string uid = 1
optional dispute_result = 2
optional sender_node_address = 3
SupportType type = 4
message
pb.proto:1175Used in:
string holder_address = 1
message
pb.proto:2588Used in:
double value = 1
The EditType determines and constricts what offer details can be modified by the request, simplifying param validation. (The CLI need to infer this detail from 'editoffer' command options, other clients do not.)
Used in:
ACTIVATION_STATE_ONLY = 0
Edit only the offer's activation state (enabled or disabled).
FIXED_PRICE_ONLY = 1
Edit only the offer's fixed price.
FIXED_PRICE_AND_ACTIVATION_STATE = 2
Edit only the offer's fixed price and activation state.
MKT_PRICE_MARGIN_ONLY = 3
Edit only the offer's market price margin.
MKT_PRICE_MARGIN_AND_ACTIVATION_STATE = 4
Edit only the offer's market price margin and activation state.
TRIGGER_PRICE_ONLY = 5
Edit only the market price margin based offer's trigger price.
TRIGGER_PRICE_AND_ACTIVATION_STATE = 6
Edit only the market price margin based offer's trigger price and activation state.
MKT_PRICE_MARGIN_AND_TRIGGER_PRICE = 7
Edit only the offer's market price margin and trigger price.
MKT_PRICE_MARGIN_AND_TRIGGER_PRICE_AND_ACTIVATION_STATE = 8
Edit only the offer's market price margin, trigger price, and activation state.
message
pb.proto:2452Used in:
bool is_accepted = 1
optional proposal_vote_result = 2
message
pb.proto:1328Used in:
string contact = 1
string city = 2
string extra_info = 3
message
pb.proto:1266Used in:
string sort_code = 1
string account_nr = 2
string email = 3
message
pb.proto:2532Used in:
optional currency = 1
message
pb.proto:135Used in:
optional sender_node_address = 1
string uid = 2
string trade_id = 3
int32 trader_id = 4
int64 seq_num_or_file_length = 5
bytes message_data = 6
message
pb.proto:733Used in: ,
repeated string node_addresses_banned_from_trading = 1
repeated string banned_offer_ids = 2
repeated banned_payment_accounts = 3
string signature_as_base64 = 4
bytes owner_pub_key_bytes = 5
map<string, string> extra_data = 6
repeated string banned_currencies = 7
repeated string banned_payment_methods = 8
repeated string arbitrators = 9
repeated string seed_nodes = 10
repeated string price_relay_nodes = 11
bool prevent_public_btc_network = 12
repeated string btc_nodes = 13
bool disable_dao = 14
string disable_dao_below_version = 15
string disable_trade_below_version = 16
repeated string mediators = 17
repeated string refundAgents = 18
repeated string bannedSignerPubKeys = 19
repeated string btc_fee_receiver_addresses = 20
int64 creation_date = 21
string signer_pub_key_as_hex = 22
repeated string bannedPrivilegedDevPubKeys = 23
bool disable_auto_conf = 24
repeated string banned_auto_conf_explorers = 25
repeated string node_addresses_banned_from_network = 26
bool disable_api = 27
bool disable_mempool_validation = 28
bool disable_pow_message = 29
double pow_difficulty = 30
int64 maker_fee_btc = 31
int64 taker_fee_btc = 32
int64 maker_fee_bsq = 33
int64 taker_fee_bsq = 34
repeated int32 enabled_pow_versions = 35
repeated delayedPayoutPaymentAccounts = 36
repeated string addedBtcNodes = 37
repeated string addedSeedNodes = 38
string uid = 39
message
pb.proto:346string trade_id = 1
bytes seller_signature = 2
string seller_payout_address = 3
optional sender_node_address = 4
string uid = 5
message
pb.proto:2308Used in:
(message has no fields)
message
pb.proto:2054Used in:
int32 from_block_height = 1
int32 nonce = 2
optional sender_node_address = 3
repeated int32 supported_capabilities = 4
message
pb.proto:2061Used in:
repeated blocks = 1
int32 request_nonce = 2
string pub_key = 3
bytes signature = 4
message
pb.proto:554Used in:
int32 height = 1
int32 nonce = 2
message
pb.proto:569Used in:
repeated state_hashes = 1
int32 request_nonce = 2
message
pb.proto:510DAO blocks request.
Used in:
int32 from_block_height = 1
int32 nonce = 2
optional sender_node_address = 3
repeated int32 supported_capabilities = 4
message
pb.proto:518DAO blocks response.
Used in:
repeated raw_blocks = 1
Because of the way how PB implements inheritance we need to use the super class as type.
int32 request_nonce = 2
message
grpc.proto:158Used as request type in: Offers.GetBsqSwapOffers, Offers.GetMyBsqSwapOffers
string direction = 1
The BSQ swap offer's BUY (BTC) or SELL (BTC) direction.
message
pb.proto:544Used in:
int32 height = 1
int32 nonce = 2
message
pb.proto:559Used in:
repeated state_hashes = 1
int32 request_nonce = 2
message
pb.proto:119Used in:
int32 request_nonce = 1
bool is_get_updated_data_response = 2
repeated data_set = 3
repeated int32 supported_capabilities = 4
repeated persistable_network_payload_items = 5
bool was_truncated = 6
message
pb.proto:166Used in:
string version = 1
message
pb.proto:170Used in:
map<string, string> inventory = 1
message
grpc.proto:139Deprecated with rpc method GetMyOffer since 27-Dec-2021 (v1.8.0).
Used as request type in: Offers.GetMyBsqSwapOffer, Offers.GetMyOffer
string id = 1
The offer's unique identifier.
Used in:
UNKNOWN = 0
An invalid offer category probably indicates a software bug.
FIAT = 1
Indicates offer is to BUY or SELL BTC with a fiat currency.
ALTCOIN = 2
Indicates offer is to BUY or SELL BTC with an altcoin.
BSQ_SWAP = 3
Indicates offer is to swap BTC for BSQ.
message
grpc.proto:126Used as request type in: Offers.GetBsqSwapOffer, Offers.GetOffer
string id = 1
The offer's unique identifier.
message
pb.proto:144Used in:
optional sender_node_address = 1
int32 nonce = 2
repeated int32 supported_capabilities = 3
repeated reported_peers = 4
message
pb.proto:151Used in:
int32 request_nonce = 1
repeated reported_peers = 2
repeated int32 supported_capabilities = 3
message
pb.proto:549Used in:
int32 height = 1
int32 nonce = 2
message
pb.proto:564Used in:
repeated state_hashes = 1
int32 request_nonce = 2
Rpc method GetTrades parameter determining what category of trade list is is being requested.
Used in:
OPEN = 0
Get all currently open trades.
CLOSED = 1
Get all completed trades.
FAILED = 2
Get all failed trades.
message
pb.proto:128Used in:
optional sender_node_address = 1
int32 nonce = 2
repeated bytes excluded_keys = 3
string version = 4
message
pb.proto:1224Used in:
string mobile_nr = 1
message
pb.proto:1334Used in:
string holder_name = 1
string account_nr = 2
string ifsc = 3
oneof message
neft_account_payload = 4
rtgs_account_payload = 5
imps_account_payload = 6
message
pb.proto:659Used in:
map<string, uint64> data = 1
message
pb.proto:1351Used in:
(message has no fields)
message
pb.proto:239Used in:
string trade_id = 1
optional sender_node_address = 2
int64 trade_amount = 3
int64 trade_price = 4
int64 tx_fee = 5
int64 taker_fee = 6
bool is_currency_for_taker_fee_btc = 7
repeated raw_transaction_inputs = 8
int64 change_output_value = 9
string change_output_address = 10
bytes taker_multi_sig_pub_key = 11
string taker_payout_address_string = 12
optional taker_pub_key_ring = 13
optional taker_payment_account_payload = 14
Not used anymore from 1.7.0 but kept for backward compatibility.
string taker_account_id = 15
string taker_fee_tx_id = 16
repeated accepted_arbitrator_node_addresses = 17
repeated accepted_mediator_node_addresses = 18
optional arbitrator_node_address = 19
optional mediator_node_address = 20
string uid = 21
bytes account_age_witness_signature_of_offer_id = 22
int64 current_date = 23
repeated accepted_refund_agent_node_addresses = 24
optional refund_agent_node_address = 25
bytes hash_of_takers_payment_account_payload = 26
string takers_payout_method_id = 27
int32 burning_man_selection_height = 28
Added in v 1.9.7
message
pb.proto:271Used in:
string trade_id = 1
optional maker_payment_account_payload = 2
Not used anymore from 1.7.0 but kept for backward compatibility.
string maker_account_id = 3
string maker_contract_as_json = 4
string maker_contract_signature = 5
string maker_payout_address_string = 6
bytes prepared_deposit_tx = 7
repeated maker_inputs = 8
bytes maker_multi_sig_pub_key = 9
optional sender_node_address = 10
string uid = 11
bytes account_age_witness_signature_of_prepared_deposit_tx = 12
int64 current_date = 13
int64 lock_time = 14
bytes hash_of_makers_payment_account_payload = 15
string makers_payout_method_id = 16
message
pb.proto:1259Used in:
string address = 1
message
pb.proto:1272Used in:
string email = 1
string holder_name = 2
string question = 3
string answer = 4
message
pb.proto:2256Used in: ,
string tx_id = 1
int32 chain_height = 2
int64 amount = 3
string pub_key = 4
string issuance_type = 5
message
pb.proto:1185Used in:
string bank_name = 1
string bank_code = 2
string bank_branch_name = 3
string bank_branch_code = 4
string bank_account_type = 5
string bank_account_name = 6
string bank_account_number = 7
message
pb.proto:2584Used in:
uint64 value = 1
message
pb.proto:663Used in:
optional protected_mailbox_storage_entry = 1
optional decrypted_message_with_pub_key = 2
message
pb.proto:651Used in:
repeated mailbox_item = 1
message
pb.proto:807Used in:
optional prefixed_sealed_and_signed_message = 1
bytes sender_pub_key_for_add_operation_bytes = 2
bytes owner_pub_key_bytes = 3
map<string, string> extra_data = 4
message
pb.proto:1535Used in:
int32 sequence_nr = 1
int64 time_stamp = 2
message
pb.proto:2553Used in:
optional payment_account = 1
int32 trigger_value = 2
bool is_buy_offer = 3
repeated string alert_ids = 4
message
pb.proto:362Used in:
string trade_id = 1
bytes payout_tx = 2
optional sender_node_address = 3
string uid = 4
message
pb.proto:369Used in:
string uid = 1
string trade_id = 3
bytes tx_signature = 2
optional sender_node_address = 4
message
pb.proto:1890Used in:
repeated dispute = 1
Used in:
PB_ERROR_MEDIATION_RESULT = 0
UNDEFINED_MEDIATION_RESULT = 1
MEDIATION_RESULT_ACCEPTED = 2
MEDIATION_RESULT_REJECTED = 3
SIG_MSG_SENT = 4
SIG_MSG_ARRIVED = 5
SIG_MSG_IN_MAILBOX = 6
SIG_MSG_SEND_FAILED = 7
RECEIVED_SIG_MSG = 8
PAYOUT_TX_PUBLISHED = 9
PAYOUT_TX_PUBLISHED_MSG_SENT = 10
PAYOUT_TX_PUBLISHED_MSG_ARRIVED = 11
PAYOUT_TX_PUBLISHED_MSG_IN_MAILBOX = 12
PAYOUT_TX_PUBLISHED_MSG_SEND_FAILED = 13
RECEIVED_PAYOUT_TX_PUBLISHED_MSG = 14
PAYOUT_TX_SEEN_IN_NETWORK = 15
message
pb.proto:709Used in: ,
optional node_address = 1
repeated string language_codes = 2
int64 registration_date = 3
string registration_signature = 4
bytes registration_pub_key = 5
optional pub_key_ring = 6
string email_address = 7
string info = 8
map<string, string> extra_data = 9
message
pb.proto:1436Used in:
string holder_name = 1
string holder_id = 2
message
pb.proto:2434Used in:
optional issuance = 1
bytes signature = 2
message
pb.proto:2439Used in:
repeated merit = 1
message
pb.proto:2560string message = 1
optional sender_node_address = 2
string uid = 3
message
pb.proto:2566string message_version = 1
string message = 2
message
pb.proto:1414Used in:
string mobile_nr = 1
string holder_name = 2
message
pb.proto:1294Used in:
string account_id = 1
message
pb.proto:1217Used in:
string holder_name = 1
string country_code = 2
string state = 3
string email = 4
message
pb.proto:2417Used in:
repeated blind_vote = 1
message
pb.proto:2331Used in:
string tx_id = 1
string pre_image = 2
message
pb.proto:2336Used in:
repeated my_proof_of_burn = 1
message
pb.proto:2368Used in:
repeated proposal = 1
message
pb.proto:2322Used in:
string uid = 1
bytes salt = 2
message
pb.proto:2327Used in:
repeated my_reputation = 1
message
pb.proto:2386Used in:
int32 height = 1
optional ballot_list = 2
bytes secret_key_encoded = 3
optional blind_vote = 4
int64 date = 5
string reveal_tx_id = 6
message
pb.proto:2395Used in:
repeated my_vote = 1
message
pb.proto:1179Used in:
(message has no fields)
message
pb.proto:1592Used in:
repeated string path = 1
message
pb.proto:1345Used in:
(message has no fields)
message
pb.proto:1402Used in:
string mobile_nr = 1
message
pb.proto:23Used in: ,
int32 message_version = 1
oneof message
preliminary_get_data_request = 2
get_data_response = 3
get_updated_data_request = 4
get_peers_request = 5
get_peers_response = 6
ping = 7
pong = 8
offer_availability_request = 9
offer_availability_response = 10
refresh_offer_message = 11
add_data_message = 12
remove_data_message = 13
remove_mailbox_data_message = 14
close_connection_message = 15
prefixed_sealed_and_signed_message = 16
inputs_for_deposit_tx_request = 17
inputs_for_deposit_tx_response = 18
deposit_tx_message = 19
counter_currency_transfer_started_message = 20
payout_tx_published_message = 21
open_new_dispute_message = 22
peer_opened_dispute_message = 23
chat_message = 24
dispute_result_message = 25
peer_published_dispute_payout_tx_message = 26
private_notification_message = 27
get_blocks_request = 28
get_blocks_response = 29
new_block_broadcast_message = 30
add_persistable_network_payload_message = 31
ack_message = 32
republish_governance_data_request = 33
new_dao_state_hash_message = 34
get_dao_state_hashes_request = 35
get_dao_state_hashes_response = 36
new_proposal_state_hash_message = 37
get_proposal_state_hashes_request = 38
get_proposal_state_hashes_response = 39
new_blind_vote_state_hash_message = 40
get_blind_vote_state_hashes_request = 41
get_blind_vote_state_hashes_response = 42
bundle_of_envelopes = 43
mediated_payout_tx_signature_message = 44
mediated_payout_tx_published_message = 45
delayed_payout_tx_signature_request = 46
delayed_payout_tx_signature_response = 47
deposit_tx_and_delayed_payout_tx_message = 48
peer_published_delayed_payout_tx_message = 49
refresh_trade_state_request = 50
trader_signed_witness_message = 51
get_inventory_request = 52
get_inventory_response = 53
share_buyer_payment_account_message = 54
Added at 1.7.0
sellers_bsq_swap_request = 55
buyers_bsq_swap_request = 56
bsq_swap_tx_inputs_message = 57
bsq_swap_finalize_tx_request = 58
bsq_swap_finalized_tx_message = 59
file_transfer_part = 60
get_accounting_blocks_request = 61
get_accounting_blocks_response = 62
new_accounting_block_broadcast_message = 63
message
pb.proto:2068Used in:
optional block = 1
string pub_key = 2
bytes signature = 3
message
pb.proto:540Used in:
optional state_hash = 1
message
pb.proto:524Used in:
optional raw_block = 1
Because of the way how PB implements inheritance we need to use the super class as type.
message
pb.proto:532Used in:
optional state_hash = 1
message
pb.proto:536Used in:
optional state_hash = 1
message
pb.proto:574Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string host_name = 1
int32 port = 2
message
pb.proto:1280Deprecated, not used.
Used in:
string account_nr = 1
message
pb.proto:1604Used in: , ,
oneof message
offer_payload = 1
bsq_swap_offer_payload = 2
PB_ERROR = 0
UNKNOWN = 1
OFFER_FEE_PAID = 2
AVAILABLE = 3
NOT_AVAILABLE = 4
REMOVED = 5
MAKER_OFFLINE = 6
message
pb.proto:174Used in:
string offer_id = 1
optional pub_key_ring = 2
int64 takers_trade_price = 3
repeated int32 supported_capabilities = 4
string uid = 5
bool is_taker_api_user = 6
int32 burning_man_selection_height = 7
Added in v 1.9.7
message
pb.proto:184Used in:
string offer_id = 1
AvailabilityResult availability_result = 2
repeated int32 supported_capabilities = 3
string uid = 4
optional arbitrator = 5
optional mediator = 6
optional refund_agent = 7
Used in: , ,
OFFER_DIRECTION_ERROR = 0
BUY = 1
SELL = 2
message
grpc.proto:284OfferInfo describes an offer to a client. It is derived from the heavier Offer object in the daemon, which holds too much state to be sent to clients.
Used in: , , , , , , , , , ,
string id = 1
The offer's unique identifier.
string direction = 2
The offer's BUY (BTC) or SELL (BTC) direction.
string price = 3
For fiat offers: the fiat price for 1 BTC to 4 decimal places, e.g., 45000 EUR is "45000.0000". For altcoin offers: the altcoin price for 1 BTC to 8 decimal places, e.g., 0.00005 BTC is "0.00005000".
bool use_market_based_price = 4
Whether the offer price is fixed, or market price margin based.
double market_price_margin_pct = 5
The offer's market price margin above or below the current market BTC price, e.g., 5.00 represents 5%.
uint64 amount = 6
The offer's BTC amount in satoshis. Ten million satoshis is represented as 10000000.
uint64 min_amount = 7
The offer's minimum BTC amount in satoshis. One million satoshis is represented as 1000000.
string volume = 8
The rounded volume of currency to be traded for BTC. Fiat volume is rounded to whole currency units (no cents). Altcoin volume is rounded to 2 decimal places.
string min_volume = 9
The rounded, minimum volume of currency to be traded for BTC. Fiat volume is rounded to whole currency units (no cents). Altcoin volume is rounded to 2 decimal places.
uint64 buyer_security_deposit = 10
A long representing the BTC buyer's security deposit in satoshis.
string trigger_price = 11
A market price margin based offer's trigger price is the market BTC price at which the offer is automatically disabled. Disabled offers are never automatically enabled, they must be manually re-enabled. A zero value indicates trigger price is not set. Trigger price does not apply to fixed price offers.
bool is_currency_for_maker_fee_btc = 12
Whether the offer maker paid the trading fee in BTC or not (BSQ).
string payment_account_id = 13
The unique identifier of the payment account used to create the offer.
string payment_method_id = 14
The unique identifier of the payment method used to create the offer.
string payment_method_short_name = 15
The short description of the payment method used to create the offer.
string base_currency_code = 16
For fiat offers, the baseCurrencyCode is BTC, and the counter_currency_code is the fiat currency code. For altcoin offers it is the opposite, the baseCurrencyCode is the altcoin code and the counter_currency_code is BTC.
string counter_currency_code = 17
For fiat offers, the base_currency_code is BTC, and the counter_currency_code is the fiat currency code. For altcoin offers it is the opposite, the base_currency_code is the altcoin code and the counter_currency_code is BTC.
uint64 date = 18
The creation date of the offer as a long: the number of milliseconds that have elapsed since January 1, 1970.
string state = 19
The internal state of the offer, e.g., AVAILABLE, NOT_AVAILABLE, REMOVED, etc.
uint64 seller_security_deposit = 20
A long representing the BTC seller's security deposit in satoshis.
string offer_fee_payment_tx_id = 21
The bitcoin transaction id of the offer maker's fee payment.
uint64 tx_fee = 22
The bitcoin transaction fee (amount) for the offer maker's fee payment transaction, in satoshis.
uint64 maker_fee = 23
The offer maker's Bisq trade fee amount in satoshis.
bool is_activated = 24
Whether the offer is currently enabled or not.
bool is_my_offer = 25
Whether the offer was created by the user or not.
bool is_my_pending_offer = 26
Whether the newly created offer was created by the user or not.
bool is_bsq_swap_offer = 27
Whether the offer is a BSQ swap offer or not (v1 protocol offer).
string owner_node_address = 28
The offer creator's Tor onion address.
string pub_key_ring = 29
The offer creator's public key ring as a string.
string version_nr = 30
The Bisq software version used to create the offer.
int32 protocol_version = 31
The bitcoin protocol version used to create the offer.
message
pb.proto:814Used in: , ,
string id = 1
int64 date = 2
optional owner_node_address = 3
optional pub_key_ring = 4
OfferDirection direction = 5
int64 price = 6
double market_price_margin = 7
bool use_market_based_price = 8
int64 amount = 9
int64 min_amount = 10
string base_currency_code = 11
string counter_currency_code = 12
repeated arbitrator_node_addresses = 13
Not used anymore but still required as old clients check for nonNull.
repeated mediator_node_addresses = 14
Not used anymore but still required as old clients check for nonNull.
string payment_method_id = 15
string maker_payment_account_id = 16
string offer_fee_payment_tx_id = 17
string country_code = 18
repeated string accepted_country_codes = 19
string bank_id = 20
repeated string accepted_bank_ids = 21
string version_nr = 22
int64 block_height_at_offer_creation = 23
int64 tx_fee = 24
int64 maker_fee = 25
bool is_currency_for_maker_fee_btc = 26
int64 buyer_security_deposit = 27
int64 seller_security_deposit = 28
int64 max_trade_limit = 29
int64 max_trade_period = 30
bool use_auto_close = 31
bool use_re_open_after_auto_close = 32
int64 lower_close_price = 33
int64 upper_close_price = 34
bool is_private_offer = 35
string hash_of_challenge = 36
map<string, string> extra_data = 37
int32 protocol_version = 38
message
pb.proto:455Used in:
optional dispute = 1
optional sender_node_address = 2
string uid = 3
SupportType type = 4
message
pb.proto:1621Used in:
optional offer = 1
OpenOffer.State state = 2
optional arbitrator_node_address = 3
optional mediator_node_address = 4
optional refund_agent_node_address = 5
int64 trigger_price = 6
Used in:
PB_ERROR = 0
AVAILABLE = 1
RESERVED = 2
CLOSED = 3
CANCELED = 4
DEACTIVATED = 5
message
pb.proto:2376Used in:
string param_name = 1
string param_value = 2
int32 activation_height = 3
message
pb.proto:1390Used in:
string email = 1
message
pb.proto:2498Used in: , , , , , , , ,
string id = 1
int64 creation_date = 2
optional payment_method = 3
string account_name = 4
repeated trade_currencies = 5
optional selected_trade_currency = 6
optional payment_account_payload = 7
map<string, string> extra_data = 8
message
pb.proto:679Used in:
string payment_method_id = 1
string get_method_name = 2
string value = 3
message
pb.proto:1596Used in:
repeated payment_account = 1
message
pb.proto:1064Used in: , , , , , ,
string id = 1
string payment_method_id = 2
int64 max_trade_period = 3
Not used anymore but we need to keep it in PB for backward compatibility.
oneof message
ali_pay_account_payload = 4
chase_quick_pay_account_payload = 5
clear_xchange_account_payload = 6
country_based_payment_account_payload = 7
crypto_currency_account_payload = 8
faster_payments_account_payload = 9
interac_e_transfer_account_payload = 10
o_k_pay_account_payload = 11
perfect_money_account_payload = 12
swish_account_payload = 13
u_s_postal_money_order_account_payload = 14
uphold_account_payload = 16
cash_app_account_payload = 17
money_beam_account_payload = 18
venmo_account_payload = 19
popmoney_account_payload = 20
revolut_account_payload = 21
we_chat_pay_account_payload = 22
money_gram_account_payload = 23
hal_cash_account_payload = 24
prompt_pay_account_payload = 25
advanced_cash_account_payload = 26
instant_crypto_currency_account_payload = 27
japan_bank_account_payload = 28
Transferwise_account_payload = 29
australia_payid_payload = 30
amazon_gift_card_account_payload = 31
cash_by_mail_account_payload = 32
capitual_account_payload = 33
Paysera_account_payload = 34
Paxum_account_payload = 35
swift_account_payload = 36
cel_pay_account_payload = 37
monese_account_payload = 38
verse_account_payload = 39
bsq_swap_account_payload = 40
sbp_account_payload = 41
map<string, string> exclude_from_json_data = 15
message
grpc.proto:717Used in:
string id = 1
The unique identifier of the payment account.
string payment_method_id = 2
The unique identifier of the payment method.
string address = 3
The optional altcoin wallet address associated with the (altcoin) payment account.
string payment_details = 4
The optional payment details, if available.
message
pb.proto:2509Used in: , ,
string id = 1
int64 max_trade_period = 2
int64 max_trade_limit = 3
message
pb.proto:354Used in:
string trade_id = 1
bytes payout_tx = 2
optional sender_node_address = 3
string uid = 4
optional signed_witness = 5
Added in v1.4.0
message
pb.proto:1386Used in:
string email = 1
message
pb.proto:1358Used in:
string email_or_mobile_nr = 1
message
pb.proto:579Used in: , ,
optional node_address = 1
int64 date = 2
repeated int32 supported_capabilities = 3
message
pb.proto:1565Used in:
repeated peer = 1
message
pb.proto:462Used in:
optional dispute = 1
optional sender_node_address = 2
string uid = 3
SupportType type = 4
message
pb.proto:330Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
message
pb.proto:495Used in:
string uid = 1
bytes transaction = 2
string trade_id = 3
optional sender_node_address = 4
SupportType type = 5
message
pb.proto:1314Used in:
string account_nr = 1
message
pb.proto:1468oneof message
sequence_number_map = 1
persisted_entry_map = 2
peer_list = 3
address_entry_list = 4
navigation_path = 5
tradable_list = 6
arbitration_dispute_list = 8
preferences_payload = 9
user_payload = 10
payment_account_list = 11
account_age_witness_store = 13
trade_statistics2_store = 14
proposal_store = 16
temp_proposal_store = 17
blind_vote_store = 18
my_proposal_list = 19
ballot_list = 20
my_vote_list = 21
my_blind_vote_list = 22
dao_state_store = 24
my_reputation_list = 25
my_proof_of_burn_list = 26
unconfirmed_bsq_change_output_list = 27
signed_witness_store = 28
mediation_dispute_list = 29
refund_dispute_list = 30
trade_statistics3_store = 31
mailbox_message_list = 32
ignored_mailbox_map = 33
removed_payloads_map = 34
bsq_block_store = 35
burning_man_accounting_store = 36
message
pb.proto:615Used in: ,
oneof message
account_age_witness = 1
trade_statistics2 = 2
proposal_payload = 3
blind_vote_payload = 4
signed_witness = 5
trade_statistics3 = 6
message
pb.proto:1541Deprecated. Not used anymore.
Used in:
map<string, > persisted_entry_map = 1
message
pb.proto:157Used in:
int32 nonce = 1
int32 last_round_trip_time = 2
message
pb.proto:1410Used in:
string pix_key = 1
message
pb.proto:162Used in:
int32 request_nonce = 1
message
pb.proto:1304Used in:
string account_id = 1
string holder_name = 2
message
pb.proto:1922Used in:
string user_language = 1
optional user_country = 2
repeated fiat_currencies = 3
repeated crypto_currencies = 4
optional block_chain_explorer_main_net = 5
optional block_chain_explorer_test_net = 6
optional bsq_block_chain_explorer = 7
string backup_directory = 8
bool auto_select_arbitrators = 9
map<string, bool> dont_show_again_map = 10
bool tac_accepted = 11
bool use_tor_for_bitcoin_j = 12
bool show_own_offers_in_offer_book = 13
optional preferred_trade_currency = 14
int64 withdrawal_tx_fee_in_vbytes = 15
bool use_custom_withdrawal_tx_fee = 16
double max_price_distance_in_percent = 17
string offer_book_chart_screen_currency_code = 18
string trade_charts_screen_currency_code = 19
string buy_screen_currency_code = 20
string sell_screen_currency_code = 21
int32 trade_statistics_tick_unit_index = 22
bool resync_Spv_requested = 23
bool sort_market_currencies_numerically = 24
bool use_percentage_based_price = 25
map<string, string> peer_tag_map = 26
string bitcoin_nodes = 27
repeated string ignore_traders_list = 28
string directory_chooser_path = 29
int64 buyer_security_deposit_as_long = 30
Superseded by buyerSecurityDepositAsPercent.
bool use_animations = 31
optional selectedPayment_account_for_createOffer = 32
bool pay_fee_in_Btc = 33
repeated string bridge_addresses = 34
int32 bridge_option_ordinal = 35
int32 tor_transport_ordinal = 36
string custom_bridges = 37
int32 bitcoin_nodes_option_ordinal = 38
string referral_id = 39
string phone_key_and_token = 40
bool use_sound_for_mobile_notifications = 41
bool use_trade_notifications = 42
bool use_market_notifications = 43
bool use_price_notifications = 44
bool use_standby_mode = 45
bool is_dao_full_node = 46
string rpc_user = 47
string rpc_pw = 48
string take_offer_selected_payment_account_id = 49
double buyer_security_deposit_as_percent = 50
int32 ignore_dust_threshold = 51
double buyer_security_deposit_as_percent_for_crypto = 52
int32 block_notify_port = 53
int32 css_theme = 54
bool tac_accepted_v120 = 55
repeated auto_confirm_settings = 56
double bsq_average_trim_threshold = 57
bool hide_non_account_payment_methods = 58
bool show_offers_matching_my_accounts = 59
bool deny_api_taker = 60
bool notify_on_pre_release = 61
bool use_full_mode_dao_monitor = 62
int32 clear_data_after_days = 63
string buy_screen_crypto_currency_code = 64
string sell_screen_crypto_currency_code = 65
bool use_bitcoin_uris_in_qr_codes = 66
int64 user_defined_trade_limit = 67
bool user_has_raised_trade_limit = 68
bool process_burning_man_accounting_data = 69
bool is_full_b_m_accounting_node = 70
bool use_bisq_wallet_funding = 71
message
pb.proto:232Used in: ,
optional node_address = 1
optional sealed_and_signed = 2
bytes address_prefix_hash = 3
string uid = 4
message
pb.proto:112Used in:
int32 nonce = 21
This was set to 21 instead of 1 in some old commit so we cannot change it.
repeated bytes excluded_keys = 2
repeated int32 supported_capabilities = 3
string version = 4
message
pb.proto:2547Used in:
string currencyCode = 1
int64 high = 2
int64 low = 3
message
pb.proto:503Used in:
string uid = 1
optional sender_node_address = 2
optional private_notification_payload = 3
message
pb.proto:673Used in:
string message = 1
string signature_as_base64 = 2
bytes sig_public_key_bytes = 3
message
pb.proto:1820Used in:
optional trading_peer = 1
string offer_id = 2
string account_id = 3
optional pub_key_ring = 4
string take_offer_fee_tx_id = 5
bytes payout_tx_signature = 6
bytes prepared_deposit_tx = 9
repeated raw_transaction_inputs = 10
int64 change_output_value = 11
string change_output_address = 12
bool use_savings_wallet = 13
int64 funds_needed_for_trade_as_long = 14
bytes my_multi_sig_pub_key = 15
optional temp_trading_peer_node_address = 16
string payment_started_message_state = 17
bytes mediated_payout_tx_signature = 18
int64 buyer_payout_amount_from_mediation = 19
int64 seller_payout_amount_from_mediation = 20
optional payment_account = 21
int32 burning_man_selection_height = 22
Added in v 1.9.7
message
pb.proto:1368Used in:
string prompt_pay_id = 1
message
pb.proto:878Used in:
bytes payload = 1
int64 counter = 2
bytes challenge = 3
double difficulty = 4
int64 duration = 5
bytes solution = 6
int32 version = 7
message
pb.proto:2264Used in: , , , ,
string name = 1
string link = 2
uint32 version = 3
int64 creation_date = 4
string tx_id = 5
oneof message
compensation_proposal = 6
reimbursement_proposal = 7
change_param_proposal = 8
role_proposal = 9
confiscate_bond_proposal = 10
generic_proposal = 11
remove_asset_proposal = 12
map<string, string> extra_data = 20
We leave some index space here in case we add more subclasses.
message
pb.proto:2350Used in: ,
optional proposal = 1
bytes hash = 2
message
pb.proto:2478Used in: ,
int32 height = 1
bytes hash = 2
bytes prev_hash = 3
int32 num_proposals = 4
message
pb.proto:2355Used in:
repeated items = 1
message
pb.proto:2443Used in:
optional proposal = 1
int64 stake_of_Accepted_votes = 2
int64 stake_of_Rejected_votes = 3
int32 num_accepted_votes = 4
int32 num_rejected_votes = 5
int32 num_ignored_votes = 6
message
pb.proto:641Used in: , ,
optional entry = 1
bytes receivers_pub_key_bytes = 2
message
pb.proto:626Used in: , , , ,
optional storagePayload = 1
bytes owner_pub_key_bytes = 2
int32 sequence_number = 3
bytes signature = 4
int64 creation_time_stamp = 5
message
pb.proto:585Used in: , , , , , , , , , , , , , , ,
bytes signature_pub_key_bytes = 1
bytes encryption_pub_key_bytes = 2
message
pb.proto:2223Used in:
int32 req_sigs = 1
ScriptType script_type = 2
repeated string addresses = 3
string asm = 4
string hex = 5
message
pb.proto:2090Used in:
repeated raw_txs = 1
Because of the way how PB implements inheritance we need to use the super class as type.
message
pb.proto:1039Used in: , , , , , , , ,
int64 index = 1
bytes parent_transaction = 2
int64 value = 3
int32 script_type_id = 4
message
pb.proto:2113Used in:
repeated raw_tx_outputs = 1
Because of the way how PB implements inheritance we need to use the super class as type.
message
pb.proto:2171Used in:
(message has no fields)
message
pb.proto:194Used in:
bytes hash_of_data_and_seq_nr = 1
bytes signature = 2
bytes hash_of_payload = 3
int32 sequence_number = 4
message
pb.proto:377Deprecated since 1.4.0.
Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
message
pb.proto:721Used in: ,
optional node_address = 1
repeated string language_codes = 2
int64 registration_date = 3
string registration_signature = 4
bytes registration_pub_key = 5
optional pub_key_ring = 6
string email_address = 7
string info = 8
map<string, string> extra_data = 9
message
pb.proto:1894Used in:
repeated dispute = 1
Used in:
PB_ERROR_REFUND_RESULT = 0
UNDEFINED_REFUND_RESULT = 1
message
pb.proto:2542Used in:
string code = 1
string name = 2
message
pb.proto:2288Used in:
int64 requested_bsq = 1
string bsq_address = 2
message
pb.proto:2311Used in:
string ticker_symbol = 1
message
pb.proto:205Used in:
optional protected_storage_entry = 1
message
pb.proto:209Used in:
optional protected_storage_entry = 1
message
pb.proto:655Used in:
map<string, uint64> date_by_hashes = 1
message
pb.proto:2571Used in:
string key = 1
string group = 2
oneof message
string_value_reporting_item = 3
long_value_reporting_item = 4
double_value_reporting_item = 5
message
pb.proto:2592string address = 1
repeated reporting_item = 2
message
pb.proto:529Used in:
(message has no fields)
message
pb.proto:1309Used in:
string account_id = 1
string user_name = 2
message
pb.proto:2315Used in:
string uid = 1
string name = 2
string link = 3
string bonded_role_type = 4
Name of BondedRoleType enum.
message
pb.proto:2298Used in:
optional role = 1
int64 required_bond_unit = 2
int32 unlock_time = 3
message
pb.proto:1348Used in:
(message has no fields)
message
pb.proto:1182Used in:
(message has no fields)
message
pb.proto:1419Used in:
string mobile_nr = 1
string holder_name = 2
message
pb.proto:1462Used in:
string holder_name = 1
string mobile_number = 2
string bank_name = 3
Used in:
PB_ERROR_SCRIPT_TYPES = 0
PUB_KEY = 1
PUB_KEY_HASH = 2
SCRIPT_HASH = 3
MULTISIG = 4
NULL_DATA = 5
WITNESS_V0_KEYHASH = 6
WITNESS_V0_SCRIPTHASH = 7
NONSTANDARD = 8
WITNESS_UNKNOWN = 9
WITNESS_V1_TAPROOT = 10
message
pb.proto:591Used in:
bytes encrypted_secret_key = 1
bytes encrypted_payload_with_hmac = 2
bytes signature = 3
bytes sig_public_key_bytes = 4
message
pb.proto:1774Used in:
optional trade = 1
message
pb.proto:1778Used in:
optional trade = 1
message
pb.proto:391Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
optional taker_pub_key_ring = 4
int64 trade_amount = 5
int64 tx_fee_per_vbyte = 6
int64 maker_fee = 7
int64 taker_fee = 8
int64 trade_date = 9
message
pb.proto:1240Used in:
string holder_name = 1
string iban = 2
string bic = 3
string email = 4
repeated string accepted_country_codes = 5
message
pb.proto:1248Used in:
string holder_name = 1
string iban = 2
string bic = 3
repeated string accepted_country_codes = 4
message
pb.proto:1526Used in:
optional bytes = 1
optional map_value = 2
message
pb.proto:1522Used in:
repeated sequence_number_entries = 1
message
pb.proto:316Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
optional buyer_payment_account_payload = 4
message
pb.proto:893Used in: , , ,
SignedWitness.VerificationMethod verification_method = 1
bytes account_age_witness_hash = 2
bytes signature = 3
bytes signer_pub_key = 4
bytes witness_owner_pub_key = 5
int64 date = 6
int64 trade_amount = 7
Used in:
PB_ERROR = 0
ARBITRATOR = 1
TRADE = 2
message
pb.proto:1550Used in:
repeated items = 1
message
pb.proto:1200Used in:
repeated string accepted_banks = 1
message
pb.proto:2203Used in:
int64 block_height = 1
string tx_id = 2
int32 input_index = 3
message
pb.proto:634Used in: ,
oneof message
protected_storage_entry = 1
protected_mailbox_storage_entry = 2
message
pb.proto:598Used in: ,
oneof message
alert = 1
arbitrator = 2
mediator = 3
filter = 4
mailbox_storage_payload = 6
offer_payload = 7
temp_proposal_payload = 8
refund_agent = 9
bsq_swap_offer_payload = 10
message
pb.proto:1424Used in:
string holder_name = 1
message
pb.proto:2580Used in:
string value = 1
message
pb.proto:2025Used in:
string key = 1
repeated value = 2
Dispute support types.
Used in: , , , , ,
ARBITRATION = 0
MEDIATION = 1
TRADE = 2
REFUND = 3
message
pb.proto:1441Used in:
string beneficiary_name = 1
string beneficiary_account_nr = 2
string beneficiary_address = 3
string beneficiary_city = 4
string beneficiary_phone = 5
string special_instructions = 6
string bank_swift_code = 7
string bank_country_code = 8
string bank_name = 9
string bank_branch = 10
string bank_address = 11
string intermediary_swift_code = 12
string intermediary_country_code = 13
string intermediary_name = 14
string intermediary_branch = 15
string intermediary_address = 16
message
pb.proto:1318Used in:
string mobile_nr = 1
string holder_name = 2
message
pb.proto:2344Used in:
optional proposal = 1
bytes owner_pub_key_encoded = 2
map<string, string> extra_data = 3
message
pb.proto:2359Used in:
repeated items = 1
message
pb.proto:1428Used in:
string iban = 1
message
pb.proto:1639Used in:
oneof message
open_offer = 1
buyer_as_maker_trade = 2
buyer_as_taker_trade = 3
seller_as_maker_trade = 4
seller_as_taker_trade = 5
bsq_swap_buyer_as_maker_trade = 6
bsq_swap_buyer_as_taker_trade = 7
bsq_swap_seller_as_maker_trade = 8
bsq_swap_seller_as_taker_trade = 9
message
pb.proto:1600Used in:
repeated tradable = 1
message
pb.proto:1653Used in: , , ,
optional offer = 1
optional process_model = 2
string taker_fee_tx_id = 3
string deposit_tx_id = 4
string payout_tx_id = 5
int64 trade_amount_as_long = 6
int64 tx_fee_as_long = 7
int64 taker_fee_as_long = 8
int64 take_offer_date = 9
bool is_currency_for_taker_fee_btc = 10
int64 trade_price = 11
optional trading_peer_node_address = 12
Trade.State state = 13
Trade.DisputeState dispute_state = 14
Trade.TradePeriodState trade_period_state = 15
optional contract = 16
string contract_as_json = 17
bytes contract_hash = 18
string taker_contract_signature = 19
string maker_contract_signature = 20
optional arbitrator_node_address = 21
optional mediator_node_address = 22
bytes arbitrator_btc_pub_key = 23
string taker_payment_account_id = 24
string error_message = 25
optional arbitrator_pub_key_ring = 26
optional mediator_pub_key_ring = 27
string counter_currency_tx_id = 28
repeated chat_message = 29
MediationResultState mediation_result_state = 30
int64 lock_time = 31
bytes delayed_payout_tx_bytes = 32
optional refund_agent_node_address = 33
optional refund_agent_pub_key_ring = 34
RefundResultState refund_result_state = 35
int64 last_refresh_request_date = 36
string counter_currency_extra_data = 37
string asset_tx_proof_result = 38
name of AssetTxProofResult enum
string uid = 39
int64 sellerConfirmedPaymentReceiptDate = 40
Used in:
PB_ERROR_DISPUTE_STATE = 0
NO_DISPUTE = 1
DISPUTE_REQUESTED = 2
Arbitration requested. We use the enum name for resolving enums so it cannot be renamed.
DISPUTE_STARTED_BY_PEER = 3
Arbitration requested. We use the enum name for resolving enums so it cannot be renamed.
DISPUTE_CLOSED = 4
Arbitration requested. We use the enum name for resolving enums so it cannot be renamed
MEDIATION_REQUESTED = 5
MEDIATION_STARTED_BY_PEER = 6
MEDIATION_CLOSED = 7
REFUND_REQUESTED = 8
REFUND_REQUEST_STARTED_BY_PEER = 9
REFUND_REQUEST_CLOSED = 10
PB_ERROR_PHASE = 0
INIT = 1
TAKER_FEE_PUBLISHED = 2
DEPOSIT_PUBLISHED = 3
DEPOSIT_CONFIRMED = 4
FIAT_SENT = 5
FIAT_RECEIVED = 6
PAYOUT_PUBLISHED = 7
WITHDRAWN = 8
Used in:
PB_ERROR_STATE = 0
PREPARATION = 1
TAKER_PUBLISHED_TAKER_FEE_TX = 2
MAKER_SENT_PUBLISH_DEPOSIT_TX_REQUEST = 3
MAKER_SAW_ARRIVED_PUBLISH_DEPOSIT_TX_REQUEST = 4
MAKER_STORED_IN_MAILBOX_PUBLISH_DEPOSIT_TX_REQUEST = 5
MAKER_SEND_FAILED_PUBLISH_DEPOSIT_TX_REQUEST = 6
TAKER_RECEIVED_PUBLISH_DEPOSIT_TX_REQUEST = 7
SELLER_PUBLISHED_DEPOSIT_TX = 8
SELLER_SENT_DEPOSIT_TX_PUBLISHED_MSG = 9
SELLER_SAW_ARRIVED_DEPOSIT_TX_PUBLISHED_MSG = 10
SELLER_STORED_IN_MAILBOX_DEPOSIT_TX_PUBLISHED_MSG = 11
SELLER_SEND_FAILED_DEPOSIT_TX_PUBLISHED_MSG = 12
BUYER_RECEIVED_DEPOSIT_TX_PUBLISHED_MSG = 13
BUYER_SAW_DEPOSIT_TX_IN_NETWORK = 14
DEPOSIT_CONFIRMED_IN_BLOCK_CHAIN = 15
BUYER_CONFIRMED_IN_UI_FIAT_PAYMENT_INITIATED = 16
BUYER_SENT_FIAT_PAYMENT_INITIATED_MSG = 17
BUYER_SAW_ARRIVED_FIAT_PAYMENT_INITIATED_MSG = 18
BUYER_STORED_IN_MAILBOX_FIAT_PAYMENT_INITIATED_MSG = 19
BUYER_SEND_FAILED_FIAT_PAYMENT_INITIATED_MSG = 20
SELLER_RECEIVED_FIAT_PAYMENT_INITIATED_MSG = 21
SELLER_CONFIRMED_IN_UI_FIAT_PAYMENT_RECEIPT = 22
SELLER_PUBLISHED_PAYOUT_TX = 23
SELLER_SENT_PAYOUT_TX_PUBLISHED_MSG = 24
SELLER_SAW_ARRIVED_PAYOUT_TX_PUBLISHED_MSG = 25
SELLER_STORED_IN_MAILBOX_PAYOUT_TX_PUBLISHED_MSG = 26
SELLER_SEND_FAILED_PAYOUT_TX_PUBLISHED_MSG = 27
BUYER_RECEIVED_PAYOUT_TX_PUBLISHED_MSG = 28
BUYER_SAW_PAYOUT_TX_IN_NETWORK = 29
WITHDRAW_COMPLETED = 30
Used in:
PB_ERROR_TRADE_PERIOD_STATE = 0
FIRST_HALF = 1
SECOND_HALF = 2
TRADE_PERIOD_OVER = 3
message
pb.proto:2519Used in: ,
string code = 1
string name = 2
oneof message
crypto_currency = 3
fiat_currency = 4
message
grpc.proto:613TODO Modify bisq-grpc-api-doc to include core Trade enums in API Reference.
Used in: , ,
optional offer = 1
The original offer.
string trade_id = 2
The unique identifier of the trade.
string short_id = 3
An abbreviation of unique identifier of the trade. It cannot be used as parameter to rpc methods GetTrade, ConfirmPaymentStarted, CloseTrade, etc., but it may be useful while interacting with support or trading peers.
uint64 date = 4
The creation date of the trade as a long: the number of milliseconds that have elapsed since January 1, 1970.
string role = 5
A brief description of the user's role in the trade, i.e., an offer maker or taker, a BTC buyer or seller.
bool is_currency_for_taker_fee_btc = 6
Whether the offer taker's Bisq trade fee was paid in BTC or not (BSQ).
uint64 tx_fee_as_long = 7
The bitcoin miner transaction fee in satoshis.
uint64 taker_fee_as_long = 8
The offer taker's Bisq trade fee in satoshis.
string taker_fee_tx_id = 9
The bitcoin transaction id for offer taker's Bisq trade fee.
string deposit_tx_id = 10
The bitcoin transaction id for the offer taker's security deposit.
string payout_tx_id = 11
The bitcoin transaction id for trade payout.
uint64 trade_amount_as_long = 12
The trade payout amount in satoshis.
string trade_price = 13
For fiat trades: the fiat price for 1 BTC to 4 decimal places, e.g., 41000.50 EUR is "41000.5000". For altcoin trades: the altcoin price for 1 BTC to 8 decimal places, e.g., 0.5 BTC is "0.50000000".
string trading_peer_node_address = 14
The trading peer's node address.
string state = 15
The internal state of the trade. (TODO bisq-grpc-api-doc -> include Trade.State in API Reference.)
string phase = 16
The internal phase of the trade. (TODO bisq-grpc-api-doc -> include Trade.Phase in API Reference.)
string trade_period_state = 17
How much of the trade protocol's time limit has elapsed. (TODO bisq-grpc-api-doc -> include Trade.TradePeriodState in API Reference.)
bool is_deposit_published = 18
Whether the trade's security deposit bitcoin transaction has been broadcast, or not.
bool is_deposit_confirmed = 19
Whether the trade's security deposit bitcoin transaction has been confirmed at least once, or not.
bool is_payment_started_message_sent = 20
Whether the trade's 'start payment' message has been sent by the BTC buyer, or not.
bool is_payment_received_message_sent = 21
Whether the trade's 'payment received' message has been sent by the BTC seller, or not.
bool is_payout_published = 22
Whether the trade's payout bitcoin transaction has been confirmed at least once, or not.
bool is_completed = 23
Whether the trade's payout has been completed and the trade is now closed, or not.
string contract_as_json = 24
The entire trade contract as a json string.
optional contract = 25
The summary of the trade contract.
string trade_volume = 26
The volume of currency traded for BTC.
optional bsq_swap_trade_info = 28
The details specific to the BSQ swap trade. If the trade is not a BSQ swap, this field should be ignored.
string closing_status = 29
Needed by open/closed/failed trade list items.
bool has_failed = 30
Whether the trade failed.
string error_message = 31
Error message applicable when trade is failed.
string auto_conf_tx_id = 32
txId used for XMR auto conf.
string auto_conf_tx_key = 33
tx key used for XMR auto conf.
message
pb.proto:776Deprecated
Used in: ,
string base_currency = 1
string counter_currency = 2
OfferDirection direction = 3
int64 trade_price = 4
int64 trade_amount = 5
int64 trade_date = 6
string payment_method_id = 7
int64 offer_date = 8
bool offer_use_market_based_price = 9
double offer_market_price_margin = 10
int64 offer_amount = 11
int64 offer_min_amount = 12
string offer_id = 13
string deposit_tx_id = 14
bytes hash = 15
map<string, string> extra_data = 16
message
pb.proto:1557Deprecated. Not used anymore. We use a list not a hash map to save disc space. The hash can be calculated from the payload anyway.
Used in:
repeated items = 1
message
pb.proto:795Used in: ,
string currency = 1
int64 price = 2
int64 amount = 3
string payment_method = 4
int64 date = 5
string mediator = 6
string refund_agent = 7
bytes hash = 8
map<string, string> extra_data = 9
message
pb.proto:1561Used in:
repeated items = 1
message
pb.proto:384Deprecated since 1.4.0.
Used in:
string uid = 1
string trade_id = 2
optional sender_node_address = 3
optional signed_witness = 4
message
pb.proto:1845Used in:
string account_id = 1
optional payment_account_payload = 2
string payout_address_string = 3
string contract_as_json = 4
string contract_signature = 5
bytes signature = 6
optional pub_key_ring = 7
bytes multi_sig_pub_key = 8
repeated raw_transaction_inputs = 9
int64 change_output_value = 10
string change_output_address = 11
bytes account_age_witness_nonce = 12
bytes account_age_witness_signature = 13
int64 current_date = 14
bytes mediated_payout_tx_signature = 15
bytes hash_of_payment_account_payload = 16
message
pb.proto:1376Used in:
string email = 1
message
pb.proto:1380Used in:
string email = 1
string holder_name = 2
string beneficiary_address = 3
message
pb.proto:2118Used in:
repeated tx_outputs = 1
Because of the way how PB implements inheritance we need to use the super class as type.
TxType txType = 2
int64 burnt_bsq = 3
message
grpc.proto:724Used in: , ,
bool use_custom_tx_fee_rate = 1
Whether the daemon's custom btc transaction fee rate preference is set, or not.
uint64 custom_tx_fee_rate = 2
The daemon's custom btc transaction fee rate preference, in sats/byte.
uint64 fee_service_rate = 3
The Bisq network's most recently available btc transaction fee rate, in sats/byte.
uint64 last_fee_service_request_ts = 4
The date of the most recent Bisq network fee rate request as a long: the number of milliseconds that have elapsed since January 1, 1970.
uint64 min_fee_service_rate = 5
The Bisq network's minimum btc transaction fee rate, in sats/byte.
message
grpc.proto:733Used in: , , ,
string tx_id = 1
The bitcoin transaction id.
uint64 input_sum = 2
The sum of the bitcoin transaction's input values in satoshis.
uint64 output_sum = 3
The sum of the bitcoin transaction's output values in satoshis.
uint64 fee = 4
The bitcoin transaction's miner fee in satoshis.
int32 size = 5
The bitcoin transaction's size in bytes.
bool is_pending = 6
Whether the bitcoin transaction has been confirmed at least one time, or not.
string memo = 7
An optional memo associated with the bitcoin transaction.
message
pb.proto:2145Used in:
string connected_tx_output_tx_id = 1
int32 connected_tx_output_index = 2
string pub_key = 3
message
pb.proto:2174Used in:
TxOutputType tx_output_type = 1
int32 lock_time = 2
int32 unlock_block_height = 3
Used in:
PB_ERROR_TX_OUTPUT_TYPE = 0
UNDEFINED_OUTPUT = 1
GENESIS_OUTPUT = 2
BSQ_OUTPUT = 3
BTC_OUTPUT = 4
PROPOSAL_OP_RETURN_OUTPUT = 5
COMP_REQ_OP_RETURN_OUTPUT = 6
REIMBURSEMENT_OP_RETURN_OUTPUT = 7
CONFISCATE_BOND_OP_RETURN_OUTPUT = 8
ISSUANCE_CANDIDATE_OUTPUT = 9
BLIND_VOTE_LOCK_STAKE_OUTPUT = 10
BLIND_VOTE_OP_RETURN_OUTPUT = 11
VOTE_REVEAL_UNLOCK_STAKE_OUTPUT = 12
VOTE_REVEAL_OP_RETURN_OUTPUT = 13
ASSET_LISTING_FEE_OP_RETURN_OUTPUT = 14
PROOF_OF_BURN_OP_RETURN_OUTPUT = 15
LOCKUP_OUTPUT = 16
LOCKUP_OP_RETURN_OUTPUT = 17
UNLOCK_OUTPUT = 18
INVALID_OUTPUT = 19
enum TxType
pb.proto:2125Used in:
PB_ERROR_TX_TYPE = 0
UNDEFINED_TX_TYPE = 1
UNVERIFIED = 2
INVALID = 3
GENESIS = 4
TRANSFER_BSQ = 5
PAY_TRADE_FEE = 6
PROPOSAL = 7
COMPENSATION_REQUEST = 8
REIMBURSEMENT_REQUEST = 9
BLIND_VOTE = 10
VOTE_REVEAL = 11
LOCKUP = 12
UNLOCK = 13
ASSET_LISTING_FEE = 14
PROOF_OF_BURN = 15
IRREGULAR = 16
message
pb.proto:1323Used in:
string postal_address = 1
string holder_name = 2
message
pb.proto:2340Used in:
repeated unconfirmed_tx_output = 1
message
pb.proto:2165Used in:
int32 index = 1
int64 value = 2
string tx_id = 3
message
pb.proto:1284Used in:
string account_id = 1
string account_owner = 2
message
pb.proto:1354Used in:
string virtual_payment_address = 1
message
pb.proto:2005Used in:
string account_id = 1
repeated payment_accounts = 2
optional current_payment_account = 3
repeated string accepted_language_locale_codes = 4
optional developers_alert = 5
optional displayed_alert = 6
optional developers_filter = 7
repeated accepted_arbitrators = 8
repeated accepted_mediators = 9
optional registered_arbitrator = 10
optional registered_mediator = 11
optional price_alert_filter = 12
repeated market_alert_filters = 13
repeated accepted_refund_agents = 14
optional registered_refund_agent = 15
map<string, string> cookie = 16
repeated sub_account_map_entries = 17
message
pb.proto:1299Deprecated, not used.
Used in:
string venmo_user_name = 1
string holder_name = 2
message
pb.proto:1432Used in:
string holder_name = 1
message
pb.proto:2430Used in: ,
bool accepted = 1
message
pb.proto:2399Used in:
string proposal_tx_id = 1
optional vote = 2
message
pb.proto:2404repeated item = 1
message
pb.proto:1115Used in:
string account_nr = 1
message
pb.proto:1228Used in:
string holder_name = 1
string city = 2
string state = 3
string email = 4