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.

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

Refactor TxMintValue #663

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft

Refactor TxMintValue #663

wants to merge 5 commits into from
+170 −126

Conversation

carbolymer
Copy link
Contributor

Changelog

- description: |
    <insert-changelog-description-here>
# 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

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

@carbolymer carbolymer force-pushed the mgalazyn/feature/refactor-txmintvalue branch 3 times, most recently from ef2b00c to c2c740b Compare October 31, 2024 11:49
@carbolymer carbolymer force-pushed the mgalazyn/feature/refactor-txmintvalue branch 8 times, most recently from 6e860f9 to fefbe40 Compare November 4, 2024 20:31
Jimbo4350
Jimbo4350 reviewed Nov 6, 2024
View reviewed changes
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.

This looks good to me. One gripe regarding traverseScriptWitnesses. Clean up and I'll have a final look before approving.

cardano-api/internal/Cardano/Api/Tx/Body.hs
, (assetName', quantity, _) <- assets
]

-- | Index the assets with witnesses in the order of policy ids.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add a comment here referencing the spec and why we have to index on the order of policy ids?

cardano-api/internal/Cardano/Api/Tx/Body.hs
@@ -1588,7 +1619,7 @@ data TxBodyError
| TxBodyOutputNegative !Quantity !TxOutInAnyEra
| TxBodyOutputOverflow !Quantity !TxOutInAnyEra
| TxBodyMetadataError ![(Word64, TxMetadataRangeError)]
| TxBodyMintAdaError
| TxBodyMintAdaError -- TODO remove - case nonexistent
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

cardano-api/internal/Cardano/Api/Fees.hs

traverseScriptWitnesses
:: [(a, Either (TxBodyErrorAutoBalance era) (ScriptWitness ctx era))]
-> Either (TxBodyErrorAutoBalance era) [(a, ScriptWitness ctx era)]
:: [(a, Either (TxBodyErrorAutoBalance era) b)]
Copy link
Contributor

Choose a reason for hiding this comment

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

This may be "neater" Haskell but making this more generic doesn't really help the reader IMO. Also it's only instantiated to ScriptWitness ctx era.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not only instantiated to ScriptWitness ctx era - in line 1629 is used against

        [ (Value, Either (TxBodyErrorAutoBalance era)
          ( AssetName
          , Quantity
          , BuildTxWith build (ScriptWitness WitCtxMint era)
          )
        ]

cardano-api/internal/Cardano/Api/Tx/Body.hs
(Map PolicyId (ScriptWitness WitCtxMint era))
-> Map
PolicyId
[ ( AssetName
Copy link
Contributor

Choose a reason for hiding this comment

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

A 3-tuple is less than ideal but I can't think of what to call this instead.

cardano-api/internal/Cardano/Api/Script.hs
@@ -676,6 +677,17 @@ data WitCtx witctx where
WitCtxMint :: WitCtx WitCtxMint
WitCtxStake :: WitCtx WitCtxStake

-- TODO: not needed anymore - remove
Copy link
Contributor

Choose a reason for hiding this comment

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

👍

@carbolymer carbolymer force-pushed the mgalazyn/feature/refactor-txmintvalue branch from 5842e38 to 416a201 Compare November 19, 2024 13:33
@carbolymer
Copy link
Contributor Author

carbolymer commented Nov 19, 2024 •
edited
Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jimbo4350 Jimbo4350 Jimbo4350 left review comments

@dcoutts dcoutts Awaiting requested review from dcoutts dcoutts will be requested when the pull request is marked ready for review dcoutts is a code owner

@erikd erikd Awaiting requested review from erikd erikd will be requested when the pull request is marked ready for review erikd is a code owner

@newhoggy newhoggy Awaiting requested review from newhoggy newhoggy will be requested when the pull request is marked ready for review newhoggy is a code owner

@smelc smelc Awaiting requested review from smelc smelc will be requested when the pull request is marked ready for review smelc is a code owner

@palas palas Awaiting requested review from palas palas will be requested when the pull request is marked ready for review palas is a code owner

@kevinhammond kevinhammond Awaiting requested review from kevinhammond kevinhammond will be requested when the pull request is marked ready for review kevinhammond is a code owner

@CarlosLopezDeLara CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara will be requested when the pull request is marked ready for review CarlosLopezDeLara is a code owner

@disassembler disassembler Awaiting requested review from disassembler disassembler will be requested when the pull request is marked ready for review disassembler is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@carbolymer @Jimbo4350