Skip to content

Commit

Permalink
chore: version bumps and note about versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
prestwich committed Apr 4, 2020
1 parent 3e9790d commit c6e3302
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 3 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ recommend a specific security model. Any SPV verification involves complex
security assumptions. Please seek external review for your design before
building with these libraries.

### A note about versioning

Implementations are versioned separately. I.e. there is no consistent feature
set for a given version number. Wherever possible we use SemVer. Because go's
versioning system is ridiculous, all releases are minor bumps, even when they
should be major bumps.

This may change in future releases.

At time of writing the following versions are roughly equivalent:
- Go v1.4.0
- JS v4.0.0
- rust v3.0.0
- py v3.0.0

Versions older than these have incompatible JSON Proof and Header formats.


### Bitcoin Endianness Gotchas
Block explorers tend to show txids and merkle roots in big-endian (BE) format.
Most human-facing apps do this as well. However, due to Satoshi's inscrutable
Expand Down
2 changes: 1 addition & 1 deletion js/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@summa-tx/bitcoin-spv-js",
"version": "3.0.0",
"version": "4.0.0",
"description": "bitcoin SPV proofs in Javascript",
"main": "dist/index.js",
"engines": {
Expand Down
2 changes: 1 addition & 1 deletion python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

setup(
name='bitcoin-spv-py',
version='2.0.0',
version='3.0.0',
url='https://github.com/summa-tx/bitcoin-spv',
author='James Prestwich',
author_email='[email protected]',
Expand Down
2 changes: 1 addition & 1 deletion rust/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "bitcoin-spv"
version = "2.0.0"
version = "3.0.0"
authors = ["James Prestwich <[email protected]>"]
edition = "2018"
license="LGPL-3.0-or-later"
Expand Down

0 comments on commit c6e3302

Please sign in to comment.