ZIP: 202
Title: Version 3 Transaction Format for Overwinter
Owners: Daira Hopwood <daira@electriccoin.co>
Original-Authors: Simon Liu
Status: Final
Category: Consensus
Created: 2018-01-10
License: MIT

Terminology

The key words "MUST", "MUST NOT", and "MAY" in this document are to be interpreted as described in RFC 2119. [1]

The terms "consensus branch", "network upgrade", and "consensus rule change" in this document are to be interpreted as described in ZIP 200. [3]

The term "Overwinter" in this document is to be interpreted as described in ZIP 201. [4]

Abstract

This proposal defines a new transaction format required for Network Upgrade Mechanism [3] and Transaction Expiry [5].

Motivation

Zcash launched with support for upstream Bitcoin version 1 transactions and defined a new version 2 transaction format which added fields required for shielded transactions.

Version	Field	Description	Type
>= 1	`version`	positive value	`int32`
>= 1	`tx_in_count`	variable-length integer	`compactSize`
>= 1	`tx_in`	list of inputs	`vector`
>= 1	`tx_out_count`	variable-length integer	`compactSize`
>= 1	`tx_out`	list of outputs	`vector`
>= 1	`lock_time`	block height or timestamp	`uint32`
>= 2	`nJoinSplit`	variable-length integer	`compactSize`
>= 2	`vJoinSplit`	list of joinsplits	`vector`
>= 2	`joinSplitPubKey`	joinsplit_sig public key	32 bytes
>= 2	`joinSplitSig`	signature	64 bytes

A new transaction format is required to:

support safe network upgrades as specified in Network Upgrade Mechanism [3];
provide replay protection between pre-Overwinter and Overwinter consensus branches during upgrades;
provide replay protection between different consensus branches post-Overwinter;
enable a consensus branch to support multiple transaction version formats;
ensure transaction formats are parsed uniquely across parallel consensus branches;
support transaction expiry [5].

Specification

Transaction format version 3

A new version 3 transaction format will be introduced for Overwinter.

The version 3 format differs from the version 2 format in the following ways:

header (first four bytes, little-endian encoded)
- fOverwintered flag : bit 31, must be set
- nVersion : bits 30-0, positive integer
nVersionGroupId
nExpiryHeight

Version	Field	Description	Type
>= 3	header	contains: `fOverwintered` flag (bit 31, always set) `nVersion` (bits 30-0)	`uint32`
>= 3	`nVersionGroupId`	version group ID (not zero)	`uint32`
>= 1	`tx_in_count`	variable-length integer	`compactSize`
>= 1	`tx_in`	list of inputs	`vector`
>= 1	`tx_out_count`	variable-length integer	`compactSize`
>= 1	`tx_out`	list of outputs	`vector`
>= 1	`lock_time`	block height or timestamp	`uint32`
>= 3	`expiryHeight`	block height	`uint32`
>= 2	`nJoinSplit`	variable-length integer	`compactSize`
>= 2	`vJoinSplit`	list of joinsplits	`vector`
>= 2	`joinSplitPubKey`	joinsplit_sig public key	32 bytes
>= 2	`joinSplitSig`	signature	64 bytes

Header Field

The first four bytes of pre-Overwinter and Overwinter transactions are little-endian encoded.

Version 1 transaction (txid 5c6ba844e1ca1c8083cd53e29971bd82f1f9eea1f86c1763a22dd4ca183ae061)

begins with little-endian byte sequence [0x01, 0x00, 0x00, 0x00];
deserialized as 32-bit signed integer with decimal value of 1.

Version 2 transaction (txid 4435bf8064e74f01262cb1725fd9b53e600fa285950163fd961bed3a64260d8b)

begins with little-endian byte sequence [0x02, 0x00, 0x00, 0x00];
deserialized as 32-bit signed integer with decimal value of 2.

Transaction parsers for versions of Zcash prior to Overwinter, and for most other Bitcoin forks, require the transaction version number to be positive.

With the version 3 transaction format, the first four bytes of a serialized transaction, the 32-bit header, are made up of two fields as shown in the table above:

1-bit fOverwintered flag, must be set;
31-bit unsigned int for the version.

Pre-Overwinter parsers will deserialize these four bytes as a 32-bit signed integer. With two's complement integers, the most significant bit indicates whether an integer is positive or negative. With the Overwinter flag set, the transaction version will be negative, resulting in pre-Overwinter parsers rejecting the transaction as invalid. This provides transaction replay protection between pre-Overwinter and Overwinter software.

Consider the following example of a serialized version 3 transaction.

Pre-Overwinter parser:

data begins with little-endian byte sequence: [0x03, 0x00, 0x00, 0x80];
deserialized as 32-bit signed integer.
- with hexadecimal value of 0x80000003 (most significant bit is set);
- decimal value of -2147483645.

Legacy parsers will expect the version to be a positive value, such as 1 or 2, and will thus reject the Overwinter transaction as invalid.

Overwinter parser:

data begins with little-endian byte sequence: [0x03, 0x00, 0x00, 0x80];
deserialized as 32-bit unsigned integer
- with binary value of 0b10000000000000000000000000000011;
the 32-bits are decomposed into two fields:
- fOverwintered flag (bit 31) as a boolean, expected to be set;
- version (bits 30 - bit 0) as an unsigned integer, expected to have a decimal value of 3.

Overwinter parsers will accept the transaction as valid as the most significant bit of the header has been set. By masking off (unsetting) the most significant bit, the parser can retrieve the transaction version number:

0x80000003 & 0x7FFFFFFF = 0x00000003 = 3

Version Group ID

The version group ID is a non-zero, random and unique identifier, of type uint32, assigned to a transaction format version, or a group of soft-forking transaction format versions. The version group ID helps nodes disambiguate between consensus branches using the same version number.

That is, it prevents a client on one branch of the network from attempting to parse transactions intended for another consensus branch, in the situation where the transactions share the same format version number but are actually specified differently. For example, Zcash and a clone of Zcash might both define their own custom v3 transaction formats, but each will have its own unique version group ID, so that they can reject v3 transactions with unknown version group IDs.

The combination of transaction version and version group ID, nVersion || nVersionGroupId, uniquely defines the transaction format, thus enabling parsers to reject transactions from outside the client's chain which cannot be parsed.

By convention, it is expected that when introducing a new transaction version requiring a network upgrade, a new unique version group ID will be assigned to that transaction version.

However, if a new transaction version can be correctly parsed according to the format of a preceding version (that is, it only restricts the format, or defines fields that were previously reserved and which old parsers can safely ignore), then the same version group ID MAY be re-used.

Expiry Height

The expiry height field, as defined in the Transaction Expiry ZIP [5], stores the block height after which a transaction can no longer be mined.

Transaction Validation

A valid Overwinter transaction intended for Zcash MUST have:

version number 3; and
version group ID 0x03C48270; and
fOverwintered flag set.

Overwinter validators MUST reject transactions for violating consensus rules if:

the fOverwintered flag is not set; or
the version group ID is unknown; or
the version number is unknown.

Validation of version 3 transactions MUST use the signature validation process detailed in the Transaction Signature Validation for Overwinter ZIP [2].

Implementation

The comments and code samples in this section apply to the reference C++ implementation of Zcash. Other implementations may vary.

Transaction Version

Transaction version remains a positive value. The main Zcash chain will follow convention and continue to order transaction versions in an ascending order.

Tests can continue to check for the existence of forwards-compatible transaction fields by checking the transaction version using comparison operators:

if (tx.nVersion >= 2) {
    for (int js = 0; js < joinsplits; js++) {
        ...
    }
}

When (de)serializing v3 transactions, the version group ID must also be checked in case the transaction is intended for a consensus branch which has a different format for its version 3 transaction:

if (tx.nVersion == 3 && tx.nVersionGroupId == OVERWINTER_VERSION_GROUP_ID) {
    auto expiryHeight = tx.nExpiryHeight;
}

Tests can continue to set the version to zero as an error condition:

mtx.nVersion = 0

Overwinter Validation

To test if the format of an Overwinter transaction is v3 or not:

if (tx.fOverwintered && tx.nVersion == 3) {
    // Valid v3 format transaction
}

This only tests that the format of the transaction matches the v3 specification described above.

To test if the format of an Overwinter transaction is both v3 and the transaction itself is intended for the client's chain:

if (tx.fOverwintered &&
    tx.nVersionGroupId == OVERWINTER_VERSION_GROUP_ID) &&
    tx.nVersion == 3) {
    // Valid v3 format transaction intended for this client's chain
}

It is expected that this test involving nVersionGroupId is only required when a transaction is being constructed or deserialized e.g. when an external transaction enters the system.

However, it's possible that a clone of Zcash is using the same version group ID and passes the conditional.

Ultimately, a client can determine if a transaction is truly intended for the client's chain or not by following the signature validation process detailed in the Transaction Signature Validation for Overwinter ZIP [2].

Deployment

This proposal will be deployed with the Overwinter network upgrade. The activation block height proposal is in [4].

Backwards compatibility

This proposal intentionally creates what is known as a "bilateral consensus rule change" [3] between pre-Overwinter software and Overwinter-compatible software. Use of this new transaction format requires that all network participants upgrade their software to a compatible version within the upgrade window. Pre-Overwinter software will treat Overwinter transactions as invalid.

Once Overwinter has activated, Overwinter-compatible software will reject version 1 and version 2 transactions, and will only accept transactions based upon supported transaction version numbers and recognized version group IDs.

Reference Implementation

zcash/zcash#2925

References

[1]	RFC 2119: Key words for use in RFCs to Indicate Requirement Levels

[2]	(1, 2) ZIP 143: Transaction Signature Validation for Overwinter

[3]	(1, 2, 3, 4) ZIP 200: Network Upgrade Mechanism

[4]	(1, 2) ZIP 201: Network Handshaking for Overwinter

[5]	(1, 2, 3) ZIP 203: Transaction Expiry

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

zip-0202.rst

zip-0202.rst

Terminology

Abstract

Motivation

Specification

Transaction format version 3

Header Field

Version Group ID

Expiry Height

Transaction Validation

Implementation

Transaction Version

Overwinter Validation

Deployment

Backwards compatibility

Reference Implementation

References

Files

zip-0202.rst

Latest commit

History

zip-0202.rst

File metadata and controls

Terminology

Abstract

Motivation

Specification

Transaction format version 3

Header Field

Version Group ID

Expiry Height

Transaction Validation

Implementation

Transaction Version

Overwinter Validation

Deployment

Backwards compatibility

Reference Implementation

References