Interface: ServerToClientEvents

Defined in: packages/overcast-core/src/rfq/events.ts:313

Server→client broadcasts, keyed by event name. Use as the first type parameter on a client Socket<...> and the second on the server Server<...>, so .on(...) / .emit(...) are checked on both ends.

Properties

error

error: (payload) => void;

Defined in: packages/overcast-core/src/rfq/events.ts:321

Parameters

Parameter	Type
payload	{ code: | "NOT_REGISTERED" | "WRONG_ROLE" | "VALIDATION_FAILED" | "RFQ_NOT_FOUND" | "RFQ_NOT_OPEN" | "QUOTE_NOT_FOUND" | "NOT_OWNER" | "ALREADY_ACCEPTED" | "BAD_SIGNATURE" | "SETTLEMENT_SUBMIT_FAILED" | "COLLATERAL_SUBMIT_FAILED" | "ACCEPT_OFFER_FAILED" | "INTERNAL"; message: string; }
payload.code	| "NOT_REGISTERED" | "WRONG_ROLE" | "VALIDATION_FAILED" | "RFQ_NOT_FOUND" | "RFQ_NOT_OPEN" | "QUOTE_NOT_FOUND" | "NOT_OWNER" | "ALREADY_ACCEPTED" | "BAD_SIGNATURE" | "SETTLEMENT_SUBMIT_FAILED" | "COLLATERAL_SUBMIT_FAILED" | "ACCEPT_OFFER_FAILED" | "INTERNAL"
payload.message	string

Returns

void

---

newQuote

newQuote: (payload) => void;

Defined in: packages/overcast-core/src/rfq/events.ts:315

Parameters

Parameter	Type	Description
payload	{ creator: string; details: { borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; domain: number; endTimestamp: number; premiumAmount: string; premiumAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementAmount: string; settlementAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer: string; startTimestamp: number; }; expiry: number; operation: { digest: string; expiry: number; salt: string; signature: string; signingKey: string; }; quoteId: string; rfqId: string; }	-
payload.creator	string	The creator of the quote.
payload.details	{ borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; domain: number; endTimestamp: number; premiumAmount: string; premiumAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementAmount: string; settlementAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer: string; startTimestamp: number; }	-
payload.details.borrowAllowed	boolean	-
payload.details.collateralAmount	string	-
payload.details.collateralAsset	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.collateralAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.collateralAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.collateralAsset.chain?	string	The chain the asset lives on.
payload.details.collateralAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.collateralAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.collateralAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.collateralAsset.logoUrl?	string	Logo of the coin
payload.details.collateralAsset.name?	string	Human name of the asset.
payload.details.collateralAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.collateralAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.collateralAsset.volatility?	number	Volatility of the asset
payload.details.domain	number	-
payload.details.endTimestamp	number	-
payload.details.premiumAmount	string	-
payload.details.premiumAsset	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.premiumAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.premiumAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.premiumAsset.chain?	string	The chain the asset lives on.
payload.details.premiumAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.premiumAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.premiumAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.premiumAsset.logoUrl?	string	Logo of the coin
payload.details.premiumAsset.name?	string	Human name of the asset.
payload.details.premiumAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.premiumAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.premiumAsset.volatility?	number	Volatility of the asset
payload.details.settlementAmount	string	-
payload.details.settlementAsset	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.settlementAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.settlementAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.settlementAsset.chain?	string	The chain the asset lives on.
payload.details.settlementAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.settlementAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.settlementAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.settlementAsset.logoUrl?	string	Logo of the coin
payload.details.settlementAsset.name?	string	Human name of the asset.
payload.details.settlementAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.settlementAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.settlementAsset.volatility?	number	Volatility of the asset
payload.details.settlementLayer	string	-
payload.details.startTimestamp	number	-
payload.expiry	number	When this quote becomes invalid.
payload.operation	{ digest: string; expiry: number; salt: string; signature: string; signingKey: string; }	The signed offer operation the quoter authorized this quote with.
payload.operation.digest	string	The digest that has been signed
payload.operation.expiry	number	Unix seconds after which the operation is no longer valid.
payload.operation.salt	string	Random per-operation salt (nonce) for replay protection.
payload.operation.signature	string	ed25519 signature over the operation digest, base58-encoded.
payload.operation.signingKey	string	The public key that produced signature.
payload.quoteId	string	-
payload.rfqId	string	-

Returns

void

---

newRfq

newRfq: (payload) => void;

Defined in: packages/overcast-core/src/rfq/events.ts:314

Parameters

Parameter	Type	Description
payload	{ creator: string; details: { borrowAllowed?: boolean; collateralAmount?: string; collateralAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; domain?: number; endTimestamp?: number; premiumAmount?: string; premiumAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementAmount?: string; settlementAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer?: string; startTimestamp?: number; }; expiry: number; options?: objectOutputType<{ responder: ZodOptional<ZodArray<ZodString, "many">>; }, ZodTypeAny, "passthrough">; rfqId: string; side: "TAKER" | "MAKER"; }	-
payload.creator	string	The creator of the RFQ.
payload.details	{ borrowAllowed?: boolean; collateralAmount?: string; collateralAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; domain?: number; endTimestamp?: number; premiumAmount?: string; premiumAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementAmount?: string; settlementAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer?: string; startTimestamp?: number; }	Curated details of the RFQ.
payload.details.borrowAllowed?	boolean	-
payload.details.collateralAmount?	string	-
payload.details.collateralAsset?	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.collateralAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.collateralAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.collateralAsset.chain?	string	The chain the asset lives on.
payload.details.collateralAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.collateralAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.collateralAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.collateralAsset.logoUrl?	string	Logo of the coin
payload.details.collateralAsset.name?	string	Human name of the asset.
payload.details.collateralAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.collateralAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.collateralAsset.volatility?	number	Volatility of the asset
payload.details.domain?	number	-
payload.details.endTimestamp?	number	-
payload.details.premiumAmount?	string	-
payload.details.premiumAsset?	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.premiumAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.premiumAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.premiumAsset.chain?	string	The chain the asset lives on.
payload.details.premiumAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.premiumAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.premiumAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.premiumAsset.logoUrl?	string	Logo of the coin
payload.details.premiumAsset.name?	string	Human name of the asset.
payload.details.premiumAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.premiumAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.premiumAsset.volatility?	number	Volatility of the asset
payload.details.settlementAmount?	string	-
payload.details.settlementAsset?	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.settlementAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.settlementAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.settlementAsset.chain?	string	The chain the asset lives on.
payload.details.settlementAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.settlementAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.settlementAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.settlementAsset.logoUrl?	string	Logo of the coin
payload.details.settlementAsset.name?	string	Human name of the asset.
payload.details.settlementAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.settlementAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.settlementAsset.volatility?	number	Volatility of the asset
payload.details.settlementLayer?	string	-
payload.details.startTimestamp?	number	-
payload.expiry	number	When this RFQ becomes invalid.
payload.options?	objectOutputType<{ responder: ZodOptional<ZodArray<ZodString, "many">>; }, ZodTypeAny, "passthrough">	RFQ options; there might be an unknown option in the future.
payload.rfqId	string	-
payload.side	"TAKER" | "MAKER"	RFQ is designed in a way that it is side un-aware. Both makers or takers of options can create RFQs.

Returns

void

---

quoteAccepted

quoteAccepted: (payload) => void;

Defined in: packages/overcast-core/src/rfq/events.ts:316

Parameters

Parameter	Type	Description
payload	{ details: { borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; domain: number; endTimestamp: number; premiumAmount: string; premiumAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementAmount: string; settlementAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer: string; startTimestamp: number; }; maker: string; optionId: string; quoteId: string; rfqId: string; taker: string; }	-
payload.details	{ borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; domain: number; endTimestamp: number; premiumAmount: string; premiumAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementAmount: string; settlementAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer: string; startTimestamp: number; }	-
payload.details.borrowAllowed	boolean	-
payload.details.collateralAmount	string	-
payload.details.collateralAsset	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.collateralAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.collateralAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.collateralAsset.chain?	string	The chain the asset lives on.
payload.details.collateralAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.collateralAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.collateralAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.collateralAsset.logoUrl?	string	Logo of the coin
payload.details.collateralAsset.name?	string	Human name of the asset.
payload.details.collateralAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.collateralAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.collateralAsset.volatility?	number	Volatility of the asset
payload.details.domain	number	-
payload.details.endTimestamp	number	-
payload.details.premiumAmount	string	-
payload.details.premiumAsset	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.premiumAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.premiumAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.premiumAsset.chain?	string	The chain the asset lives on.
payload.details.premiumAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.premiumAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.premiumAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.premiumAsset.logoUrl?	string	Logo of the coin
payload.details.premiumAsset.name?	string	Human name of the asset.
payload.details.premiumAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.premiumAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.premiumAsset.volatility?	number	Volatility of the asset
payload.details.settlementAmount	string	-
payload.details.settlementAsset	{ address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }	-
payload.details.settlementAsset.address	string	The on-chain address (mint) that uniquely identifies the asset.
payload.details.settlementAsset.cashLike?	boolean	Whether or not the asset can be treated similar to cash
payload.details.settlementAsset.chain?	string	The chain the asset lives on.
payload.details.settlementAsset.coinGeckoId?	string	CoinGecko id for price lookups, e.g. usd-coin.
payload.details.settlementAsset.decimals?	number	Number of decimal places in the asset's native units.
payload.details.settlementAsset.lastKnownPriceUsd?	number	Last known USD price, sourced best-effort from an external feed (CoinGecko). Untrusted — do not use for settlement, signing, valuation, or any value transfer. It is informational only (e.g. showing an approximate notional in a picker), may be stale, missing, or wrong, and is never part of the canonical, content-addressed asset identity. Present only once a price has actually been fetched for the asset.
payload.details.settlementAsset.logoUrl?	string	Logo of the coin
payload.details.settlementAsset.name?	string	Human name of the asset.
payload.details.settlementAsset.rwa?	boolean	Whether the asset is a real-world asset (RWA) — e.g. tokenized private equity — rather than a native crypto asset.
payload.details.settlementAsset.symbol?	string	Human ticker, e.g. USDC.
payload.details.settlementAsset.volatility?	number	Volatility of the asset
payload.details.settlementLayer	string	-
payload.details.startTimestamp	number	-
payload.maker	string	-
payload.optionId	string	-
payload.quoteId	string	-
payload.rfqId	string	-
payload.taker	string	-

Returns

void

---

rfqCancelled

rfqCancelled: (payload) => void;

Defined in: packages/overcast-core/src/rfq/events.ts:318

An RFQ was cancelled by its creator (or its creator disconnected).

Parameters

Parameter	Type
payload	{ rfqId: string; }
payload.rfqId	string

Returns

void

---

rfqExpired

rfqExpired: (payload) => void;

Defined in: packages/overcast-core/src/rfq/events.ts:320

An RFQ reached its TTL without being accepted.

Parameters

Parameter	Type
payload	{ rfqId: string; }
payload.rfqId	string

Returns

void