ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update protocol README (#4457)

Browse Source
This commit is contained in:
Elliot Lee
2023-03-21 08:01:47 -07:00
committed by GitHub
parent 305c9a8d61
commit 9fcb28acad
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/ripple/protocol/README.md
View File

@@ -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.
@@ -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)