Page MenuHomePhabricator

[ecash-herald] Update parseOpReturn to recognize authentication txs
ClosedPublic

Authored by emack on Aug 12 2024, 05:33.

Details

Summary

Update the herald to recognize the authentication txs.

Test Plan

npm test

Diff Detail

Repository
rABC Bitcoin ABC
Branch
parseAuthTxs
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 29938
Build 59411: Build Diffecash-herald-tests
Build 59410: arc lint + arc unit

Event Timeline

emack requested review of this revision.Aug 12 2024, 05:33
Fabien requested changes to this revision.Aug 12 2024, 08:19
Fabien added a subscriber: Fabien.
Fabien added inline comments.
apps/ecash-herald/src/parse.js
672

Not including address in msg here for privacy reasons

This is a blockchain and public information already, what is your privacy concern here ?

672

At least indicate what it's about, because Authentication tx is something only you can understand.

675

See comment in D16623

This revision now requires changes to proceed.Aug 12 2024, 08:19
emack marked 3 inline comments as done.

Updated authentication tx msg and added reference to spec

Fabien requested changes to this revision.Aug 12 2024, 17:53
Fabien added inline comments.
apps/ecash-herald/src/parse.js
671 ↗(On Diff #49150)

This is still not helpful, how is the reader suppose to guess what protocol this is ?

This revision now requires changes to proceed.Aug 12 2024, 17:53
emack marked an inline comment as done.

Updated rendered messages

apps/ecash-herald/src/parse.js
673 ↗(On Diff #49150)

Also just realized the comments on the previous revision didn't get posted.

The privacy risk is more about the herald basically telling everyone in real time when certain addresses log in on their mobile devices (i.e. they're online), which is strictly an opt-in permission across most social platforms. People can always monitor addresses themselves but this automates it in real time if you start showing addresses with this parsed action.

I also wanted to keep this app neutral hence the reference to the op return guideline but fair point on the user not seeing this context, so I've updated the msg.

Fabien requested changes to this revision.Aug 14 2024, 07:31
Fabien added inline comments.
apps/ecash-herald/src/parse.js
673 ↗(On Diff #49204)

If you don't do anything with that info it has little benefit. Either provide a count like CACHET does (my favorite solution) or link to the tx or something.

apps/ecash-herald/test/mocks/appTxSamples.js
598 ↗(On Diff #49204)

You're missing the third case

This revision now requires changes to proceed.Aug 14 2024, 07:31
emack marked 2 inline comments as done.

Updated with on-spec but empty identifier condition

apps/ecash-herald/src/parse.js
673 ↗(On Diff #49204)

This parseOpReturn function only takes in the opreturn hex. Unlike CACHET token txs, the send quantity nor txid is not part of the opreturn payload, hence not possible to render a count (it's a dust tx so it's always 5.5 tx) nor an explorer link in this function. Is it worth hardcoding the 5.5 tx dust amount to this message? Otherwise the current message is still better than seeing random hex.

Let's update the message with better usability in another diff, that's already an improvement

This revision is now accepted and ready to land.Aug 14 2024, 15:10

Rebase to master and version bump