Class: MemoryStore
Defined in: packages/overcast-core/src/storage/memory.ts:57
In-memory reference implementation of the storage ports. Backs both the trusted write side (OvercastStore) and the public read side (OvercastView); a real deployment swaps this for a database-backed store implementing the same interfaces.
Reads return curated (display) shapes, so the store is constructed with an AssetRegistry used to resolve asset addresses to metadata on the way out. Filtering, sorting and pagination are done in JS here — the same query objects a SQL implementation would push down to the database.
Implements
Constructors
Constructor
new MemoryStore(registry?): MemoryStore;
Defined in: packages/overcast-core/src/storage/memory.ts:84
Parameters
| Parameter | Type |
|---|---|
registry | AssetRegistry |
Returns
MemoryStore
Properties
checkpoints
checkpoints: Map<CheckpointKind, Checkpoint>;
Defined in: packages/overcast-core/src/storage/memory.ts:58
collateralOffers
collateralOffers: Map<string, CollateralOffer>;
Defined in: packages/overcast-core/src/storage/memory.ts:71
offerClosed
offerClosed: Map<string, OfferClosed>;
Defined in: packages/overcast-core/src/storage/memory.ts:63
offerCreated
offerCreated: Map<string, OfferCreated>;
Defined in: packages/overcast-core/src/storage/memory.ts:61
Indexed *Created events, retained for their createdAt (checkpoint ts).
optionCreated
optionCreated: Map<string, OptionCreated>;
Defined in: packages/overcast-core/src/storage/memory.ts:62
optionExercised
optionExercised: Map<string, OptionExercised[]>;
Defined in: packages/overcast-core/src/storage/memory.ts:65
Exercise / redeem events, keyed by the option id they belong to.
optionRedeemed
optionRedeemed: Map<string, OptionRedeemed[]>;
Defined in: packages/overcast-core/src/storage/memory.ts:66
options
options: Map<string, MarketOption>;
Defined in: packages/overcast-core/src/storage/memory.ts:69
Derived current-state projections.
quotes
quotes: Map<string, StoredQuote>;
Defined in: packages/overcast-core/src/storage/memory.ts:75
rfqs
rfqs: Map<string, StoredRfq>;
Defined in: packages/overcast-core/src/storage/memory.ts:74
Off-chain RFQ channel, persisted for after-the-fact fetches.
settlementOffers
settlementOffers: Map<string, SettlementOffer>;
Defined in: packages/overcast-core/src/storage/memory.ts:70
Methods
getCheckpoint()
getCheckpoint(kind): Promise<Checkpoint | null>;
Defined in: packages/overcast-core/src/storage/memory.ts:162
The indexer's resume cursor for the given loop (see CheckpointKind).
Parameters
| Parameter | Type |
|---|---|
kind | CheckpointKind |
Returns
Promise<Checkpoint | null>
Implementation of
OvercastStorage.getCheckpoint
getCollateralOffer()
getCollateralOffer(id): Promise<
| WithId<CuratedCollateralOffer>
| null>;
Defined in: packages/overcast-core/src/storage/memory.ts:245
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<
| WithId<CuratedCollateralOffer>
| null>
Implementation of
OvercastStorage.getCollateralOffer
getOption()
getOption(id): Promise<CuratedMarketOption | null>;
Defined in: packages/overcast-core/src/storage/memory.ts:221
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<CuratedMarketOption | null>
Implementation of
OvercastStorage.getOption
getOptionExercised()
getOptionExercised(option): Promise<OptionExercised[]>;
Defined in: packages/overcast-core/src/storage/memory.ts:311
Parameters
| Parameter | Type |
|---|---|
option | string |
Returns
Promise<OptionExercised[]>
Implementation of
OvercastEventHistory.getOptionExercised
getOptionRedeemed()
getOptionRedeemed(option): Promise<OptionRedeemed[]>;
Defined in: packages/overcast-core/src/storage/memory.ts:314
Parameters
| Parameter | Type |
|---|---|
option | string |
Returns
Promise<OptionRedeemed[]>
Implementation of
OvercastEventHistory.getOptionRedeemed
getOptionTotals()
getOptionTotals(option): Promise<OptionTotals>;
Defined in: packages/overcast-core/src/storage/memory.ts:317
Parameters
| Parameter | Type |
|---|---|
option | string |
Returns
Promise<OptionTotals>
Implementation of
OvercastEventHistory.getOptionTotals
getRfq()
getRfq(id): Promise<StoredRfq | null>;
Defined in: packages/overcast-core/src/storage/memory.ts:292
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<StoredRfq | null>
Implementation of
OvercastStorage.getRfq
getSettlementOffer()
getSettlementOffer(id): Promise<
| WithId<CuratedSettlementOffer>
| null>;
Defined in: packages/overcast-core/src/storage/memory.ts:268
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<
| WithId<CuratedSettlementOffer>
| null>
Implementation of
OvercastStorage.getSettlementOffer
insertEvents()
insertEvents(events): Promise<void>;
Defined in: packages/overcast-core/src/storage/memory.ts:90
Insert a batch of indexed on-chain events, updating the derived offer / option / totals projections. Idempotent per event so re-indexing a range is safe.
Parameters
| Parameter | Type |
|---|---|
events | IndexedEvents[] |
Returns
Promise<void>
Implementation of
OvercastStorage.insertEvents
listAssets()
listAssets(): Promise<object[]>;
Defined in: packages/overcast-core/src/storage/memory.ts:303
The backend's asset allowlist (GET /assets) — the curated metadata that
raw OptionDetails asset addresses are resolved against. Drives a
client's pick-from-list UX and symbol display; the backend rejects any
RFQ / quote / offer over an asset absent from this list. Returned as a bare
list (not paged) — it is a small, fixed allowlist, not indexed data.
Returns
Promise<object[]>
Implementation of
OvercastStorage.listAssets
listCollateralOffers()
listCollateralOffers(query?): Promise<Page<WithId<CuratedCollateralOffer>>>;
Defined in: packages/overcast-core/src/storage/memory.ts:231
Open collateral offers, each tagged with its content-address id.
Parameters
| Parameter | Type |
|---|---|
query? | OfferQuery |
Returns
Promise<Page<WithId<CuratedCollateralOffer>>>
Implementation of
OvercastStorage.listCollateralOffers
listOptions()
listOptions(query?): Promise<Page<CuratedMarketOption>>;
Defined in: packages/overcast-core/src/storage/memory.ts:180
Curated market options, paginated and filterable.
Parameters
| Parameter | Type |
|---|---|
query? | OptionQuery |
Returns
Promise<Page<CuratedMarketOption>>
Implementation of
OvercastStorage.listOptions
listQuotes()
listQuotes(rfqId, page?): Promise<Page<StoredQuote>>;
Defined in: packages/overcast-core/src/storage/memory.ts:296
Quotes submitted against a given RFQ.
Parameters
| Parameter | Type |
|---|---|
rfqId | string |
page? | Pagination |
Returns
Promise<Page<StoredQuote>>
Implementation of
OvercastStorage.listQuotes
listRfqs()
listRfqs(query?): Promise<Page<StoredRfq>>;
Defined in: packages/overcast-core/src/storage/memory.ts:277
Persisted RFQs — both still-open and historical.
Parameters
| Parameter | Type |
|---|---|
query? | RfqQuery |
Returns
Implementation of
OvercastStorage.listRfqs
listSettlementOffers()
listSettlementOffers(query?): Promise<Page<WithId<CuratedSettlementOffer>>>;
Defined in: packages/overcast-core/src/storage/memory.ts:254
Open settlement offers, each tagged with its content-address id.
Parameters
| Parameter | Type |
|---|---|
query? | OfferQuery |
Returns
Promise<Page<WithId<CuratedSettlementOffer>>>
Implementation of
OvercastStorage.listSettlementOffers
recordQuote()
recordQuote(quote): Promise<void>;
Defined in: packages/overcast-core/src/storage/memory.ts:133
Persist (or update) an off-chain quote submitted against an RFQ.
Parameters
| Parameter | Type |
|---|---|
quote | StoredQuote |
Returns
Promise<void>
Implementation of
OvercastStorage.recordQuote
recordRfq()
recordRfq(rfq): Promise<void>;
Defined in: packages/overcast-core/src/storage/memory.ts:128
Persist (or update) an off-chain RFQ so it is fetchable after the fact.
Parameters
| Parameter | Type |
|---|---|
rfq | StoredRfq |
Returns
Promise<void>
Implementation of
OvercastStorage.recordRfq
setCheckpoint()
setCheckpoint(kind, checkpoint): Promise<void>;
Defined in: packages/overcast-core/src/storage/memory.ts:167
Parameters
| Parameter | Type |
|---|---|
kind | CheckpointKind |
checkpoint | Checkpoint | null |
Returns
Promise<void>
Implementation of
OvercastStorage.setCheckpoint
setQuoteStatus()
setQuoteStatus(
quoteId,
status,
optionId?): Promise<void>;
Defined in: packages/overcast-core/src/storage/memory.ts:149
Transition a quote to a new status (and bind its optionId once accepted),
stamping updatedAt. No-op if the quote is unknown.
Parameters
| Parameter | Type |
|---|---|
quoteId | string |
status | QuoteStatus |
optionId? | string |
Returns
Promise<void>
Implementation of
OvercastStorage.setQuoteStatus
setRfqStatus()
setRfqStatus(rfqId, status): Promise<void>;
Defined in: packages/overcast-core/src/storage/memory.ts:141
Transition a persisted RFQ to a new lifecycle status, stamping updatedAt.
A cheaper alternative to reconstructing the whole StoredRfq for a
recordRfq upsert. No-op if the RFQ is unknown.
Parameters
| Parameter | Type |
|---|---|
rfqId | string |
status | RfqStatus |
Returns
Promise<void>
Implementation of
OvercastStorage.setRfqStatus