Class TransactionSignCommandAbstract

Hierarchy

  • default
    • TransactionSignCommand

Constructors

constructor

Properties

_client _dataPath _metadata _schema argv config debug id _base _enableJsonFlag _flags _globalFlags aliases args deprecateAliases? deprecationOptions? description examples flags help hidden id parse parserOptions plugin run state? strict summary? usage

Accessors

ctor enableJsonFlag globalFlags

Methods

_run catch error exit finally getApplication init jsonEnabled log logToStderr parse printJSON run toErrorJson toSuccessJson warn warnIfCommandDeprecated warnIfFlagDeprecated

Constructors

constructor

  • Parameters

    • argv: string[]
    • config: Config

    Returns TransactionSignCommand

Properties

Protected _client

_client: undefined | APIClient

Protected _dataPath

_dataPath: string

Protected _metadata

_metadata: ModuleMetadataJSON[]

Protected _schema

_schema: RegisteredSchema

argv

argv: string[]

config

config: Config

Protected debug

debug: ((...args: any[]) => void)

Type declaration

    • (...args: any[]): void

    • Parameters

      • Rest ...args: any[]

      Returns void

id

id: undefined | string

Static _base

_base: string

Static _enableJsonFlag

_enableJsonFlag: boolean

Protected Static _flags

_flags: FlagInput<{
    [flag: string]: any;
}>

A hash of flags for the command

Protected Static _globalFlags

_globalFlags: FlagInput<{
    [flag: string]: any;
}>

Static aliases

aliases: string[]

An array of aliases for this command.

Static args

args: {
    description: string;
    name: string;
    required: boolean;
}[] = ...

Static Optional deprecateAliases

deprecateAliases?: boolean

Emit deprecation warning when a command alias is used

Static Optional deprecationOptions

deprecationOptions?: Deprecation

Static description

description: string = 'Sign encoded transaction.'

Static examples

examples: string[] = ...

Static flags

flags: {
    chain-id: OptionFlag<undefined | string>;
    data-path: OptionFlag<undefined | string>;
    json: BooleanFlag<boolean>;
    key-derivation-path: OptionFlag<string>;
    mandatory-keys: OptionFlag<undefined | string[]>;
    offline: {
        aliases?: string[];
        allowNo: boolean;
        char?: AlphabetLowercase | AlphabetUppercase;
        default?: Default<boolean, Record<string, unknown>>;
        dependsOn: string[];
        deprecateAliases?: boolean;
        deprecated?: true | Deprecation;
        description?: string;
        env?: string;
        exactlyOne?: string[];
        exclusive: string[];
        helpGroup?: string;
        helpLabel?: string;
        hidden?: boolean;
        name: string;
        parse: FlagParser<boolean, boolean, any>;
        relationships?: Relationship[];
        required?: boolean;
        summary?: string;
        type: "boolean";
    };
    optional-keys: OptionFlag<undefined | string[]>;
    passphrase: OptionFlag<undefined | string>;
    pretty: BooleanFlag<boolean>;
} = ...

Type declaration

  • chain-id: OptionFlag<undefined | string>
  • data-path: OptionFlag<undefined | string>
  • json: BooleanFlag<boolean>
  • key-derivation-path: OptionFlag<string>
  • mandatory-keys: OptionFlag<undefined | string[]>
  • offline: {
        aliases?: string[];
        allowNo: boolean;
        char?: AlphabetLowercase | AlphabetUppercase;
        default?: Default<boolean, Record<string, unknown>>;
        dependsOn: string[];
        deprecateAliases?: boolean;
        deprecated?: true | Deprecation;
        description?: string;
        env?: string;
        exactlyOne?: string[];
        exclusive: string[];
        helpGroup?: string;
        helpLabel?: string;
        hidden?: boolean;
        name: string;
        parse: FlagParser<boolean, boolean, any>;
        relationships?: Relationship[];
        required?: boolean;
        summary?: string;
        type: "boolean";
    }
    • Optional aliases?: string[]

      Alternate names that can be used for this flag.

    • allowNo: boolean
    • Optional char?: AlphabetLowercase | AlphabetUppercase
    • Optional default?: Default<boolean, Record<string, unknown>>

      specifying a default of false is the same as not specifying a default

    • dependsOn: string[]
    • Optional deprecateAliases?: boolean

      Emit deprecation warning when a flag alias is provided

    • Optional deprecated?: true | Deprecation

      Make the flag as deprecated.

    • Optional description?: string

      A description of flag usage. If summary is provided, the description is assumed to be a longer description and will be shown in a separate section within help.

    • Optional env?: string

      Accept an environment variable as input

    • Optional exactlyOne?: string[]

      Exactly one of these flags must be provided.

    • exclusive: string[]
    • Optional helpGroup?: string

      Shows this flag in a separate list in the help.

    • Optional helpLabel?: string

      The flag label to show in help. Defaults to "[-] --" where - is only displayed if the char is defined.

    • Optional hidden?: boolean

      If true, the flag will not be shown in the help.

    • name: string
    • parse: FlagParser<boolean, boolean, any>
    • Optional relationships?: Relationship[]

      Define complex relationships between flags.

    • Optional required?: boolean

      If true, the flag will be required.

    • Optional summary?: string

      A short summary of flag usage to show in the flag list. If not provided, description will be used.

    • type: "boolean"
  • optional-keys: OptionFlag<undefined | string[]>
  • passphrase: OptionFlag<undefined | string>
  • pretty: BooleanFlag<boolean>

Static help

help: undefined | string

Static hidden

hidden: boolean

Hide the command from help

Static id

id: string

A command ID, used mostly in error or verbose reporting.

Static parse

parse: boolean

Static parserOptions

parserOptions: {}

Type declaration

    Static plugin

    plugin: undefined | Plugin

    Static run

    run: ((argv?: string[], config?: LoadOptions) => PromiseLike<any>)

    Type declaration

      • (argv?: string[], config?: LoadOptions): PromiseLike<any>

      • instantiate and run the command

        Parameters

        • Optional argv: string[]

          argv

        • Optional config: LoadOptions

        Returns PromiseLike<any>

    Static Optional state

    state?: string

    Mark the command as a given state (e.g. beta or deprecated) in help

    Static strict

    strict: boolean

    When set to false, allows a variable amount of arguments

    Static Optional summary

    summary?: string

    The tweet-sized description for your class, used in a parent-commands sub-command listing and as the header for the command help.

    Static usage

    usage: undefined | string | string[]

    An override string (or strings) for the default usage documentation.

    Accessors

    ctor

    • get ctor(): typeof default

    • Returns typeof default

    Static enableJsonFlag

    • get enableJsonFlag(): boolean

    • Returns boolean

    • set enableJsonFlag(value: boolean): void

    • Parameters

      • value: boolean

      Returns void

    Static globalFlags

    • get globalFlags(): FlagInput<{
          [flag: string]: any;
      }>

    • Returns FlagInput<{
          [flag: string]: any;
      }>

    • set globalFlags(flags: FlagInput<{
          [flag: string]: any;
      }>): void

    • Parameters

      • flags: FlagInput<{
            [flag: string]: any;
        }>

      Returns void

    Methods

    _run

    • _run<T>(): Promise<undefined | T>

    • Type Parameters

      • T

      Returns Promise<undefined | T>

    Protected catch

    • Parameters

      • err: CommandError

      Returns Promise<any>

    error

    • Parameters

      • input: string | Error
      • options: {
            code?: string;
            exit: false;
        } & PrettyPrintableError

      Returns void

    • Parameters

      • input: string | Error
      • Optional options: {
            code?: string;
            exit?: number;
        } & PrettyPrintableError

      Returns never

    exit

    • Parameters

      • Optional code: number

      Returns void

    finally

    Abstract getApplication

    Protected init

    • Returns Promise<any>

    jsonEnabled

    • Returns boolean

    log

    • Parameters

      • Optional message: string
      • Rest ...args: any[]

      Returns void

    logToStderr

    • Parameters

      • Optional message: string
      • Rest ...args: any[]

      Returns void

    Protected parse

    • Type Parameters

      • F extends FlagOutput

      • G extends FlagOutput

      • A extends {
            [name: string]: any;
        }

      Parameters

      • Optional options: Input<F, G>
      • Optional argv: string[]

      Returns Promise<ParserOutput<F, G, A>>

    printJSON

    run

    Protected toErrorJson

    • Parameters

      • err: unknown

      Returns any

    Protected toSuccessJson

    • Parameters

      • result: unknown

      Returns any

    warn

    • Parameters

      • input: string | Error

      Returns string | Error

    Protected warnIfCommandDeprecated

    • Returns void

    Protected warnIfFlagDeprecated

    • Parameters

      • flags: Record<string, unknown>

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc