Class NodeCommandHandlers

Hierarchy (View Summary)

CommandHandler
- NodeCommandHandlers

Constructors

constructor

new NodeCommandHandlers(
    leaseManager: LockManager,
    localConfig: LocalConfigRuntimeState,
    remoteConfig: RemoteConfigRuntimeStateApi,
    tasks: NodeCommandTasks,
    configs: NodeCommandConfigs,
): NodeCommandHandlers
Parameters
- leaseManager: LockManager
- localConfig: LocalConfigRuntimeState
- remoteConfig: RemoteConfigRuntimeStateApi
- tasks: NodeCommandTasks
- configs: NodeCommandConfigs
Returns NodeCommandHandlers
Overrides CommandHandler.constructor
- Defined in src/commands/node/handlers.ts:37

Properties

`Protected` `Readonly`_configMaps

_configMaps: Map<string, any> = ...

`Optional` `Readonly`logger

logger?: SoloLogger

Methods

add

add(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:527

addExecute

addExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:586

addPrepare

addPrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:547

addSubmitTransactions

addSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:566

all

all(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:634

changeAllNodePhases

changeAllNodePhases(
phase: DeploymentPhase,
ledgerPhase?: LedgerPhase,
): SoloListrTask<any>
Changes the state from all consensus nodes components in remote config.
Parameters
- phase: DeploymentPhase
  to which to change the consensus node component
- ledgerPhase: LedgerPhase = undefined
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:884

commandAction

commandAction(
    argv: any,
    actionTasks: any,
    options: any,
    errorString: string,
    lease: Lock,
    commandName?: string,
): Promise<void>
Parameters
- argv: any
- actionTasks: any
- options: any
- errorString: string
- lease: Lock
- OptionalcommandName: string
Returns Promise<void>
Inherited from CommandHandler.commandAction
- Defined in src/core/command-handler.ts:33

connections

connections(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:655

destroy

destroy(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:449

destroyExecute

destroyExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:507

destroyPrepare

destroyPrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:468

destroySubmitTransactions

destroySubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:487

freeze

freeze(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:831

freezeUpgrade

freezeUpgrade(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:264

getUnusedConfigs

getUnusedConfigs(configName: string): string[]
Parameters
- configName: string
Returns string[]
Inherited from CommandHandler.getUnusedConfigs
- Defined in src/core/command-handler.ts:96

keys

keys(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:729

logs

logs(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:613

prepareUpgrade

prepareUpgrade(argv: ArgvStruct): Promise<boolean>
******** Handlers *********
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:242

refresh

refresh(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:699

restart

restart(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:854

setup

setup(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:804

setupHomeDirectory

setupHomeDirectory(directories?: string[]): string[]
Setup home directories
Parameters
- directories: string[] = ...
Returns string[]
Inherited from CommandHandler.setupHomeDirectory
- Defined in src/core/command-handler.ts:74

start

start(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:773

states

states(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:682

stop

stop(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:749

update

update(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:283

updateExecute

updateExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:342

updatePrepare

updatePrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:303

updateSubmitTransactions

updateSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:322

upgrade

upgrade(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:430

upgradeExecute

upgradeExecute(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:405

upgradePrepare

upgradePrepare(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:368

upgradeSubmitTransactions

upgradeSubmitTransactions(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/node/handlers.ts:385

validateAllNodePhases

validateAllNodePhases(
    acceptedPhases: {
        acceptedPhases?: DeploymentPhase[];
        excludedPhases?: DeploymentPhase[];
    },
): SoloListrTask<any>
Creates tasks to validate that each node state is either one of the accepted states or not one of the excluded.
Parameters
- acceptedPhases: { acceptedPhases?: DeploymentPhase[]; excludedPhases?: DeploymentPhase[] }
  the state at which the nodes can be, not matching any of the states throws an error
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:916

validateSingleNodeState

validateSingleNodeState(
    acceptedPhases: {
        acceptedPhases?: DeploymentPhase[];
        excludedPhases?: DeploymentPhase[];
    },
): SoloListrTask<any>
Creates tasks to validate that specific node state is either one of the accepted states or not one of the excluded.
Parameters
- acceptedPhases: { acceptedPhases?: DeploymentPhase[]; excludedPhases?: DeploymentPhase[] }
  the state at which the node can be, not matching any of the states throws an error
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:961

Class NodeCommandHandlers

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NodeCommandHandlers

Properties

Protected Readonly_configMaps

Optional Readonlylogger

Methods

add

Parameters

Returns Promise<boolean>

addExecute

Parameters

Returns Promise<boolean>

addPrepare

Parameters

Returns Promise<boolean>

addSubmitTransactions

Parameters

Returns Promise<boolean>

all

Parameters

Returns Promise<boolean>

changeAllNodePhases

Parameters

Returns SoloListrTask<any>

commandAction

Parameters

Returns Promise<void>

connections

Parameters

Returns Promise<boolean>

destroy

Parameters

Returns Promise<boolean>

destroyExecute

Parameters

Returns Promise<boolean>

destroyPrepare

Parameters

Returns Promise<boolean>

destroySubmitTransactions

Parameters

Returns Promise<boolean>

freeze

Parameters

Returns Promise<boolean>

freezeUpgrade

Parameters

Returns Promise<boolean>

getUnusedConfigs

Parameters

Returns string[]

keys

Parameters

Returns Promise<boolean>

logs

Parameters

Returns Promise<boolean>

prepareUpgrade

Parameters

Returns Promise<boolean>

refresh

Parameters

Returns Promise<boolean>

restart

Parameters

Returns Promise<boolean>

setup

Parameters

Returns Promise<boolean>

setupHomeDirectory

Parameters

Returns string[]

`Protected` `Readonly`_configMaps

`Optional` `Readonly`logger