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

Remove legacy commands #905

Merged
merged 7 commits into from
Sep 26, 2024
Merged

Remove legacy commands #905

merged 7 commits into from
Sep 26, 2024

Conversation

Jimbo4350
Copy link
Contributor

@Jimbo4350 Jimbo4350 commented Sep 19, 2024

Changelog

cardano-cli's command line has changed as follows:

cardano-cli - General purpose command-line utility to interact with
cardano-node. Provides specific commands to manage keys, addresses, build &
submit transactions, certificates, etc.
 
 Usage: cardano-cli 
-                     ( shelley
+                     ( legacy
+                     | byron
+                     | shelley
                      | allegra
                      | mary
                      | alonzo
                      | babbage
                      | conway
                      | latest
-                     | legacy
-                     | Legacy commands
-                     | byron
                      | hash
                      | ping
                      | debug commands
@@ -24,6 +23,13 @@
   -h,--help                Show this help text
 
 Available commands:
+  legacy                   Legacy commands
+
+Byron specific commands
+  byron                    Byron specific commands
+
+Available commands:
   shelley                  Shelley era commands - DEPRECATED - will be removed
                            in the future
   allegra                  Allegra era commands - DEPRECATED - will be removed
@@ -35,31 +41,8 @@
   babbage                  Babbage era commands - DEPRECATED - will be removed
                            in the future
   conway                   Conway era commands
-  latest                   Latest era commands (Babbage) - DEPRECATED - will be
+  latest                   Latest era commands (Conway)
-  legacy                   Legacy commands - DEPRECATED - will be removed in the
-                           future
-
-Legacy commands
-  address                  Payment address commands
-  stake-address            Stake address commands
-  key                      Key utility commands
-  transaction              Transaction commands
-  node                     Node operation commands
-  stake-pool               Stake pool commands
-  query                    Node query commands. Will query the local node whose
-                           Unix domain socket is obtained from the
-                           CARDANO_NODE_SOCKET_PATH environment variable.
-  genesis                  Genesis block commands
-  governance               Governance commands
-  text-view                Commands for dealing with Shelley TextView files.
-                           Transactions, addresses etc are stored on disk as
-                           TextView files.
-
-Byron specific commands
-  byron                    Byron specific commands
-
-Available commands:
   hash                     Compute the hash to pass to the various --*-hash
                            arguments of commands.
   ping                     Ping a cardano node either using node-to-node or node-to-client protocol. It negotiates a handshake and keeps sending keep alive messages.
- description: |
    Large deprecation of legacy commands and removal of related code.
# uncomment types applicable to the change:
  type:
  - breaking       # the API has changed in a breaking way

Context

Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff

Comment on lines 53 to 55
-- There are name clashes between Shelley commands and the Byron backwards
-- compat commands (e.g. "genesis"), and we need to prefer the Shelley ones
-- so we list it first.
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment needs updating

@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-legacy-commands branch 2 times, most recently from f74ae10 to 51adbc9 Compare September 23, 2024 13:56
@Jimbo4350
Copy link
Contributor Author

Don't merge until QA signs off cc: @mkoura

@mkoura
Copy link
Contributor

mkoura commented Sep 24, 2024

Looking good 👍

I modified cardano-node-tests and cardano-clusterlib-py to work with the change (and stay compatible with older cardano-cli releases), and all regression tests passed.

- Cardano.CLI.Legacy.Commands.Key
- Cardano.CLI.Legacy.Commands.Transaction
- Cardano.CLI.Legacy.Commands.Query
- Cardano.CLI.Legacy.Commands.TextView
- Cardano.CLI.Legacy.Commands.StakePool
- Cardano.CLI.Legacy.Commands.StakeAddress
- Cardano.CLI.Legacy.Commands.Node
- Cardano.CLI.Legacy.Options.Key
- Cardano.CLI.Legacy.Commands.Address
- Cardano.CLI.Legacy.Run.Transaction
- Cardano.CLI.Legacy.Run.TextView
- Cardano.CLI.Legacy.Run.StakePool
- Cardano.CLI.Legacy.Run.StakeAddress
- Cardano.CLI.Legacy.Run.Address
- Cardano.CLI.Legacy.Run.Key
- Cardano.CLI.Legacy.Run.Node
- Cardano.CLI.Legacy.Run.Query
@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-legacy-commands branch from cf70d78 to bf24a35 Compare September 26, 2024 11:25
@Jimbo4350 Jimbo4350 force-pushed the jordan/deprecate-legacy-commands branch from bf24a35 to 935cea1 Compare September 26, 2024 11:34
@Jimbo4350 Jimbo4350 merged commit 74ff1d6 into main Sep 26, 2024
23 of 25 checks passed
@Jimbo4350 Jimbo4350 deleted the jordan/deprecate-legacy-commands branch September 26, 2024 11:53
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.

3 participants