From 9fcb28acad120902791e59007f1746f98733eeb7 Mon Sep 17 00:00:00 2001 From: Elliot Lee Date: Tue, 21 Mar 2023 08:01:47 -0700 Subject: [PATCH] docs: update protocol README (#4457) --- src/ripple/protocol/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/ripple/protocol/README.md b/src/ripple/protocol/README.md index 9a0f4952a3..9864b700ef 100644 --- a/src/ripple/protocol/README.md +++ b/src/ripple/protocol/README.md @@ -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)