The output of gethelp function in cli_wallet for some functions is not well formatted #450

Closed
opened 2022-09-20 14:36:09 +00:00 by wsalloum · 20 comments
wsalloum commented 2022-09-20 14:36:09 +00:00 (Migrated from gitlab.com)

The output for the gethelp in cli_wallet should be formatted as the following :

new >>> gethelp list_accounts
gethelp list_accounts

Lists all accounts registered in the blockchain. This returns a list of all account names and their account ids, sorted by account name.

Use the 'lowerbound' and limit parameters to page through the list. To
retrieve all accounts, start by setting 'lowerbound' to the empty string
'""', and then each iteration, pass the last account name returned as the
'lowerbound' for the next 'list_accounts()' call.

Command:
    list_accounts lowerbound limit

Parameters:
    lowerbound (string): the name of the first account to return. If the
        named account does not exist, the list will start at the account
        that comes after 'lowerbound'
    limit (integer): the maximum number of accounts to return (max: 1000)

Returns:
    a list of accounts mapping account names to account ids

But it is not well formatted for the following list:

create_account_role
create_bid
create_custom_permission
create_worker
create_account_with_brain_key
create_lottery
create_asset
create_custom_account_authority
create_offer
update_asset_feed_producers
update_account_role
update_custom_account_authority
update_custom_permission
transfer
list_buy_offers
list_event_groups
list_offer_history
list_betting_market_groups
list_committee_members
list_events_in_group
list_offers
list_sports
list_betting_markets
list_core_accounts
list_sell_offers
get_events_containing_sub_string
get_global_betting_statistics
get_key_label
get_account_lotteries
get_account_roles_by_owner
get_limit_orders
get_active_custom_account_authorities_by_operation
get_lotteries
get_lottery_balance
get_total_matched_bet_amount_for_betting_market_group
get_market_history
get_matched_bets_for_bettor
get_tournaments
get_all_matched_bets_for_bettor
get_tournaments_by_state
get_all_unmatched_bets_for_bettor
get_offer_history_by_bidder
get_offer_history_by_issuer
get_offer_history_by_item
get_unmatched_bets_for_bettor
get_offers_by_issuer
get_offers_by_item
get_block
get_order_book
get_blocks
get_private_key
get_call_orders
get_custom_account_authorities
get_public_key
get_custom_account_authorities_by_permission_id
get_custom_account_authorities_by_permission_name
get_settle_orders
get_custom_permission_by_name
get_custom_permissions
set_key_label
set_fees_on_builder_transaction
set_password
settle_asset
sign_builder_transaction

For example :

unlocked >>> gethelp get_tournaments_by_state 
gethelp get_tournaments_by_state 

No help defined for method get_tournaments_by_state

unlocked >>> gethelp get_transaction_id       
gethelp get_transaction_id 

Convert a JSON transaction to its transactin ID.

Command:
    get_transaction_id trx


The output for the gethelp in cli_wallet should be formatted as the following : ``` new >>> gethelp list_accounts gethelp list_accounts Lists all accounts registered in the blockchain. This returns a list of all account names and their account ids, sorted by account name. Use the 'lowerbound' and limit parameters to page through the list. To retrieve all accounts, start by setting 'lowerbound' to the empty string '""', and then each iteration, pass the last account name returned as the 'lowerbound' for the next 'list_accounts()' call. Command: list_accounts lowerbound limit Parameters: lowerbound (string): the name of the first account to return. If the named account does not exist, the list will start at the account that comes after 'lowerbound' limit (integer): the maximum number of accounts to return (max: 1000) Returns: a list of accounts mapping account names to account ids ``` But it is not well formatted for the following list: ``` create_account_role create_bid create_custom_permission create_worker create_account_with_brain_key create_lottery create_asset create_custom_account_authority create_offer update_asset_feed_producers update_account_role update_custom_account_authority update_custom_permission transfer list_buy_offers list_event_groups list_offer_history list_betting_market_groups list_committee_members list_events_in_group list_offers list_sports list_betting_markets list_core_accounts list_sell_offers get_events_containing_sub_string get_global_betting_statistics get_key_label get_account_lotteries get_account_roles_by_owner get_limit_orders get_active_custom_account_authorities_by_operation get_lotteries get_lottery_balance get_total_matched_bet_amount_for_betting_market_group get_market_history get_matched_bets_for_bettor get_tournaments get_all_matched_bets_for_bettor get_tournaments_by_state get_all_unmatched_bets_for_bettor get_offer_history_by_bidder get_offer_history_by_issuer get_offer_history_by_item get_unmatched_bets_for_bettor get_offers_by_issuer get_offers_by_item get_block get_order_book get_blocks get_private_key get_call_orders get_custom_account_authorities get_public_key get_custom_account_authorities_by_permission_id get_custom_account_authorities_by_permission_name get_settle_orders get_custom_permission_by_name get_custom_permissions set_key_label set_fees_on_builder_transaction set_password settle_asset sign_builder_transaction ``` For example : ``` unlocked >>> gethelp get_tournaments_by_state gethelp get_tournaments_by_state No help defined for method get_tournaments_by_state unlocked >>> gethelp get_transaction_id gethelp get_transaction_id Convert a JSON transaction to its transactin ID. Command: get_transaction_id trx ```
serkixenos commented 2022-09-22 12:29:38 +00:00 (Migrated from gitlab.com)

@wsalloum Can you review the docs for these functions here:
https://gitlab.com/PBSA/peerplays/-/blob/develop/libraries/wallet/include/graphene/wallet/wallet.hpp

Lets check if these functions are documented at all. If not, we do not expect any output from them, but we can consider documenting them. If yes, we can take a closer look into formatting issues.

Split this list into actually documented and not documented at all.

@wsalloum Can you review the docs for these functions here: https://gitlab.com/PBSA/peerplays/-/blob/develop/libraries/wallet/include/graphene/wallet/wallet.hpp Lets check if these functions are documented at all. If not, we do not expect any output from them, but we can consider documenting them. If yes, we can take a closer look into formatting issues. Split this list into actually documented and not documented at all.
timur.5 commented 2022-09-22 12:37:16 +00:00 (Migrated from gitlab.com)

Possibly, we should leave no functions without comments
and fail the build if we face undocumented ones in wallet.hpp?

We can mark hidden functions explicitly by something like '@hidden'.
After '@hidden' there can be other comments -
programmers could need them internally.

Possibly, we should leave no functions without comments and fail the build if we face undocumented ones in wallet.hpp? We can mark hidden functions explicitly by something like '\@hidden'. After '\@hidden' there can be other comments - programmers could need them internally.
wsalloum commented 2022-09-26 08:05:06 +00:00 (Migrated from gitlab.com)

Not documented:

add_operation_to_builder_transaction
begin_builder_transaction
buy_ticket
cancel_bet
cancel_offer
create_account_role
create_bid
create_custom_account_authority
create_custom_permission
create_lottery
create_offer
dbg_generate_blocks
dbg_make_mia
dbg_make_uia
dbg_push_blocks
dbg_stream_json_objects
dbg_update_object
delete_account_role
delete_custom_account_authority
delete_custom_permission
flood_network
get_account_lotteries
get_account_roles_by_owner
get_active_custom_account_authorities_by_operation
get_all_matched_bets_for_bettor
get_all_unmatched_bets_for_bettor
get_block
get_blocks
get_call_orders
get_custom_account_authorities
get_custom_account_authorities_by_permission_id
get_custom_account_authorities_by_permission_name
get_custom_permission_by_name
get_custom_permissions
get_events_containing_sub_string
get_global_betting_statistics
get_key_label
get_limit_orders
get_lotteries
get_lottery_balance
get_market_history
get_matched_bets_for_bettor
get_offer_history_by_bidder
get_offer_history_by_issuer
get_offer_history_by_item
get_offers_by_issuer
get_offers_by_item
get_order_book
get_public_key
get_settle_orders
get_son_listener_log
get_total_matched_bet_amount_for_betting_market_group
get_tournaments
get_tournaments_by_state
get_unmatched_bets_for_bettor
import_account_keys
import_accounts
list_betting_market_groups
list_betting_markets
list_buy_offers
list_core_accounts
list_event_groups
list_events_in_group
list_offer_history
list_offers
list_sell_offers
list_sports
network_add_nodes
network_get_connected_peers
nft_lottery_buy_ticket
preview_builder_transaction
propose_builder_transaction
propose_builder_transaction2
propose_create_betting_market
propose_create_betting_market_group
propose_create_betting_market_rules
propose_create_event
propose_create_event_group
propose_create_sport
propose_delete_event_group
propose_delete_sport
propose_resolve_betting_market_group
propose_update_betting_market
propose_update_betting_market_group
propose_update_betting_market_rules
propose_update_event
propose_update_event_group
propose_update_sport
remove_builder_transaction
replace_operation_in_builder_transaction
set_fees_on_builder_transaction
set_key_label
sign_builder_transaction
update_account_role
update_custom_account_authority
update_custom_permission

Not formatted:

create_asset
get_private_key
get_transaction_id
import_balance
set_password
transfer
transfer2
update_son

Not documented: ``` add_operation_to_builder_transaction begin_builder_transaction buy_ticket cancel_bet cancel_offer create_account_role create_bid create_custom_account_authority create_custom_permission create_lottery create_offer dbg_generate_blocks dbg_make_mia dbg_make_uia dbg_push_blocks dbg_stream_json_objects dbg_update_object delete_account_role delete_custom_account_authority delete_custom_permission flood_network get_account_lotteries get_account_roles_by_owner get_active_custom_account_authorities_by_operation get_all_matched_bets_for_bettor get_all_unmatched_bets_for_bettor get_block get_blocks get_call_orders get_custom_account_authorities get_custom_account_authorities_by_permission_id get_custom_account_authorities_by_permission_name get_custom_permission_by_name get_custom_permissions get_events_containing_sub_string get_global_betting_statistics get_key_label get_limit_orders get_lotteries get_lottery_balance get_market_history get_matched_bets_for_bettor get_offer_history_by_bidder get_offer_history_by_issuer get_offer_history_by_item get_offers_by_issuer get_offers_by_item get_order_book get_public_key get_settle_orders get_son_listener_log get_total_matched_bet_amount_for_betting_market_group get_tournaments get_tournaments_by_state get_unmatched_bets_for_bettor import_account_keys import_accounts list_betting_market_groups list_betting_markets list_buy_offers list_core_accounts list_event_groups list_events_in_group list_offer_history list_offers list_sell_offers list_sports network_add_nodes network_get_connected_peers nft_lottery_buy_ticket preview_builder_transaction propose_builder_transaction propose_builder_transaction2 propose_create_betting_market propose_create_betting_market_group propose_create_betting_market_rules propose_create_event propose_create_event_group propose_create_sport propose_delete_event_group propose_delete_sport propose_resolve_betting_market_group propose_update_betting_market propose_update_betting_market_group propose_update_betting_market_rules propose_update_event propose_update_event_group propose_update_sport remove_builder_transaction replace_operation_in_builder_transaction set_fees_on_builder_transaction set_key_label sign_builder_transaction update_account_role update_custom_account_authority update_custom_permission ``` Not formatted: ``` create_asset get_private_key get_transaction_id import_balance set_password transfer transfer2 update_son ```
serkixenos commented 2022-09-29 20:10:07 +00:00 (Migrated from gitlab.com)

Comments:

create_asset - special case, the gethelp output format differs from usual, but its correct
get_private_key - docs updated, param descriptions added
get_transaction_id - docs updated, param descriptions added
import_balance - docs updated, param descriptions added
set_password - docs updated, param descriptions added
transfer - special case, the gethelp format output differs from usual, but its correct
transfer2 - docs updated, param descriptions added
update_son - gethelp output is as expected

Special gethelp cases:

https://gitlab.com/PBSA/peerplays/-/blob/update-cli-wallet-docs/libraries/wallet/wallet.cpp#L5752

create_account_with_brain_key
create_asset
import_key
register_account
transfer

Additionally documented commands:

add_operation_to_builder_transaction
begin_builder_transaction
preview_builder_transaction
propose_builder_transaction
propose_builder_transaction2
remove_builder_transaction
replace_operation_in_builder_transaction
set_fees_on_builder_transaction
sign_builder_transaction

References:

https://gitlab.com/PBSA/peerplays/-/commits/update-cli-wallet-docs

c0fd97ae52

Comments: ``` create_asset - special case, the gethelp output format differs from usual, but its correct get_private_key - docs updated, param descriptions added get_transaction_id - docs updated, param descriptions added import_balance - docs updated, param descriptions added set_password - docs updated, param descriptions added transfer - special case, the gethelp format output differs from usual, but its correct transfer2 - docs updated, param descriptions added update_son - gethelp output is as expected ``` Special gethelp cases: https://gitlab.com/PBSA/peerplays/-/blob/update-cli-wallet-docs/libraries/wallet/wallet.cpp#L5752 ``` create_account_with_brain_key create_asset import_key register_account transfer ``` Additionally documented commands: ``` add_operation_to_builder_transaction begin_builder_transaction preview_builder_transaction propose_builder_transaction propose_builder_transaction2 remove_builder_transaction replace_operation_in_builder_transaction set_fees_on_builder_transaction sign_builder_transaction ``` References: https://gitlab.com/PBSA/peerplays/-/commits/update-cli-wallet-docs https://gitlab.com/PBSA/peerplays/-/commit/c0fd97ae521b47f883fb09321c6b85f20f8e7d5a
serkixenos commented 2022-09-29 20:12:24 +00:00 (Migrated from gitlab.com)

Updated list of undocumented functions

buy_ticket
cancel_bet
cancel_offer
create_account_role
create_bid
create_custom_account_authority
create_custom_permission
create_lottery
create_offer
dbg_generate_blocks
dbg_make_mia
dbg_make_uia
dbg_push_blocks
dbg_stream_json_objects
dbg_update_object
delete_account_role
delete_custom_account_authority
delete_custom_permission
flood_network
get_account_lotteries
get_account_roles_by_owner
get_active_custom_account_authorities_by_operation
get_all_matched_bets_for_bettor
get_all_unmatched_bets_for_bettor
get_block
get_blocks
get_call_orders
get_custom_account_authorities
get_custom_account_authorities_by_permission_id
get_custom_account_authorities_by_permission_name
get_custom_permission_by_name
get_custom_permissions
get_events_containing_sub_string
get_global_betting_statistics
get_key_label
get_limit_orders
get_lotteries
get_lottery_balance
get_market_history
get_matched_bets_for_bettor
get_offer_history_by_bidder
get_offer_history_by_issuer
get_offer_history_by_item
get_offers_by_issuer
get_offers_by_item
get_order_book
get_public_key
get_settle_orders
get_son_listener_log
get_total_matched_bet_amount_for_betting_market_group
get_tournaments
get_tournaments_by_state
get_unmatched_bets_for_bettor
import_account_keys
import_accounts
list_betting_market_groups
list_betting_markets
list_buy_offers
list_core_accounts
list_event_groups
list_events_in_group
list_offer_history
list_offers
list_sell_offers
list_sports
network_add_nodes
network_get_connected_peers
nft_lottery_buy_ticket
propose_create_betting_market
propose_create_betting_market_group
propose_create_betting_market_rules
propose_create_event
propose_create_event_group
propose_create_sport
propose_delete_event_group
propose_delete_sport
propose_resolve_betting_market_group
propose_update_betting_market
propose_update_betting_market_group
propose_update_betting_market_rules
propose_update_event
propose_update_event_group
propose_update_sport
set_key_label
update_account_role
update_custom_account_authority
update_custom_permission
Updated list of undocumented functions ``` buy_ticket cancel_bet cancel_offer create_account_role create_bid create_custom_account_authority create_custom_permission create_lottery create_offer dbg_generate_blocks dbg_make_mia dbg_make_uia dbg_push_blocks dbg_stream_json_objects dbg_update_object delete_account_role delete_custom_account_authority delete_custom_permission flood_network get_account_lotteries get_account_roles_by_owner get_active_custom_account_authorities_by_operation get_all_matched_bets_for_bettor get_all_unmatched_bets_for_bettor get_block get_blocks get_call_orders get_custom_account_authorities get_custom_account_authorities_by_permission_id get_custom_account_authorities_by_permission_name get_custom_permission_by_name get_custom_permissions get_events_containing_sub_string get_global_betting_statistics get_key_label get_limit_orders get_lotteries get_lottery_balance get_market_history get_matched_bets_for_bettor get_offer_history_by_bidder get_offer_history_by_issuer get_offer_history_by_item get_offers_by_issuer get_offers_by_item get_order_book get_public_key get_settle_orders get_son_listener_log get_total_matched_bet_amount_for_betting_market_group get_tournaments get_tournaments_by_state get_unmatched_bets_for_bettor import_account_keys import_accounts list_betting_market_groups list_betting_markets list_buy_offers list_core_accounts list_event_groups list_events_in_group list_offer_history list_offers list_sell_offers list_sports network_add_nodes network_get_connected_peers nft_lottery_buy_ticket propose_create_betting_market propose_create_betting_market_group propose_create_betting_market_rules propose_create_event propose_create_event_group propose_create_sport propose_delete_event_group propose_delete_sport propose_resolve_betting_market_group propose_update_betting_market propose_update_betting_market_group propose_update_betting_market_rules propose_update_event propose_update_event_group propose_update_sport set_key_label update_account_role update_custom_account_authority update_custom_permission ```
serkixenos commented 2022-10-02 13:59:05 +00:00 (Migrated from gitlab.com)

mentioned in issue #460

mentioned in issue #460
serkixenos commented 2022-10-03 17:48:03 +00:00 (Migrated from gitlab.com)
Some fixes applied throught this ticket https://gitlab.com/PBSA/peerplays/-/issues/460 MRs https://gitlab.com/PBSA/peerplays/-/merge_requests/161 and https://gitlab.com/PBSA/peerplays/-/merge_requests/162
serkixenos commented 2022-10-14 18:43:50 +00:00 (Migrated from gitlab.com)

assigned to @milo_peerplays

assigned to @milo_peerplays
milo_peerplays commented 2022-10-20 12:00:45 +00:00 (Migrated from gitlab.com)

mentioned in merge request !167

mentioned in merge request !167
milo_peerplays commented 2022-10-25 10:49:00 +00:00 (Migrated from gitlab.com)

Additional fixes added as part of !168 MR.

Additional fixes added as part of !168 MR.
milo_peerplays commented 2022-10-25 10:50:10 +00:00 (Migrated from gitlab.com)

The updated state of methods missing the documentation and the reason for missing:

buy_ticket - missing in PP
cancel_bet - missing in PP
cancel_offer - missing in PP
create_account_role - missing in PP
create_bid - missing in PP
create_custom_account_authority - missing in PP
create_custom_permission - missing in PP
create_lottery - missing in PP
create_offer - missing in PP
dbg_generate_blocks - missing in both
dbg_make_mia - missing in both
dbg_make_uia - missing in both
dbg_push_blocks - missing in both
dbg_stream_json_objects - missing in both
dbg_update_object - missing in both
delete_account_role - missing in PP
delete_custom_account_authority - missing in PP
delete_custom_permission  - missing in both
flood_network  - missing in both
get_account_lotteries  - missing in PP
get_account_roles_by_owner  - missing in PP
get_active_custom_account_authorities_by_operation  - missing in PP
get_all_matched_bets_for_bettor  - missing in PP
get_all_unmatched_bets_for_bettor - missing in PP
get_custom_account_authorities - missing in PP
get_custom_account_authorities_by_permission_id - missing in PP
get_custom_account_authorities_by_permission_name - missing in PP
get_custom_permission_by_name - missing in PP
get_custom_permissions - missing in PP
get_events_containing_sub_string - missing in PP
get_global_betting_statistics - missing in PP
get_key_label - not displayed
get_lotteries - missing in PP
get_lottery_balance - missing in PP
get_matched_bets_for_bettor - missing in PP
get_offer_history_by_bidder - missing in PP
get_offer_history_by_issuer - missing in PP
get_offer_history_by_item - missing in PP
get_offers_by_issuer - missing in PP
get_offers_by_item - missing in PP
get_total_matched_bet_amount_for_betting_market_group - missing in PP
get_tournaments - missing in PP
get_tournaments_by_state - missing in PP
get_unmatched_bets_for_bettor - missing in PP
list_betting_market_groups - missing in PP
list_betting_markets - missing in PP
list_buy_offers - missing in PP
list_core_accounts - missing in PP
list_event_groups - missing in PP
list_events_in_group - missing in PP
list_offer_history - missing in PP
list_offers - missing in PP
list_sell_offers - missing in PP
list_sports - missing in PP
network_add_nodes - missing in both
network_get_connected_peers - missing in both
nft_lottery_buy_ticket - missing in PP
propose_create_betting_market - missing in PP
propose_create_betting_market_group - missing in PP
propose_create_betting_market_rules - missing in PP
propose_create_event - missing in PP
propose_create_event_group - missing in PP
propose_create_sport - missing in PP
propose_delete_event_group - missing in PP
propose_delete_sport - missing in PP
propose_resolve_betting_market_group - missing in PP
propose_update_betting_market - missing in PP
propose_update_betting_market_group - missing in PP
propose_update_betting_market_rules - missing in PP
propose_update_event - missing in PP
propose_update_event_group - missing in PP
propose_update_sport - missing in PP
set_key_label - not displayed
update_account_role - missing in PP
update_custom_account_authority - missing in PP
update_custom_permission - missing in PP
The updated state of methods missing the documentation and the reason for missing: ``` buy_ticket - missing in PP cancel_bet - missing in PP cancel_offer - missing in PP create_account_role - missing in PP create_bid - missing in PP create_custom_account_authority - missing in PP create_custom_permission - missing in PP create_lottery - missing in PP create_offer - missing in PP dbg_generate_blocks - missing in both dbg_make_mia - missing in both dbg_make_uia - missing in both dbg_push_blocks - missing in both dbg_stream_json_objects - missing in both dbg_update_object - missing in both delete_account_role - missing in PP delete_custom_account_authority - missing in PP delete_custom_permission - missing in both flood_network - missing in both get_account_lotteries - missing in PP get_account_roles_by_owner - missing in PP get_active_custom_account_authorities_by_operation - missing in PP get_all_matched_bets_for_bettor - missing in PP get_all_unmatched_bets_for_bettor - missing in PP get_custom_account_authorities - missing in PP get_custom_account_authorities_by_permission_id - missing in PP get_custom_account_authorities_by_permission_name - missing in PP get_custom_permission_by_name - missing in PP get_custom_permissions - missing in PP get_events_containing_sub_string - missing in PP get_global_betting_statistics - missing in PP get_key_label - not displayed get_lotteries - missing in PP get_lottery_balance - missing in PP get_matched_bets_for_bettor - missing in PP get_offer_history_by_bidder - missing in PP get_offer_history_by_issuer - missing in PP get_offer_history_by_item - missing in PP get_offers_by_issuer - missing in PP get_offers_by_item - missing in PP get_total_matched_bet_amount_for_betting_market_group - missing in PP get_tournaments - missing in PP get_tournaments_by_state - missing in PP get_unmatched_bets_for_bettor - missing in PP list_betting_market_groups - missing in PP list_betting_markets - missing in PP list_buy_offers - missing in PP list_core_accounts - missing in PP list_event_groups - missing in PP list_events_in_group - missing in PP list_offer_history - missing in PP list_offers - missing in PP list_sell_offers - missing in PP list_sports - missing in PP network_add_nodes - missing in both network_get_connected_peers - missing in both nft_lottery_buy_ticket - missing in PP propose_create_betting_market - missing in PP propose_create_betting_market_group - missing in PP propose_create_betting_market_rules - missing in PP propose_create_event - missing in PP propose_create_event_group - missing in PP propose_create_sport - missing in PP propose_delete_event_group - missing in PP propose_delete_sport - missing in PP propose_resolve_betting_market_group - missing in PP propose_update_betting_market - missing in PP propose_update_betting_market_group - missing in PP propose_update_betting_market_rules - missing in PP propose_update_event - missing in PP propose_update_event_group - missing in PP propose_update_sport - missing in PP set_key_label - not displayed update_account_role - missing in PP update_custom_account_authority - missing in PP update_custom_permission - missing in PP ```
milo_peerplays commented 2022-10-26 12:14:24 +00:00 (Migrated from gitlab.com)

mentioned in merge request !170

mentioned in merge request !170
milo_peerplays commented 2022-10-29 17:42:33 +00:00 (Migrated from gitlab.com)

mentioned in commit 43ce3f517b1a18bf8373f3cd37f04dbcbcb5645a

mentioned in commit 43ce3f517b1a18bf8373f3cd37f04dbcbcb5645a
serkixenos commented 2022-10-29 17:42:33 +00:00 (Migrated from gitlab.com)

mentioned in commit 034c7e83fc15295eb7a00fcf7d9d6cf44a5a6306

mentioned in commit 034c7e83fc15295eb7a00fcf7d9d6cf44a5a6306
serkixenos commented 2022-10-30 02:28:07 +00:00 (Migrated from gitlab.com)

mentioned in commit 06bc65cc79

mentioned in commit 06bc65cc7929074bffe6acc63f5ad95178351241
serkixenos commented 2022-10-30 02:43:35 +00:00 (Migrated from gitlab.com)

assigned to @wsalloum and @prandnum

assigned to @wsalloum and @prandnum
prandnum commented 2022-11-05 14:31:47 +00:00 (Migrated from gitlab.com)

@milo_peerplays what is the expected behavior? get_key_label and set_key_label help is not proper.

unlocked >>> gethelp get_key_label 
gethelp get_key_label 
6 key_not_found_exception: Key Not Found
No entry for method get_key_label
    {"name":"get_key_label"}
    th_a  api_documentation.hpp:66 get_detailed_description
unlocked >>> gethelp  set_key_label 
gethelp  set_key_label 
6 key_not_found_exception: Key Not Found
No entry for method set_key_label
    {"name":"set_key_label"}
    th_a  api_documentation.hpp:66 get_detailed_description
unlocked >>> 

Following is the current behavior:

unlocked >>> gethelp  buy_ticket
gethelp  buy_ticket

No help defined for method buy_ticket

unlocked >>> gethelp  cancel_bet
gethelp  cancel_bet

No help defined for method cancel_bet

unlocked >>> gethelp  cancel_offer
gethelp  cancel_offer

No help defined for method cancel_offer

unlocked >>> gethelp  create_account_role
gethelp  create_account_role

No help defined for method create_account_role

unlocked >>> gethelp  create_bid
gethelp  create_bid

No help defined for method create_bid

unlocked >>> gethelp  create_custom_account_authority
gethelp  create_custom_account_authority

No help defined for method create_custom_account_authority

unlocked >>> gethelp  create_custom_permission
gethelp  create_custom_permission

No help defined for method create_custom_permission

unlocked >>> gethelp  create_lottery
gethelp  create_lottery

No help defined for method create_lottery

unlocked >>> gethelp  create_offer
gethelp  create_offer

No help defined for method create_offer

unlocked >>> gethelp  dbg_generate_blocks
gethelp  dbg_generate_blocks

No help defined for method dbg_generate_blocks

unlocked >>> gethelp  dbg_make_mia
gethelp  dbg_make_mia

No help defined for method dbg_make_mia

unlocked >>> gethelp  dbg_make_uia
gethelp  dbg_make_uia

No help defined for method dbg_make_uia

unlocked >>> gethelp  dbg_push_blocks
gethelp  dbg_push_blocks

No help defined for method dbg_push_blocks

unlocked >>> gethelp  dbg_stream_json_objects
gethelp  dbg_stream_json_objects

No help defined for method dbg_stream_json_objects

unlocked >>> gethelp  dbg_update_object
gethelp  dbg_update_object

No help defined for method dbg_update_object

unlocked >>> gethelp  delete_account_role
gethelp  delete_account_role

No help defined for method delete_account_role

unlocked >>> gethelp  delete_custom_account_authority
gethelp  delete_custom_account_authority

No help defined for method delete_custom_account_authority

unlocked >>> gethelp  delete_custom_permission
gethelp  delete_custom_permission

No help defined for method delete_custom_permission

unlocked >>> gethelp  flood_network
gethelp  flood_network

No help defined for method flood_network

unlocked >>> gethelp  get_account_lotteries
gethelp  get_account_lotteries

No help defined for method get_account_lotteries

unlocked >>> gethelp  get_account_roles_by_owner
gethelp  get_account_roles_by_owner

No help defined for method get_account_roles_by_owner

unlocked >>> gethelp  get_active_custom_account_authorities_by_operation
gethelp  get_active_custom_account_authorities_by_operation

No help defined for method get_active_custom_account_authorities_by_operation

unlocked >>> gethelp  get_all_matched_bets_for_bettor
gethelp  get_all_matched_bets_for_bettor

No help defined for method get_all_matched_bets_for_bettor

unlocked >>> gethelp  get_all_unmatched_bets_for_bettor
gethelp  get_all_unmatched_bets_for_bettor

No help defined for method get_all_unmatched_bets_for_bettor

unlocked >>> gethelp  get_custom_account_authorities
gethelp  get_custom_account_authorities

No help defined for method get_custom_account_authorities

unlocked >>> gethelp  get_custom_account_authorities_by_permission_id
gethelp  get_custom_account_authorities_by_permission_id

No help defined for method get_custom_account_authorities_by_permission_id

unlocked >>> gethelp  get_custom_account_authorities_by_permission_name
gethelp  get_custom_account_authorities_by_permission_name

No help defined for method get_custom_account_authorities_by_permission_name

unlocked >>> gethelp  get_custom_permission_by_name
gethelp  get_custom_permission_by_name

No help defined for method get_custom_permission_by_name

unlocked >>> gethelp  get_custom_permissions
gethelp  get_custom_permissions

No help defined for method get_custom_permissions

unlocked >>> gethelp  get_events_containing_sub_string
gethelp  get_events_containing_sub_string

No help defined for method get_events_containing_sub_string

unlocked >>> gethelp  get_global_betting_statistics
gethelp  get_global_betting_statistics

No help defined for method get_global_betting_statistics

unlocked >>> gethelp  get_key_label
gethelp  get_key_label
6 key_not_found_exception: Key Not Found
No entry for method get_key_label
    {"name":"get_key_label"}
    th_a  api_documentation.hpp:66 get_detailed_description
unlocked >>> gethelp  get_lotteries
gethelp  get_lotteries

No help defined for method get_lotteries

unlocked >>> gethelp  get_lottery_balance
gethelp  get_lottery_balance

No help defined for method get_lottery_balance

unlocked >>> gethelp  get_matched_bets_for_bettor
gethelp  get_matched_bets_for_bettor

No help defined for method get_matched_bets_for_bettor

unlocked >>> gethelp  get_offer_history_by_bidder
gethelp  get_offer_history_by_bidder

No help defined for method get_offer_history_by_bidder

unlocked >>> gethelp  get_offer_history_by_issuer
gethelp  get_offer_history_by_issuer

No help defined for method get_offer_history_by_issuer

unlocked >>> gethelp  get_offer_history_by_item
gethelp  get_offer_history_by_item

No help defined for method get_offer_history_by_item

unlocked >>> gethelp  get_offers_by_issuer
gethelp  get_offers_by_issuer

No help defined for method get_offers_by_issuer

unlocked >>> gethelp  get_offers_by_item
gethelp  get_offers_by_item

No help defined for method get_offers_by_item

unlocked >>> gethelp  get_total_matched_bet_amount_for_betting_market_group
gethelp  get_total_matched_bet_amount_for_betting_market_group

No help defined for method get_total_matched_bet_amount_for_betting_market_group

unlocked >>> gethelp  get_tournaments
gethelp  get_tournaments

No help defined for method get_tournaments

unlocked >>> gethelp  get_tournaments_by_state
gethelp  get_tournaments_by_state

No help defined for method get_tournaments_by_state

unlocked >>> gethelp  get_unmatched_bets_for_bettor
gethelp  get_unmatched_bets_for_bettor

No help defined for method get_unmatched_bets_for_bettor

unlocked >>> gethelp  list_betting_market_groups
gethelp  list_betting_market_groups

No help defined for method list_betting_market_groups

unlocked >>> gethelp  list_betting_markets
gethelp  list_betting_markets

No help defined for method list_betting_markets

unlocked >>> gethelp  list_buy_offers
gethelp  list_buy_offers

No help defined for method list_buy_offers

unlocked >>> gethelp  list_core_accounts
gethelp  list_core_accounts

No help defined for method list_core_accounts

unlocked >>> gethelp  list_event_groups
gethelp  list_event_groups

No help defined for method list_event_groups

unlocked >>> gethelp  list_events_in_group
gethelp  list_events_in_group

No help defined for method list_events_in_group

unlocked >>> gethelp  list_offer_history
gethelp  list_offer_history

No help defined for method list_offer_history

unlocked >>> gethelp  list_offers
gethelp  list_offers

No help defined for method list_offers

unlocked >>> gethelp  list_sell_offers
gethelp  list_sell_offers

No help defined for method list_sell_offers

unlocked >>> gethelp  list_sports
gethelp  list_sports

No help defined for method list_sports

unlocked >>> gethelp  network_add_nodes
gethelp  network_add_nodes

No help defined for method network_add_nodes

unlocked >>> gethelp  network_get_connected_peers
gethelp  network_get_connected_peers

No help defined for method network_get_connected_peers

unlocked >>> gethelp  nft_lottery_buy_ticket
gethelp  nft_lottery_buy_ticket

No help defined for method nft_lottery_buy_ticket

unlocked >>> gethelp  propose_create_betting_market
gethelp  propose_create_betting_market

No help defined for method propose_create_betting_market

unlocked >>> gethelp  propose_create_betting_market_group
gethelp  propose_create_betting_market_group

No help defined for method propose_create_betting_market_group

unlocked >>> gethelp  propose_create_betting_market_rules
gethelp  propose_create_betting_market_rules

No help defined for method propose_create_betting_market_rules

unlocked >>> gethelp  propose_create_event
gethelp  propose_create_event

No help defined for method propose_create_event

unlocked >>> gethelp  propose_create_event_group
gethelp  propose_create_event_group

No help defined for method propose_create_event_group

unlocked >>> gethelp  propose_create_sport
gethelp  propose_create_sport

No help defined for method propose_create_sport

unlocked >>> gethelp  propose_delete_event_group
gethelp  propose_delete_event_group

No help defined for method propose_delete_event_group

unlocked >>> gethelp  propose_delete_sport
gethelp  propose_delete_sport

No help defined for method propose_delete_sport

unlocked >>> gethelp  propose_resolve_betting_market_group
gethelp  propose_resolve_betting_market_group

No help defined for method propose_resolve_betting_market_group

unlocked >>> gethelp  propose_update_betting_market
gethelp  propose_update_betting_market

No help defined for method propose_update_betting_market

unlocked >>> gethelp  propose_update_betting_market_group
gethelp  propose_update_betting_market_group

No help defined for method propose_update_betting_market_group

unlocked >>> gethelp  propose_update_betting_market_rules
gethelp  propose_update_betting_market_rules

No help defined for method propose_update_betting_market_rules

unlocked >>> gethelp  propose_update_event
gethelp  propose_update_event

No help defined for method propose_update_event

unlocked >>> gethelp  propose_update_event_group
gethelp  propose_update_event_group

No help defined for method propose_update_event_group

unlocked >>> gethelp  propose_update_sport
gethelp  propose_update_sport

No help defined for method propose_update_sport

unlocked >>> gethelp  set_key_label
gethelp  set_key_label
6 key_not_found_exception: Key Not Found
No entry for method set_key_label
    {"name":"set_key_label"}
    th_a  api_documentation.hpp:66 get_detailed_description
unlocked >>> gethelp  update_account_role
gethelp  update_account_role

No help defined for method update_account_role

unlocked >>> gethelp  update_custom_account_authority
gethelp  update_custom_account_authority

No help defined for method update_custom_account_authority

unlocked >>> gethelp  update_custom_permission
gethelp  update_custom_permission

No help defined for method update_custom_permission

unlocked >>> 
@milo_peerplays what is the expected behavior? get_key_label and set_key_label help is not proper. ``` unlocked >>> gethelp get_key_label gethelp get_key_label 6 key_not_found_exception: Key Not Found No entry for method get_key_label {"name":"get_key_label"} th_a api_documentation.hpp:66 get_detailed_description unlocked >>> gethelp set_key_label gethelp set_key_label 6 key_not_found_exception: Key Not Found No entry for method set_key_label {"name":"set_key_label"} th_a api_documentation.hpp:66 get_detailed_description unlocked >>> ``` Following is the current behavior: ``` unlocked >>> gethelp buy_ticket gethelp buy_ticket No help defined for method buy_ticket unlocked >>> gethelp cancel_bet gethelp cancel_bet No help defined for method cancel_bet unlocked >>> gethelp cancel_offer gethelp cancel_offer No help defined for method cancel_offer unlocked >>> gethelp create_account_role gethelp create_account_role No help defined for method create_account_role unlocked >>> gethelp create_bid gethelp create_bid No help defined for method create_bid unlocked >>> gethelp create_custom_account_authority gethelp create_custom_account_authority No help defined for method create_custom_account_authority unlocked >>> gethelp create_custom_permission gethelp create_custom_permission No help defined for method create_custom_permission unlocked >>> gethelp create_lottery gethelp create_lottery No help defined for method create_lottery unlocked >>> gethelp create_offer gethelp create_offer No help defined for method create_offer unlocked >>> gethelp dbg_generate_blocks gethelp dbg_generate_blocks No help defined for method dbg_generate_blocks unlocked >>> gethelp dbg_make_mia gethelp dbg_make_mia No help defined for method dbg_make_mia unlocked >>> gethelp dbg_make_uia gethelp dbg_make_uia No help defined for method dbg_make_uia unlocked >>> gethelp dbg_push_blocks gethelp dbg_push_blocks No help defined for method dbg_push_blocks unlocked >>> gethelp dbg_stream_json_objects gethelp dbg_stream_json_objects No help defined for method dbg_stream_json_objects unlocked >>> gethelp dbg_update_object gethelp dbg_update_object No help defined for method dbg_update_object unlocked >>> gethelp delete_account_role gethelp delete_account_role No help defined for method delete_account_role unlocked >>> gethelp delete_custom_account_authority gethelp delete_custom_account_authority No help defined for method delete_custom_account_authority unlocked >>> gethelp delete_custom_permission gethelp delete_custom_permission No help defined for method delete_custom_permission unlocked >>> gethelp flood_network gethelp flood_network No help defined for method flood_network unlocked >>> gethelp get_account_lotteries gethelp get_account_lotteries No help defined for method get_account_lotteries unlocked >>> gethelp get_account_roles_by_owner gethelp get_account_roles_by_owner No help defined for method get_account_roles_by_owner unlocked >>> gethelp get_active_custom_account_authorities_by_operation gethelp get_active_custom_account_authorities_by_operation No help defined for method get_active_custom_account_authorities_by_operation unlocked >>> gethelp get_all_matched_bets_for_bettor gethelp get_all_matched_bets_for_bettor No help defined for method get_all_matched_bets_for_bettor unlocked >>> gethelp get_all_unmatched_bets_for_bettor gethelp get_all_unmatched_bets_for_bettor No help defined for method get_all_unmatched_bets_for_bettor unlocked >>> gethelp get_custom_account_authorities gethelp get_custom_account_authorities No help defined for method get_custom_account_authorities unlocked >>> gethelp get_custom_account_authorities_by_permission_id gethelp get_custom_account_authorities_by_permission_id No help defined for method get_custom_account_authorities_by_permission_id unlocked >>> gethelp get_custom_account_authorities_by_permission_name gethelp get_custom_account_authorities_by_permission_name No help defined for method get_custom_account_authorities_by_permission_name unlocked >>> gethelp get_custom_permission_by_name gethelp get_custom_permission_by_name No help defined for method get_custom_permission_by_name unlocked >>> gethelp get_custom_permissions gethelp get_custom_permissions No help defined for method get_custom_permissions unlocked >>> gethelp get_events_containing_sub_string gethelp get_events_containing_sub_string No help defined for method get_events_containing_sub_string unlocked >>> gethelp get_global_betting_statistics gethelp get_global_betting_statistics No help defined for method get_global_betting_statistics unlocked >>> gethelp get_key_label gethelp get_key_label 6 key_not_found_exception: Key Not Found No entry for method get_key_label {"name":"get_key_label"} th_a api_documentation.hpp:66 get_detailed_description unlocked >>> gethelp get_lotteries gethelp get_lotteries No help defined for method get_lotteries unlocked >>> gethelp get_lottery_balance gethelp get_lottery_balance No help defined for method get_lottery_balance unlocked >>> gethelp get_matched_bets_for_bettor gethelp get_matched_bets_for_bettor No help defined for method get_matched_bets_for_bettor unlocked >>> gethelp get_offer_history_by_bidder gethelp get_offer_history_by_bidder No help defined for method get_offer_history_by_bidder unlocked >>> gethelp get_offer_history_by_issuer gethelp get_offer_history_by_issuer No help defined for method get_offer_history_by_issuer unlocked >>> gethelp get_offer_history_by_item gethelp get_offer_history_by_item No help defined for method get_offer_history_by_item unlocked >>> gethelp get_offers_by_issuer gethelp get_offers_by_issuer No help defined for method get_offers_by_issuer unlocked >>> gethelp get_offers_by_item gethelp get_offers_by_item No help defined for method get_offers_by_item unlocked >>> gethelp get_total_matched_bet_amount_for_betting_market_group gethelp get_total_matched_bet_amount_for_betting_market_group No help defined for method get_total_matched_bet_amount_for_betting_market_group unlocked >>> gethelp get_tournaments gethelp get_tournaments No help defined for method get_tournaments unlocked >>> gethelp get_tournaments_by_state gethelp get_tournaments_by_state No help defined for method get_tournaments_by_state unlocked >>> gethelp get_unmatched_bets_for_bettor gethelp get_unmatched_bets_for_bettor No help defined for method get_unmatched_bets_for_bettor unlocked >>> gethelp list_betting_market_groups gethelp list_betting_market_groups No help defined for method list_betting_market_groups unlocked >>> gethelp list_betting_markets gethelp list_betting_markets No help defined for method list_betting_markets unlocked >>> gethelp list_buy_offers gethelp list_buy_offers No help defined for method list_buy_offers unlocked >>> gethelp list_core_accounts gethelp list_core_accounts No help defined for method list_core_accounts unlocked >>> gethelp list_event_groups gethelp list_event_groups No help defined for method list_event_groups unlocked >>> gethelp list_events_in_group gethelp list_events_in_group No help defined for method list_events_in_group unlocked >>> gethelp list_offer_history gethelp list_offer_history No help defined for method list_offer_history unlocked >>> gethelp list_offers gethelp list_offers No help defined for method list_offers unlocked >>> gethelp list_sell_offers gethelp list_sell_offers No help defined for method list_sell_offers unlocked >>> gethelp list_sports gethelp list_sports No help defined for method list_sports unlocked >>> gethelp network_add_nodes gethelp network_add_nodes No help defined for method network_add_nodes unlocked >>> gethelp network_get_connected_peers gethelp network_get_connected_peers No help defined for method network_get_connected_peers unlocked >>> gethelp nft_lottery_buy_ticket gethelp nft_lottery_buy_ticket No help defined for method nft_lottery_buy_ticket unlocked >>> gethelp propose_create_betting_market gethelp propose_create_betting_market No help defined for method propose_create_betting_market unlocked >>> gethelp propose_create_betting_market_group gethelp propose_create_betting_market_group No help defined for method propose_create_betting_market_group unlocked >>> gethelp propose_create_betting_market_rules gethelp propose_create_betting_market_rules No help defined for method propose_create_betting_market_rules unlocked >>> gethelp propose_create_event gethelp propose_create_event No help defined for method propose_create_event unlocked >>> gethelp propose_create_event_group gethelp propose_create_event_group No help defined for method propose_create_event_group unlocked >>> gethelp propose_create_sport gethelp propose_create_sport No help defined for method propose_create_sport unlocked >>> gethelp propose_delete_event_group gethelp propose_delete_event_group No help defined for method propose_delete_event_group unlocked >>> gethelp propose_delete_sport gethelp propose_delete_sport No help defined for method propose_delete_sport unlocked >>> gethelp propose_resolve_betting_market_group gethelp propose_resolve_betting_market_group No help defined for method propose_resolve_betting_market_group unlocked >>> gethelp propose_update_betting_market gethelp propose_update_betting_market No help defined for method propose_update_betting_market unlocked >>> gethelp propose_update_betting_market_group gethelp propose_update_betting_market_group No help defined for method propose_update_betting_market_group unlocked >>> gethelp propose_update_betting_market_rules gethelp propose_update_betting_market_rules No help defined for method propose_update_betting_market_rules unlocked >>> gethelp propose_update_event gethelp propose_update_event No help defined for method propose_update_event unlocked >>> gethelp propose_update_event_group gethelp propose_update_event_group No help defined for method propose_update_event_group unlocked >>> gethelp propose_update_sport gethelp propose_update_sport No help defined for method propose_update_sport unlocked >>> gethelp set_key_label gethelp set_key_label 6 key_not_found_exception: Key Not Found No entry for method set_key_label {"name":"set_key_label"} th_a api_documentation.hpp:66 get_detailed_description unlocked >>> gethelp update_account_role gethelp update_account_role No help defined for method update_account_role unlocked >>> gethelp update_custom_account_authority gethelp update_custom_account_authority No help defined for method update_custom_account_authority unlocked >>> gethelp update_custom_permission gethelp update_custom_permission No help defined for method update_custom_permission unlocked >>> ```
prandnum commented 2022-11-07 19:05:13 +00:00 (Migrated from gitlab.com)

@milo_peerplays could you please provide your comments on the above.

@milo_peerplays could you please provide your comments on the above.
milo_peerplays commented 2022-11-08 12:22:42 +00:00 (Migrated from gitlab.com)

That is expected. We have been discussing it in the daily. These 3 methods do not have documentation:
set_key_label, get_key_label and get_public_key.

That is expected. We have been discussing it in the daily. These 3 methods do not have documentation: `set_key_label`, `get_key_label` and `get_public_key`.
prandnum commented 2022-11-09 17:28:04 +00:00 (Migrated from gitlab.com)

closing this ticket with above comments.

closing this ticket with above comments.
prandnum (Migrated from gitlab.com) closed this issue 2022-11-09 17:28:05 +00:00
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Peerplays_Blockchain/peerplays_migrated#450
No description provided.