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

HTLC database APIs #1713

Open
abitmore opened this issue Apr 10, 2019 · 8 comments

Comments

@abitmore
Copy link
Member

commented Apr 10, 2019

User Story
As a user / client developer I want database APIs to query for active HTLC objects.

  • One API to list all HTLC objects.
  • APIs to by account, perhaps 2 APIs, one query by from, one query by to.
  • Pagination should be considered.
  • Perhaps by default order by expiration?
  • Perhaps let get_full_accounts API return HTLC objects as well.
  • Best have CLI commands as well.

UI work is blocked by this.

Impacts
Describe which portion(s) of BitShares Core may be impacted by your request. 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)

Additional Context (optional)
Add any other context about your request here.

CORE TEAM TASK LIST

  • Evaluate / Prioritize Feature Request
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution
  • Perform QA/Testing
  • Update Documentation
@oxarbitrage

This comment has been minimized.

Copy link
Member

commented Apr 10, 2019

I am interested on this one.

Question: Do we want to add the API calls in in database.cpp or do we want to create a new(enabled or disabled by default) htlc_api in api.cpp?

@pmconrad

This comment has been minimized.

Copy link
Contributor

commented Apr 11, 2019

IMO database.cpp, but please use consistent naming.

@oxarbitrage oxarbitrage self-assigned this Apr 17, 2019

@syalon

This comment has been minimized.

Copy link
Member

commented Apr 21, 2019

Is it possible to provide an api for query by hashvalue?

@syalon

This comment has been minimized.

Copy link
Member

commented Apr 21, 2019

In addition, preimage length is too unfriendly for users.

@syalon

This comment has been minimized.

Copy link
Member

commented Apr 21, 2019

MobileApp requirements:

  • get_full_accounts returns all relevant htlc, including from and to.
  • query by hash (if possible)
  • preimage length (can omit the best). Is this just for quick verification?
@abitmore

This comment has been minimized.

Copy link
Member Author

commented Apr 21, 2019

In addition, preimage length is too unfriendly for users.

Perhaps we can make preimage_size effectively optional, e.g. if size==0, don't check the size. Need a BSIP.

@abitmore abitmore moved this from To do to In development in Feature Release (3.1.0) Apr 22, 2019

@ryanRfox ryanRfox moved this from In development to In testing in Feature Release (3.1.0) Apr 30, 2019

@jmjatlanta jmjatlanta moved this from In testing to Done in Feature Release (3.1.0) Apr 30, 2019

@jmjatlanta

This comment has been minimized.

Copy link
Contributor

commented Apr 30, 2019

The majority of these requests have been fixed by #1742. Others are being considered (i.e. sorting), and still others would require a BSIP (i.e. making preimage length optional).

@abitmore

This comment has been minimized.

Copy link
Member Author

commented May 11, 2019

Lack of an API to fetch all HTLCs. See #1749 (comment). Moving to next milestone.

@pmconrad pmconrad removed this from To do in Feature Release (3.2.0) Jun 19, 2019

@pmconrad pmconrad added this to New -Awaiting Core Team Evaluation in Project Backlog via automation Jun 19, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.