Skip to content

cli utils for post processing ts-proto output, useful for cosmos based tx messaging

License

Notifications You must be signed in to change notification settings

onezoomin/protots

Repository files navigation

protots (oclif generated cli)

protots const will generate a tree of constants for all tx in the given folder. (eventually via #3)

example command and output

./bin/dev const src/generated/cosmos/ -i '["v1/tx.ts", "v1beta1/tx.ts"]'

export const MSGS = {
  "COSMOS": {
    "BANK": {
      "SEND": "/cosmos.bank.v1beta1.MsgSend",
      "MULTI_SEND": "/cosmos.bank.v1beta1.MsgMultiSend",
      "CLIENT_IMPL": "/cosmos.bank.v1beta1.MsgClientImpl"
    },
    "DISTRIBUTION": {
      "SET_WITHDRAW_ADDRESS": "/cosmos.distribution.v1beta1.MsgSetWithdrawAddress",
      "WITHDRAW_DELEGATOR_REWARD": "/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward",
      "WITHDRAW_VALIDATOR_COMMISSION": "/cosmos.distribution.v1beta1.MsgWithdrawValidatorCommission",
      "FUND_COMMUNITY_POOL": "/cosmos.distribution.v1beta1.MsgFundCommunityPool",
      "CLIENT_IMPL": "/cosmos.distribution.v1beta1.MsgClientImpl"
    },
    "CRISIS": {
      "VERIFY_INVARIANT": "/cosmos.crisis.v1beta1.MsgVerifyInvariant",
      "CLIENT_IMPL": "/cosmos.crisis.v1beta1.MsgClientImpl"
    },
    "EVIDENCE": {
      "SUBMIT_EVIDENCE": "/cosmos.evidence.v1beta1.MsgSubmitEvidence",
      "CLIENT_IMPL": "/cosmos.evidence.v1beta1.MsgClientImpl"
    },
    "GOV": {
      "SUBMIT_PROPOSAL": "/cosmos.gov.v1beta1.MsgSubmitProposal",
      "VOTE": "/cosmos.gov.v1beta1.MsgVote",
      "DEPOSIT": "/cosmos.gov.v1beta1.MsgDeposit",
      "CLIENT_IMPL": "/cosmos.gov.v1beta1.MsgClientImpl"
    },
    "VESTING": {
      "CREATE_VESTING_ACCOUNT": "/cosmos.vesting.v1beta1.MsgCreateVestingAccount",
      "CLIENT_IMPL": "/cosmos.vesting.v1beta1.MsgClientImpl"
    },
    "SLASHING": {
      "UNJAIL": "/cosmos.slashing.v1beta1.MsgUnjail",
      "CLIENT_IMPL": "/cosmos.slashing.v1beta1.MsgClientImpl"
    },
    "STAKING": {
      "CREATE_VALIDATOR": "/cosmos.staking.v1beta1.MsgCreateValidator",
      "EDIT_VALIDATOR": "/cosmos.staking.v1beta1.MsgEditValidator",
      "DELEGATE": "/cosmos.staking.v1beta1.MsgDelegate",
      "BEGIN_REDELEGATE": "/cosmos.staking.v1beta1.MsgBeginRedelegate",
      "UNDELEGATE": "/cosmos.staking.v1beta1.MsgUndelegate",
      "CLIENT_IMPL": "/cosmos.staking.v1beta1.MsgClientImpl"
    },
    "TX": {}
  }
} 

...

oclif example stuff below

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g protots
$ protots COMMAND
running command...
$ protots (--version)
protots/0.0.0 darwin-x64 node-v14.18.2
$ protots --help [COMMAND]
USAGE
  $ protots COMMAND
...

Commands

protots help [COMMAND]

Display help for protots.

USAGE
  $ protots help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for protots.

See code: @oclif/plugin-help

protots plugins

List installed plugins.

USAGE
  $ protots plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ protots plugins

See code: @oclif/plugin-plugins

protots plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ protots plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ protots plugins:inspect myplugin

protots plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ protots plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ protots plugins add

EXAMPLES
  $ protots plugins:install myplugin 

  $ protots plugins:install https://github.com/someuser/someplugin

  $ protots plugins:install someuser/someplugin

protots plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ protots plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ protots plugins:link myplugin

protots plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ protots plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ protots plugins unlink
  $ protots plugins remove

protots plugins update

Update installed plugins.

USAGE
  $ protots plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

About

cli utils for post processing ts-proto output, useful for cosmos based tx messaging

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published