Class StateMachine

A StateMachine class that manages states and transitions between them.

Index

Constructors

Properties

id litContracts litNodeClient status

Accessors

isRunning signer

Methods

addState addStateFromDefinition addTransition addTransitionFromDefinition getFromContext pushToContext resolveContextPathOrLiteral setToContext startMachine stopMachine fromDefinition

Constructors

constructor

new StateMachine(params): StateMachine
Parameters
- params: BaseStateMachineParams
Returns StateMachine
- Defined in packages/event-listener/src/lib/state-machine.ts:68

Properties

id

id: string

litContracts

litContracts: LitContracts

`Readonly`litNodeClient

litNodeClient: LitNodeClient

status

status: MachineStatus = 'stopped'

Accessors

isRunning

get isRunning(): boolean
Indicates if the state machine is running

Returns boolean
- Defined in packages/event-listener/src/lib/state-machine.ts:153

signer

get signer(): Wallet
Returns an ethers Wallet the state machine can use

Returns Wallet
- Defined in packages/event-listener/src/lib/state-machine.ts:160

Methods

addState

addState(params): void
Adds a custom state to the state machine.
Parameters
- params: BaseStateParams
  The parameters for the state.
Returns void
- Defined in packages/event-listener/src/lib/state-machine.ts:182

addStateFromDefinition

addStateFromDefinition(stateDefinition): void
Adds a state to the state machine using the declarative interface.
Parameters
- stateDefinition: StateDefinition
  The state definition.
Returns void
- Defined in packages/event-listener/src/lib/state-machine.ts:194

addTransition

addTransition(params): void
Adds a transition between two states.
Parameters
- params: TransitionParams
  The parameters for the transition.
Returns void
- Defined in packages/event-listener/src/lib/state-machine.ts:211

addTransitionFromDefinition

addTransitionFromDefinition(transitionDefinition): void
Parameters
- transitionDefinition: TransitionDefinition
Returns void
- Defined in packages/event-listener/src/lib/state-machine.ts:270

getFromContext

getFromContext<T>(path?): T
Gets a value from the machine context If value or path do not exist it returns undefined
Type Parameters
- T
Parameters
- Optionalpath: string | string[]
  the context path to read
Returns T
- Defined in packages/event-listener/src/lib/state-machine.ts:433

pushToContext

pushToContext(path, value): void
Pushes a value in the machine context. The value will be converted to an array if it is not If path does not exist, it is created
Parameters
- path: string | string[]
  the context path to write
- value: unknown
  the value to write in the context path
Returns void
- Defined in packages/event-listener/src/lib/state-machine.ts:466

resolveContextPathOrLiteral

resolveContextPathOrLiteral<T>(value): T
Resolves a value from the context if it specifies a path or returns it as a literal
Type Parameters
- T = unknown
Parameters
- value: ContextOrLiteral<T>
  the literal value or read context object
Returns T
- Defined in packages/event-listener/src/lib/state-machine.ts:441

setToContext

setToContext(path, value): void
Sets a value in the machine context If path does not exist, it is created
Parameters
- path: string | string[]
  the context path to write
- value: unknown
  the value to write in the context path
Returns void
- Defined in packages/event-listener/src/lib/state-machine.ts:456

startMachine

startMachine(initialState, onStop?): Promise<void>
Starts the state machine with the given initial state.
Parameters
- initialState: string
  The key of the initial state.
- OptionalonStop: voidAsyncFunction
  Optional callback to execute when the machine is stopped.
Returns Promise<void>
- Defined in packages/event-listener/src/lib/state-machine.ts:410

stopMachine

stopMachine(): Promise<void>
Stops the state machine by exiting the current state and not moving to another one.

Returns Promise<void>
- Defined in packages/event-listener/src/lib/state-machine.ts:473

`Static`fromDefinition

fromDefinition(machineConfig): StateMachine
Parameters
- machineConfig: StateMachineDefinition
Returns StateMachine
- Defined in packages/event-listener/src/lib/state-machine.ts:82