mirrors/bisq
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq.git synced 2024-11-19 01:41:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update .proto rpc get/take offer method comments

Browse Source 
Explain that the API's getoffer(s) and takeoffer methods only
work as expected when the user's node has payment account/methods
matching the available offers' own payment methods.

- getoffers returns only the offers with payment methods matching
  those set up on the user's node

- getoffer will only return the offer if the user's node has a
  payment method matching the payment method associated with the
  requested offer

- takeoffer will fail if the user's node does not have a matching
  payment method
This commit is contained in:
ghubstan 2022-06-29 11:53:20 -03:00
parent 11eabc745b
commit 60c7feeb5d
No known key found for this signature in database
GPG Key ID: E35592D6800A861E
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
proto/src/main/proto/grpc.proto
View File

@ -66,7 +66,8 @@ service Offers {
// Get the available BSQ swap offer with offer-id. // Get the available BSQ swap offer with offer-id.
rpc GetBsqSwapOffer (GetOfferRequest) returns (GetBsqSwapOfferReply) { rpc GetBsqSwapOffer (GetOfferRequest) returns (GetBsqSwapOfferReply) {
} }
// Get the v1 protocol offer with offer-id. // Get 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.
rpc GetOffer (GetOfferRequest) returns (GetOfferReply) { rpc GetOffer (GetOfferRequest) returns (GetOfferReply) {
} }
// Get user's BSQ swap offer with offer-id. // Get user's BSQ swap offer with offer-id.
@ -78,7 +79,9 @@ service Offers {
// Get all available BSQ swap offers with a BUY (BTC) or SELL (BTC) direction. // Get all available BSQ swap offers with a BUY (BTC) or SELL (BTC) direction.
rpc GetBsqSwapOffers (GetBsqSwapOffersRequest) returns (GetBsqSwapOffersReply) { rpc GetBsqSwapOffers (GetBsqSwapOffersRequest) returns (GetBsqSwapOffersReply) {
} }
// Get all available v1 protocol offers with a BUY (BTC) or SELL (BTC) direction. // Get 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.
rpc GetOffers (GetOffersRequest) returns (GetOffersReply) { rpc GetOffers (GetOffersRequest) returns (GetOffersReply) {
} }
// Get all user's BSQ swap offers with a BUY (BTC) or SELL (BTC) direction. // Get all user's BSQ swap offers with a BUY (BTC) or SELL (BTC) direction.
@ -485,7 +488,8 @@ service Trades {
// Get currently open, or historical trades (closed or failed). // Get currently open, or historical trades (closed or failed).
rpc GetTrades (GetTradesRequest) returns (GetTradesReply) { rpc GetTrades (GetTradesRequest) returns (GetTradesReply) {
} }
// Take an open offer. // Take 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.
rpc TakeOffer (TakeOfferRequest) returns (TakeOfferReply) { rpc TakeOffer (TakeOfferRequest) returns (TakeOfferReply) {
} }
// Send a 'payment started' message to a trading peer (the BTC seller). // Send a 'payment started' message to a trading peer (the BTC seller).