Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsitency between slate docs and CLI help for method takeoffer #15

Open
pmartincalvo opened this issue Aug 30, 2022 · 4 comments
Open

Comments

@pmartincalvo
Copy link

The version 1.9.4 of the CLi shows the following help:

OPTIONS
-------
--offer-id
		The ID of the buy or sell offer to take.

--payment-account
		The ID of the fiat payment account used to send or receive funds during the trade.
		The payment account's payment method must match that of the offer.

--fee-currency
		The wallet currency used to pay the Bisq trade taker fee (BSQ|BTC).  Default is BTC

But the web docs of the API show this:

Name Type Description
offer_id string The unique identifier of the offer being taken.
payment_account_id string The unique identifier of the payment account used to take offer.
taker_fee_currency_code string The code of the currency (BSQ or BTC) used to pay the taker's Bisq trade fee.
amount uint64 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.

Notice how the amount argument described in the web docs does not appear in the CLI help.

The issue is both finding out which of them is true, and then fixing the wrong one so that both are correct and consistent.

@ghubstan
Copy link
Owner

The CLI takeoffer --help needs to be updated for the recently added --amount parameter. Thanks for informing me. I will add a PR tomorrow.

@ghubstan
Copy link
Owner

The API Reference doc is correct.

@pmartincalvo
Copy link
Author

Awesome. Thanks a lot.

@ghubstan
Copy link
Owner

@pmartincalvo: turns out I did not forget to update the CLI takeoffer --help man page in PR bisq-network/bisq#6312. The v1.9.5 releases include the updated man page.

The confusion was due to the lack of version info in the API Reference, as you point out in #14.

The v1.9.5 CLI takeoffer man page is in sync with the API Reference -- describing the master branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants