Struct PayOnchainRequest

pub struct PayOnchainRequest {
    pub address: Address<NetworkUnchecked>,
    pub amount: Amount,
    pub priority: Option<ConfirmationPriority>,
    pub client_payment_id: Option<ClientPaymentId>,
    pub personal_note: Option<String>,
}

A request to send Bitcoin on-chain.

Fields

address: Address<NetworkUnchecked>

The Bitcoin address to send to. Must be valid for the network this wallet is configured for.

amount: Amount

The amount we will send.

priority: Option<ConfirmationPriority>

How quickly the transaction should confirm. A higher priority pays a higher on-chain fee. Defaults to "normal".

client_payment_id: Option<ClientPaymentId>

A client-generated id for this payment, used for idempotency. Retrying a request with the same client_payment_id won’t send the payment twice.

If None, a random id is generated, which provides no idempotency across separate pay_onchain calls.

personal_note: Option<String>

An optional personal note for this payment. The receiver will not see this note. If provided, it must be non-empty and no longer than 200 chars / 512 UTF-8 bytes.

Trait Implementations

impl<'de> Deserialize<'de> for PayOnchainRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PayOnchainRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PayOnchainRequest> for PayOnchainRequest

type Error = Error

The type returned in the event of a conversion error.

fn try_from(req: PayOnchainRequest) -> Result<Self>

Performs the conversion.