Interface: ServerToClientEvents
Defined in: packages/overcast-core/src/rfq/events.ts:385
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:393
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:387
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | { creator: Address; details: { borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; domain?: 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; domain?: 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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer: string; startTimestamp: number; }; expiry: number; operation: { curve: SignatureCurve; digest: Bytes32; expiry: number; salt: Bytes32; signature: Hex; signingKey: Bytes32; }; quoteId: string; rfqId: string; } | - |
payload.creator | Address | The creator of the quote. |
payload.details | { borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; domain?: 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; domain?: 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; domain?: 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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.collateralAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.premiumAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.settlementAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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 | { curve: SignatureCurve; digest: Bytes32; expiry: number; salt: Bytes32; signature: Hex; signingKey: Bytes32; } | The signed offer operation the quoter authorized this quote with. |
payload.operation.curve | SignatureCurve | The curve that was used to sign the digest |
payload.operation.digest | Bytes32 | The digest that has been signed |
payload.operation.expiry | number | Unix seconds after which the operation is no longer valid. |
payload.operation.salt | Bytes32 | Random per-operation salt (nonce) for replay protection. |
payload.operation.signature | Hex | ed25519 signature over the operation digest — 64 raw bytes in hex. |
payload.operation.signingKey | Bytes32 | 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:386
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | { creator: Address; details: { borrowAllowed?: boolean; collateralAmount?: string; collateralAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; domain?: 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; domain?: 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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer?: string; startTimestamp?: number; }; domain: number; expiry: number; options?: { [key: string]: unknown; responder?: Bytes32[]; }; rfqId: string; side: "TAKER" | "MAKER"; } | - |
payload.creator | Address | The creator of the RFQ. |
payload.details | { borrowAllowed?: boolean; collateralAmount?: string; collateralAsset?: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; domain?: 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; domain?: 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; domain?: 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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.collateralAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.premiumAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.settlementAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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.domain | number | The deployment this RFQ is for, so a subscriber can filter by chain even though details is partial. Authoritative over details.domain. |
payload.expiry | number | When this RFQ becomes invalid. |
payload.options? | { [key: string]: unknown; responder?: Bytes32[]; } | RFQ options; there might be an unknown option in the future. |
payload.options.responder? | Bytes32[] | Optional list that are allowed to respond. If not provided, everyone can respond |
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:388
Parameters
| Parameter | Type | Description |
|---|---|---|
payload | { details: { borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; domain?: 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; domain?: 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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; }; settlementLayer: string; startTimestamp: number; }; maker: Address; optionId: Bytes32; quoteId: string; rfqId: string; taker: Address; } | - |
payload.details | { borrowAllowed: boolean; collateralAmount: string; collateralAsset: { address: string; cashLike?: boolean; chain?: string; coinGeckoId?: string; decimals?: number; domain?: 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; domain?: 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; domain?: 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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.collateralAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.premiumAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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; domain?: number; lastKnownPriceUsd?: number; logoUrl?: string; name?: string; rwa?: boolean; symbol?: string; volatility?: number; } | - |
payload.details.settlementAsset.address | string | The on-chain address (mint) identifying the asset, in the layer's own encoding (base58 on Solana, 0x… on an EVM chain) — see Address. |
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, e.g. "base". A display label only — it is a caller-chosen name (see ChainName), carried by no wire payload and never used to key or look up an asset. domain is the identity. |
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.domain? | number | The protocol domain the asset lives on — the same separator OptionDetails.domain carries and every indexed event is tagged with, and the first half of the asset's key in an AssetRegistry. Optional because a single-domain deployment has nothing to disambiguate; such an asset registers as a wildcard, matching any domain that has no asset of its own at that address. Populate it as soon as one backend serves two domains — an address is only unique within a domain. |
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 | Address | - |
payload.optionId | Bytes32 | Content-address of the option the accepted quote settled into. |
payload.quoteId | string | - |
payload.rfqId | string | - |
payload.taker | Address | - |
Returns
void
rfqCancelled
rfqCancelled: (payload) => void;
Defined in: packages/overcast-core/src/rfq/events.ts:390
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:392
An RFQ reached its TTL without being accepted.
Parameters
| Parameter | Type |
|---|---|
payload | { rfqId: string; } |
payload.rfqId | string |
Returns
void