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.

Sign up for GitHub

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

Jump to bottom

Update all account-related API's to support account name as parameter #969

Closed
33 of 37 tasks
abitmore opened this issue May 25, 2018 · 3 comments
Closed
33 of 37 tasks

Update all account-related API's to support account name as parameter #969

abitmore opened this issue May 25, 2018 · 3 comments
Assignees
@oxarbitrage
Labels
1c Task Task for team member to perform. Description may contain a Task List and reference child Sub-Tasks 2d Developing Status indicating currently designing and developing a solution 3b Feature Classification indicating the addition of novel functionality to the design 4b Normal Priority Priority indicating the moderate impact to system/user -OR- existing workaround is costly to perform 5a Docs Needed Status specific to Documentation indicating the need for proper documentation to be added 6 API Impact flag identifying the application programing interface (API) 6 UX Impact flag identifying the User Interface (UX)
Milestone
201808 - Non-Cons...

Comments

@abitmore
Copy link
Member

abitmore commented May 25, 2018 •
edited by oxarbitrage
Loading

User Story
As an API user I want to use account name directly for all APIs. Some APIs support account names, e.g. get_accounts, but others don't support, e.g. get_relative_account_history.

The following API calls will be impacted with the proposed change:

Database API:

  • get_accounts
  • get_account_references
  • get_vesting_balances
  • get_margin_positions
  • get_witness_by_account
  • get_committee_member_by_account
  • get_workers_by_account
  • get_full_accounts
  • get_account_balances
  • verify_account_authority
  • get_proposed_transactions
  • get_withdraw_permissions_by_giver
  • get_withdraw_permissions_by_recipient

API:

  • get_account_history
  • get_account_history_by_operations
  • get_account_history_operations
  • get_relative_account_history

Wallet:

  • resync
  • get_account
  • import_balance
  • create_committee_member
  • get_witness
  • get_committee_member
  • create_witness
  • get_vesting_balances
  • vote_for_committee_member
  • vote_for_witness
  • list_account_balances
  • get_account_history
  • get_account_history_by_operations
  • get_relative_account_history

Note: This feature will slightly impact performance but will greatly improve usability.

CORE TEAM TASK LIST

  • Evaluate / Prioritize Feature Request
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution (in progress: @oxarbitrage )
  • Perform QA/Testing
  • Update Documentation
@oxarbitrage oxarbitrage added 1c Task Task for team member to perform. Description may contain a Task List and reference child Sub-Tasks 2c Ready for Development Status indicating the Requirements are sufficent to begin designing a solution 3b Feature Classification indicating the addition of novel functionality to the design 4b Normal Priority Priority indicating the moderate impact to system/user -OR- existing workaround is costly to perform 5a Docs Needed Status specific to Documentation indicating the need for proper documentation to be added 6 API Impact flag identifying the application programing interface (API) labels May 28, 2018
@oxarbitrage oxarbitrage added this to the 201807 - Next Non-Consensus-Changing Release milestone May 28, 2018
@oxarbitrage oxarbitrage self-assigned this May 28, 2018
@oxarbitrage oxarbitrage mentioned this issue May 29, 2018
Merged
@oxarbitrage
Copy link
Member

oxarbitrage commented Jun 1, 2018 •
edited by ryanRfox
Loading

Note: @ryanRfox moved the list of APIs impacted into the Description as part of the User Story for easier reading.

@oxarbitrage oxarbitrage added 2d Developing Status indicating currently designing and developing a solution and removed 2c Ready for Development Status indicating the Requirements are sufficent to begin designing a solution labels Jun 5, 2018
@ryanRfox ryanRfox added the 6 UX Impact flag identifying the User Interface (UX) label Jun 6, 2018
@oxarbitrage
Copy link
Member

closed by #989

@cedar-book
Copy link

summary document

@abitmore abitmore mentioned this issue Aug 4, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oxarbitrage oxarbitrage

Labels
1c Task Task for team member to perform. Description may contain a Task List and reference child Sub-Tasks 2d Developing Status indicating currently designing and developing a solution 3b Feature Classification indicating the addition of novel functionality to the design 4b Normal Priority Priority indicating the moderate impact to system/user -OR- existing workaround is costly to perform 5a Docs Needed Status specific to Documentation indicating the need for proper documentation to be added 6 API Impact flag identifying the application programing interface (API) 6 UX Impact flag identifying the User Interface (UX)
Projects
None yet
Milestone
201808 - Non-Consensus-Changing Release
Development

No branches or pull requests
4 participants
@abitmore @ryanRfox @oxarbitrage @cedar-book