Skip to content

Update TxInsReference haddock to mention public key inputs#851

Merged
nbacquey merged 1 commit intomasterfrom
mgalazyn/chore/update-txinsreference-haddock
Jun 4, 2025
Merged

Update TxInsReference haddock to mention public key inputs#851
nbacquey merged 1 commit intomasterfrom
mgalazyn/chore/update-txinsreference-haddock

Conversation

@carbolymer
Copy link
Copy Markdown
Contributor

@carbolymer carbolymer commented May 27, 2025

Changelog

- description: |
    Update TxInsReference haddock to mention public key inputs
# 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

IntersectMBO/cardano-node#6174 (comment)

Adds clarification public key inputs resolved datum-related types.

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

@nbacquey nbacquey added this pull request to the merge queue Jun 4, 2025
Merged via the queue into master with commit 3b17c77 Jun 4, 2025
28 checks passed
@nbacquey nbacquey deleted the mgalazyn/chore/update-txinsreference-haddock branch June 4, 2025 15:31
-- ^ A set of datums, whose hashes are referenced in UTXO of reference inputs. Those datums will be inserted
-- to the datum map available to the scripts. Note that inserting a datum with hash not present in the reference
-- input will result in an error on transaction submission.
-- ^ A set of public key inputs resolved datums, whose hashes are referenced in UTXO of reference inputs. Those
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is till too opaque. Imagine coming back to this in a year. Include the reason why this was added and what problem it solves.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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