Add psbt ffi bindings

[benalleng]

This add some basic ffi bindings for psbts including serialization
and deserizlization as well as a few methods used in payjoin
integration tests that are needed for downstream bindings there.

supersedes #22 as it build off the work @rustaceanrob did

[benalleng]

@DanGould I chose these bindings for now based on some integration tests from rust-payjoin.

namely, .fee(), .extract_tx(), and .combine()

https://github.com/payjoin/rust-payjoin/blob/518d8d2600c0a57fc3ef7ab3b75a5e6b1c7f89aa/payjoin/tests/integration.rs#L902-L905

[DanGould]

I believe remote error types can be used with uniffi::remote(Enum). Then I'd guess they don't need to derive thiserror::Error, or require a conversion, or require the explicit display #[error] attributes. Not sure If it has been tried in this repo before. I think an enum still needs to be written with each variant but some of the other boilerplate that might get out of sync can go. I am not certain of this but the documentation suggests it.

https://mozilla.github.io/uniffi-rs/latest/types/remote_ext_types.html

[benalleng]

With the Psbt Error Enum there are a lot of complex error payload types, wouldn't these all still need to be converted for this to be easily used as a remote(Enum)? I'm just not sure its worth it to avoid error messages getting out of sync unless there is a way to more easily avoid those conversions.

[DanGould]

I think #[uniffi(flat_error)] might be able to keep the upstream payload types but inherit debug/display implementations (perhaps with #[uniffi::export(Debug), uniffi::export(Display)], not sure to what extent these macros can be combined). You may need to rely on the bitcoin/std feature so errors are std::error::Error in order to make sure UniFFI knows the remote PsbtError can be thrown as an error.

[thunderbiscuit]

Errors have been a pain in our side for a long time, but I'm curious to see if some of the new features in uniffi might fix some of those pain points for us. In particular, simply using the remote error types would be awesome instead of reimplementing errors.

For a comprehensive dive into this from a year ago (some things have changed since then so I still have hope!) see this issue: bitcoindevkit/bdk-ffi#509.

[thunderbiscuit]

From what I remember our problem was mostly about having to choose between offering the complex types in the payload vs correct and interesting error messages for users (which they expect in their target languages).

I think if you have complex types in the payload, your Display becomes a stringified version of the type, and that's what you get in Kotlin for your exception.message field (where you expect a good message). Same thing for Swift (I think it's the description field). If you want to instead fix this message, you cannot have fields in your enum (something like that). The issue as far as I remember is that for some errors you'd much rather have the message, and for others you'd rather have the data... 😅

[thunderbiscuit]

Note that you cannot use #[uniffi::export(Display)] on enums (you get the error unsupported item: only functions and impl blocks may be annotated with this attribute).

[DanGould]

Are you sure that message is related? I definitely use #[uniffi::export(Display)] on this struct which is neither a function nor an impl block

[thunderbiscuit]

Ok weird. Maybe I got this wrong. I tried a bunch of stuff 2 weeks ago to play with the errors a bit more and got to the same place we ended up so far.

Let me know how you make out I'm definitely interested in better errors!

[reez]

bumping this so we get it merged (or merge a new pr if that's what ben wants to do instead, up to you @benalleng )

[thunderbiscuit]

Using 0.30.0 of uniffi your errors should start getting a toString/description/__str__ from the Display trait (doesn't work yet for Kotlin but should be fixed at some point soon, see mozilla/uniffi-rs#2699).

Still need to test to make sure that the thiserror crate will work as expected and populate your Display, but that should in theory clean up your errors quite a bit if you're willing to upgrade to 0.30.0.

[thunderbiscuit]

We are also doing some work exposing the Psbt type in bdk-ffi, so if you want to see some of that take a look at our implementation. The lead on this is @ItoroD

[benalleng]

I plan on merging this as-is and then addressing the Error serialization after uniffi 0.30 has been setup in the rest of our ffi layer

[reez]

I plan on merging this as-is and then addressing the Error serialization after uniffi 0.30 has been setup in the rest of our ffi layer

im good w that 👍