Add binding docstrings

[dangeross]

This PR is to support including docstrings defined in the Uniffi UDL file to be included in bindings that are generated from it.

• Bump the React Native codegen to use Uniffi 0.25.0. In doing so we switch to use the NordSecurity uniffi 0.25.0 which supports docstrings (From 0.26.0 we can switch back to mozilla) 73765ba
• Add docstring handling to the React Native codegen ff5ea42
• Add comments to the UDL file for structs and methods c758753

There is a lot of changes to the boilerplate code on upgrading the React Native codegen to 0.25.0, we also have to bring in changes to the Swift and Kotlin codegen. You can find the meat & potatoes of the changes here:

• https://github.com/breez/breez-sdk-liquid/compare/savage-rn-codegen-0.25?expand=1#diff-d9d7d38f76acd697d85cdfb06f30932594aa8b60d52eca5d5e11d2675437533e
• https://github.com/breez/breez-sdk-liquid/compare/savage-rn-codegen-0.25?expand=1#diff-b825ef98eadf4aad5176c05a28c458d9c5b0c2b62186b6e6e6ef08399bea707d
• https://github.com/breez/breez-sdk-liquid/compare/savage-rn-codegen-0.25?expand=1#diff-3af0a2c994746e8dba8366989cb82148f5868cdb40e7ab4160b54aa8f785d677

Adding these changes also enables docstings to be used in C#, Go, Kotlin, Python & Swift generated bindings.

For example
Adding to the UDL file:

    /// Pays to a Bitcoin address via a chain swap.
    ///
    /// Depending on [Config]'s `payment_timeout_sec`, this function will return:
    /// * [PaymentState::Pending] payment - if the payment could be initiated but didn't yet
    ///   complete in this time
    /// * [PaymentState::Complete] payment - if the payment was successfully completed in this time
    ///
    /// # Arguments
    ///
    /// * `req` - the [PayOnchainRequest] containing:
    ///     * `address` - the Bitcoin address to pay to
    ///     * `prepare_response` - the [PreparePayOnchainResponse] from calling [BindingLiquidSdk::prepare_pay_onchain]
    ///
    /// # Errors
    ///
    /// * [PaymentError::PaymentTimeout] - if the payment could not be initiated in this time
    [Throws=PaymentError]
    SendPaymentResponse pay_onchain(PayOnchainRequest req);

Generates jsdocs:

/**
 * Pays to a Bitcoin address via a chain swap.
 *
 * Depending on {@link Config}'s `paymentTimeoutSec`, this function will return:
 * * {@link PaymentState.PENDING} payment - if the payment could be initiated but didn't yet
 *   complete in this time
 * * {@link PaymentState.COMPLETE} payment - if the payment was successfully completed in this time
 *
 * # Arguments
 *
 * * `req` - the {@link PayOnchainRequest} containing:
 *     * `address` - the Bitcoin address to pay to
 *     * `prepareResponse` - the {@link PreparePayOnchainResponse} from calling {@link preparePayOnchain}
 *
 * # Errors
 *
 * * {@link PaymentError.PAYMENT_TIMEOUT} - if the payment could not be initiated in this time
 */
export const payOnchain = async (req: PayOnchainRequest): Promise<SendPaymentResponse> => {
    const response = await BreezSDKLiquid.payOnchain(req)
    return response
}

[ok300]

With the new uniffi_bindgen_kmp, is the uniffi_bindgen_kotlin_multiplatform below still necessary?

[dangeross]

I had to split the use of uniffi_bindgen because of compatibility issues, so uniffi_bindgen_kmp is uniffi_bindgen 0.25.2 for use with uniffi_bindgen_kotlin_multiplatform.

I will play around a bit more to see if I can get them to use the same uniffi_bindgen.

[ok300]

Related to breez/breez-sdk-greenlight#781

[dangeross]

There are two open PRs for both Go & C# to upgrade to uniffi 0.28:

• Kristupas/update uniffi.0.28.0 NordSecurity/uniffi-bindgen-cs#86
• Migrate to uniffi v0.28.3 NordSecurity/uniffi-bindgen-go#65

Kotlin multi-platform has upgraded to uniffi 0.28:

• https://gitlab.com/trixnity/uniffi-kotlin-multiplatform-bindings/-/merge_requests/55

Upgrading to uniffi 0.28 will allow us to annotate/document our rust bindings directly and remove to need to maintain a UDL file