Skip to content

Update to new cardano-api's modules structure. Replace usage of parital IsString with parsers #1202

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.

Sign up for GitHub

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

Jump to bottom
Merged
carbolymer merged 4 commits into from
Jun 11, 2025
Merged

Update to new cardano-api's modules structure. Replace usage of parital IsString with parsers #1202

carbolymer merged 4 commits into from
Jun 11, 2025

Conversation

@carbolymer
Copy link
Contributor

@carbolymer carbolymer commented May 27, 2025 •
edited
Loading

Changelog

- description: |
    Add `--help` argument where it was missing.
    Upgrade [cardano-api-10.17.0.0](https://github.com/IntersectMBO/cardano-api/blob/master/cardano-api/CHANGELOG.md#101700). 
# 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
   - refactoring    # QoL changes
  # - 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

Integrates changes from:

Changes how we test help texts: instead of inducing a failure by invalid command usage, we now use --help toggle for the help text. Help text test will fail if the parsing results in an error.

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

@carbolymer carbolymer self-assigned this May 27, 2025
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-partial-instances branch 6 times, most recently from 4b4b148 to 4054443 Compare June 2, 2025 20:17
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-partial-instances branch 3 times, most recently from 8eaf886 to 288f3a3 Compare June 10, 2025 06:24
@carbolymer carbolymer mentioned this pull request Jun 10, 2025
Merged
9 tasks
@carbolymer carbolymer changed the title Remove partial instances Update to new cardano-api modules' structure. Remove partial instances Jun 10, 2025
@carbolymer carbolymer changed the title Update to new cardano-api modules' structure. Remove partial instances Update to new cardano-api's modules structure. Remove partial instances Jun 10, 2025
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-partial-instances branch from 288f3a3 to ad0d71b Compare June 11, 2025 08:46
@carbolymer carbolymer changed the title Update to new cardano-api's modules structure. Remove partial instances Update to new cardano-api's modules structure. Replace usage of parital IsString with parsers Jun 11, 2025
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-partial-instances branch from a0088b8 to 108ed6a Compare June 11, 2025 10:14
@carbolymer carbolymer marked this pull request as ready for review June 11, 2025 10:16
@carbolymer carbolymer requested a review from a team June 11, 2025 10:16
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-partial-instances branch 4 times, most recently from feb7551 to d751e82 Compare June 11, 2025 10:35
@carbolymer
Update Cardano.Api imports to the new structure
c7dff9d
@carbolymer
Fix help texts generation
5b04582 
Previously help texts were generated by forcing an invalid usage. Now
`--help` flag is used for that purpose.
@carbolymer carbolymer force-pushed the mgalazyn/refactor/remove-partial-instances branch from d751e82 to 5b04582 Compare June 11, 2025 10:58
Jimbo4350
Jimbo4350 reviewed Jun 11, 2025
View reviewed changes
cardano-cli/test/cardano-cli-golden/files/golden/help/query_tx-mempool_info.cli
Missing: (--mainnet | --testnet-magic NATURAL) --socket-path SOCKET_PATH
Usage: cardano-cli query tx-mempool info

Usage: cardano-cli query tx-mempool [--cardano-mode [--epoch-slots SLOTS]]
Copy link
Contributor

@Jimbo4350 Jimbo4350 Jun 11, 2025

Choose a reason for hiding this comment

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

Same here regarding losing test coverage.

cardano-cli/test/cardano-cli-golden/files/golden/help/query_tx-mempool_next-tx.cli
Usage: cardano-cli query tx-mempool next-tx

Usage: cardano-cli query tx-mempool [--cardano-mode [--epoch-slots SLOTS]]
(--mainnet | --testnet-magic NATURAL)
Copy link
Contributor

@Jimbo4350 Jimbo4350 Jun 11, 2025

Choose a reason for hiding this comment

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

Same here regarding losing test coverage.

@carbolymer carbolymer added this pull request to the merge queue Jun 11, 2025
Merged via the queue into master with commit 91a8e09 Jun 11, 2025
25 checks passed
@carbolymer carbolymer deleted the mgalazyn/refactor/remove-partial-instances branch June 11, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jimbo4350 Jimbo4350 Jimbo4350 approved these changes

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy is a code owner

@palas palas Awaiting requested review from palas palas is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler is a code owner

Assignees

@carbolymer carbolymer

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@carbolymer @Jimbo4350