Class AccountCommand

Hierarchy (View Summary)

BaseCommand
- AccountCommand

Constructors

constructor

new AccountCommand(
options: Options,
systemAccounts?: number[][],
): AccountCommand
Parameters
- options: Options
- systemAccounts: number[][] = constants.SYSTEM_ACCOUNTS
Returns AccountCommand
Overrides BaseCommand.constructor
- Defined in src/commands/account.ts:51

Properties

`Protected` `Readonly`chartManager

chartManager: ChartManager

`Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`depManager

depManager: DependencyManager

`Protected` `Readonly`helm

helm: HelmClient

`Protected` `Readonly`k8Factory

k8Factory: K8Factory

`Protected` `Readonly`leaseManager

leaseManager: LockManager

`Readonly`localConfig

localConfig: LocalConfig

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`remoteConfigManager

remoteConfigManager: RemoteConfigManager

`Static` `Readonly`COMMAND_NAME

COMMAND_NAME: "account" = 'account'

Methods

close

close(): Promise<void>
Returns Promise<void>
Overrides BaseCommand.close
- Defined in src/commands/account.ts:837

create

create(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/account.ts:441

createNewAccount

createNewAccount(
    context_: {
        config: {
            amount: number;
            contextName: string;
            ecdsaPrivateKey?: string;
            ed25519PrivateKey?: string;
            generateEcdsaKey: boolean;
            namespace: NamespaceName;
            setAlias: boolean;
        };
        privateKey: PrivateKey;
    },
): Promise<
    {
        accountAlias?: string;
        accountId: string;
        balance: number;
        privateKey: string;
        publicKey: string;
    },
>
Parameters
- context_: {
      config: {
          amount: number;
          contextName: string;
          ecdsaPrivateKey?: string;
          ed25519PrivateKey?: string;
          generateEcdsaKey: boolean;
          namespace: NamespaceName;
          setAlias: boolean;
      };
      privateKey: PrivateKey;
  }
Returns Promise<
    {
        accountAlias?: string;
        accountId: string;
        balance: number;
        privateKey: string;
        publicKey: string;
    },
>
- Defined in src/commands/account.ts:142

get

get(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/account.ts:646

getCommandDefinition

getCommandDefinition(): {
    builder: (yargs: any) => any;
    command: string;
    desc: string;
}
Returns { builder: (yargs: any) => any; command: string; desc: string }
- Defined in src/commands/account.ts:729

init

init(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/account.ts:211

run

run(cmd: string, verbose?: boolean): Promise<string[]>
Returns a promise that invokes the shell command
Parameters
- cmd: string
- verbose: boolean = false
Returns Promise<string[]>
Inherited from BaseCommand.run
- Defined in src/core/shell-runner.ts:17

setupHomeDirectory

setupHomeDirectory(directories?: string[]): string[]
Setup home directories
Parameters
- directories: string[] = []
Returns string[]
Inherited from BaseCommand.setupHomeDirectory
- Defined in src/commands/base.ts:246

setupHomeDirectoryTask

setupHomeDirectoryTask(): { task: () => Promise<void>; tile: string }
Returns { task: () => Promise<void>; tile: string }
Inherited from BaseCommand.setupHomeDirectoryTask
- Defined in src/commands/base.ts:271

update

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

`Static`prepareValuesFilesMap

prepareValuesFilesMap(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: string,
    valuesFileInput?: string,
): Record<string, string>
Prepare the values files map for each cluster

Order of precedence:
1. Chart's default values file (if chartDirectory is set)
2. Profile values file
3. User's values file
Parameters
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: string
  the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<string, string>
Inherited from BaseCommand.prepareValuesFilesMap
- Defined in src/commands/base.ts:173

`Static`prepareValuesFilesMapMulticluster

prepareValuesFilesMapMulticluster(
    clusterReferences: ClusterReferences,
    chartDirectory?: string,
    profileValuesFile?: Record<string, string>,
    valuesFileInput?: string,
): Record<string, string>
Prepare the values files map for each cluster

Order of precedence:
1. Chart's default values file (if chartDirectory is set)
2. Profile values file
3. User's values file
Parameters
- clusterReferences: ClusterReferences
- OptionalchartDirectory: string
  the chart directory
- OptionalprofileValuesFile: Record<string, string>
  mapping of clusterRef to the profile values file full path
- OptionalvaluesFileInput: string
  the values file input string
Returns Record<string, string>
Inherited from BaseCommand.prepareValuesFilesMapMulticluster
- Defined in src/commands/base.ts:100

Class AccountCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AccountCommand

Properties

Protected ReadonlychartManager

ReadonlyconfigManager

Protected ReadonlydepManager

Protected Readonlyhelm

Protected Readonlyk8Factory

Protected ReadonlyleaseManager

ReadonlylocalConfig

Optionallogger

Protected ReadonlyremoteConfigManager

Static ReadonlyCOMMAND_NAME

Methods

close

Returns Promise<void>

create

Parameters

Returns Promise<boolean>

createNewAccount

Parameters

Returns Promise< { accountAlias?: string; accountId: string; balance: number; privateKey: string; publicKey: string; },>

get

Parameters

Returns Promise<boolean>

getCommandDefinition

Returns { builder: (yargs: any) => any; command: string; desc: string }

init

Parameters

Returns Promise<boolean>

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

setupHomeDirectoryTask

Returns { task: () => Promise<void>; tile: string }

update

Parameters

Returns Promise<boolean>

StaticprepareValuesFilesMap

Parameters

Returns Record<string, string>

StaticprepareValuesFilesMapMulticluster

Parameters

Returns Record<string, string>

Settings

On This Page

`Protected` `Readonly`chartManager

`Readonly`configManager

`Protected` `Readonly`depManager

`Protected` `Readonly`helm

`Protected` `Readonly`k8Factory

`Protected` `Readonly`leaseManager

`Readonly`localConfig

`Optional`logger

`Protected` `Readonly`remoteConfigManager

`Static` `Readonly`COMMAND_NAME

Returns Promise<
{
accountAlias?: string;
accountId: string;
balance: number;
privateKey: string;
publicKey: string;
},
>

`Static`prepareValuesFilesMap

`Static`prepareValuesFilesMapMulticluster