Interface: OvercastView
Defined in: packages/overcast-core/src/storage/index.ts:354
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
getOffer()
getOffer(id): Promise<
| WithId<CuratedOffer>
| null>;
Defined in: packages/overcast-core/src/storage/index.ts:375
Parameters
| Parameter | Type | Description |
|---|---|---|
id | Bytes32 | the offer's content-address (see getId). |
Returns
Promise<
| WithId<CuratedOffer>
| null>
getOption()
getOption(id): Promise<CuratedMarketOption | null>;
Defined in: packages/overcast-core/src/storage/index.ts:365
Parameters
| Parameter | Type | Description |
|---|---|---|
id | Bytes32 | the option's content-address (see getId). |
Returns
Promise<CuratedMarketOption | null>
getRfq()
getRfq(id): Promise<StoredRfq | null>;
Defined in: packages/overcast-core/src/storage/index.ts:390
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<StoredRfq | null>
listAssets()
listAssets(query?): Promise<object[]>;
Defined in: packages/overcast-core/src/storage/index.ts:411
The assets the deployment holds curated metadata for (GET /assets) — what
raw OptionDetails asset addresses are resolved against. Drives a
client's pick-from-list UX, symbol display and decimal scaling. Returned as
a bare list (not paged) — it is small, curated reference data, not indexed
data.
Not a permission list. An asset that is absent is uncurated, not unsupported: the protocol trades whatever an offer's terms name, so options are written over it all the same — its amounts simply render in native units against a bare address until someone describes it.
Filter by domain for one chain's assets; unfiltered returns every domain
the deployment serves, each asset tagged with its own Asset.domain.
A consumer pinned to one chain wants the filtered form — which is what
OvercastApp.assets() asks for.
Parameters
| Parameter | Type |
|---|---|
query? | AssetQuery |
Returns
Promise<object[]>
listAuthorizedKeys()
listAuthorizedKeys(query?): Promise<Page<AuthorizedKey>>;
Defined in: packages/overcast-core/src/storage/index.ts:386
Delegated signing keys, paginated and filterable — the projection of the
AuthorizedKeySet / AuthorizedKeyRemoved history. Revoked keys are
included by default; filter on active to get only the live delegations.
This is a read of on-chain authorization state, not an authorization check: it says who an account has delegated to, and the protocol still verifies every SignedOperation against the chain itself.
Parameters
| Parameter | Type |
|---|---|
query? | AuthorizedKeyQuery |
Returns
Promise<Page<AuthorizedKey>>
listOffers()
listOffers(query?): Promise<Page<WithId<CuratedOffer>>>;
Defined in: packages/overcast-core/src/storage/index.ts:373
Offers, each tagged with its content-address id and its lifecycle
OfferStatus. Matched and cancelled offers are included by default;
filter on status for just the open book (open) or just the history
(closed).
Parameters
| Parameter | Type |
|---|---|
query? | OfferQuery |
Returns
Promise<Page<WithId<CuratedOffer>>>
listOptions()
listOptions(query?): Promise<Page<CuratedMarketOption>>;
Defined in: packages/overcast-core/src/storage/index.ts:363
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:392
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:389
Persisted RFQs — both still-open and historical.
Parameters
| Parameter | Type |
|---|---|
query? | RfqQuery |
Returns
listUserDeposits()
listUserDeposits(query?): Promise<Page<UserDepositWire>>;
Defined in: packages/overcast-core/src/storage/index.ts:359
Live vault balances, paginated and filterable. Still uncurated — canonical slots and a decimal-string amount (UserDepositWire).
Parameters
| Parameter | Type |
|---|---|
query? | UserDepositQuery |
Returns
Promise<Page<UserDepositWire>>