package xudrpc
Get desktop application:
View/edit binary Protocol Buffers messages
service Xud
xudrpc.proto:45The primary service for interacting with a running xud node.
rpc AddCurrency (, )
xudrpc.proto:49Adds a currency to the list of supported currencies. Once added, the currency may be used for new trading pairs. shell: xucli addcurrency <currency> <swap_client> [decimal_places] [token_address]
message
xudrpc.proto:405(message has no fields)
rpc AddPair (, )
xudrpc.proto:59Adds a trading pair to the list of supported trading pairs. The newly supported pair is advertised to peers so they may begin sending orders for it. shell: xucli addpair <base_currency> <quote_currency>
message
xudrpc.proto:407string base_currency = 1
The base currency that is bought and sold for this trading pair.
string quote_currency = 2
The currency used to quote a price for the base currency.
message
xudrpc.proto:413(message has no fields)
rpc Ban (, )
xudrpc.proto:69Bans a node and immediately disconnects from it. This can be used to prevent any connections to a specific node. shell: xucli ban <node_identifier>
message
xudrpc.proto:430string node_identifier = 1
The node pub key or alias of the node to ban.
message
xudrpc.proto:434(message has no fields)
rpc ChangePassword (, )
xudrpc.proto:78Changes the xud master password, including the wallet passwords for any underlying clients. shell: xucli changepass
message
xudrpc.proto:454string new_password = 1
string old_password = 2
message
xudrpc.proto:458(message has no fields)
rpc CloseChannel (, )
xudrpc.proto:86Closes any existing payment channels with a peer for the specified currency. shell: xucli closechannel <currency> [node_identifier ] [--force]
message
xudrpc.proto:460string node_identifier = 1
The node pub key or alias of the peer with which to close any channels with.
string currency = 2
The ticker symbol of the currency of the channel to close.
bool force = 3
Whether to force close the channel in case the peer is offline or unresponsive.
string destination = 4
The on-chain address to send funds extracted from the channel. If unspecified, the funds return to the default wallet for the client closing the channel.
uint64 amount = 5
For Connext only - the amount to extract from the channel. If 0 or unspecified, the entire off-chain balance for the specified currency will be extracted.
uint64 fee = 6
A manual fee rate set in sat/byte that should be used when crafting the closure transaction.
message
xudrpc.proto:478repeated string transaction_ids = 1
The id of the transaction per channel close.
rpc Connect (, )
xudrpc.proto:97Attempts to connect to a node. Once connected, the node is added to the list of peers and becomes available for swaps and trading. A handshake exchanges information about the peer's supported trading and swap clients. Orders will be shared with the peer upon connection and upon new order placements. shell: xucli connect <node_uri>
message
xudrpc.proto:483string node_uri = 1
The uri of the node to connect to in "[nodePubKey]@[host]:[port]" format.
message
xudrpc.proto:488(message has no fields)
rpc WalletDeposit (, )
xudrpc.proto:106Gets an address to deposit a given currency into the xud wallets. shell: xucli walletdeposit <currency>
rpc Deposit (, )
xudrpc.proto:115Gets an address to deposit a given currency directly into a channel. shell: xucli deposit <currency>
rpc DiscoverNodes (, )
xudrpc.proto:123Discover nodes from a specific peer and apply new connections
message
xudrpc.proto:532string node_identifier = 1
The node pub key or alias of the peer to discover nodes from.
message
xudrpc.proto:536uint32 num_nodes = 1
rpc GetBalance (, )
xudrpc.proto:132Gets the total balance available across all payment channels and wallets for one or all currencies. shell: xucli getbalance [currency]
message
xudrpc.proto:551string currency = 1
The ticker symbol of the currency to query for, if unspecified then balances for all supported currencies are queried.
message
xudrpc.proto:556map<string, > balances = 1
A map between currency ticker symbols and their balances.
rpc GetInfo (, )
xudrpc.proto:140Gets general information about this node. shell: xucli getinfo
message
xudrpc.proto:561(message has no fields)
message
xudrpc.proto:562string version = 1
The version of this instance of xud.
string node_pub_key = 2
The node pub key of this node.
repeated string uris = 3
A list of uris that can be used to connect to this node. These are shared with peers.
uint32 num_peers = 4
The number of currently connected peers.
uint32 num_pairs = 5
The number of supported trading pairs.
optional orders = 6
The number of active, standing orders in the order book.
map<string, > lnd = 7
string alias = 9
The alias of this instance of xud.
string network = 10
The network of this node.
repeated string pending_swap_hashes = 11
optional connext = 12
rpc GetMnemonic (, )
xudrpc.proto:148Gets the master seed mnemonic . shell: xucli getnemonic
message
xudrpc.proto:584(message has no fields)
message
xudrpc.proto:585repeated string seed_mnemonic = 1
rpc GetNodeInfo (, )
xudrpc.proto:156Gets general information about a node. shell: xucli getnodeinfo <node_identifier>
message
xudrpc.proto:589string node_identifier = 1
The node pub key or alias of the node for which to get information.
message
xudrpc.proto:593sint32 reputationScore = 1
The node's reputation score. Points are subtracted for unexpected or potentially malicious behavior. Points are added when swaps are successfully executed.
bool banned = 2
Whether the node is currently banned.
rpc ListOrders (, )
xudrpc.proto:168Gets orders from the order book. This call returns the state of the order book at a given point in time, although it is not guaranteed to still be vaild by the time a response is received and processed by a client. It accepts an optional trading pair id parameter. If specified, only orders for that particular trading pair are returned. Otherwise, all orders are returned. Orders are separated into buys and sells for each trading pair, but unsorted. shell: xucli listorders [pair_id] [include_own_orders] [limit]
message
xudrpc.proto:607string pair_id = 1
The trading pair for which to retrieve orders.
ListOrdersRequest.Owner owner = 2
Whether only own, only peer or both orders should be included in result.
uint32 limit = 3
The maximum number of orders to return from each side of the order book.
bool include_aliases = 4
Whether to include the node aliases of owners of the orders.
message
xudrpc.proto:622map<string, > orders = 1
A map between pair ids and their buy and sell orders.
rpc ListCurrencies (, )
xudrpc.proto:176Gets a list of this node's supported currencies. shell: xucli listcurrencies
message
xudrpc.proto:601(message has no fields)
message
xudrpc.proto:602repeated currencies = 1
The list of available currencies in the orderbook.
rpc ListPairs (, )
xudrpc.proto:184Gets a list of this nodes suported trading pairs. shell: xucli listpairs
message
xudrpc.proto:627(message has no fields)
message
xudrpc.proto:628repeated string pairs = 1
The list of supported trading pair tickers in formats like "LTC/BTC".
rpc ListPeers (, )
xudrpc.proto:192Gets a list of connected peers. shell: xucli listpeers
message
xudrpc.proto:633(message has no fields)
message
xudrpc.proto:634repeated peers = 1
The list of connected peers.
rpc OpenChannel (, )
xudrpc.proto:200Opens a payment channel to a peer for the specified amount and currency. shell: xucli openchannel <currency> <amount> [node_identifier] [push_amount]
message
xudrpc.proto:656string node_identifier = 1
The node pub key or alias of the peer with which to open channel with.
string currency = 2
The ticker symbol of the currency to open the channel for.
uint64 amount = 3
The amount to be deposited into the channel denominated in satoshis.
uint64 push_amount = 4
The balance amount to be pushed to the remote side of the channel denominated in satoshis.
uint64 fee = 5
The manual fee rate set in sat/byte that should be used when crafting the funding transaction in the channel.
message
xudrpc.proto:669string transaction_id = 1
The id of the transaction that opened the channel.
rpc OrderBook (, )
xudrpc.proto:209Gets an order book depth chart where orders are grouped into "buckets" according to their price rounded to a given level of precision. shell: xucli orderbook [pair_id] [precision]
message
xudrpc.proto:697string pair_id = 1
The trading pair for which to retrieve orders.
int32 precision = 2
The number of digits to the right of the decimal point for each price bucket. A negative number rounds digits to the left of the decimal point, e.g. -2 would round to the hundreds place.
uint32 limit = 3
The maximum number of price "buckets" to return, if zero or unspecified then no limit is imposed.
message
xudrpc.proto:706map<string, > buckets = 1
A map between currency tickers and sorted lists of order buckets
rpc PlaceOrder (, stream )
xudrpc.proto:219Adds an order to the order book. If price is zero or unspecified a market order will get added.
message
xudrpc.proto:814oneof event
match = 1
An order (or portion thereof) that matched the newly placed order.
swap_success = 2
A successful swap of a peer order that matched the newly placed order.
remaining_order = 3
The remaining portion of the order, after matches, that enters the order book.
swap_failure = 4
A swap attempt that failed.
rpc PlaceOrderSync (, )
xudrpc.proto:229The synchronous, non-streaming version of PlaceOrder. shell: xucli buy <quantity> <pair_id> <price> [order_id] [stream] shell: xucli sell <quantity> <pair_id> <price> [order_id] [stream]
message
xudrpc.proto:803repeated internal_matches = 1
A list of own orders (or portions thereof) that matched the newly placed order.
repeated swap_successes = 2
A list of successful swaps of peer orders that matched the newly placed order.
optional remaining_order = 3
The remaining portion of the order, after matches, that enters the order book.
repeated swap_failures = 4
A list of swap attempts that failed.
rpc ExecuteSwap (, )
xudrpc.proto:238Executes a swap on a maker peer order.
message
xudrpc.proto:540string order_id = 1
The order id of the maker order.
string pair_id = 2
The trading pair of the swap orders.
string peer_pub_key = 3
The node pub key of the peer which owns the maker order. This is optional but helps locate the order more quickly.
uint64 quantity = 4
The quantity to swap denominated in satoshis. The whole order will be swapped if unspecified.
rpc RemoveCurrency (, )
xudrpc.proto:249Removes a currency from the list of supported currencies. Only currencies that are not in use for any currently supported trading pairs may be removed. Once removed, the currency can no longer be used for any supported trading pairs. shell: xucli removecurrency <currency>
message
xudrpc.proto:834string currency = 1
The ticker symbol for this currency such as BTC, LTC, ETH, etc...
message
xudrpc.proto:838(message has no fields)
rpc RemoveOrder (, )
xudrpc.proto:261Removes an order from the order book by its local id. This should be called when an order is canceled or filled outside of xud. Removed orders become immediately unavailable for swaps, and peers are notified that the order is no longer valid. Any portion of the order that is on hold due to ongoing swaps will not be removed until after the swap attempts complete. shell: xucli removeorder <order_id> [quantity]
message
xudrpc.proto:840string order_id = 1
The local id of the order to remove.
uint64 quantity = 2
The quantity to remove from the order denominated in satoshis. If zero or unspecified then the entire order is removed.
message
xudrpc.proto:847uint64 quantity_on_hold = 1
Any portion of the order that was on hold due to ongoing swaps at the time of the request and could not be removed until after the swaps finish.
uint64 remaining_quantity = 2
Remaining portion of the order if it was a partial removal.
uint64 removed_quantity = 3
Successfully removed portion of the order.
string pair_id = 4
Removed order's pairId. (e.g. ETH/BTC)
rpc RemoveAllOrders (, )
xudrpc.proto:272Removes all orders from the order book. Removed orders become immediately unavailable for swaps, and peers are notified that the orders are no longer valid. Any portion of the orders that is on hold due to ongoing swaps will not be removed until after the swap attempts complete. shell: xucli removeallorders
message
xudrpc.proto:859(message has no fields)
message
xudrpc.proto:861repeated string removed_order_ids = 1
The local order ids that were successfully removed.
repeated string on_hold_order_ids = 2
The local order ids that were on hold and failed to be removed.
rpc RemovePair (, )
xudrpc.proto:283Removes a trading pair from the list of currently supported trading pair. This call will effectively cancel any standing orders for that trading pair. Peers are informed when a pair is no longer supported so that they will know to stop sending orders for it. shell: xucli removepair <pair_id>
message
xudrpc.proto:868string pair_id = 1
The trading pair ticker to remove in a format such as "LTC/BTC".
message
xudrpc.proto:872(message has no fields)
rpc SetLogLevel (, )
xudrpc.proto:292Set the logging level. shell: xucli loglevel <level>
message
xudrpc.proto:895LogLevel log_level = 1
message
xudrpc.proto:898(message has no fields)
rpc Shutdown (, )
xudrpc.proto:301Begin gracefully shutting down xud. shell: xucli shutdown
message
xudrpc.proto:900(message has no fields)
message
xudrpc.proto:901(message has no fields)
rpc SubscribeOrders (, stream )
xudrpc.proto:312Subscribes to orders being added to and removed from the order book. This call allows the client to maintain an up-to-date view of the order book. For example, an exchange that wants to show its users a real time view of the orders available to them would subscribe to this streaming call to be alerted as new orders are added and expired orders are removed.
message
xudrpc.proto:903bool existing = 1
Whether to transmit all existing active orders upon establishing the stream.
message
xudrpc.proto:750oneof order_update
order = 1
An order that was added to the order book.
order_removal = 2
An order (or portion thereof) that was removed from the order book.
rpc SubscribeSwapFailures (, stream )
xudrpc.proto:322Subscribes to failed swaps. By default, only swaps that are initiated by a remote peer are transmitted unless a flag is set to include swaps initiated by the local node. This call allows the client to get real-time notifications when swap attempts are failing. It can be used for status monitoring, debugging, and testing purposes.
rpc SubscribeSwaps (, stream )
xudrpc.proto:333Subscribes to completed swaps. By default, only swaps that are initiated by a remote peer are transmitted unless a flag is set to include swaps initiated by the local node. This call allows the client to get real-time notifications when its orders are filled by a peer. It can be used for tracking order executions, updating balances, and informing a trader when one of their orders is settled through the Exchange Union network.
rpc SubscribeSwapsAccepted (, stream )
xudrpc.proto:341Subscribes to accepted swaps. This stream emits a message when the local xud node accepts a swap request from a peer, but before the swap has actually succeeded.
message
xudrpc.proto:908(message has no fields)
message
xudrpc.proto:916string order_id = 1
The global UUID for the order that was accepted to be swapped.
string local_id = 2
The local id for the order that was accepted to be swapped.
string pair_id = 3
The trading pair that the swap is for.
uint64 quantity = 4
The order quantity that was accepted to be swapped.
double price = 5
The price for the swap.
string peer_pub_key = 6
The node pub key of the peer that executed this order.
string r_hash = 7
The hex-encoded payment hash for the swap.
uint64 amount_receiving = 8
The amount received denominated in satoshis.
uint64 amount_sending = 9
The amount sent denominated in satoshis.
string currency_receiving = 10
The ticker symbol of the currency received.
string currency_sending = 11
The ticker symbol of the currency sent.
rpc TradeHistory (, )
xudrpc.proto:349Gets a list of completed trades. shell: xucli tradehistory [limit]
message
xudrpc.proto:1008uint32 limit = 1
The maximum number of trades to return
message
xudrpc.proto:1013repeated trades = 1
rpc TradingLimits (, )
xudrpc.proto:358Gets the trading limits for one or all currencies. shell: xucli tradinglimits [currency]
message
xudrpc.proto:1028string currency = 1
The ticker symbol of the currency to query for, if unspecified then trading limits for all supported currencies are queried.
message
xudrpc.proto:1033map<string, > limits = 1
A map between currency ticker symbols and their trading limits.
rpc Unban (, )
xudrpc.proto:366Removes a ban from a node manually and, optionally, attempts to connect to it. shell: xucli unban <node_identifier> [reconnect]
message
xudrpc.proto:1038string node_identifier = 1
The node pub key or alias of the peer to unban.
bool reconnect = 2
Whether to attempt to connect to the peer after it is unbanned.
message
xudrpc.proto:1044(message has no fields)
rpc WalletWithdraw (, )
xudrpc.proto:375Withdraws a given currency from the xud wallets to a specified address. shell: xucli withdraw [amount] [currency] <destination> [fee]
message
xudrpc.proto:1058string currency = 1
The ticker symbol of the currency to withdraw.
string destination = 2
The address to withdraw funds to.
uint64 amount = 3
The amount to withdraw denominated in satoshis
bool all = 4
Whether to withdraw all available funds for this currency. If true, the amount field is ignored.
uint32 fee = 5
The fee to use for the withdrawal transaction denominated in satoshis per byte.
message
xudrpc.proto:1071string transaction_id = 1
The id of the withdrawal transaction.
service XudInit
xudrpc.proto:28A service for interacting with a locked or uninitalized xud node.
rpc CreateNode (, )
xudrpc.proto:33Creates an xud identity node key and underlying wallets. The node key and wallets are derived from a single seed and encrypted using a single password provided as a parameter to the call. shell: xucli create
message
xudrpc.proto:490string password = 1
The password in utf-8 with which to encrypt the new xud node key as well as any uninitialized underlying wallets.
message
xudrpc.proto:495repeated string seed_mnemonic = 1
The 24 word mnemonic to recover the xud identity key and underlying wallets
repeated string initialized_lnds = 2
The list of lnd clients that were initialized.
bool initialized_connext = 3
Whether the connext wallet was initialized.
rpc RestoreNode (, )
xudrpc.proto:37Restores an xud instance and underlying wallets from a seed. shell: xucli restore [backup_directory]
message
xudrpc.proto:874repeated string seed_mnemonic = 1
The 24 word mnemonic to recover the xud identity key and underlying wallets
string password = 2
The password in utf-8 with which to encrypt the restored xud node key as well as any restored underlying wallets.
map<string, bytes> lnd_backups = 3
A map between the currency of the LND and its multi channel SCB
bytes xud_database = 6
The XUD database backup
message
xudrpc.proto:887repeated string restored_lnds = 1
The list of lnd clients that were initialized.
bool restored_connext = 2
Whether the connext wallet was initialized.
rpc UnlockNode (, )
xudrpc.proto:41Unlocks and decrypts the xud node key and any underlying wallets. shell: xucli unlock
message
xudrpc.proto:1046string password = 1
The password in utf-8 with which to unlock an existing xud node key as well as underlying client wallets such as lnd.
message
xudrpc.proto:1051repeated string unlocked_lnds = 1
The list of lnd clients that were unlocked.
repeated string locked_lnds = 3
The list of lnd clients that could not be unlocked.
message
xudrpc.proto:415Used in:
uint64 total_balance = 1
Total balance denominated in satoshis.
uint64 channel_balance = 2
Sum of confirmed channel balances denominated in satoshis.
uint64 pending_channel_balance = 3
Sum of pending channel balances denominated in satoshis.
uint64 inactive_channel_balance = 4
Sum of inactive channel balances denominated in satoshis.
uint64 wallet_balance = 5
Confirmed wallet balance in satoshis.
uint64 unconfirmed_wallet_balance = 6
Unconfirmed wallet balance in satoshis.
message
xudrpc.proto:436Used in:
string chain = 1
The blockchain the swap client is on (eg bitcoin, litecoin)
string network = 2
The network the swap client is on (eg regtest, testnet, mainnet)
message
xudrpc.proto:443Used in:
uint32 active = 1
The number of active/online channels for this lnd instance that can be used for swaps.
uint32 inactive = 2
The number of inactive/offline channels for this lnd instance.
uint32 pending = 3
The number of channels that are pending on-chain confirmation before they can be used.
uint32 closed = 4
The number of channels that have been closed.
message
xudrpc.proto:827Used in:
string status = 1
string address = 2
string version = 4
string chain = 5
message
xudrpc.proto:504Used as request type in: Xud.AddCurrency
Used as field type in:
string currency = 1
The ticker symbol for this currency such as BTC, LTC, ETH, etc...
Currency.SwapClient swap_client = 2
The payment channel network client to use for executing swaps.
string token_address = 3
The contract address for layered tokens such as ERC20.
uint32 decimal_places = 4
The number of places to the right of the decimal point of the smallest subunit of the currency. For example, BTC, LTC, and others where the smallest subunits (satoshis) are 0.00000001 full units (bitcoins) have 8 decimal places. ETH has 18. This can be thought of as the base 10 exponent of the smallest subunit expressed as a positive integer. A default value of 8 is used if unspecified.
Used in:
LND = 0
CONNEXT = 2
message
xudrpc.proto:523Used as request type in: Xud.Deposit, Xud.WalletDeposit
string currency = 1
The ticker symbol of the currency to deposit.
message
xudrpc.proto:527Used as response type in: Xud.Deposit, Xud.WalletDeposit
string address = 1
The address to use to deposit funds.
Used in:
BOTH = 0
OWN = 1
PEER = 2
message
xudrpc.proto:639Used in:
string status = 1
optional channels = 2
repeated chains = 3
uint32 blockheight = 4
repeated string uris = 5
string version = 6
string alias = 7
Used in:
ALERT = 0
ERROR = 1
WARN = 2
INFO = 3
VERBOSE = 4
DEBUG = 5
TRACE = 6
message
xudrpc.proto:649Used in: ,
string node_pub_key = 1
The pub key of this node
string alias = 2
An alias for this node deterministically generated from the pub key
message
xudrpc.proto:674Used in: , , , ,
double price = 1
The price of the order.
uint64 quantity = 2
The quantity of the order in satoshis.
string pair_id = 3
The trading pair that this order is for.
string id = 4
A UUID for this order.
optional node_identifier = 5
The identifier of the node that created this order.
string local_id = 6
The local id for this order, if applicable.
uint64 created_at = 7
The epoch time in milliseconds when this order was created.
OrderSide side = 8
Whether this order is a buy or sell
bool is_own_order = 9
Whether this order is a local own order or a remote peer order.
uint64 hold = 10
The quantity on hold pending swap execution.
message
xudrpc.proto:707Used in:
double price = 1
The rounded price of the bucket.
uint64 quantity = 2
The total quantity for all orders that fall into this bucket.
message
xudrpc.proto:713Used in:
repeated sell_buckets = 1
A sorted list of buckets for sell orders
repeated buy_buckets = 2
A sorted list of buckets for buy orders.
message
xudrpc.proto:723Used in:
uint64 quantity = 1
The quantity removed from the order.
string pair_id = 2
The trading pair that the order is for.
string order_id = 3
The global UUID for the order.
string local_id = 4
The local id for the order, if applicable.
bool is_own_order = 5
Whether the order being removed is a local own order or a remote peer order.
Used in: , ,
BUY = 0
SELL = 1
BOTH = 2
message
xudrpc.proto:736Used in:
repeated buy_orders = 1
A list of buy orders sorted by descending price.
repeated sell_orders = 2
A list of sell orders sorted by ascending price.
message
xudrpc.proto:743Used in:
uint32 peer = 1
The number of orders belonging to remote xud nodes.
uint32 own = 2
The number of orders belonging to our local xud node.
message
xudrpc.proto:759Used in:
string address = 1
The socket address with host and port for this peer.
string node_pub_key = 2
The node pub key to uniquely identify this peer.
map<string, string> lnd_pub_keys = 3
A map of ticker symbols to lnd pub keys for this peer
bool inbound = 4
Indicates whether this peer was connected inbound.
repeated string pairs = 5
A list of trading pair tickers supported by this peer.
string xud_version = 6
The version of xud being used by the peer.
uint32 seconds_connected = 7
The time in seconds that we have been connected to this peer.
string alias = 9
The alias for this peer's public key
repeated lnd_uris = 10
string connext_identifier = 11
The connext identifier for this peer
message
xudrpc.proto:777A map of ticker symbols to lnd uris for this peer
Used in:
string currency = 1
repeated string uri = 2
message
xudrpc.proto:786Used as request type in: Xud.PlaceOrder, Xud.PlaceOrderSync
double price = 1
The price of the order.
uint64 quantity = 2
The quantity of the order denominated in satoshis.
string pair_id = 3
The trading pair that the order is for.
string order_id = 4
The local id to assign to the order.
OrderSide side = 5
Whether the order is a buy or sell.
string replace_order_id = 6
The local id of an existing order to be replaced. If provided, the order must be successfully found and removed before the new order is placed, otherwise an error is returned.
bool immediate_or_cancel = 7
Whether the order must be filled immediately and not allowed to enter the order book.
enum Role
xudrpc.proto:389Used in: ,
TAKER = 0
MAKER = 1
INTERNAL = 2
message
xudrpc.proto:910Used as request type in: Xud.SubscribeSwapFailures, Xud.SubscribeSwaps
bool include_taker = 1
Whether to include the results for swaps initiated via the PlaceOrder or ExecuteSwap calls. These swap results are also returned in the responses for the respective calls.
message
xudrpc.proto:941Used as response type in: Xud.SubscribeSwapFailures
Used as field type in: ,
string order_id = 1
The global UUID for the order that failed the swap.
string pair_id = 2
The trading pair that the swap is for.
uint64 quantity = 3
The order quantity that was attempted to be swapped.
string peer_pub_key = 4
The node pub key of the peer that we attempted to swap with.
string failure_reason = 5
The reason why the swap failed.
message
xudrpc.proto:954Used as response type in: Xud.ExecuteSwap, Xud.SubscribeSwaps
Used as field type in: ,
string order_id = 1
The global UUID for the order that was swapped.
string local_id = 2
The local id for the order that was swapped.
string pair_id = 3
The trading pair that the swap is for.
uint64 quantity = 4
The order quantity that was swapped.
string r_hash = 5
The hex-encoded payment hash for the swap.
uint64 amount_received = 8
The amount received denominated in satoshis.
uint64 amount_sent = 9
The amount sent denominated in satoshis.
string peer_pub_key = 10
The node pub key of the peer that executed this order.
Role role = 11
Our role in the swap, either MAKER or TAKER.
string currency_received = 12
The ticker symbol of the currency received.
string currency_sent = 13
The ticker symbol of the currency sent.
string r_preimage = 14
The hex-encoded preimage.
double price = 15
The price used for the swap.
message
xudrpc.proto:983Used in:
optional maker_order = 1
The maker order involved in this trade.
optional taker_order = 2
The taker order involved in this trade. Note that when a trade occurs from a remote peer filling one of our orders, we do not receive the order (only a swap request) and this field will be empty.
string r_hash = 3
The payment hash involved in this trade.
uint64 quantity = 4
The quantity transacted in this trade.
string pair_id = 5
The trading pair for this trade.
double price = 6
The price used for the trade.
Role role = 7
Our role in the trade.
uint64 executed_at = 8
The epoch time in milliseconds that this trade was executed
OrderSide side = 9
Whether this node was on the buy or sell side of the trade - or both in case of internal trades.
optional counterparty = 10
The counterparty to this trade, if applicable.
message
xudrpc.proto:1017Used in:
uint64 max_sell = 1
Maximum outbound limit for a sell order denominated in satoshis.
uint64 max_buy = 2
Maximum inbound limit for a buy order denominated in satoshis.
uint64 reserved_sell = 3
The outbound amount reserved for open sell orders.
uint64 reserved_buy = 4
The inbound amount reserved for open buy orders.