summaryrefslogtreecommitdiff
path: root/bip-0174.mediawiki
diff options
context:
space:
mode:
authorAndrew Chow <achow101-github@achow101.com>2019-08-01 14:28:37 -0400
committerAndrew Chow <achow101-github@achow101.com>2019-08-01 14:28:37 -0400
commit503f35a9a066a51be29d9c81e73f72f54a403b76 (patch)
tree2a52aa7c01a9b46afb00a756c6ff55e42896d4cf /bip-0174.mediawiki
parent32b496a65fe76cfc729876716d3a6c807acb4989 (diff)
downloadbips-503f35a9a066a51be29d9c81e73f72f54a403b76.tar.xz
Add Version type
Diffstat (limited to 'bip-0174.mediawiki')
-rw-r--r--bip-0174.mediawiki17
1 files changed, 17 insertions, 0 deletions
diff --git a/bip-0174.mediawiki b/bip-0174.mediawiki
index b4a6407..bbc0fc6 100644
--- a/bip-0174.mediawiki
+++ b/bip-0174.mediawiki
@@ -124,6 +124,12 @@ The currently defined global types are as follows:
** Value: The master key fingerprint as defined by BIP 32 concatenated with the derivation path of the public key. The derivation path is represented as 32 bit unsigned integer indexes concatenated with each other. The number of 32 bit unsigned integer indexes must match the depth provided in the extended public key.
*** <tt>{master key fingerprint}|{32-bit int}|...|{32-bit int}</tt>
+* Type: Version Number <tt>PSBT_GLOBAL_VERSION = 0xFB</tt>
+** Key: None. The key must only contain the 1 byte type.
+*** <tt>{0xFB}</tt>
+** Value: The 32-bit little endian unsigned integer representing the version number of this PSBT. If ommitted, the version number is 0.
+*** <tt>{32-bit int}</tt>
+
The currently defined per-input types are defined as follows:
* Type: Non-Witness UTXO <tt>PSBT_IN_NON_WITNESS_UTXO = 0x00</tt>
@@ -432,6 +438,17 @@ types will be ignored and passed-through by signers which do not know about them
If one byte type fields were to ever run out, new extensions can still be added by defining multi-byte types where the first byte signals that the next byte indicates the type and so on.
+===Version Numbers===
+
+The Version number field exists only as a safeguard in the event that a backwards incompatible change is introduced to PSBT.
+If a parser encounters a version number it does not recognize, it should exit immediately as this indicates that the PSBT will contain types that it does not know about and cannot be ignored.
+Current PSBTs are Version 0. Any PSBT that does not have the version field is version 0.
+It is not expected that any backwards incompatible change will be introduced to PSBT, so it is not expected that the version field will ever actually be seen.
+
+Updaters and combiners that need to add a version number to a PSBT should use the highest version number required.
+For example, if a combiner sees two PSBTs for the same transaction, one with version 0, and the other with version 1, then it should combine them and produce a PSBT with version 1.
+If an updater is updating a PSBT and needs to add a field that is only available in version 1, then it should set the PSBT version number to 1 unless a version higher than that is already specified.
+
==Compatibility==
This transaction format is designed so that it is unable to be properly unserialized