Class: HttpOvercastView

Defined in: packages/overcast-core/src/storage/http.ts:76

An OvercastView backed by the Overcast backend's REST API.

The backend serves every domain it indexes, so an unscoped list spans all of them. This view is built from one app's OvercastConfig, so it scopes every list to that config's OvercastConfig.domain by default — see scope for how to widen a single query back out.

Implements

• OvercastView

Constructors

Constructor

new HttpOvercastView(config?): HttpOvercastView;

Defined in: packages/overcast-core/src/storage/http.ts:82

Parameters

Parameter	Type
config?	OvercastConfig

Returns

HttpOvercastView

Methods

getOffer()

getOffer(id): Promise<
  | WithId<CuratedOffer>
| null>;

Defined in: packages/overcast-core/src/storage/http.ts:133

Parameters

Parameter	Type	Description
id	Bytes32	the offer's content-address (see getId).

Returns

Promise< | WithId<CuratedOffer> | null>

Implementation of

OvercastView.getOffer

---

getOption()

getOption(id): Promise<CuratedMarketOption | null>;

Defined in: packages/overcast-core/src/storage/http.ts:120

Parameters

Parameter	Type	Description
id	Bytes32	the option's content-address (see getId).

Returns

Promise<CuratedMarketOption | null>

Implementation of

OvercastView.getOption

---

getRfq()

getRfq(id): Promise<StoredRfq | null>;

Defined in: packages/overcast-core/src/storage/http.ts:165

Parameters

Parameter	Type
id	Bytes32

Returns

Promise<StoredRfq | null>

Implementation of

OvercastView.getRfq

---

listAssets()

listAssets(query?): Promise<object[]>;

Defined in: packages/overcast-core/src/storage/http.ts:178

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[]>

Implementation of

OvercastView.listAssets

---

listAuthorizedKeys()

listAuthorizedKeys(query?): Promise<Page<AuthorizedKey>>;

Defined in: packages/overcast-core/src/storage/http.ts:139

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>>

Implementation of

OvercastView.listAuthorizedKeys

---

listOffers()

listOffers(query?): Promise<Page<WithId<CuratedOffer>>>;

Defined in: packages/overcast-core/src/storage/http.ts:126

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>>>

Implementation of

OvercastView.listOffers

---

listOperations()

listOperations(query?): Promise<Page<ConsumedOperation>>;

Defined in: packages/overcast-core/src/storage/http.ts:150

Delegated operations' replay-protection records, paginated and filterable — the projection of OperationConsumed / OperationReplayProtectionKeyCleared. Sorted by expiry ascending by default, so a expired: true, cleared: false page is a ready-made oldest-first sweep of on-chain replay-protection state to reclaim.

Parameters

Parameter	Type
query?	OperationQuery

Returns

Promise<Page<ConsumedOperation>>

Implementation of

OvercastView.listOperations

---

listOptions()

listOptions(query?): Promise<Page<CuratedMarketOption>>;

Defined in: packages/overcast-core/src/storage/http.ts:113

Curated market options, paginated and filterable.

Parameters

Parameter	Type
query?	OptionQuery

Returns

Promise<Page<CuratedMarketOption>>

Implementation of

OvercastView.listOptions

---

listQuotes()

listQuotes(rfqId, page?): Promise<Page<StoredQuote>>;

Defined in: packages/overcast-core/src/storage/http.ts:169

Quotes submitted against a given RFQ.

Parameters

Parameter	Type
rfqId	Bytes32
page?	Pagination

Returns

Promise<Page<StoredQuote>>

Implementation of

OvercastView.listQuotes

---

listRfqs()

listRfqs(query?): Promise<Page<StoredRfq>>;

Defined in: packages/overcast-core/src/storage/http.ts:161

Persisted RFQs — both still-open and historical.

Parameters

Parameter	Type
query?	RfqQuery

Returns

Promise<Page<StoredRfq>>

Implementation of

OvercastView.listRfqs

---

listUserDeposits()

listUserDeposits(query?): Promise<Page<UserDepositWire>>;

Defined in: packages/overcast-core/src/storage/http.ts:102

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>>

Implementation of

OvercastView.listUserDeposits