Skip to main content

Interface: OvercastLayer

Defined in: packages/overcast-core/src/layer/layer.ts:27

Describes a single settlement layer by bundling the three types that vary between implementations, so the rest of the SDK threads one generic (L) instead of repeating <T, R, C> everywhere. Each consumer derives what it needs via indexed access (L["tx"], L["receipt"], L["config"]).

A layer defines this once (e.g. SolanaLayer) and passes it as the single generic argument to ProtocolFactory, OvercastChainSigner, SigningWriter and OvercastApp.

Type Param​

tx

the built-but-unsubmitted transaction the writer produces.

Type Param​

receipt

the signer's submission receipt (e.g. TxInfo).

Type Param​

config

the layer's OvercastConfig (connection + key material).

Type Param​

settlement

the union of settlement-layer type keys this chain implements. Always includes the KnownSettlementLayer subset every chain must support (e.g. "physical"), plus any chain-specific extras. Keys the chain's SettlementLayerRegistry and every SettlementSelection, so selecting an unsupported layer is a compile error — and the registry can't be built without the known subset.

Properties​

config​

config: OvercastConfig;

Defined in: packages/overcast-core/src/layer/layer.ts:30

receipt​

receipt: TxInfo;

Defined in: packages/overcast-core/src/layer/layer.ts:29

settlement​

settlement: 
  | KnownSettlementLayer
  | string & object;

Defined in: packages/overcast-core/src/layer/layer.ts:35

tx​

tx: UnsignedTransaction;

Defined in: packages/overcast-core/src/layer/layer.ts:28