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

gethelp command in CLI wallet built with Ubuntu 20 lacks docs for command parameters #2770

Closed
1 of 17 tasks
abitmore opened this issue Jul 12, 2023 · 1 comment
Closed
1 of 17 tasks

Comments

@abitmore
Copy link
Member

abitmore commented Jul 12, 2023

Bug Description

CLI wallet built with Ubuntu 18.04 (with doxygen 1.8.13) or Ubuntu 16.04 (with doxygen 1.8.11):

>>> gethelp transfer

Transfer an amount from one account to another.

Parameters:
    from: the name or id of the account sending the funds (type: string)
    to: the name or id of the account receiving the funds (type: string)
    amount: the amount to send (in nominal units - to send half of a BTS,
        specify 0.5) (type: string)
    asset_symbol_or_id: the symbol or id of the asset to send (type:
        string)
    memo: a memo to attach to the transaction. The memo will be encrypted
        in the transaction and readable for the receiver. There is no
        length limit other than the limit imposed by maximum transaction
        size, but transaction increase with transaction size (type: string)
    broadcast: true to broadcast the transaction on the network (type:
        bool)

Returns
    the signed transaction transferring funds

usage: transfer FROM TO AMOUNT SYMBOL "memo" BROADCAST

example: transfer "1.3.11" "1.3.4" 1000.03 CORE "memo" true
example: transfer "usera" "userb" 1000.123 CORE "memo" true

CLI wallet built with Ubuntu 20.04 (with doxygen 1.8.17):

>>> gethelp transfer

Transfer an amount from one account to another.

Returns
    the signed transaction transferring funds

usage: transfer FROM TO AMOUNT SYMBOL "memo" BROADCAST

example: transfer "1.3.11" "1.3.4" 1000.03 CORE "memo" true
example: transfer "usera" "userb" 1000.123 CORE "memo" true

Both have doxygen installed, with different versions though.

Impacts
Describe which portion(s) of BitShares Core may be impacted by this bug. Please tick at least one box.

  • API (the application programming interface)
  • Build (the build process or something prior to compiled code)
  • CLI (the command line wallet)
  • Deployment (the deployment process after building such as Docker, Travis, etc.)
  • DEX (the Decentralized EXchange, market engine, etc.)
  • P2P (the peer-to-peer network for transaction/block propagation)
  • Performance (system or user efficiency, etc.)
  • Protocol (the blockchain logic, consensus, validation, etc.)
  • Security (the security of system or user data, etc.)
  • UX (the User Experience)
  • Other (please add below)

CORE TEAM TASK LIST

  • Evaluate / Prioritize Bug Report
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution
  • Perform QA/Testing
  • Update Documentation
@abitmore
Copy link
Member Author

Fixed by #2771.

Feature Release (7.1.0) automation moved this from To do to Done Jul 14, 2023
@abitmore abitmore added this to To do in Protocol Upgrade Release (7.0.0) via automation Sep 25, 2023
@abitmore abitmore removed this from Done in Feature Release (7.1.0) Sep 25, 2023
@abitmore abitmore moved this from To do to Done in Protocol Upgrade Release (7.0.0) Sep 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

1 participant