Skip to main content

Interface: SolanaConfig<N>

Defined in: solana-client/src/config.ts:30

Solana-specific OvercastConfig. Adds the RPC endpoint (and an optional commitment) the SolanaChainSigner connects with; privateKey (inherited) is the wallet's signing key and is required for a signing wallet.

Extends​

  • OvercastConfig<N>

Type Parameters​

Type Parameter
N extends ChainName

Properties​

ackTimeoutMs?​

optional ackTimeoutMs?: number;

Defined in: overcast-core/dist/config.d.ts:61

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

Inherited from​

OvercastConfig.ackTimeoutMs

apiKey?​

optional apiKey?: string;

Defined in: overcast-core/dist/config.d.ts:56

The API Key used for authentication against the backend

Inherited from​

OvercastConfig.apiKey

axios?​

optional axios?: CreateAxiosDefaults<any>;

Defined in: overcast-core/dist/config.d.ts:68

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.

Inherited from​

OvercastConfig.axios

backend?​

optional backend?: string;

Defined in: overcast-core/dist/config.d.ts:27

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

Inherited from​

OvercastConfig.backend

chainName​

chainName: N;

Defined in: overcast-core/dist/config.d.ts:18

The name this chain is filed under

Inherited from​

OvercastConfig.chainName

commitment?​

optional commitment?: Commitment;

Defined in: solana-client/src/config.ts:34

Commitment for the connection + confirmations. Defaults to "confirmed".

domain​

domain: number;

Defined in: overcast-core/dist/config.d.ts:22

The domain of the overcast app.

Inherited from​

OvercastConfig.domain

feeHookProgramId?​

optional feeHookProgramId?: string;

Defined in: solana-client/src/config.ts:58

Address (base58) of the deployed protocol-fee hook program, overriding FEE_HOOK_PROGRAM_ID. Used by the reader to verify a hook config account is owned by the domain's hook program before quoting a fee.

overcastApi?​

optional overcastApi?: OvercastView;

Defined in: overcast-core/dist/config.d.ts:72

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

Inherited from​

OvercastConfig.overcastApi

owner?​

optional owner?: Address;

Defined in: overcast-core/dist/config.d.ts:48

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

Inherited from​

OvercastConfig.owner

privateKey?​

optional privateKey?: string | number[];

Defined in: overcast-core/dist/config.d.ts:42

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.

Inherited from​

OvercastConfig.privateKey

programId?​

optional programId?: string;

Defined in: solana-client/src/config.ts:42

Address (base58) of the deployed core program, overriding PROGRAM_ID (the canonical deployment baked into the generated @overcast-xyz/solana-program IDL).

protocolSigner?​

optional protocolSigner?: OvercastProtocolSigner;

Defined in: overcast-core/dist/config.d.ts:81

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

Inherited from​

OvercastConfig.protocolSigner

rpcUrl​

rpcUrl: string;

Defined in: solana-client/src/config.ts:32

Solana RPC endpoint the wallet connects to.

settlementOracleProgramId?​

optional settlementOracleProgramId?: string;

Defined in: solana-client/src/config.ts:52

Address (base58) of the deployed oracle-settlement layer program, overriding SETTLEMENT_ORACLE_PROGRAM_ID.

settlementPhysicalProgramId?​

optional settlementPhysicalProgramId?: string;

Defined in: solana-client/src/config.ts:47

Address (base58) of the deployed physical-settlement layer program, overriding SETTLEMENT_PHYSICAL_PROGRAM_ID.

socketConfig?​

optional socketConfig?: Partial<ManagerOptions & SocketOptions>;

Defined in: overcast-core/dist/config.d.ts:52

The configuration used for the socket.io websocket connection

Inherited from​

OvercastConfig.socketConfig

socketUrl?​

optional socketUrl?: string;

Defined in: overcast-core/dist/config.d.ts:36

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.

Inherited from​

OvercastConfig.socketUrl

wallet?​

optional wallet?: Wallet;

Defined in: solana-client/src/config.ts:36

The wallet that will be used as a chain signer