Configuration

This page lists every field a SomniaMarkets instance accepts, with its type, whether it is required, and its default. The same fields, minus the three signer fields, form ClientConfig, the configuration of the engine. For the values to put in these fields on each network, see Networks and endpoints.

import { SomniaMarkets } from "@somnia-chain/markets-sdk";

const exchange = new SomniaMarkets(config); // config: SomniaMarketsConfig

SomniaMarketsConfig

SomniaMarketsConfig is ClientConfig plus the signer fields privateKey, account, and walletClient.

Signer resolution

A method that writes, or reads data scoped to the caller, resolves the caller's address in this order: walletClient.account.address, then account.address, then account when it is a string, then the address derived from privateKey. When none is set, walletAddress is undefined and every authenticated method throws SignerRequiredError.

setSigner(signer) replaces the signer after construction. Passing {} removes it. Live watches and market data are unaffected.

Signer paths

Lazy connections

The viem chain WebSocket opens on the first chain read, write, or watch. An instance that only performs indexer reads never opens one. The price-feed WebSocket opens on the first watchPrice. close() stops the watches and channels and closes every socket the instance opened, both the price-feed WebSockets and the viem chain transport, so a Node process exits on its own afterwards. Instances sharing a wsRpcUrl share one chain socket, which closes when the last of them closes.

FixedFees

DEFAULT_FEES is { maxFeePerGas: 60_000_000_000n, maxPriorityFeePerGas: 0n }: a 60 gwei ceiling and no tip.

Gas

Every SDK-signed write uses a fixed gas ceiling of 10,000,000 gas. Gas is never estimated. Unused gas is not charged. The mempool accepts a transaction only when the account holds gas × maxFeePerGas on top of the transaction value: 0.6 STT or SOMI at the defaults. A lower-level write accepts a per-call gas override only when its public parameter type declares one. Unified exchange methods such as createOrder and cancelOrder do not expose that override.

SomniaMarketsAddresses

Every field is optional and typed Address, except lend.

SOMNIA_MAINNET_ADDRESSES and SOMNIA_TESTNET_ADDRESSES, exported from the root entry, hold the current deployments. SOMNIA_MAINNET_LEND and SOMNIA_TESTNET_LEND hold the SomniaLend addresses and are already included in the two address constants.

PriceFeedConfig

SOMNIA_TESTNET_PRICE_FEED is { url: "https://price-feed.dev.oracle.somnia.host/v1/graphql", quote: "USDC" }. SOMNIA_MAINNET_PRICE_FEED is { url: "https://price-feed.prd.oracle.somnia.host/v1/graphql", quote: "USDC" }. They index different chains; see networks and endpoints.

Transport constants