Files
xahaud/src/ripple/protocol
Richard Holland daccb5b4c0 Add ignore_default option to account_lines API:
This flag, if present, suppresses the output of incoming
trustlines in default state.

This is primarily motivated by observing that users of Xumm often
have many unwanted incoming trustlines in a default state, which are
not useful in the vast majority of cases.

Being able to suppress those when doing `account_lines` saves bandwidth
and resources.
2021-12-14 17:44:24 -08:00
..
2020-06-30 09:15:37 -07:00
2020-12-04 12:45:12 -08:00
2021-01-20 11:30:03 -08:00
2021-06-01 15:37:15 -07:00
2020-09-01 08:58:57 -07:00
2021-09-13 15:13:14 -07:00
2020-05-05 16:05:22 -07:00
2017-06-08 21:37:22 -07:00
2020-09-01 08:58:57 -07:00
2021-03-11 14:35:30 -08:00
2021-01-09 13:50:07 -08:00
2015-07-29 11:56:05 -04:00
2020-12-04 12:45:12 -08:00
2020-12-04 12:45:12 -08:00
2020-12-04 12:45:12 -08:00
2021-06-01 15:37:15 -07:00
2021-09-13 15:13:14 -07:00
2021-10-06 13:17:10 -07:00
2020-05-05 16:05:22 -07:00

protocol

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

Serialized Objects

In ripple 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.

The term "Tx" or "tx" is an abbreviation for "Transaction", a commonly occurring object type.

Optional Fields

Our serialized fields have some "type magic" to make optional fields easier to read:

  • The operation x[sfFoo] means "return the value of 'Foo' if it exists, or the default value if it doesn't."
  • The operation x[~sfFoo] means "return the value of 'Foo' if it exists, or nothing if it doesn't." This usage of the tilde/bitwise NOT operator is not standard outside of the rippled codebase.
    • As a consequence of this, x[~sfFoo] = y[~sfFoo] assigns the value of Foo from y to x, including omitting Foo from x if it doesn't exist in y.

Typically, for things that are guaranteed to exist, you use x[sfFoo] and avoid having to deal with a container that may or may not hold a value. For things not guaranteed to exist, you use x[~sfFoo] because you want such a container. It avoids having to look something up twice, once just to see if it exists and a second time to get/set its value. (Real example)

The source of this "type magic" is in SField.h.