IntersectMBO / cardano-api

Cardano API
Apache License 2.0
22 stars 20 forks source link

Adapt user-facing functions' names to Lovelace->Coin renaming #611

Closed smelc closed 1 month ago

smelc commented 1 month ago

Changelog

- description: |
    Deprecated some functions named `*Lovelace*`. Use the same ones with the `Coin` name instead (as advised in deprecation stanza).
# 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

As noticed by https://github.com/IntersectMBO/cardano-api/issues/607, when we removed the Lovelace type (and replaced it with the ledger's Coin), we did not adapt function names accordingly. This PR hence deprecates the *Lovelace* functions and advice to use the same ones with the Coin name instead.

Fixes https://github.com/IntersectMBO/cardano-api/issues/607

How to trust this PR

Checklist

nhenin commented 1 month ago

Thx @smelc :-)