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:41

Properties

`Protected` `Readonly`_configMaps

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

`Optional` `Readonly`logger

logger?: SoloLogger

`Static` `Readonly`KEYS_COMMAND

KEYS_COMMAND: string = 'node keys'

`Static` `Readonly`SETUP_COMMAND

SETUP_COMMAND: "node setup" = 'node setup'

`Static` `Readonly`START_COMMAND

START_COMMAND: "node start" = 'node start'

Methods

add

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

addExecute

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

addPrepare

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

addSubmitTransactions

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

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:987

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
- commandName: string = 'command'
Returns Promise<void>
Inherited from CommandHandler.commandAction
- Defined in src/core/command-handler.ts:33

delete

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

deleteExecute

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

deletePrepare

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

deleteSubmitTransactions

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

downloadGeneratedFiles

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

freeze

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

freezeUpgrade

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

getUnusedConfigs

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

keys

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

logs

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

prepareUpgrade

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

refresh

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

restart

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

setup

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

setupHomeDirectory

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

setupHomeDirectoryTask

setupHomeDirectoryTask(): { task: () => Promise<void>; title: string }
Returns { task: () => Promise<void>; title: string }
Inherited from CommandHandler.setupHomeDirectoryTask
- Defined in src/core/command-handler.ts:95

start

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

states

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

stop

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

update

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

updateExecute

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

updatePrepare

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

updateSubmitTransactions

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

upgrade

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

upgradeExecute

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

upgradePrepare

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

upgradeSubmitTransactions

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

validateAllNodePhases

validateAllNodePhases(
    __namedParameters: {
        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
- __namedParameters: { acceptedPhases?: DeploymentPhase[]; excludedPhases?: DeploymentPhase[] }
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:1019

validateSingleNodeState

validateSingleNodeState(
    __namedParameters: {
        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
- __namedParameters: { acceptedPhases?: DeploymentPhase[]; excludedPhases?: DeploymentPhase[] }
Returns SoloListrTask<any>
- Defined in src/commands/node/handlers.ts:1064

Class NodeCommandHandlers

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NodeCommandHandlers

Properties

Protected Readonly_configMaps

Optional Readonlylogger

Static ReadonlyKEYS_COMMAND

Static ReadonlySETUP_COMMAND

Static ReadonlySTART_COMMAND

Methods

add

Parameters

Returns Promise<boolean>

addExecute

Parameters

Returns Promise<boolean>

addPrepare

Parameters

Returns Promise<boolean>

addSubmitTransactions

Parameters

Returns Promise<boolean>

changeAllNodePhases

Parameters

Returns SoloListrTask<any>

commandAction

Parameters

Returns Promise<void>

delete

Parameters

Returns Promise<boolean>

deleteExecute

Parameters

Returns Promise<boolean>

deletePrepare

Parameters

Returns Promise<boolean>

deleteSubmitTransactions

Parameters

Returns Promise<boolean>

downloadGeneratedFiles

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

`Static` `Readonly`KEYS_COMMAND

`Static` `Readonly`SETUP_COMMAND

`Static` `Readonly`START_COMMAND