Liking cljdoc? Tell your friends :D

monero-store.schema

Malli value objects for the storefront domain.

Single source for m/=> contracts and schema-driven test synthesis. Nothing here names a payment provider: a rail is identified by a keyword the registry knows, so adding one never edits this namespace.

Malli value objects for the storefront domain.

Single source for `m/=>` contracts and schema-driven test synthesis. Nothing
here names a payment provider: a rail is identified by a keyword the registry
knows, so adding one never edits this namespace.
raw docstring

ChargeHandleclj

What a rail hands back so the customer can complete payment.

:handle/pay-to is an address to send to; :handle/redirect-url a hosted page to visit. A rail supplies whichever it has, and both may be present.

What a rail hands back so the customer can complete payment.

`:handle/pay-to` is an address to send to; `:handle/redirect-url` a hosted
page to visit. A rail supplies whichever it has, and both may be present.
sourceraw docstring

ChargeRequestclj

What a rail needs to open a payment. :charge/amount is the amount locked for this invoice, in the rail's own currency.

What a rail needs to open a payment. `:charge/amount` is the amount locked
for this invoice, in the rail's own currency.
sourceraw docstring

check!clj

(check! schema value)
(check! schema value ctx)

value when it satisfies schema.

Throws ExceptionInfo (:monero-store/error :schema-violation) carrying a humanized explanation merged with ctx otherwise.

`value` when it satisfies `schema`.

Throws ExceptionInfo (`:monero-store/error :schema-violation`) carrying a
humanized explanation merged with `ctx` otherwise.
sourceraw docstring

CheckoutSessionclj

One hosted checkout as its processor reports it. The unit of evidence a processor rail settles from.

:checkout/status is the session's own lifecycle (open, complete, expired) and :checkout/payment-status whether the money arrived; a session can be complete without being paid.

One hosted checkout as its processor reports it. The unit of evidence a
processor rail settles from.

`:checkout/status` is the session's own lifecycle (open, complete, expired)
and `:checkout/payment-status` whether the money arrived; a session can be
complete without being paid.
sourceraw docstring

CheckoutStateclj

A CheckoutState ADT value. Its variants come from the sum, as above.

A CheckoutState ADT value. Its variants come from the sum, as above.
sourceraw docstring

CurrencyIdclj

A currency the registry knows. Unregistered ids are not money.

A currency the registry knows. Unregistered ids are not money.
sourceraw docstring

Customerclj

Whoever is paying. :customer/ref is the id the host application knows them by; this store never authenticates anyone itself.

Whoever is paying. `:customer/ref` is the id the host application knows them
by; this store never authenticates anyone itself.
sourceraw docstring

Endpointclj

A service the store must be able to reach to settle through it.

A service the store must be able to reach to settle through it.
sourceraw docstring

Fulfilmentclj

What the host application was told to hand over, and when.

What the host application was told to hand over, and when.
sourceraw docstring

HexStringclj

source

Instantclj

source

Invoiceclj

A payment opened for one item.

The quote keys are present only when the amount was converted from the item's stored price: they record the rate that was locked, who agreed it, and when the lock lapses.

A payment opened for one item.

The quote keys are present only when the amount was converted from the item's
stored price: they record the rate that was locked, who agreed it, and when
the lock lapses.
sourceraw docstring

InvoiceStatusclj

source

Itemclj

One sellable thing. :item/metadata is the host application's — this store stores it, correlates on it, and never reads it.

One sellable thing. `:item/metadata` is the host application's — this store
stores it, correlates on it, and never reads it.
sourceraw docstring

ItemIdclj

source

moneyclj

(money currency amount)

Money of amount minor units in currency, at that currency's scale.

Throws ExceptionInfo for an unregistered currency, or when the result does not satisfy Money.

Money of `amount` minor units in `currency`, at that currency's scale.

Throws ExceptionInfo for an unregistered currency, or when the result does
not satisfy Money.
sourceraw docstring

Moneyclj

An exact amount of one currency: :money/amount integer minor units at :money/scale decimal places. Scale is the currency's, never the caller's.

An exact amount of one currency: `:money/amount` integer minor units at
`:money/scale` decimal places. Scale is the currency's, never the caller's.
sourceraw docstring

NonBlankclj

source

Pairclj

[base quote]. A price on this pair is how many quote minor-unit-free units one whole base unit costs.

[base quote]. A price on this pair is how many `quote` minor-unit-free units
one whole `base` unit costs.
sourceraw docstring

Paymentclj

One observed movement of money against one invoice, recorded once.

One observed movement of money against one invoice, recorded once.
sourceraw docstring

PaymentResolutionclj

What the store was able to do with an observed movement of money.

What the store was able to do with an observed movement of money.
sourceraw docstring

Periodclj

How long one purchase of a recurring item lasts. :once never renews.

How long one purchase of a recurring item lasts. `:once` never renews.
sourceraw docstring

PositiveNumberclj

source

ProviderIdclj

Id of a registered payment rail. Deliberately open: a new rail is a registry entry, not an edit to this enum.

Id of a registered payment rail. Deliberately open: a new rail is a registry
entry, not an edit to this enum.
sourceraw docstring

ProviderProfileclj

Measured, swappable behaviour of a payment rail. The DIP swap point.

:provider/settlement-poll? says whether the rail can be asked, unprompted, what it has seen — a rail with no way to call the store must be polled or it never settles at all. :provider/webhook-auth says how, if at all, a notice it posts can be authenticated.

Measured, swappable behaviour of a payment rail. The DIP swap point.

`:provider/settlement-poll?` says whether the rail can be asked, unprompted,
what it has seen — a rail with no way to call the store must be polled or it
never settles at all. `:provider/webhook-auth` says how, if at all, a notice
it posts can be authenticated.
sourceraw docstring

Quoteclj

A stored price converted to another currency and locked for one invoice.

:quote/sources names every source that agreed the rate, so a past charge stays auditable after the sources have moved on.

A stored price converted to another currency and locked for one invoice.

`:quote/sources` names every source that agreed the rate, so a past charge
stays auditable after the sources have moved on.
sourceraw docstring

Rateclj

One source's price for one pair, as that source reported it.

One source's price for one pair, as that source reported it.
sourceraw docstring

RateSourceIdclj

Id of an independent price source.

Id of an independent price source.
sourceraw docstring

Reachabilityclj

A Reachability ADT value. Variants are read off the sum itself.

A Reachability ADT value. Variants are read off the sum itself.
sourceraw docstring

ReachabilityReportclj

What one probe of one endpoint found.

What one probe of one endpoint found.
sourceraw docstring

ReachabilitySummaryclj

One round of probes over every endpoint a deployment must reach.

One round of probes over every endpoint a deployment must reach.
sourceraw docstring

Settlementclj

Normalized result of interpreting what a rail has seen.

:settlement/references names the individual movements behind the amount. :settlement/suspect? says a movement was seen and rejected; it contributes no funds, and a rail that cannot observe such a thing omits the key.

Normalized result of interpreting what a rail has seen.

`:settlement/references` names the individual movements behind the amount.
`:settlement/suspect?` says a movement was seen and rejected; it contributes
no funds, and a rail that cannot observe such a thing omits the key.
sourceraw docstring

SettlementOutcomeclj

A SettlementOutcome ADT value. Variants are read off the sum itself.

A SettlementOutcome ADT value. Variants are read off the sum itself.
sourceraw docstring

SettlementStatusclj

source

Subaddressclj

An address opened for one invoice.

An address opened for one invoice.
sourceraw docstring

WalletObservationclj

What a wallet reports for one address at a point in time. The unit of evidence a chain rail settles from.

:wallet/unlocked-amount is the wallet's own view of what is spendable; a wallet more permissive than this store's confirmation policy can never widen the gate, so the two are taken together and the smaller wins.

What a wallet reports for one address at a point in time. The unit of
evidence a chain rail settles from.

`:wallet/unlocked-amount` is the wallet's own view of what is spendable; a
wallet more permissive than this store's confirmation policy can never widen
the gate, so the two are taken together and the smaller wins.
sourceraw docstring

WalletTransferclj

One incoming transfer a wallet has seen for an address.

One incoming transfer a wallet has seen for an address.
sourceraw docstring

WebhookNoticeclj

A settlement notice as received at the HTTP boundary.

A settlement notice as received at the HTTP boundary.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close