Page MenuHomePhabricator

[Cashtab] OP_RETURN prefix protocols
ClosedPublic

Authored by kieran709 on Dec 20 2021, 17:37.

Details

Reviewers
bytesofman
Group Reviewers
Restricted Project
Commits
rABC36875d03b628: [Cashtab] OP_RETURN prefix protocols
Summary

Markdown file and CSV added to provide context and information regarding XED OP_RETURN prefix protocols. Related to task T1985.

Test Plan

cd web/cashtab
inspect xec-protocols.csv and op_return-prefix-guidelines.md
ensure information is correct and advise on what is missing.

Diff Detail

Repository
rABC Bitcoin ABC
Branch
op-return-prefix
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 17716
Build 35258: Build Diffcashtab-tests
Build 35257: arc lint + arc unit

Event Timeline

bytesofman added inline comments.
web/cashtab/op_return-prefix-guideline.md
3 ↗(On Diff #31482)

Replace this line with:

This document extends the app dev OP_RETURN convention described [here](BCH op_return-prefix-guideline.md](https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/op_return-prefix-guideline.md)

5 ↗(On Diff #31482)

I think no need to keep two separate docs, since we do not need to re-write all of the existing spec in the referenced BCH doc. So, remove this, and go straight to the table (in this same file)

7 ↗(On Diff #31482)

Add a short paragraph before the table.

As a courtesy to the eCash community, we recommend to either submit a ticket or a pull request to the Git repository at https://reviews.bitcoinabc.org to claim your prefix with:

* A display name for the protocol
* An author (or list of authors)
* A URL pointing to the specification of the protocol
* An eCash address (to avoid ambiguity and to later modify names / authors / URL)

App prefixes below are little-endian, i.e. how they appear in eCash transaction outputs.
web/cashtab/xec-protocols.csv
1 ↗(On Diff #31482)

Column headers should be:

Prefix (little-endian),DisplayName,Authors,eCashAddress,SpecificationUrl,TxidRedirectUrl

Please fill in all columns of the SLP [eToken] and Cash Fusion entries per the original spec (they are unchanged)

Rows should read:

534c5000, eToken,SLP devs,ecash:qq2p8mu0gmxfzva2g36kh70efp8hx7qg7qh20l0qls,http://simpleledger.cash/,
46555a00,CashFusion,Jonald Fyookball and Mark Lundeberg,ecash:qqqxxmjyavdkwdj6npa5w6xl0fzq3wc5fu6s5x69jj,https://github.com/cashshuffle/spec/blob/master/CASHFUSION.md,
00746162, Cashtab, Bitcoin ABC, N/A, N/A
This revision now requires changes to proceed.Dec 20 2021, 22:24

Responding to review feedback, not positive I nailed it as the markdown table seems a bit messy.

deleted unnecessary csv file per review feedback

Please create a new directory under web/ called standards/ and place this .md file there, instead of in the cashtab/ folder

web/cashtab/op_return-prefix-guideline.md
18

Use ecash:pqnqv9lt7e5vjyp0w88zf2af0l92l8rxdg2jj94l5j for Bitcoin ABC ecash address

This revision now requires changes to proceed.Dec 21 2021, 19:09

Responding to review feedback.

bytesofman added inline comments.
web/standards/op_return-prefix-guideline.md
3 ↗(On Diff #31551)

Make the word here. link to https://github.com/bitcoincashorg/bitcoincash.org/blob/master/spec/op_return-prefix-guideline.md

So, replace here: [link and stuff] with here. where here. is the hyperlink.

5 ↗(On Diff #31551)

Replace this line with If you are a developer using an OP_RETURN prefix for your app, please claim your prefix by submitting a diff to this repo, including:

14 ↗(On Diff #31551)

Add n/a for all blank TxidRedirectUrl fields

18 ↗(On Diff #31551)

Add https://cashtab.com/ as the Specification URL for Cashtab

Also add a new row:

65746162, Cashtab Encrypted, Bitcoin ABC, ecash:pqnqv9lt7e5vjyp0w88zf2af0l92l8rxdg2jj94l5j, https://cashtab.com/, n/a

24 ↗(On Diff #31551)

Remove BCH, so new link title will be [op_return-prefix-guideline.md]

26 ↗(On Diff #31551)

Remove BCH prefix , so new link title will be [protocols.csv]

28 ↗(On Diff #31551)

Delete this line

This revision now requires changes to proceed.Dec 29 2021, 18:11

responding to review feedback

bytesofman requested changes to this revision.Jan 3 2022, 13:41
bytesofman added inline comments.
web/standards/op_return-prefix-guideline.md
23 ↗(On Diff #31594)

Replace Original BCH OP_return protocol documentation with Resources

This revision now requires changes to proceed.Jan 3 2022, 13:41

Responding to review feedback

This revision is now accepted and ready to land.Jan 3 2022, 16:00
This revision was automatically updated to reflect the committed changes.