@proto-kit/sequencer • Docs
Documentation / @proto-kit/sequencer / SettlementModule
Class: SettlementModule
Lifecycle of a SequencerModule
start(): Executed to execute any logic required to start the module
Extends
Implements
Constructors
new SettlementModule()
new SettlementModule(
baseLayer,protocol,settlementStorage,signer,parentContainer,addressRegistry,argsRegistry):SettlementModule
Parameters
• baseLayer: MinaBaseLayer
• protocol: Protocol<MandatoryProtocolModulesRecord>
• settlementStorage: SettlementStorage
• signer: MinaSigner
• parentContainer: ModuleContainerLike
• addressRegistry: AddressRegistry
• argsRegistry: ContractArgsRegistry
Returns
Overrides
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:66
Properties
contract?
protectedoptionalcontract:SettlementContractType&SmartContract
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:60
currentConfig
protectedcurrentConfig:undefined|SettlementModuleConfig
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:17
events
events:
EventEmitter<SettlementModuleEvents>
Implementation of
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:64
utils
utils:
SettlementUtils
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:62
presets
staticpresets:Presets<unknown> ={}
Inherited from
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
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:18
Methods
checkDeployment()
checkDeployment(
tokenBridges?):Promise<void>
Parameters
• tokenBridges?: object[]
Returns
Promise<void>
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:220
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:20
deploy()
deploy(
addresses,options):Promise<void>
Parameters
• addresses
• addresses.dispatchContract?: PublicKey
• addresses.settlementContract: PublicKey
• options = {}
• options.nonce?: number
Returns
Promise<void>
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:181
getContract()
getContract():
SettlementContractType&SmartContract
Returns
SettlementContractType & SmartContract
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:131
getSettlementContract()
getSettlementContract():
SettlementContractType&SmartContract
Returns
SettlementContractType & SmartContract
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:119
getSettlementContractAddress()
getSettlementContractAddress():
PublicKey
Returns
PublicKey
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:108
settleBatch()
settleBatch(
batch,options):Promise<Settlement>
Parameters
• batch: SettleableBatch
• options = {}
• options.nonce?: number
Returns
Promise<Settlement>
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:148
settlementContractModule()
protectedsettlementContractModule():SettlementContractModule<MandatorySettlementModulesRecord>
Returns
SettlementContractModule<MandatorySettlementModulesRecord>
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:102
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
Defined in
packages/sequencer/src/settlement/SettlementModule.ts:204
dependencies()
staticdependencies():DependencyRecord