Class NodeCommandHandlers

Implements

CommandHandlers

Index

Constructors

Properties

consensusNodes contexts getConfig parent remoteConfigManager ADD_CONTEXT_FILE DELETE_CONTEXT_FILE UPDATE_CONTEXT_FILE UPGRADE_CONTEXT_FILE

Constructors

constructor

new NodeCommandHandlers(opts: any): NodeCommandHandlers
Parameters
- opts: any
Returns NodeCommandHandlers
- Defined in src/commands/node/handlers.ts:64

Properties

consensusNodes

consensusNodes: ConsensusNode[]

contexts

contexts: string[]

getConfig

getConfig: (
    configName: string,
    flags: CommandFlag[],
    extraProperties?: string[],
) => object

`Readonly`parent

parent: BaseCommand

`Readonly`remoteConfigManager

remoteConfigManager: RemoteConfigManager

`Static` `Readonly`ADD_CONTEXT_FILE

ADD_CONTEXT_FILE: "node-add.json" = 'node-add.json'

`Static` `Readonly`DELETE_CONTEXT_FILE

DELETE_CONTEXT_FILE: "node-delete.json" = 'node-delete.json'

`Static` `Readonly`UPDATE_CONTEXT_FILE

UPDATE_CONTEXT_FILE: "node-update.json" = 'node-update.json'

`Static` `Readonly`UPGRADE_CONTEXT_FILE

UPGRADE_CONTEXT_FILE: "node-upgrade.json" = 'node-upgrade.json'

Methods

add

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

addExecute

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

addExecuteTasks

addExecuteTasks(argv: any): (SoloListrTask<any> | Task)[]
Parameters
- argv: any
Returns (SoloListrTask<any> | Task)[]
- Defined in src/commands/node/handlers.ts:173

addPrepare

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

addPrepareTasks

addPrepareTasks(argv: any, lease: Lease): Task[]
Parameters
- argv: any
- lease: Lease
Returns Task[]
- Defined in src/commands/node/handlers.ts:144

addSubmitTransactions

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

addSubmitTransactionsTasks

addSubmitTransactionsTasks(argv: any): Task[]
Parameters
- argv: any
Returns Task[]
- Defined in src/commands/node/handlers.ts:165

changeAllNodeStates

changeAllNodeStates(state: ConsensusNodeStates): ListrTask<any, any, any>
Changes the state from all consensus nodes components in remote config.
Parameters
- state: ConsensusNodeStates
  to which to change the consensus node component
Returns ListrTask<any, any, any>
- Defined in src/commands/node/handlers.ts:877

delete

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

deleteExecute

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

deleteExecuteTaskList

deleteExecuteTaskList(argv: any): (SoloListrTask<any> | Task)[]
Parameters
- argv: any
Returns (SoloListrTask<any> | Task)[]
- Defined in src/commands/node/handlers.ts:120

deletePrepare

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

deletePrepareTaskList

deletePrepareTaskList(
argv: any,
lease: Lease,
): (ListrTask<any, any, any> | Task)[]
******** Task Lists *********
Parameters
- argv: any
- lease: Lease
Returns (ListrTask<any, any, any> | Task)[]
- Defined in src/commands/node/handlers.ts:101

deleteSubmitTransactions

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

deleteSubmitTransactionsTaskList

deleteSubmitTransactionsTaskList(argv: any): Task[]
Parameters
- argv: any
Returns Task[]
- Defined in src/commands/node/handlers.ts:112

downloadGeneratedFiles

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

freezeUpgrade

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

keys

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

logs

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

prepareUpgrade

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

refresh

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

removeNodeAndProxies

removeNodeAndProxies(): ListrTask<any, any, any>
Removes the consensus node, envoy and haproxy components from remote config.

Returns ListrTask<any, any, any>
- Defined in src/commands/node/handlers.ts:858

setup

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

start

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

states

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

stop

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

update

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

updateExecute

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

updateExecuteTasks

updateExecuteTasks(argv: any): (SoloListrTask<any> | Task)[]
Parameters
- argv: any
Returns (SoloListrTask<any> | Task)[]
- Defined in src/commands/node/handlers.ts:218

updatePrepare

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

updatePrepareTasks

updatePrepareTasks(argv: any, lease: Lease): (ListrTask<any, any, any> | Task)[]
Parameters
- argv: any
- lease: Lease
Returns (ListrTask<any, any, any> | Task)[]
- Defined in src/commands/node/handlers.ts:199

updateSubmitTransactions

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

updateSubmitTransactionsTasks

updateSubmitTransactionsTasks(argv: any): Task[]
Parameters
- argv: any
Returns Task[]
- Defined in src/commands/node/handlers.ts:210

upgrade

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

upgradeExecute

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

upgradeExecuteTasks

upgradeExecuteTasks(argv: any): Task[]
Parameters
- argv: any
Returns Task[]
- Defined in src/commands/node/handlers.ts:258

upgradePrepare

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

upgradePrepareTasks

upgradePrepareTasks(
argv: any,
lease: Lease,
): (ListrTask<any, any, any> | Task)[]
Parameters
- argv: any
- lease: Lease
Returns (ListrTask<any, any, any> | Task)[]
- Defined in src/commands/node/handlers.ts:243

upgradeSubmitTransactions

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

upgradeSubmitTransactionsTasks

upgradeSubmitTransactionsTasks(argv: any): Task[]
Parameters
- argv: any
Returns Task[]
- Defined in src/commands/node/handlers.ts:254

validateAllNodeStates

validateAllNodeStates(
    __namedParameters: {
        acceptedStates?: ConsensusNodeStates[];
        excludedStates?: ConsensusNodeStates[];
    },
): ListrTask<any, any, any>
Creates tasks to validate that each node state is either one of the accepted states or not one of the excluded.
Parameters
- __namedParameters: {
  acceptedStates?: ConsensusNodeStates[];
  excludedStates?: ConsensusNodeStates[];
  }
Returns ListrTask<any, any, any>
- Defined in src/commands/node/handlers.ts:914

validateSingleNodeState

validateSingleNodeState(
    __namedParameters: {
        acceptedStates?: ConsensusNodeStates[];
        excludedStates?: ConsensusNodeStates[];
    },
): ListrTask<any, any, any>
Creates tasks to validate that specific node state is either one of the accepted states or not one of the excluded.
Parameters
- __namedParameters: {
  acceptedStates?: ConsensusNodeStates[];
  excludedStates?: ConsensusNodeStates[];
  }
Returns ListrTask<any, any, any>
- Defined in src/commands/node/handlers.ts:956

Class NodeCommandHandlers

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NodeCommandHandlers

Properties

consensusNodes

contexts

getConfig

Readonlyparent

ReadonlyremoteConfigManager

Static ReadonlyADD_CONTEXT_FILE

Static ReadonlyDELETE_CONTEXT_FILE

Static ReadonlyUPDATE_CONTEXT_FILE

Static ReadonlyUPGRADE_CONTEXT_FILE

Methods

add

Parameters

Returns Promise<boolean>

addExecute

Parameters

Returns Promise<boolean>

addExecuteTasks

Parameters

Returns (SoloListrTask<any> | Task)[]

addPrepare

Parameters

Returns Promise<boolean>

addPrepareTasks

Parameters

Returns Task[]

addSubmitTransactions

Parameters

Returns Promise<boolean>

addSubmitTransactionsTasks

Parameters

Returns Task[]

changeAllNodeStates

Parameters

Returns ListrTask<any, any, any>

delete

Parameters

Returns Promise<boolean>

deleteExecute

Parameters

Returns Promise<boolean>

deleteExecuteTaskList

Parameters

Returns (SoloListrTask<any> | Task)[]

deletePrepare

Parameters

Returns Promise<boolean>

deletePrepareTaskList

Parameters

Returns (ListrTask<any, any, any> | Task)[]

deleteSubmitTransactions

Parameters

Returns Promise<boolean>

deleteSubmitTransactionsTaskList

Parameters

Returns Task[]

downloadGeneratedFiles

Parameters

Returns Promise<boolean>

freezeUpgrade

Parameters

Returns Promise<boolean>

keys

Parameters

Returns Promise<boolean>

logs

Parameters

Returns Promise<boolean>

prepareUpgrade

Parameters

`Readonly`parent

`Readonly`remoteConfigManager

`Static` `Readonly`ADD_CONTEXT_FILE

`Static` `Readonly`DELETE_CONTEXT_FILE

`Static` `Readonly`UPDATE_CONTEXT_FILE

`Static` `Readonly`UPGRADE_CONTEXT_FILE