How to write payment driver
This document aims to provide guidelines to developing a payment driver based on boilerplate code from the Yagna repository. It assumes the reader has some experience in the Rust language and also the Yagna project's codebase. We're providing an information for payment driver that will be integrated into the Yagna daemon codebase and gains from reusing a lot of already provided components. It's also possible to develop stand-alone driver application that communicates with the Yagna daemon via socket, but it won't be described here.
The payment service of the Yagna daemon expects that payment driver will handle all communication with any particular L2 network provider (but it's not limited to the Ethereum ecosystem). You might assume that payment driver should:
- Communicate with daemon services over Golem Service Bus (GSB),
- Provide operation like deposits, exits, transfer, account unlocking,
- Delegate transaction's signing to the Identity service,
- Notify Payment service about committed transactions,
- Retry operations that failed due to non-critical causes.
Here is a checklist that driver implementors would want to follow:
- Fork the Yagna repository and clone it locally to start working on the code,
- Create a new crate for your driver in the
- Implement all methods from the
PaymentDrivertrait. Some of them are described in the section below,
- Your implementation can also benefit from database handling code and background tasks in the
cronmodule, but it is not mandatory to use them,
- Make a new driver build and start with the Yagna daemon. See instructions below.
- Test and verify it's working using the instructions from the section below.
- Send us a Pull Request.
core/payment-driver/base- base driver components which defines the database schema and operations, registers to GSB events, help with creation of background jobs and some utility code.
core/payment-driver/base/driver.rs- declares a Rust's trait that a new driver has to implement
core/payment-driver/base/cron.rs- declares a driver's periodical operation trait. It's optional to use it.
core/payment-driver/base/bus.rs- declares the driver's operations to other daemon services, e.g.
core/payment-driver/base/dao- handy functions to DB (sqlite) interaction. It's optional to use it.
Let's see what a driver's trait exposes:
init- Initializes the account to be used with the driver service. After successful intialization the account should be ready to send and/or receive payments (depending on the
modeparameter). It should call
bus::register_accountto notify Payment service about the driver readiness. Driver should be able to handle multiple accounts. Called by CLI.
enter- Deposits the funds from Ethereum L1 into the driver's supported network. Called by CLI.
exit- Exits the funds outside the driver's supported network (most likely to L1). Called by CLI.
get_account_balance- Gets the balance of the account.
transfer- Transfers the funds between specified accounts. Called by CLI.
fund- Funds the account from faucet when run on testnet. Provides instructions how to fund on mainnet.
schedule_payment- Schedules the payment between specified accounts. Payments are processed by the
cronjob. Payment tracking is done by cron job, see:
PaymentDriverCron::confirm_payments. Returns an
order_id. See also
verify_payment- Verifies the payment transaction specified by transaction's confirmation (transaction's identifier).
validate_allocation- Validates that allocated funds are still sufficient to cover the costs of the task (including the transaction fees, e.g. Ethereum's Gas). Allocation is created when the requestor publishes the task on the market.
account_event- Called by the Identity service to notify the driver that specified account is locked / unlocked. Identity service holds accounts private keys and signs transactions.
recv_init_required- Tells whether account initialization is needed for receiving payments.
sign_payment- Signs Yagna's payment message with the same key that was used to sign the blockchain transaction. Driver trait provides a default implementation of this method so it's not required to implement it.
verify_signature- Verifies the signature on payment message (see
sign_payment). Driver trait provides a default implementation of this method so it's not required to implement it.
get_name- Returns driver's name. It should be lowercase, ASCII-only with no whitespace.
get_networks- Returns networks supported by the driver (e.g. mainnet, rinkeby, ropsten).
get_default_network- Returns default network for the dirver. It should be one of the networks returned by
shut_down- Performs all neccesary shutdown routines. It is recommended that the driver sends out all pending transactions on shutdown.
The following driver's operations are processed periodically by the cron jobs. It is not mandatory to implement
PaymentDriverCrontrait as long as the driver can operate without the cron.
confirm_payments- Confirms scheduled payments.
process_payments- Processes scheduled payments.
The payment driver receives all requests via the GSB. This is also a communication channel to call other services. See
register_account- Notifies the Payment service that the account is ready to sending / receiving funds. See
sign- Delegates signing of the transaction's payload to the Identity service.
notify_payment- Notifies the Payment service that the scheduled payment is processed successfully. It also links the
confirmation(e.g. transaction's hash). See
schedule_paymentabove. This notification leads to
verify_paymentcall on the provider side.
Add a new block in
start_payment_driversfunction in the
core/serv/src/main.rsfile. It should follow the convention and declares its own compilation flag. Don't forget to set this flag during the compilation :wink:.
When you consider your work done, take some time to actually see it in action. Be sure we will scrupulously test the driver behavior in the following scenarios, including the error messages written in logs and returned from CLI. Don't hesitate to ask questions, we are here to help.
We will run the following tests (happy paths and providing invalid parameters to make it fail).
- 2.Start an example payment service (each test assumes running from scratch)
rm payment.db* && cargo run --example payment_api -- --driver=<DRIVER> --platform=<PLATFORM>
- 3.Start invoice flow example (restart above
platform_apion each test)
cargo run --example invoice_flow -- --platform=<PLATFORM>
- 4.Start debit note flow example (restart above
platform_apion each test)
cargo run --example debit_note_flow -- --platform=<PLATFORM>
- 5.Don't be afraid to try the other examples as well ;)