Interface: SettlementParams<L>
Defined in: packages/overcast-core/src/protocol/writer.ts:24
The inputs a settlement-consulting write (exerciseOption / redeemOption)
takes beyond the option and amount. Grouped into one object because the last
of them is chain-specific: settlement is typed as the layer's
OvercastLayer.settlementContext, so a context shape the chain doesn't
model fails to compile rather than being smuggled in as a list of addresses.
Note the signing boundary between the two opaque fields: metadata is part of
what operation signs over, settlement is not (see the field docs).
Type Parameters
| Type Parameter | Description |
|---|---|
L extends OvercastLayer | the OvercastLayer describing this settlement layer. |
Properties
metadata?
optional metadata?: Metadata;
Defined in: packages/overcast-core/src/protocol/writer.ts:33
Opaque settlement-layer metadata, forwarded to the layer verbatim (no interpretation). Defaults to empty; a physical layer needs none. Build it yourself or via OvercastSettlementLayer.buildMetadata.
On the delegated path this is inside the signed payload: the acting party signed over these exact bytes, so they must match what was signed.
operation?
optional operation?: SignedOperation;
Defined in: packages/overcast-core/src/protocol/writer.ts:41
Delegated authorization by the acting party (the option's taker for exercise, its maker for redeem). Omitted, that party must sign the transaction itself; present, anyone may submit it and the chain verifies this off-chain signature instead.
settlement?
optional settlement?: L["settlementContext"];
Defined in: packages/overcast-core/src/protocol/writer.ts:54
Chain-specific extra inputs the option's settlement layer needs to resolve the call, forwarded to it uninterpreted (see OvercastLayer.settlementContext). Build it via OvercastSettlementLayer.buildContext rather than assembling it by hand — that keeps per-layer conventions (which accounts, in what order) on the layer instead of at the call site.
Deliberately outside what operation signs over: it names what the layer
reads, not terms the acting party agrees to.