Improve takeoffer param api ref comments

This commit is contained in:
ghubstan 2022-09-11 12:21:26 -03:00
parent 44af373570
commit 35f4fe14b2
No known key found for this signature in database
GPG key ID: E35592D6800A861E

View file

@ -514,8 +514,14 @@ service Trades {
message TakeOfferRequest { message TakeOfferRequest {
string offer_id = 1; // The unique identifier of the offer being taken. string 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 offer. // The unique identifier of the payment account used to take a Bisq v1 protocol offer.
string taker_fee_currency_code = 3; // The code of the currency (BSQ or BTC) used to pay the taker's Bisq trade fee. // 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 payment_account_id = 2;
// 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.
string taker_fee_currency_code = 3;
// The trade's intended BTC amount in satoshis. Ten million satoshis is represented as 10000000. // 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 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. // If not set (0 default), the taken offer's (max) amount becomes the intended trade amount.