Skip to main content

Type Alias: OvercastConfig<N>

type OvercastConfig<N> = object;

Defined in: packages/overcast-core/src/config.ts:15

Connection, identity and backend configuration for one chain.

Type Parameters​

Type ParameterDefault typeDescription
N extends ChainNameChainNamethe chain's ChainName, as a literal on a configured config (OvercastConfig<"base">). Defaults to the open ChainName, which is what the chain-agnostic consumers (the protocol signer, the RFQ client, the HTTP view) want: none of them reads the name.

Properties​

ackTimeoutMs?​

optional ackTimeoutMs?: number;

Defined in: packages/overcast-core/src/config.ts:67

How long (ms) to wait for a server ack on request/response calls before failing with an INTERNAL RfqError. Optional — defaults to 10s.

apiKey?​

optional apiKey?: string;

Defined in: packages/overcast-core/src/config.ts:61

The API Key used for authentication against the backend

axios?​

optional axios?: CreateAxiosDefaults;

Defined in: packages/overcast-core/src/config.ts:75

Extra axios defaults merged into the HTTP client backing the read-only OvercastView (see HttpOvercastView). Use it for headers, timeouts, auth interceptors, proxies, etc. baseURL is always derived from backend and cannot be overridden here.

backend?​

optional backend?: string;

Defined in: packages/overcast-core/src/config.ts:29

backend service of overcast. Optional — relayers (the backend itself) have none, and no client currently reads it.

chainName​

chainName: N;

Defined in: packages/overcast-core/src/config.ts:19

The name this chain is filed under

domain​

domain: number;

Defined in: packages/overcast-core/src/config.ts:23

The domain of the overcast app.

overcastApi?​

optional overcastApi?: OvercastView;

Defined in: packages/overcast-core/src/config.ts:80

Optional api client that will be used instead of the default HttpOvercastView that hits the REST backend

owner?​

optional owner?: Address;

Defined in: packages/overcast-core/src/config.ts:51

The wallet address the app acts as when it holds no key of its own or a different one. Automatically set to the chainSigner's address if owner is not present. Either chainSigner or owner is required

privateKey?​

optional privateKey?: number[] | string;

Defined in: packages/overcast-core/src/config.ts:44

This is either the private key directly (raw bytes or base58) or a path to a key file. Optional so read-only clients can omit it; required by any wallet that signs.

protocolSigner?​

optional protocolSigner?: OvercastProtocolSigner;

Defined in: packages/overcast-core/src/config.ts:90

Optional protocol signer used to sign protocol payloads, taking precedence over one derived from privateKey. Supply your own (e.g. a remote / HSM signer) to override the default ed25519 signer built by createProtocolSigner. This is the protocol signer for this chain. Make sure that this signer operates on the correct curve

socketConfig?​

optional socketConfig?: Partial<ManagerOptions & SocketOptions>;

Defined in: packages/overcast-core/src/config.ts:56

The configuration used for the socket.io websocket connection

socketUrl?​

optional socketUrl?: string;

Defined in: packages/overcast-core/src/config.ts:38

Base URL the realtime RFQ socket connects to. Socket.io derives the namespace from this URL's path, so it must NOT carry a REST prefix (the namespace is always /rfq). Optional — defaults to backend. Set it separately when REST and the socket need different bases, e.g. a same-origin proxy where REST is under /api/backend but the socket must stay at the origin root ("") so the namespace resolves to /rfq.