search

rust-bitcoin / rust-bech32

Bech32 format encoding and decoding
MIT License
93 stars 49 forks source link

Release tracking PR: `v0.10.0` #168

Closed tcharding closed 6 months ago

tcharding commented 8 months ago

In preparation for doing the first "real" (non-beta) release of the new primitives module add a changelog entry and bump the version.

tcharding commented 8 months ago

Before this merges can you confirm please that the new accessor methods fully cover your use case in liquid @apoelstra. Using the new API over there was the last step before we were confident to release this, right?

apoelstra commented 8 months ago

Yeah, lemme PR to rust-elements to use the new accessors first please.

apoelstra commented 8 months ago

@tcharding can we do a beta2 release first which includes the new stuff?

tcharding commented 8 months ago

Sure thing, I couldn't think of a nice next beta version name yesterday - I'll use beta2 as suggested.

tcharding commented 8 months ago

Next beta release done in https://github.com/rust-bitcoin/rust-bech32/pull/169, keeping this here for the v0.10.0 when it comes - can't be far away.

tcharding commented 7 months ago

Note the diff includes change to CHANGELOG removing mention of v0.10.0-beta.2, since we yanked it I believe this is correct.

apoelstra commented 7 months ago

Ok, sorry, we have to do one more iteration on the API.

The issue I'm having is that there is a specific sequence to parsing a Segwit string:

So I think what we want to do is move remove_witness_version from UncheckedHrpstring to CheckedHrpstring and we should be good to go. I suppose it ought to yield the witness version but honestly it doesn't have to, it just be a &mut method that changes self.data to self.data[1..] and doesn't return anything.

But we've made a ton of progress :) on my local rust-elements branch we have

 5 files changed, 40 insertions(+), 546 deletions(-)

which is basically all deleted code that I'd copied and tweaked from this library since the API didn't expose enough for me to use it directly.

tcharding commented 7 months ago

5 files changed, 40 insertions(+), 546 deletions(-)

That's a win, for sure. Will hack up your suggestions.

tcharding commented 7 months ago

I left the functions on UncheckedHrpstring - from an API perspective seems to be no reason to have them on one and not the other.

tcharding commented 6 months ago

ooo yeah, I love waking up in the morning to a fresh release - make my day @apoelstra!

apoelstra commented 6 months ago

Tagged and published.

apoelstra commented 6 months ago

Sigh, cargo seems to think that 0.10.0 is the same major rev as 0.10.0-beta and is breaking downstream crates.

Yanked 0.10.0. Will need to re-release as 0.11.0.

tcharding commented 6 months ago

Bother, I wish I came to the same conclusion before I got in a rage about every PR in rust-bitcoin being broken.

tcharding commented 6 months ago

Like, literally the reason we did the -beta releases ....