handshake-org / handshake-org/hsd

Specific RPCs for `sendrevealall` and `sendredeemall` to prevent human error

Open
#188 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
2.1k
Forks
306
PR merge metrics
No merged PRs in 30d

Description

For the wallet RPCs `sendreveal` and `sendredeem` if no `name` argument is passed, it will attempt to batch all of the reveals/redeems between names into a single transaction. This is a useful feature, but prone to user error if `name` is accidentally `undefined` for example.

It may be a good idea to add specific RPCs `sendrevealall` and `sendredeemall` to prevent this problem. The HTTP endpoints could be updated to reflect this as well with either additional endpoints `POST /wallet/:id/revealall` and `POST /wallet/:id/redeemall` or with POST body options.

_Originally posted by @tynes in https://github.com/handshake-org/hsd/pull/145_

Contributor guide

Open the contributing guide

Research direction

Start with the wallet RPCs sendreveal and sendredeem, then trace their corresponding HTTP wallet endpoints. Determine how explicit sendrevealall and sendredeemall operations should be exposed, including whether separate POST endpoints or body options are used. Done means the all-items behavior is available through distinct RPCs and reflected consistently in the HTTP API.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.