search

SoftwareVerde / bitcoin-cash-specification

Specification of the Bitcoin Cash protocols and consensus
Other
8 stars 5 forks source link

Update to create a note about VARINT/ vs Compact size potential ambiguity #32

Closed cculianu closed 2 years ago

cculianu commented 2 years ago

I only am being a pain about this to avoid headaches for people that are used to the Core line of node software where VARINT exists (internally) and is distinct from Compact size...

thesquaregroot commented 2 years ago

The "Core" family of software (BCHN, BU, and Flowee) all have an internal "VARINT" format that is distinct from this integer format (this format is referred to as COMPACTSIZE or CompactSize in that lineage of software).

I think the "this" in the parenthetical is potentially ambiguous. Maybe something like this would be more clear?

The "Core" family of software (BCHN, BU, and Flowee) all have an internal "VARINT" format that is distinct from this integer format. In that "Core" lineage of software, COMPACTSIZE or CompactSize is used to refer to the protocol's variable length integer format, while "VarInt" refers specifically to their internal variable length integer format and is not a part of the Bitcoin Cash P2P protocol.

cculianu commented 2 years ago

Yes this is good.. let me update.

cculianu commented 2 years ago

Ok, updated.

joshmg commented 2 years ago

Looks good. Thanks, @cculianu !