Skip to content

Inconsistency in "Internal Type" names #3121

Open
@mDuo13

Description

@mDuo13

In transaction references, we inconsistently mix and match different names for the same types, such as "STArray" vs "Array" or "STAccount" vs "AccountID". This happens in the transaction references and even within the Binary Format page itself.

Background

Every field table has an "Internal Type" column that describes the data type used in the canonical binary representation of the transaction or ledger entry. The definition of these types is the Type List in the Binary Format page.

The "ST" stands for "Standard Type" and is used in the rippled codebase for many data types that are not primitives like unsigned integer (UInt) types.

Proposed Solution

We should modify the Binary Format page to consistently refer to types without the "ST" prefix in the type table and headings. (Maybe we can still mention the ST-prefixed name in the text body for clarity & SEO purposes.) So, in field tables, we should change:

  • STIssue → Issue
  • STAccount → AccountID
  • STArray → Array
  • STObject → Object
  • STBlob → Blob

This applies to transaction reference and ledger entry reference pages.

Related: #2859

Metadata

Metadata

Assignees

Labels

bugTypo or other small documentation errorcontent updatesUpdating, cleaning up, or rewriting existing content for better usability or new contexts

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions