@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / MinaBaseLayer

Class: MinaBaseLayer

Lifecycle of a SequencerModule

start(): Executed to execute any logic required to start the module

Extends

• SequencerModule<MinaBaseLayerConfig>

Implements

• BaseLayer

Constructors

new MinaBaseLayer()

new MinaBaseLayer(areProofsEnabled, sequencer): MinaBaseLayer

Parameters

• areProofsEnabled: AreProofsEnabled

• sequencer: ModuleContainerLike

Returns

MinaBaseLayer

Overrides

SequencerModule.constructor

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:60

Properties

currentConfig

protected currentConfig: undefined | MinaBaseLayerConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

SequencerModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

network?

optional network: Mina

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:56

originalNetwork?

optional originalNetwork: Mina

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:58

presets

static presets: Presets<unknown> = {}

Inherited from

SequencerModule.presets

Defined in

packages/sequencer/src/sequencer/builder/SequencerModule.ts:20

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

SequencerModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

networkUtils

Get Signature

get networkUtils(): MinaNetworkUtils

Returns

MinaNetworkUtils

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:99

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

SequencerModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

isLocalBlockChain()

isLocalBlockChain(): boolean

Returns

boolean

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:108

isSignedSettlement()

isSignedSettlement(): boolean

Signed settlement happens when proofs are disabled and the network is remote This is because on local network we can use mock proofs, while on remotes ones we can’t

Returns

boolean

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:116

start()

start(): Promise<void>

Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.

Returns

Promise<void>

Overrides

SequencerModule.start

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:120

dependencies()

static dependencies(): BaseLayerDependencyRecord<MinaBaseLayer>

Returns

BaseLayerDependencyRecord<MinaBaseLayer>

Defined in

packages/sequencer/src/protocol/baselayer/MinaBaseLayer.ts:69