Class AccountCommand

Hierarchy (View Summary)

BaseCommand
- AccountCommand

Constructors

constructor

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

Properties

`Protected` `Readonly`_configMaps

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

`Protected` `Readonly`chartManager

chartManager: ChartManager

`Protected` `Readonly`configManager

configManager: ConfigManager

`Protected` `Readonly`depManager

depManager: DependencyManager

`Protected` `Readonly`helm

helm: Helm

`Protected` `Readonly`k8

k8: K8

`Protected` `Readonly`leaseManager

leaseManager: LeaseManager

`Protected` `Readonly`localConfig

localConfig: LocalConfig

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`remoteConfigManager

remoteConfigManager: RemoteConfigManager

Methods

buildAccountInfo

buildAccountInfo(
    accountInfo: AccountInfo,
    namespace: string,
    shouldRetrievePrivateKey: boolean,
): Promise<
    {
        accountId: string;
        balance: number;
        privateKey?: string;
        privateKeyRaw?: string;
        publicKey: string;
    },
>
Parameters
- accountInfo: AccountInfo
- namespace: string
- shouldRetrievePrivateKey: boolean
Returns Promise<
    {
        accountId: string;
        balance: number;
        privateKey?: string;
        privateKeyRaw?: string;
        publicKey: string;
    },
>
- Defined in solo/solo/src/commands/account.ts:58

close

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

closeConnections

closeConnections(): Promise<void>
Returns Promise<void>
- Defined in solo/solo/src/commands/account.ts:54

commandActionBuilder

commandActionBuilder(
    actionTasks: any,
    options: any,
    errorString: string,
    lease: Lease,
): (argv: any, commandDef: CommandHandlers) => Promise<void>
Parameters
- actionTasks: any
- options: any
- errorString: string
- lease: Lease
Returns (argv: any, commandDef: CommandHandlers) => Promise<void>
Inherited from BaseCommand.commandActionBuilder
- Defined in solo/solo/src/commands/base.ts:207

create

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

createNewAccount

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

get

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

getAccountInfo

getAccountInfo(ctx: { config: { accountId: string } }): Promise<AccountInfo>
Parameters
- ctx: { config: { accountId: string } }
Returns Promise<AccountInfo>
- Defined in solo/solo/src/commands/account.ts:119

getChartManager

getChartManager(): ChartManager
Returns ChartManager
Inherited from BaseCommand.getChartManager
- Defined in solo/solo/src/commands/base.ts:104

getCommandDefinition

getCommandDefinition(): {
    builder: CommandBuilder;
    command: string;
    desc: string;
}
Return Yargs command definition for 'node' command

Returns { builder: CommandBuilder; command: string; desc: string }
- Defined in solo/solo/src/commands/account.ts:550

getConfig

getConfig(
    configName: string,
    flags: CommandFlag[],
    extraProperties?: string[],
): object
Dynamically builds a class with properties from the provided list of flags and extra properties, will keep track of which properties are used. Call getUnusedConfigs() to get an array of unused properties.
Parameters
- configName: string
- flags: CommandFlag[]
- extraProperties: string[] = []
Returns object
Inherited from BaseCommand.getConfig
- Defined in solo/solo/src/commands/base.ts:113

getUnusedConfigs

getUnusedConfigs(configName: string): string[]
Get the list of unused configurations that were not accessed
Parameters
- configName: string
Returns string[]
an array of unused configurations
Inherited from BaseCommand.getUnusedConfigs
- Defined in solo/solo/src/commands/base.ts:189

init

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

prepareChartPath

prepareChartPath(
    chartDir: string,
    chartRepo: string,
    chartReleaseName: string,
): Promise<string>
Parameters
- chartDir: string
- chartRepo: string
- chartReleaseName: string
Returns Promise<string>
Inherited from BaseCommand.prepareChartPath
- Defined in solo/solo/src/commands/base.ts:74

prepareValuesFiles

prepareValuesFiles(valuesFile: string): string
Parameters
- valuesFile: string
Returns string
Inherited from BaseCommand.prepareValuesFiles
- Defined in solo/solo/src/commands/base.ts:87

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 solo/solo/src/core/shell_runner.ts:30

setupHomeDirectory

setupHomeDirectory(dirs?: string[]): string[]
Setup home directories
Parameters
- dirs: string[] = ...
  a list of directories that need to be created in sequence
Returns string[]
Inherited from BaseCommand.setupHomeDirectory
- Defined in solo/solo/src/commands/base.ts:231

setupHomeDirectoryTask

setupHomeDirectoryTask(): Task
Returns Task
Inherited from BaseCommand.setupHomeDirectoryTask
- Defined in solo/solo/src/commands/base.ts:256

transferAmountFromOperator

transferAmountFromOperator(
toAccountId: AccountId,
amount: number,
): Promise<boolean>
Parameters
- toAccountId: AccountId
- amount: number
Returns Promise<boolean>
- Defined in solo/solo/src/commands/account.ts:155

update

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

updateAccountInfo

updateAccountInfo(ctx: any): Promise<boolean>
Parameters
- ctx: any
Returns Promise<boolean>
- Defined in solo/solo/src/commands/account.ts:123

Class AccountCommand

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AccountCommand

Properties

Protected Readonly_configMaps

Protected ReadonlychartManager

Protected ReadonlyconfigManager

Protected ReadonlydepManager

Protected Readonlyhelm

Protected Readonlyk8

Protected ReadonlyleaseManager

Protected ReadonlylocalConfig

Optionallogger

Protected ReadonlyremoteConfigManager

Methods

buildAccountInfo

Parameters

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

close

Returns Promise<void>

closeConnections

Returns Promise<void>

commandActionBuilder

Parameters

Returns (argv: any, commandDef: CommandHandlers) => 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>

getAccountInfo

Parameters

Returns Promise<AccountInfo>

getChartManager

Returns ChartManager

getCommandDefinition

Returns { builder: CommandBuilder; command: string; desc: string }

getConfig

Parameters

Returns object

getConfigManager

Returns ConfigManager

getK8

Returns K8

getLeaseManager

Returns LeaseManager

getLocalConfig

Returns LocalConfig

getRemoteConfigManager

Returns RemoteConfigManager

getUnusedConfigs

Parameters

Returns string[]

init

Parameters

Returns Promise<boolean>

prepareChartPath

Parameters

Returns Promise<string>

prepareValuesFiles

Parameters

Returns string

run

Parameters

Returns Promise<string[]>

setupHomeDirectory

Parameters

Returns string[]

setupHomeDirectoryTask

`Protected` `Readonly`_configMaps

`Protected` `Readonly`chartManager

`Protected` `Readonly`configManager

`Protected` `Readonly`depManager

`Protected` `Readonly`helm

`Protected` `Readonly`k8

`Protected` `Readonly`leaseManager

`Protected` `Readonly`localConfig

`Optional`logger

`Protected` `Readonly`remoteConfigManager

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

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