Rename QueryHandle and QueryBackend to Provider variants #1665
+182
−175
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
errfrom
requested changes
Jan 22, 2025
| @@ -91,6 +91,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) | |||
| ### Changed | |||
|
|
|||
| - `cardano-serialization-lib` has been updated to `v13.2.0` ([#1656](https://github.com/Plutonomicon/cardano-transaction-lib/pull/1656)) | |||
| - `QueryHandle` has been renamed to `Provider` | |||
There was a problem hiding this comment.
Each changelog entry should include a link to the corresponding pull request or issue. See other entries for reference.
| @@ -63,7 +63,7 @@ Lucid, on the other hand, provides a way to get a UTxO that contains a specified | |||
|
|
|||
| - Both CTL and Lucid support [Blockfrost](./blockfrost.md) and [Kupo+Ogmios](./runtime.md) | |||
| - Lucid also supports [Maestro](https://www.gomaestro.org/) | |||
| - Both CTL and Lucid allow for custom backends - Lucid via `Provider` interface implementation, and CTL via a custom `QueryHandle`. | |||
| - Both CTL and Lucid allow for custom backends - Lucid via `Provider` interface implementation, and CTL via a custom `Provider`. | |||
There was a problem hiding this comment.
Suggested change
| - Both CTL and Lucid allow for custom backends - Lucid via `Provider` interface implementation, and CTL via a custom `Provider`. | |
| - Both CTL and Lucid support multiple query backends through a `Provider` interface. Although CTL does not support specifying custom backends without forking, individual queries in the existing backend can still be replaced. Refer to [doc/custom-query-layers.md](./custom-query-layers.md) for more information. |
| @@ -16,15 +16,15 @@ | |||
|
|
|||
| CTL can be extended with custom (user) query layers if needed. At this moment it can be done by forking. | |||
|
|
|||
| Every query CTL uses, except of backend-specific ones, goes through a [query handle](https://github.com/Plutonomicon/cardano-transaction-lib/blob/10a88faa2e6237aafc90568e3488f3421517af63/src/Internal/Contract/QueryHandle/Type.purs#L36). | |||
| Every query CTL uses, except of backend-specific ones, goes through a [query handle](https://github.com/Plutonomicon/cardano-transaction-lib/blob/10a88faa2e6237aafc90568e3488f3421517af63/src/Internal/Contract/Provider/Type.purs#L36). | |||
There was a problem hiding this comment.
goes through a [provider]
| @@ -31,19 +31,19 @@ import Effect.Exception (Error) | |||
| import Effect.Exception (message) as Error | |||
| import Type.Proxy (Proxy(Proxy)) | |||
|
|
|||
| type UtxosAtQuery = Address -> Aff (Either ClientError UtxoMap) | |||
| type UtxosAtProvider = Address -> Aff (Either ClientError UtxoMap) | |||
There was a problem hiding this comment.
This is a query, not a provider. Please rename it back to UtxosAtQuery.
|
|
||
| type GetUtxoByOrefQuery = | ||
| type GetUtxoByOrefProvider = |
There was a problem hiding this comment.
Same here, should be renamed back to GetUtxoByOrefQuery.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1615
Pre-review checklist
make format)templates/ctl-scaffold) has been updated## Unreleasedheader, using the appropriate sub-headings (### Added,### Changed,### Removed,### Fixed), and the links to the appropriate issues/PRs have been included