Struct PaymentGateway

pub struct PaymentGateway<S: Storage, M: MonerodClient = RpcClient>(/* private fields */);

The PaymentGateway allows you to track new Invoices, remove old Invoices from tracking, and subscribe to Invoices that are already pending.

Implementations

impl<S: Storage + 'static, M: MonerodClient + 'static> PaymentGateway<S, M>

pub fn builder( private_view_key: String, primary_address: String, store: S, ) -> PaymentGatewayBuilder<S>

Returns a builder used to create a new payment gateway.

pub async fn run(&self) -> Result<(), AcceptXmrError>

Runs the payment gateway. This function spawns a new thread, which periodically scans new blocks and transactions from the configured daemon and updates pending Invoices in the database.

Errors

• Returns an AcceptXmrError::Storage error if there was an underlying issue with the database.

• Returns an AcceptXmrError::Rpc error if there was an issue getting necessary data from the monero daemon while starting.

• Returns an AcceptXmrError::AlreadyRunning error if the payment gateway is already running.

• Returns an AcceptXmrError::Scanner error if there was an error with the scanning thread.

pub async fn status(&self) -> PaymentGatewayStatus

Returns the enum PaymentGatewayStatus describing whether the payment gateway is running, not running, or has experienced an error.

pub async fn stop(&self) -> Result<(), AcceptXmrError>

Stops the payment gateway, blocking until complete. If the payment gateway is not running, this method does nothing.

Errors

• Returns an AcceptXmrError::StopSignal error if the payment gateway could not be stopped.

• If the scanning thread exited with an error, returns the error encountered.

pub async fn new_invoice( &self, piconeros: u64, confirmations_required: u64, expiration_in: u64, description: String, ) -> Result<InvoiceId, AcceptXmrError>

Adds a new Invoice to the payment gateway for tracking, and returns the ID of the new invoice. Use a Subscriber to receive updates on the new invoice invoice as they occur.

Errors

Returns an error if there are any underlying issues modifying data in the database.

pub async fn remove_invoice( &self, invoice_id: InvoiceId, ) -> Result<Option<Invoice>, AcceptXmrError>

Remove (i.e. stop tracking) invoice, returning the old invoice if it existed.

Errors

Returns an error if there are any underlying issues modifying/retrieving data in the database.

pub fn subscribe(&self, invoice_id: InvoiceId) -> Option<Subscriber>

Returns a Subscriber for the given invoice ID. If a tracked invoice exists for that ID, the subscriber can be used to receive updates for that invoice.

pub fn subscribe_all(&self) -> Subscriber

Returns a Subscriber for all invoices.

pub async fn daemon_height(&self) -> Result<u64, AcceptXmrError>

Get current height of daemon using a monero daemon remote procedure call.

Errors

Returns an error if a connection can not be made to the daemon, or if the daemon’s response cannot be parsed.

pub async fn get_invoice( &self, invoice_id: InvoiceId, ) -> Result<Option<Invoice>, AcceptXmrError>

Get the up-to-date invoice associated with the given InvoiceId, if it exists.

Errors

Returns an error if there are any underlying issues retrieving data from the database.

pub async fn get_invoice_ids(&self) -> Result<Vec<InvoiceId>, AcceptXmrError>

Get a list of all currently tracked invoice IDs.

Errors

Returns an error if there are any underlying issues retrieving data from the database.

pub fn daemon_url(&self) -> String

Returns URL of configured daemon.

Trait Implementations

impl<S: Storage, M: MonerodClient> Clone for PaymentGateway<S, M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Storage, M: MonerodClient> Deref for PaymentGateway<S, M>

type Target = PaymentGatewayInner<S, M>

The resulting type after dereferencing.

fn deref(&self) -> &PaymentGatewayInner<S, M>

Dereferences the value.