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

docs: opReturn feature #469

Merged
merged 10 commits into from
Mar 24, 2025
Merged

docs: opReturn feature #469

merged 10 commits into from
Mar 24, 2025

Conversation

lissavxo
Copy link
Collaborator

@lissavxo lissavxo commented Mar 5, 2025

Related to #429

Description

Added a new topic on docs to describe opReturn syntax rules

Test plan

Run yarn start:docs and go to OpReturn topic

@lissavxo lissavxo requested a review from chedieck March 5, 2025 19:45
@lissavxo lissavxo force-pushed the docs/op-return-feature branch from fc47373 to 994c468 Compare March 5, 2025 20:44
@lissavxo lissavxo force-pushed the docs/op-return-feature branch from 40d052f to f15b1d8 Compare March 7, 2025 14:27
@lissavxo lissavxo requested a review from chedieck March 7, 2025 15:21
@lissavxo lissavxo requested a review from chedieck March 12, 2025 17:07
@lissavxo lissavxo force-pushed the docs/op-return-feature branch from 7366a34 to 9c80879 Compare March 14, 2025 20:11
@lissavxo lissavxo marked this pull request as ready for review March 14, 2025 20:12
Copy link
Collaborator

@chedieck chedieck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some corrections.

Also: maybe worth it mentioning that the data payload can be at most 213 bytes (when UTF-8 encoded), if there is no paymentId, if there is the limit is 205 bytes (since the paymentId takes 8 bytes.)

docs/README.md Outdated

- `0102030405060708090a0b0c` → Data payload

- `08` → 8-byte value indicating that this transaction has an 8-byte payment ID
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a "8-byte value", it is the number 8 represented in one byte.

docs/README.md Outdated

- `08` → 8-byte value indicating that this transaction has an 8-byte payment ID

- `0102030405060708` → payment ID
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uppercase

docs/README.md Outdated

- `00` → No data payload

- `08` → 8-byte value indicating that this transaction has an 8-byte payment ID
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here

docs/README.md Outdated

- `08` → 8-byte value indicating that this transaction has an 8-byte payment ID

- `0102030405060708` → payment ID
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here

@lissavxo lissavxo requested a review from chedieck March 22, 2025 21:54
@lissavxo lissavxo force-pushed the docs/op-return-feature branch from 58656b1 to a332169 Compare March 24, 2025 14:41
@chedieck chedieck merged commit 8b67a33 into master Mar 24, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants