Class: HttpOvercastView

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

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

Implements

• OvercastView

Constructors

Constructor

new HttpOvercastView(config?): HttpOvercastView;

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

Parameters

Parameter	Type
config?	OvercastConfig

Returns

HttpOvercastView

Methods

getCollateralOffer()

getCollateralOffer(id): Promise<
  | WithId<CuratedCollateralOffer>
| null>;

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

Parameters

Parameter	Type
id	string

Returns

Promise< | WithId<CuratedCollateralOffer> | null>

Implementation of

OvercastView.getCollateralOffer

---

getOption()

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

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

Parameters

Parameter	Type
id	string

Returns

Promise<CuratedMarketOption | null>

Implementation of

OvercastView.getOption

---

getRfq()

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

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

Parameters

Parameter	Type
id	string

Returns

Promise<StoredRfq | null>

Implementation of

OvercastView.getRfq

---

getSettlementOffer()

getSettlementOffer(id): Promise<
  | WithId<CuratedSettlementOffer>
| null>;

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

Parameters

Parameter	Type
id	string

Returns

Promise< | WithId<CuratedSettlementOffer> | null>

Implementation of

OvercastView.getSettlementOffer

---

listAssets()

listAssets(): Promise<object[]>;

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

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

OvercastView.listAssets

---

listCollateralOffers()

listCollateralOffers(query?): Promise<Page<WithId<CuratedCollateralOffer>>>;

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

Open collateral offers, each tagged with its content-address id.

Parameters

Parameter	Type
query?	OfferQuery

Returns

Promise<Page<WithId<CuratedCollateralOffer>>>

Implementation of

OvercastView.listCollateralOffers

---

listOptions()

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

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

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

Quotes submitted against a given RFQ.

Parameters

Parameter	Type
rfqId	string
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:127

Persisted RFQs — both still-open and historical.

Parameters

Parameter	Type
query?	RfqQuery

Returns

Promise<Page<StoredRfq>>

Implementation of

OvercastView.listRfqs

---

listSettlementOffers()

listSettlementOffers(query?): Promise<Page<WithId<CuratedSettlementOffer>>>;

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

Open settlement offers, each tagged with its content-address id.

Parameters

Parameter	Type
query?	OfferQuery

Returns

Promise<Page<WithId<CuratedSettlementOffer>>>

Implementation of

OvercastView.listSettlementOffers