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.

Sign up for GitHub

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

Update protocol README #4457

Merged
merged 1 commit into from
Mar 21, 2023
Merged

Update protocol README #4457

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions src/ripple/protocol/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# protocol

Classes and functions for handling data and
values associated with the Ripple protocol.
values associated with the XRP Ledger protocol.

## Serialized Objects

In ripple objects transmitted over the network must be
Objects transmitted over the network must be
serialized into a canonical format. The prefix "ST" refers
to classes that deal with the serialized format of ripple
objects.
to classes that deal with the serialized format.

The term "Tx" or "tx" is an abbreviation for "Transaction",
a commonly occurring object type.
Expand Down Expand Up @@ -38,3 +37,8 @@ it exists and a second time to get/set its value.

The source of this "type magic" is in
[SField.h](./SField.h#L296-L302).

### Related Resources

- [ripple-binary-codec SField enums](https://github.com/XRPLF/xrpl.js/tree/main/packages/ripple-binary-codec/src/enums)
- [SFCode Registry Tables](https://github.com/XRPLF/sFieldRegistry)