feat: add to_address_data to address type

[reez]

Description

Resolve #669 with to_address_data

Notes to the reviewers

Changelog notice

Checklists

All Submissions:

• I've signed all my commits
• I followed the contribution guidelines
• I ran cargo fmt and cargo clippy before committing

New Features:

• I've added tests for the new feature
• I've added docs for the new feature

Bugfixes:

• This pull request breaks the existing API
• I've added tests to reproduce the issue which are now passing
• I'm linking the issue being fixed by this PR

[reez]

@thunderbiscuit

• thoughts or better options for this line https://github.com/bitcoindevkit/bdk-ffi/pull/671/files#diff-c73020e295d654c61c706f3634d67285896d23813c1fb4f5c30ff57c220e154dR94 ?
• I tested this and can push up the test/tests I ran for this if helpful too

[thunderbiscuit]

Looks great!

Only one small comment/idea.

As for the non-exhaustive, if you add that qualifier to the UDL does it let you do away with the _ => unimplemented branch?

[thunderbiscuit]

I was thinking that maybe what people want here is the hash in string format? Really it's not a problem because I can transform the bytes into a hex locally but I think the Hash type maybe handles some of that (big-endianness and little-endianness) when converting to strings? We also return a string rather than the bytes when giving out the Txid (which is also a Hash).

Let me know what you think.

[reez]

Yeah I agree with what you're saying but I was also trying to balance it with how Conor was using it (which was the initial reason for exposing this method) which he mentioned was this:

"Need it to to generate a valid shutdown script for closing Lightning channels"

override fun get_shutdown_scriptpubkey(): Result_ShutdownScriptNoneZ {
        val address = ldkkeysManager!!.wallet.getLastUnusedAddress().address

        return when (val payload: Payload = address.payload()) {
            is Payload.WitnessProgram -> {
                val ver = when (payload.version.name) {
                    in "V0".."V16" -> payload.version.name.substring(1).toIntOrNull() ?: 0
                    else -> 0 // Default to 0 if it doesn't match any "V0" to "V16"
                }

                val result = ShutdownScript.new_witness_program(
                    WitnessProgram(
                        payload.program.toUByteArray().toByteArray(),
                        WitnessVersion(ver.toByte())
                    )
                )
                Result_ShutdownScriptNoneZ.ok((result as Result_ShutdownScriptInvalidShutdownScriptZ.Result_ShutdownScriptInvalidShutdownScriptZ_OK).res)
            }

            else -> {
                Result_ShutdownScriptNoneZ.err()
            }
        }
    }

What are your thoughts with that added context?

[thunderbiscuit]

Yeah the witness program I'd keep as bytes. I was more thinking of the pubkey_hash and script_hash as hex strings the way we often see/think of hashes.

[thunderbiscuit]

But honestly I'm ok with Byte arrays! Just a thought.

[reez]

Ah! yeah no what you're saying makes perfect sense to me now. pubkey_hash and script_hash have been updated/changed to strings

[reez]

Looks great!

Only one small comment/idea.

As for the non-exhaustive, if you add that qualifier to the UDL does it let you do away with the _ => unimplemented branch?

Did you happen to get this to compile if you tried this, the only reason I'm asking is because I somehow could not get it to compile (error NonExhaustive not supported for interface definition) if I tried this even though to my understanding it actually should compile based on https://mozilla.github.io/uniffi-rs/0.28/udl/enumerations.html#remote-non-exhaustive-enums

[thunderbiscuit]

@reez ah yes you're right. This is only possible with simple enums, not interface-based enums (which turn into Sealed Classes in Kotlin, can't remember what in Swift).

Ok this is good to go IMO!

[thunderbiscuit]

ACK 889b70a.

But yes if you have maybe a test showing all 3 variants of the enum (even if it's just in Swift) that'd be great I think!