Skip to content

Commit

Permalink
Prepare v9.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
klntsky committed Jul 24, 2024
1 parent ddbd601 commit 372a3c7
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 13 deletions.
16 changes: 9 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [[Unreleased]](#unreleased)
- [[v9.0.0]](#v900)
- [Deprecated](#deprecated)
- [Added](#added)
- [Removed](#removed)
Expand Down Expand Up @@ -68,7 +68,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## [Unreleased]
## [v9.0.0]

### Deprecated

Expand All @@ -78,23 +78,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Added

- `Contract.Transaction.buildTx :: Array TransactionBuilderStep -> Contract Transaction` that provides a `Contract`-based interface for the [new transaction builder](https://github.com/mlabs-haskell/purescript-cardano-transaction-builder).
- `submitTxFromBuildPlan :: UtxoMap -> BalanceTxConstraintsBuilder -> Array TransactionBuilderStep -> Contract Transaction` - a convenience function that executes the whole transaction creation pipeline starting from a build plan for [the new transaction builder](https://github.com/mlabs-haskell/purescript-cardano-transaction-builder).
- `Contract.Transaction.submitTxFromBuildPlan :: UtxoMap -> BalanceTxConstraintsBuilder -> Array TransactionBuilderStep -> Contract Transaction` - a convenience function that executes the whole transaction creation pipeline starting from a build plan for [the new transaction builder](https://github.com/mlabs-haskell/purescript-cardano-transaction-builder).
- `Contract.ClientError.pprintClientError` to provide readable error reports.
- `Contract.Staking.getStakeCredentialDelegationsAndRewards` utility function

### Removed

- **IMPORTANT** `UnbalancedTx` type has been removed. This change was motivated by the fact that `UnbalancedTx` existed simply to tie together transaction building and balancing by keeping extra context. Now that transaction builder is placed in [its own package](https://github.com/mlabs-haskell/purescript-cardano-transaction-builder), there is no more need in `UnbalancedTx`, that is not used with the new builder.
- **IMPORTANT** `Contract.Scripts.applyArgs` - use `Cardano.Plutus.ApplyArgs.applyArgs` from [purescript-uplc-apply-args](https://github.com/mlabs-haskell/purescript-uplc-apply-args)
- **IMPORTANT** `balanceTxWithConstraints` - use `balanceTx`
- **IMPORTANT** `balanceTxWithConstraints`, `balanceTxWithConstraintsE` - use `balanceTx`
- **IMPORTANT** `balanceTxsWithConstraints` - use `balanceTxs`
- **IMPORTANT** `withBalancedTxWithConstraints`, `withBalancedTxWithConstraints` - use `withBalancedTxs`
- **IMPORTANT** `Contract.Scripts.applyArgs` - use `Cardano.Plutus.ApplyArgs.applyArgs` from [purescript-uplc-apply-args](https://github.com/mlabs-haskell/purescript-uplc-apply-args).
- `Contract.Transaction.submitTxFromConstraintsReturningFee` - too niche use case to be allowed in the public API.
- `Contract.Transaction` lens values. Use lenses from `Cardano.Types.Transaction`

### Changed

- `Contract.Transaction.mkUnbalancedTx` now returns a tuple: a transaction and its used UTxOs.
- `Contract.Transaction.mkUnbalancedTx` now returns a tuple: a transaction and the UTxOs it used.
- `Contract.Transaction.balanceTx` accepts two extra argument: a list of used UTxOs (set to `Data.Map.empty` if none of them are coming from the outside of the wallet) and balancer constraints (set to `mempty` if not needed)
- Default synchronization parameters: all [wallet <-> query layer synchronization primitives](./doc/query-layers.md) are now off by default. The reason is that the runtime overhead made the users unhappy and it was not worth it for most of the users. If your dApp sends transactions in quick succession, consider enabling the synchronization again.
- Default synchronization parameters: all [wallet <-> query layer synchronization primitives](./doc/query-layers.md) are now off by default. The reason is that the runtime overhead made the users unhappy and it was not worth it for most of the users. If your dApp sends transactions in quick succession, consider enabling the synchronization again by using `softSynchronizationParams` (old behavior) or `strictSynchronizationParams`.
- `BalanceTxConstraintsBuilder` has been renamed to `BalancerConstraints`. It is still available under the old name as a type synonym.

### Fixed
Expand Down
8 changes: 4 additions & 4 deletions templates/ctl-scaffold/flake.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion templates/ctl-scaffold/flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
type = "github";
owner = "Plutonomicon";
repo = "cardano-transaction-lib";
rev = "dbc4608610b1e0d53e583b1402bf1f2765f7056f";
rev = "ddbd601e882276958fe260b8c492b5c7f489f174";
};
# To use the same version of `nixpkgs` as we do
nixpkgs.follows = "ctl/nixpkgs";
Expand Down
2 changes: 1 addition & 1 deletion templates/ctl-scaffold/packages.dhall
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ let additions =
, "web-storage"
]
, repo = "https://github.com/Plutonomicon/cardano-transaction-lib.git"
, version = "dbc4608610b1e0d53e583b1402bf1f2765f7056f"
, version = "ddbd601e882276958fe260b8c492b5c7f489f174"
}
}

Expand Down

0 comments on commit 372a3c7

Please sign in to comment.