clboss/Boltz/Service.hpp

#ifndef BOLTZ_SERVICE_HPP
#define BOLTZ_SERVICE_HPP

#include<cstdint>
#include<memory>
#include<string>

namespace Boltz { struct SwapInfo; }
namespace Ev { template<typename a> class Io; }
namespace Ln { class Amount; }

namespace Boltz {

/** class Boltz::Service
 *
 * @brief represents a particular BOLTZ
 * instance.
 *
 * @desc we are only interested in the
 * "reverse submarine" service, i.e.
 * offchain-to-onchain swap.
 */
class Service {
public:
	virtual ~Service() {}

	/** Boltz::Service::on_block
	 *
	 * @brief call this at every block in order
	 * to ensure that swaps complete correctly.
	 */
	virtual
	Ev::Io<void> on_block(std::uint32_t) =0;

	/** Boltz::Service::get_quotation
	 *
	 * @brief Return how much will be deducted
	 * from the given amount in order to appear
	 * onchain.
	 *
	 * @desc this only considers fees charged by
	 * the BOLTZ instance, and not to claim
	 * it and put it into unilateral control.
	 *
	 * @return `nullptr` if quoting failed,
	 * or a pointer to the amount to be deducted
	 * otherwise.
	 */
	virtual
	Ev::Io<std::unique_ptr<Ln::Amount>>
	get_quotation(Ln::Amount) =0;

	/** Boltz::Service::swap
	 *
	 * @brief create a reverse submarine swap
	 * paying out to the given address.
	 *
	 * @return the swap information.
	 * The invoice of the swap is an empty string
	 * if setting up fails, otherwise the swap
	 * succeeds.
	 *
	 * @desc if paying the invoice fails, the
	 * swap should be considered as automatically
	 * cancelled.
	 * The invoice has an expiry, after which it
	 * must no longer be paid.
	 */
	virtual
	Ev::Io<SwapInfo>
	swap( Ln::Amount
	    , std::string onchain_address
	    , std::uint32_t current_blockheight
	    ) =0;
};

}

#endif /* !defined(BOLTZ_SERVICE_HPP) */