Interface SpendAdmission

What an admission asks for: its kind, its largest cost, when it starts and until when, and the cap it must fit under.

interface SpendAdmission {
    kind: string;
    micro: number;
    at: Date;
    expires: Date;
    capMicro: number;
    requireFence?: boolean;
}

Hierarchy (view full)

Properties

kind: string

What is admitted, such as session or call; the store records it and a refusal names it.

micro: number

Its largest cost in whole micro-dollars, zero or more.

at: Date

When it starts, a valid date; the reservation belongs to this time's UTC day.

expires: Date

When the reservation's time is up, a valid date, after which releaseExpiredSpend settles it: at its whole amount, or as the sweep's resolver decides when it has one.

capMicro: number

The day's cap for this admission in whole micro-dollars, zero or more: the whole limit, or a share of it for a class of admission. Any other cap, infinity included, refuses the admission.

requireFence?: boolean

A reservation only a sweep with a resolver may settle once its time is up; see releaseExpiredSpend.