Difference between revisions of "VarInt"

Line 1: Line 1:
A VarInt or "Variable Integer" is an integer format used widely in Bitcoin to indicate the lengths of fields within transaction and block data.
+
A VarInt or "Variable Integer" is an integer format used widely in Bitcoin to indicate the lengths of fields within transaction, block and peer-to-peer network data.
  
 
A VarInt is a variable length field 1, 3, 5 or 9 bytes in length dependent on the size of the object being defined. The VarInt format is used as it is space efficient over simply using an 8-byte field where variable length objects are used.
 
A VarInt is a variable length field 1, 3, 5 or 9 bytes in length dependent on the size of the object being defined. The VarInt format is used as it is space efficient over simply using an 8-byte field where variable length objects are used.
Line 5: Line 5:
 
==Using VarInts==
 
==Using VarInts==
  
When expressing an integer value less than or equal to <code>0xFC</code> (252) the value itself can be used.
+
When expressing an integer between zero and <code>0xFC</code> (252) the value itself can be used expressed in uint8_t format.
  
When expressing an integer value greater than <code>0xFC</code> but less than or equal to <code>0xFFFF</code> (65,535), the varint is <code>0xFDXXXX</code> where XXXX represents the two byte integer
+
When expressing an integer value greater than <code>0xFC</code> but less than or equal to <code>0xFFFF</code> (65,535), the varint is <code>0xFDXXXX</code> where XXXX represents the two byte integer in uint16_t format.
  
When expressing an integer value greater than <code>0xFFFF</code> but less than or equal to <code>0xFFFFFFFF</code> (4,294,967,295), the varint is <code>0xFEXXXXXXXX</code> where XXXXXXXX represents the 4 byte integer
+
When expressing an integer value greater than <code>0xFFFF</code> but less than or equal to <code>0xFFFFFFFF</code> (4,294,967,295), the varint is <code>0xFEXXXXXXXX</code> where XXXXXXXX represents the 4 byte integer in uint32_t format.
  
When expressing an integer value greater than <code>0xFFFFFFFF</code> but less than or equal to <code>0xFFFFFFFFFFFFFFFF</code> (18,446,744,073,709,551,615), the varint is <code>0xFFXXXXXXXXXXXXXXXX</code> where XXXXXXXXXXXXXXXX represents the 8 byte integer
+
When expressing an integer value greater than <code>0xFFFFFFFF</code> but less than or equal to <code>0xFFFFFFFFFFFFFFFF</code> (18,446,744,073,709,551,615), the varint is <code>0xFFXXXXXXXXXXXXXXXX</code> where XXXXXXXXXXXXXXXX represents the 8 byte integer in uint64_t format.
  
===Examples===
+
===References with Examples===
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
! Value
+
! Value /br/br example value
 
! Size
 
! Size
! VarInt
+
! VarInt format /br/br example values
 
|-
 
|-
| 187 (<code>0xBB</code>)
+
| 0 <= value <= 252 (<code>0xFC</code>) /br/br e.g. 187 (<code>0xBB</code>)
| 1 byte (less than or equal to <code>0xFC</code>)
+
| /br /br 1 byte
| <code>0xBB</code>
+
| uint8_t/br/br<code>0xBB</code>
 
|-
 
|-
| 255 (<code>0xFF</code>)
+
| 253 <= value <= 65,535 (<code>0xFFFF</code>) /br/br 255 (<code>0xFF</code>) /br/br 13,337 (<code>0x3419</code>)
| 1 byte (greater than <code>0xFC</code>)
+
| /br/br 1 byte but greater than <code>0xFC</code> /br/br 2 bytes
| <code>0xFD00FF</code>
+
| 0xFD + number as uint16_t /br/br <code>0xFD00FF</code> /br/br <code>0xFD3419</code>
|-
 
| 13,337 (<code>0x3419</code>)
 
| 2 bytes
 
| <code>0xFD3419</code>
 
 
|-
 
|-
 
| 14,435,729 (<code>0xDC4591</code>)
 
| 14,435,729 (<code>0xDC4591</code>)

Revision as of 04:31, 15 June 2020

A VarInt or "Variable Integer" is an integer format used widely in Bitcoin to indicate the lengths of fields within transaction, block and peer-to-peer network data.

A VarInt is a variable length field 1, 3, 5 or 9 bytes in length dependent on the size of the object being defined. The VarInt format is used as it is space efficient over simply using an 8-byte field where variable length objects are used.

Using VarInts

When expressing an integer between zero and 0xFC (252) the value itself can be used expressed in uint8_t format.

When expressing an integer value greater than 0xFC but less than or equal to 0xFFFF (65,535), the varint is 0xFDXXXX where XXXX represents the two byte integer in uint16_t format.

When expressing an integer value greater than 0xFFFF but less than or equal to 0xFFFFFFFF (4,294,967,295), the varint is 0xFEXXXXXXXX where XXXXXXXX represents the 4 byte integer in uint32_t format.

When expressing an integer value greater than 0xFFFFFFFF but less than or equal to 0xFFFFFFFFFFFFFFFF (18,446,744,073,709,551,615), the varint is 0xFFXXXXXXXXXXXXXXXX where XXXXXXXXXXXXXXXX represents the 8 byte integer in uint64_t format.

References with Examples

Value /br/br example value Size VarInt format /br/br example values
0 <= value <= 252 (0xFC) /br/br e.g. 187 (0xBB) /br /br 1 byte uint8_t/br/br0xBB
253 <= value <= 65,535 (0xFFFF) /br/br 255 (0xFF) /br/br 13,337 (0x3419) /br/br 1 byte but greater than 0xFC /br/br 2 bytes 0xFD + number as uint16_t /br/br 0xFD00FF /br/br 0xFD3419
14,435,729 (0xDC4591) 3 bytes 0xFE00DC4591
134,250,981 (0x80081E5) 4 bytes 0xFE080081E5
198,849,843,832,919 (0xB4DA564E2857) 6 bytes 0xFF0000B4DA564E2857
5,473,425,651,754,713,432 (0x‭4BF583A17D59C158‬) 8 bytes 0xFF4BF583A17D59C158