Interface Rates

Supplies fixed CREDIT-to-USD rates from an audited source, never from config or caller input; the three rates always hold buy >= par >= payout.

See

The money model for what buy/par/payout mean, why the ordering holds, and what the spread funds.
Rates for the port and its configured adapter.

interface Rates {
    buy(currency: Currency): Rate;
    par(currency: Currency): Rate;
    payout(
        from: Currency,
        to: Currency,
        at: number,
        options?: CallOptions,
    ): Promise<Rate>;
}

Index

Methods

Methods

buy

buy(currency: Currency): Rate
The acquisition rate a user pays for credits; topUp values the buyer's cash at it.
Parameters
- currency: Currency
Returns Rate
- Defined in src/ports.ts:283

par

par(currency: Currency): Rate
The redemption and backing rate; reconciliation values spendable credits in USD at it.
Parameters
- currency: Currency
Returns Rate
- Defined in src/ports.ts:280

payout

payout(
    from: Currency,
    to: Currency,
    at: number,
    options?: CallOptions,
): Promise<Rate>
The payout rate at time at, which a cash-out converts credits at; at or below par, never above.
Parameters
- from: Currency
- to: Currency
- at: number
- Optionaloptions: CallOptions
Returns Promise<Rate>
- Defined in src/ports.ts:272