[bisq-network/bisq] Clarify meaning of API/Offer related % fields [#6] (PR #6065)

Sun Feb 20 19:43:08 CET 2022

This change fixes some inconsistencies in offer related API fields representing percentages:  
- Rename double `marketPriceMargin` -> `marketPriceMarginPct`.
- Rename double `buyerSecurityDeposit` -> `buyerSecurityDepositPct`.

In both cases, these fields' values represent "literal" percent values, e.g., 2.55 means 2.55%.

It also fixes inconsistencies between input-pct values and output-pct values. For example, when `createoffer` was passed a `marketPriceMargin`=1.0 (%) param, the `getoffer` response contained an unexpected decimal representation of the pct literal:  `marketPriceMargin`=0.01.  Now `createoffer` input equals `getoffer` output: 1.0 (%).

Summary of commits:
- Disambiguate `grpc.proto` offer pct literal field names.
- Adjust `GrpcOffersService` to new .proto *Pct field names.
- Adjust `core` api pkg classes to new .proto *Pct field names.
- Adjust `cli` module to new .proto *Pct field names.
- Adjust `apitest` cases to new .proto *Pct field names.

Based on branch `5-change-tradeinfo-proto-prc-n-vol-to-string`, PR https://github.com/bisq-network/bisq/pull/6062
You can view, comment on, or merge this pull request online at:

  https://github.com/bisq-network/bisq/pull/6065

-- Commit Summary --

  * Include unmerged API NPE fix to FeeService class (see PR #6052)
  * Prepare API Offers .proto defs for significant changes
  * Fix comment about changing "all" number fields to string
  * Delete deprecated CLI console output formatting classes
  * Change OfferInfo proto's 'price' field type to string
  * Adjust cli module to OfferInfo.price field change to string  type
  * Fix typo in comment
  * Adjust apitest cases to OfferInfo.price proto field type to string
  * Fix 'unnecessary use of fully qualified name'.
  * Change existing `uint64 triggerPrice` field type in grpc.proto to `string triggerPrice`.
  * Adjust to `string triggerPrice` change in API core classes.
  * Adjust to `string triggerPrice` change in API cli classes
  * Adjust to `string triggerPrice` change in API test cases
  * Change OfferInfo proto's volume fields' type to string
  * Adjust cli module to grpc.proto::volume field type change (string)
  * Remove some dead code
  * Add some asserts on volume/min-volume strings from server
  * Merge branch 'master' into 4-change-grpc-proto-volume-to-string
  * Change TradeInfo .proto's price & volume fields to string
  * Adjust .proto wrappers to price & volume type change
  * Adjust cli to TradeInfo .proto's price & volume type change
  * Adjust apitest cases to TradeInfo .proto's price & volume type change
  * Disambiguate  grpc.proto offer pct literal field names
  * Adjust GrpcOffersService to new .proto *Pct field names
  * Adjust core.api to new .proto *Pct field names
  * Adjust cli module to new .proto *Pct field names
  * Adjust apitest cases to new .proto *Pct field names

-- File Changes --

    M apitest/src/test/java/bisq/apitest/method/MethodTest.java (15)
    M apitest/src/test/java/bisq/apitest/method/offer/AbstractOfferTest.java (61)
    M apitest/src/test/java/bisq/apitest/method/offer/BsqSwapOfferTest.java (10)
    M apitest/src/test/java/bisq/apitest/method/offer/CancelOfferTest.java (3)
    M apitest/src/test/java/bisq/apitest/method/offer/CreateBSQOffersTest.java (55)
    M apitest/src/test/java/bisq/apitest/method/offer/CreateOfferUsingFixedPriceTest.java (37)
    M apitest/src/test/java/bisq/apitest/method/offer/CreateOfferUsingMarketPriceMarginTest.java (62)
    M apitest/src/test/java/bisq/apitest/method/offer/CreateXMROffersTest.java (25)
    M apitest/src/test/java/bisq/apitest/method/offer/EditOfferTest.java (312)
    M apitest/src/test/java/bisq/apitest/method/offer/ValidateCreateOfferTest.java (7)
    M apitest/src/test/java/bisq/apitest/method/trade/AbstractTradeTest.java (14)
    M apitest/src/test/java/bisq/apitest/method/trade/BsqSwapBuyBtcTradeTest.java (6)
    M apitest/src/test/java/bisq/apitest/method/trade/BsqSwapSellBtcTradeTest.java (4)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeBuyBSQOfferTest.java (5)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeBuyBTCOfferTest.java (3)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeBuyBTCOfferWithNationalBankAcctTest.java (3)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeBuyXMROfferTest.java (5)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeSellBSQOfferTest.java (5)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeSellBTCOfferTest.java (3)
    M apitest/src/test/java/bisq/apitest/method/trade/TakeSellXMROfferTest.java (5)
    M apitest/src/test/java/bisq/apitest/scenario/LongRunningOfferDeactivationTest.java (31)
    M apitest/src/test/java/bisq/apitest/scenario/OfferTest.java (8)
    M apitest/src/test/java/bisq/apitest/scenario/bot/BotClient.java (3)
    M apitest/src/test/java/bisq/apitest/scenario/bot/RandomOffer.java (8)
    M apitest/src/test/java/bisq/apitest/scenario/bot/RobotBob.java (12)
    M apitest/src/test/java/bisq/apitest/scenario/bot/protocol/BotProtocol.java (11)
    M apitest/src/test/java/bisq/apitest/scenario/bot/protocol/MakerBotProtocol.java (12)
    M apitest/src/test/java/bisq/apitest/scenario/bot/protocol/TakerBotProtocol.java (5)
    M cli/src/main/java/bisq/cli/CliMain.java (40)
    D cli/src/main/java/bisq/cli/ColumnHeaderConstants.java (81)
    M cli/src/main/java/bisq/cli/CurrencyFormat.java (107)
    D cli/src/main/java/bisq/cli/DirectionFormat.java (61)
    M cli/src/main/java/bisq/cli/GrpcClient.java (38)
    D cli/src/main/java/bisq/cli/OfferFormat.java (309)
    D cli/src/main/java/bisq/cli/TableFormat.java (156)
    D cli/src/main/java/bisq/cli/TradeFormat.java (222)
    D cli/src/main/java/bisq/cli/TransactionFormat.java (60)
    M cli/src/main/java/bisq/cli/opts/AbstractMethodOptionParser.java (9)
    M cli/src/main/java/bisq/cli/opts/CreateOfferOptionParser.java (12)
    M cli/src/main/java/bisq/cli/opts/EditOfferOptionParser.java (51)
    M cli/src/main/java/bisq/cli/request/OffersServiceRequest.java (72)
    M cli/src/main/java/bisq/cli/table/builder/AbstractTableBuilder.java (4)
    M cli/src/main/java/bisq/cli/table/builder/AbstractTradeListBuilder.java (52)
    M cli/src/main/java/bisq/cli/table/builder/ClosedTradeTableBuilder.java (16)
    M cli/src/main/java/bisq/cli/table/builder/FailedTradeTableBuilder.java (16)
    M cli/src/main/java/bisq/cli/table/builder/OfferTableBuilder.java (77)
    M cli/src/main/java/bisq/cli/table/builder/OpenTradeTableBuilder.java (16)
    M cli/src/main/java/bisq/cli/table/builder/TradeDetailTableBuilder.java (21)
    M cli/src/main/java/bisq/cli/table/builder/TradeTableColumnSupplier.java (36)
    R cli/src/main/java/bisq/cli/table/column/AltcoinVolumeColumn.java (39)
    M cli/src/main/java/bisq/cli/table/column/FiatColumn.java (19)
    D cli/src/main/java/bisq/cli/table/column/MixedPriceColumn.java (57)
    D cli/src/main/java/bisq/cli/table/column/MixedVolumeColumn.java (73)
    M cli/src/test/java/bisq/cli/opts/OptionParsersTest.java (2)
    M cli/src/test/java/bisq/cli/table/AddressCliOutputDiffTest.java (17)
    M cli/src/test/java/bisq/cli/table/GetBalanceCliOutputDiffTest.java (15)
    M cli/src/test/java/bisq/cli/table/GetOffersCliOutputDiffTest.java (9)
    M cli/src/test/java/bisq/cli/table/GetTradeCliOutputDiffTest.java (9)
    M cli/src/test/java/bisq/cli/table/GetTransactionCliOutputDiffTest.java (10)
    M cli/src/test/java/bisq/cli/table/PaymentAccountsCliOutputDiffTest.java (9)
    M core/src/main/java/bisq/core/api/CoreApi.java (16)
    M core/src/main/java/bisq/core/api/CoreOffersService.java (43)
    M core/src/main/java/bisq/core/api/EditOfferValidator.java (21)
    M core/src/main/java/bisq/core/api/model/CanceledTradeInfo.java (6)
    M core/src/main/java/bisq/core/api/model/OfferInfo.java (54)
    M core/src/main/java/bisq/core/api/model/TradeInfo.java (50)
    M core/src/main/java/bisq/core/api/model/builder/OfferInfoBuilder.java (22)
    M core/src/main/java/bisq/core/api/model/builder/TradeInfoV1Builder.java (8)
    M daemon/src/main/java/bisq/daemon/grpc/GrpcOffersService.java (11)
    M proto/src/main/proto/grpc.proto (238)

-- Patch Links --

https://github.com/bisq-network/bisq/pull/6065.patch
https://github.com/bisq-network/bisq/pull/6065.diff

-- 
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq/pull/6065
You are receiving this because you are subscribed to this thread.

Message ID: <bisq-network/bisq/pull/6065 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20220220/699749c9/attachment-0001.htm>