Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cardano-cli: add governance create-info command #292

Merged
merged 4 commits into from
Sep 20, 2023

Conversation

smelc
Copy link
Contributor

@smelc smelc commented Sep 20, 2023

Changelog

- description: |
    Implementation of the create-info command
# uncomment types applicable to the change:
  type:
  - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Fixes #289

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • The change log section in the PR description has been filled in
  • New tests are added if needed and existing tests are updated. These may include:
    • golden tests
    • property tests
    • round trip tests
    • integration tests
      See Running tests for more details
  • The version bounds in .cabal files are updated
  • CI passes. See note on CI. The following CI checks are required:
    • Code is linted with hlint. See .github/workflows/check-hlint.yml to get the hlint version
    • Code is formatted with stylish-haskell. See .github/workflows/stylish-haskell.yml to get the stylish-haskell version
    • Code builds on Linux, MacOS and Windows for ghc-8.10.7 and ghc-9.2.7
  • The changelog section in the PR is updated to describe the change
  • Self-reviewed the diff

@smelc
Copy link
Contributor Author

smelc commented Sep 20, 2023

As of , the output of cardano-cli conway governance action create-info --help is as follows:

Usage: cardano-cli conway governance action create-info (--mainnet | --testnet)
                                                          --governance-action-deposit NATURAL
                                                          ( --stake-pool-verification-key STRING
                                                          | --cold-verification-key-file FILE
                                                          | --stake-pool-id STAKE_POOL_ID
                                                          | --stake-verification-key STRING
                                                          | --stake-verification-key-file FILE
                                                          | --stake-key-hash HASH
                                                          )
                                                          --proposal-url TEXT
                                                          ( --proposal-text TEXT
                                                          | --proposal-file FILE
                                                          | --proposal-hash HASH
                                                          )
                                                          --out-file FILE

  Create an info action.

Available options:
  --mainnet                Use the mainnet magic id.
  --testnet                Use the testnet magic id.
  --governance-action-deposit NATURAL
                           Deposit required to submit a governance action.
  --stake-pool-verification-key STRING
                           Stake pool verification key (Bech32 or hex-encoded).
  --cold-verification-key-file FILE
                           Filepath of the stake pool verification key.
  --stake-pool-id STAKE_POOL_ID
                           Stake pool ID/verification key hash (either
                           Bech32-encoded or hex-encoded). Zero or more
                           occurences of this option is allowed.
  --stake-verification-key STRING
                           Stake verification key (Bech32 or hex-encoded).
  --stake-verification-key-file FILE
                           Filepath of the staking verification key.
  --stake-key-hash HASH    Stake verification key hash (hex-encoded).
  --proposal-url TEXT      Proposal anchor URL
  --proposal-text TEXT     Input proposal as UTF-8 encoded text.
  --proposal-file FILE     Input proposal as a text file.
  --proposal-hash HASH     Proposal anchor data hash.
  --out-file FILE          Path to action file to be used later on with build or
                           build-raw
  -h,--help                Show this help text

@smelc smelc force-pushed the smelc/create-info-governance-action branch 2 times, most recently from c33e04e to 4d5eb96 Compare September 20, 2023 13:05
@newhoggy
Copy link
Contributor

You will need to check in the test/cardano-cli-golden/files/golden/help/conway_governance_action_create-info.cli file as well.

Copy link
Contributor

@Jimbo4350 Jimbo4350 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work 👍 . Just a small style issue to fix.

@smelc smelc force-pushed the smelc/create-info-governance-action branch from 9bd2d4c to 988c91b Compare September 20, 2023 15:12
@smelc smelc enabled auto-merge September 20, 2023 15:14
@smelc smelc added this pull request to the merge queue Sep 20, 2023
Merged via the queue into main with commit a0bbd49 Sep 20, 2023
@smelc smelc deleted the smelc/create-info-governance-action branch September 20, 2023 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

missing create-info governance action
3 participants