XRPL.Payment (xrpl v1.0.0)
XRPL.Payment is a module to interact with payment modules on the XRP Ledger.
Payment channels are a tool for facilitating repeated, unidirectional payments, or temporary credit between two parties. Use these methods to work with payment channels.
Official documentation: https://xrpl.org/payment-channel-methods.html
Summary
Functions
Builds a changeset from the schema and params.
The channel_authorize method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
The channel_verify method verifies a signature that can be used to redeem a specific amount of XRP from a payment channel.
Returns the validated parameters or an error changeset.
Returns the validated parameters or an error changeset.
Expects a schema to be defined with defparams.
Functions
changeset(name, params \\ %{}, opts \\ [])
Builds a changeset from the schema and params.
channel_authorize(params)
The channel_authorize method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_authorize/
channel_authorize!(params)
channel_verify(params)
The channel_verify method verifies a signature that can be used to redeem a specific amount of XRP from a payment channel.
Official documentation: https://xrpl.org/docs/references/http-websocket-apis/public-api-methods/payment-channel-methods/channel_verify/
channel_verify!(params)
schema(binary)
validate(changeset)
@spec validate(changeset()) :: {:ok, params()} | {:error, changeset()}
Returns the validated parameters or an error changeset.
validate(name, params \\ %{}, opts \\ [])
@spec validate(name(), params(), opts()) :: {:ok, params()} | {:error, changeset()}
Returns the validated parameters or an error changeset.
Expects a schema to be defined with defparams.