Interface: OvercastView
Defined in: packages/overcast-core/src/storage/index.ts:233
The non-permissioned read surface, returning curated (display, JSON-safe) shapes. This is the interface shared across backend and frontend: a database implementation runs the query in-process, while a thin HTTP implementation in the frontend serializes the same query objects to the backend. Keep every argument and result JSON-serializable so both implementations stay honest.
Methods
getCollateralOffer()
getCollateralOffer(id): Promise<
| WithId<CuratedCollateralOffer>
| null>;
Defined in: packages/overcast-core/src/storage/index.ts:242
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<
| WithId<CuratedCollateralOffer>
| null>
getOption()
getOption(id): Promise<CuratedMarketOption | null>;
Defined in: packages/overcast-core/src/storage/index.ts:236
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<CuratedMarketOption | null>
getRfq()
getRfq(id): Promise<StoredRfq | null>;
Defined in: packages/overcast-core/src/storage/index.ts:252
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<StoredRfq | null>
getSettlementOffer()
getSettlementOffer(id): Promise<
| WithId<CuratedSettlementOffer>
| null>;
Defined in: packages/overcast-core/src/storage/index.ts:248
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<
| WithId<CuratedSettlementOffer>
| null>
listAssets()
listAssets(): Promise<object[]>;
Defined in: packages/overcast-core/src/storage/index.ts:263
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[]>
listCollateralOffers()
listCollateralOffers(query?): Promise<Page<WithId<CuratedCollateralOffer>>>;
Defined in: packages/overcast-core/src/storage/index.ts:239
Open collateral offers, each tagged with its content-address id.
Parameters
| Parameter | Type |
|---|---|
query? | OfferQuery |
Returns
Promise<Page<WithId<CuratedCollateralOffer>>>
listOptions()
listOptions(query?): Promise<Page<CuratedMarketOption>>;
Defined in: packages/overcast-core/src/storage/index.ts:235
Curated market options, paginated and filterable.
Parameters
| Parameter | Type |
|---|---|
query? | OptionQuery |
Returns
Promise<Page<CuratedMarketOption>>
listQuotes()
listQuotes(rfqId, page?): Promise<Page<StoredQuote>>;
Defined in: packages/overcast-core/src/storage/index.ts:254
Quotes submitted against a given RFQ.
Parameters
| Parameter | Type |
|---|---|
rfqId | string |
page? | Pagination |
Returns
Promise<Page<StoredQuote>>
listRfqs()
listRfqs(query?): Promise<Page<StoredRfq>>;
Defined in: packages/overcast-core/src/storage/index.ts:251
Persisted RFQs — both still-open and historical.
Parameters
| Parameter | Type |
|---|---|
query? | RfqQuery |
Returns
listSettlementOffers()
listSettlementOffers(query?): Promise<Page<WithId<CuratedSettlementOffer>>>;
Defined in: packages/overcast-core/src/storage/index.ts:245
Open settlement offers, each tagged with its content-address id.
Parameters
| Parameter | Type |
|---|---|
query? | OfferQuery |
Returns
Promise<Page<WithId<CuratedSettlementOffer>>>