Struct Invoice

pub struct Invoice { /* private fields */ }

Representation of an invoice. Invoices are created by the PaymentGateway.

Invoices have an expiration block, after which they are considered expired. However, note that the payment gateway by default will continue updating invoices even after expiration.

To receive updates for a given Invoice, use a Subscriber.

Implementations

impl Invoice

pub fn uri(&self) -> String

Returns a URI containing the address and amount due as a String. For example:

"monero:4A1WSBQdCbUCqt3DaGfmqVFchXScF43M6c5r4B6JXT3dUwuALncU9XTEnRPmUMcB3c16kVP9Y7thFLCJ5BaMW3UmSy93w3w?tx_amount=0.001"

Monero URIs can be thought of as fancy addresses that pre-fill the amount field for the user (and sometimes the description field as well). They are supported by all major wallets.

pub fn is_confirmed(&self) -> bool

Returns true if the Invoice has received the required number of confirmations.

pub fn is_paid(&self) -> bool

Returns true if the Invoice has been paid in full (regadless of whether all required confirmations have been received).

pub fn is_expired(&self) -> bool

Returns true if the Invoice’s current block is greater than or equal to its expiration block.

pub fn address(&self) -> &str

Returns the base 58 encoded subaddress of this Invoice.

pub fn id(&self) -> InvoiceId

Returns the ID of this invoice.

pub fn index(&self) -> SubIndex

Returns the subaddress index of this Invoice.

pub fn creation_height(&self) -> u64

Returns the blockchain height at which the Invoice was created.

pub fn amount_requested(&self) -> u64

Returns the amount of monero requested in piconeros.

pub fn amount_paid(&self) -> u64

Returns the amount of monero paid in piconeros.

pub fn xmr_requested(&self) -> f64

Returns the amount of monero requested in XMR.

Note that rounding may occur because the precision of f64 is insufficient for representing large amounts of XMR out to many decimal places. If accuracy is desired, amount_requested() should be preferred.

Examples

// Create a new `Invoice` for 1 millinero.
let invoice_id = payment_gateway.new_invoice(1_000_000_000, 3, 5, "for pizza".to_string()).await?;
let small_invoice = payment_gateway.get_invoice(invoice_id).await?.expect("invoice ID not found");

// One millinero, as expected.
assert_eq!(small_invoice.xmr_requested(), 0.001);

// Create a new `Invoice` for 18446744.073709551615 XMR.
let invoice_id = payment_gateway.new_invoice(18_446_744_073_709_551_615, 3, 5, "for lambo".to_string()).await?;
let large_invoice = payment_gateway.get_invoice(invoice_id).await?.expect("invoice ID not found");

// The large value has been rounded slightly due to f64 precision limitations.
assert_eq!(large_invoice.xmr_requested(), 18446744.07370955);

pub fn xmr_paid(&self) -> f64

Returns the amount of monero paid in XMR.

Note that rounding may occur because the precision of f64 is insufficient for representing large amounts of XMR out to many decimal places. If accuracy is desired, amount_paid() should be preferred.

For an example of possible rounding error, see xmr_requested()

pub fn confirmations_required(&self) -> u64

Returns the number of confirmations this Invoice requires before it is considered fully confirmed.

pub fn confirmations(&self) -> Option<u64>

Returns the number of confirmations this Invoice has received since it was paid in full. Returns None if the Invoice has not yet been paid in full.

pub fn current_height(&self) -> u64

Returns the last daemon height at which this Invoice was updated.

Returns 0 if the Invoice has not yet been updated.

pub fn expiration_height(&self) -> u64

Returns the daemon height at which this Invoice will expire.

pub fn expiration_in(&self) -> u64

Returns the number of blocks before expiration.

Examples

// Create a new `Invoice` requiring 3 confirmations, and expiring in 5 blocks.
let invoice_id = payment_gateway.new_invoice(10000, 3, 5, "for pizza".to_string()).await?;
let mut subscriber = payment_gateway.subscribe(invoice_id).expect("invoice ID not found");
let invoice = subscriber.recv().await.expect("invoice update not received");

assert_eq!(invoice.expiration_in(), 5);

pub fn description(&self) -> &str

Returns the description of this invoice.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for Invoice

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Invoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for Invoice

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<'de> Deserialize<'de> for Invoice

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Invoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Encode for Invoice

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl PartialEq for Invoice

This custom PartialEq implementation is necessary so that the order of Transfers can be ignored while comparing Invoices.

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Invoice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Invoice