From ea180981c2437a28634784ada51048fd370440e1 Mon Sep 17 00:00:00 2001 From: Nick Johnson Date: Fri, 18 Oct 2024 13:46:09 -0700 Subject: [PATCH] Add changelogs and tags --- Cargo.lock | 4 ++-- justfile | 10 ++++++++++ protocol/CHANGELOG.md | 5 +++++ protocol/Cargo.toml | 2 +- proxy/CHANGELOG.md | 3 +++ proxy/Cargo.toml | 2 +- 6 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 justfile create mode 100644 protocol/CHANGELOG.md create mode 100644 proxy/CHANGELOG.md diff --git a/Cargo.lock b/Cargo.lock index 4dfaf38..e92f416 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -71,7 +71,7 @@ checksum = "d965446196e3b7decd44aa7ee49e31d630118f90ef12f97900f262eb915c951d" [[package]] name = "bip324" -version = "0.3.1" +version = "0.4.0" dependencies = [ "bitcoin", "futures", @@ -81,7 +81,7 @@ dependencies = [ [[package]] name = "bip324-proxy" -version = "0.2.0" +version = "0.3.0" dependencies = [ "bip324", "bitcoin", diff --git a/justfile b/justfile new file mode 100644 index 0000000..313ef7a --- /dev/null +++ b/justfile @@ -0,0 +1,10 @@ +default: + @just --list + +# Add a release tag and publish to the upstream remote. Need write privileges on the repository. +tag crate version remote="upstream": + # A release tag is specific to a crate so following the convention crate-version. + echo "Adding release tag {{crate}}-{{version}} and pushing to {{remote}}..." + # Annotated tag. + git tag -a {{crate}}-{{version}} -m "Release {{version}} for {{crate}}" + git push {{remote}} {{crate}}-{{version}} diff --git a/protocol/CHANGELOG.md b/protocol/CHANGELOG.md new file mode 100644 index 0000000..f62cb08 --- /dev/null +++ b/protocol/CHANGELOG.md @@ -0,0 +1,5 @@ +# v0.4.0 + +* Adds the `AsyncProtocol` high level interface for less boilerplate integration when using an async runtime (e.g. Tokio). Codes against the `futures-rs` traits, so any runtime which is compatible with those should be supported. +* Aync read functions should now be cancellation safe. +* The high level `Io` variant of the `ProtocolError` exposes if it is worth retrying with the V1 protocol with the new `ProtocolFailureSuggestion` type. diff --git a/protocol/Cargo.toml b/protocol/Cargo.toml index 525a15f..06f324c 100644 --- a/protocol/Cargo.toml +++ b/protocol/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bip324" -version = "0.3.1" +version = "0.4.0" edition = "2021" license-file = "LICENSE" description = "Encrypted messaging over the Bitcoin P2P Protocol as specified by BIP 324" diff --git a/proxy/CHANGELOG.md b/proxy/CHANGELOG.md new file mode 100644 index 0000000..43a3ccd --- /dev/null +++ b/proxy/CHANGELOG.md @@ -0,0 +1,3 @@ +# v0.3.0 + +* The new `--v1-fallback` flag allows a proxy connection to fallback to the V1 protocol if a remote doesn't support V2. diff --git a/proxy/Cargo.toml b/proxy/Cargo.toml index 94e9349..f899b65 100644 --- a/proxy/Cargo.toml +++ b/proxy/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bip324-proxy" -version = "0.2.0" +version = "0.3.0" edition = "2021" license-file = "LICENSE" description = "BIP324 proxy enabling v1-only clients to use the v2 Bitcoin P2P Protocol"