Module model

Structs

AcceptPaymentProposedFeesRequest

An argument when calling crate::sdk::LiquidSdk::accept_payment_proposed_fees.

AssetBalance

An asset balance to denote the balance for each asset.

AssetInfo

Represents the Liquid payment asset info. The asset info is derived from the available AssetMetadata that is set in the Config.

AssetMetadata

Configuration for asset metadata. Each asset metadata item represents an entry in the Liquid Asset Registry. An example Liquid Asset in the registry would be Tether USD.

BackupRequest

An argument when calling crate::sdk::LiquidSdk::backup.

BlockchainInfo

BtcScriptBalance

BuyBitcoinRequest

An argument when calling crate::sdk::LiquidSdk::buy_bitcoin.

ChainSwap

A chain swap

CheckMessageRequest

An argument when calling crate::sdk::LiquidSdk::check_message.

CheckMessageResponse

Returned when calling crate::sdk::LiquidSdk::check_message.

Config

Configuration for the Liquid SDK

ConnectRequest

An argument when calling crate::sdk::LiquidSdk::connect. The resquest takes either a mnemonic and passphrase, or a seed.

ConnectWithSignerRequest

CreateBolt12InvoiceRequest

An argument when calling crate::sdk::LiquidSdk::create_bolt12_invoice.

CreateBolt12InvoiceResponse

Returned when calling crate::sdk::LiquidSdk::create_bolt12_invoice.

FetchPaymentProposedFeesRequest

An argument when calling crate::sdk::LiquidSdk::fetch_payment_proposed_fees.

FetchPaymentProposedFeesResponse

Returned when calling crate::sdk::LiquidSdk::fetch_payment_proposed_fees.

GetInfoResponse

Returned when calling crate::sdk::LiquidSdk::get_info.

History

LightningPaymentLimitsResponse

Returned when calling crate::sdk::LiquidSdk::fetch_lightning_limits.

Limits

The minimum and maximum in satoshis of a Lightning or onchain payment.

ListPaymentsRequest

An argument when calling crate::sdk::LiquidSdk::list_payments.

LnUrlInfo

Represents the payment LNURL info

LnUrlPayRequest

An argument when calling crate::sdk::LiquidSdk::lnurl_pay.

LnUrlPaySuccessData

LogEntry

Internal SDK log entry used in the Uniffi and Dart bindings

OnchainPaymentLimitsResponse

Returned when calling crate::sdk::LiquidSdk::fetch_onchain_limits.

PayOnchainRequest

An argument when calling crate::sdk::LiquidSdk::pay_onchain.

Payment

Represents an SDK payment.

PaymentSwapData

PaymentTxData

PrepareBuyBitcoinRequest

An argument when calling crate::sdk::LiquidSdk::prepare_buy_bitcoin.

PrepareBuyBitcoinResponse

Returned when calling crate::sdk::LiquidSdk::prepare_buy_bitcoin.

PrepareLnUrlPayRequest

An argument when calling crate::sdk::LiquidSdk::prepare_lnurl_pay.

PrepareLnUrlPayResponse

Returned when calling crate::sdk::LiquidSdk::prepare_lnurl_pay.

PreparePayOnchainRequest

An argument when calling crate::sdk::LiquidSdk::prepare_pay_onchain.

PreparePayOnchainResponse

Returned when calling crate::sdk::LiquidSdk::prepare_pay_onchain.

PrepareReceiveRequest

An argument when calling crate::sdk::LiquidSdk::prepare_receive_payment.

PrepareReceiveResponse

Returned when calling crate::sdk::LiquidSdk::prepare_receive_payment.

PrepareRefundRequest

An argument when calling crate::sdk::LiquidSdk::prepare_refund.

PrepareRefundResponse

Returned when calling crate::sdk::LiquidSdk::prepare_refund.

PrepareSendRequest

An argument when calling crate::sdk::LiquidSdk::prepare_send_payment.

PrepareSendResponse

Returned when calling crate::sdk::LiquidSdk::prepare_send_payment.

ReceivePaymentRequest

An argument when calling crate::sdk::LiquidSdk::receive_payment.

ReceivePaymentResponse

Returned when calling crate::sdk::LiquidSdk::receive_payment.

ReceiveSwap

A reverse swap, used for Receive

RecommendedFees

Returned when calling crate::sdk::LiquidSdk::recommended_fees.

RefundRequest

An argument when calling crate::sdk::LiquidSdk::refund.

RefundResponse

Returned when calling crate::sdk::LiquidSdk::refund.

RefundableSwap

Returned when calling crate::sdk::LiquidSdk::list_refundables.

RestoreRequest

An argument when calling crate::sdk::LiquidSdk::restore.

SendPaymentRequest

An argument when calling crate::sdk::LiquidSdk::send_payment.

SendPaymentResponse

Returned when calling crate::sdk::LiquidSdk::send_payment.

SendSwap

A submarine swap, used for Send

SignMessageRequest

An argument when calling crate::sdk::LiquidSdk::sign_message.

SignMessageResponse

Returned when calling crate::sdk::LiquidSdk::sign_message.

WalletInfo

Enums

BlockchainExplorer

BuyBitcoinProvider

An argument of PrepareBuyBitcoinRequest when calling crate::sdk::LiquidSdk::prepare_buy_bitcoin.

Direction

GetPaymentRequest

An argument when calling crate::sdk::LiquidSdk::get_payment.

LiquidNetwork

Network chosen for this Liquid SDK instance. Note that it represents both the Liquid and the Bitcoin network used.

ListPaymentDetails

An argument of ListPaymentsRequest when calling crate::sdk::LiquidSdk::list_payments.

LnUrlPayResult

Contains the result of the entire LNURL-pay interaction, as reported by the LNURL endpoint.

PayAmount

Used to specify the amount to sent or to send all funds.

PaymentDetails

The specific details of a payment, depending on its type

PaymentMethod

The send/receive methods supported by the SDK

PaymentState

The payment state of an individual payment.

PaymentStatus

PaymentSwapType

PaymentType

ReceiveAmount

SdkEvent

Event emitted by the SDK. Add an EventListener by calling crate::sdk::LiquidSdk::add_event_listener to listen for emitted events.

SendDestination

Specifies the supported destinations which can be payed by the SDK

SignerError

Swap

Transaction

Utxo

Constants

BREEZ_LIQUID_ESPLORA_URL

BREEZ_SWAP_PROXY_URL

BREEZ_SYNC_SERVICE_URL

DEFAULT_ONCHAIN_FEE_RATE_LEEWAY_SAT

LIQUID_FEE_RATE_MSAT_PER_VBYTE

LIQUID_FEE_RATE_SAT_PER_VBYTE

Traits

EventListener

Trait that can be used to react to various SdkEvents emitted by the SDK.

Signer

A trait that can be used to sign messages and verify signatures. The sdk user can implement this trait to use their own signer.