Interface: OvercastSettlementLayer<L>
Defined in: packages/overcast-core/src/protocol/settlement-layer.ts:24
The logic for one settlement layer on a given chain (L): the config
(Id) an offer commits to, and — for layers that have one — a
convenience helper for the exercise/redeem metadata.
A layer defines this once per chain (e.g. a Solana physical layer) and is
registered by its type key in the chain's
SettlementLayerRegistry. The registry is a caller-side helper: it
produces the config a caller pins into details.settlementLayer before
signing. The writer never consults it — it commits whatever the offer already
carries, verbatim.
Type Parameters
| Type Parameter | Description |
|---|---|
L extends OvercastLayer | the OvercastLayer describing this settlement layer. |
Properties
type
readonly type: L["settlement"];
Defined in: packages/overcast-core/src/protocol/settlement-layer.ts:26
This layer's type key — matches the on-chain discriminator and the registry key.
Methods
buildMetadata()?
optional buildMetadata(option): Promise<Metadata>;
Defined in: packages/overcast-core/src/protocol/settlement-layer.ts:46
Optional helper producing this layer's conventional exercise/redeem metadata. Purely a convenience: the writer forwards whatever bytes the caller passes verbatim, so a caller with an intent the SDK has no model for can ignore this and supply its own bytes.
Parameters
| Parameter | Type |
|---|---|
option | MarketOption |
Returns
Promise<Metadata>
createConfig()?
optional createConfig(...args): Promise<L["tx"]>;
Defined in: packages/overcast-core/src/protocol/settlement-layer.ts:38
Build a transaction that deploys a new custom config for this layer. Optional — layers with a single fixed config need not offer it.
Parameters
| Parameter | Type |
|---|---|
...args | unknown[] |
Returns
Promise<L["tx"]>
defaultConfig()
defaultConfig(details): string;
Defined in: packages/overcast-core/src/protocol/settlement-layer.ts:32
The default config (Id) for this layer, used when a caller selects the layer without naming a specific config.
Parameters
| Parameter | Type |
|---|---|
details | Partial<OptionDetails> |
Returns
string