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.

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

Bootstrapped the public facing API of cardano-ledger-api #3182

Merged
merged 1 commit into from
Dec 2, 2022

Conversation

koslambrou
Copy link
Collaborator

Summary

  • Created the Cardano.Ledger.Api module which exports anything the end-user will need in order to build and inspect transactions.

  • Completing some missing exports in lower modules

  • Bootstrapped very simple documentation on how to build and inspect transactions

Notes

After trying out cardano-ledger-api, this is my simple attempt to bootstrap some documentation on how to use the API from an external user's perspective.

I made some opinionated changes, so that I can get something started.

@koslambrou koslambrou force-pushed the cardano-ledger-api-explore branch 2 times, most recently from 151797e to f83b96b Compare December 2, 2022 12:57
Copy link
Collaborator

@lehins lehins left a comment

Choose a reason for hiding this comment

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

Thank you for adding this. One important comment, otherwise looks good.

@lehins lehins force-pushed the cardano-ledger-api-explore branch from f83b96b to 65946a5 Compare December 2, 2022 13:26
Copy link
Contributor

@JaredCorduan JaredCorduan left a comment

Choose a reason for hiding this comment

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

Thank you @koslambrou , this looks wonderful!

@koslambrou koslambrou force-pushed the cardano-ledger-api-explore branch 2 times, most recently from da62ce2 to 9f43f45 Compare December 2, 2022 19:19
@koslambrou koslambrou requested a review from lehins December 2, 2022 19:19
Copy link
Collaborator

@lehins lehins 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 great. Just a few minor comments.

Thank you for your effort!

libs/cardano-ledger-api/src/Cardano/Ledger/Api.hs Outdated Show resolved Hide resolved
libs/cardano-ledger-api/src/Cardano/Ledger/Api.hs Outdated Show resolved Hide resolved
libs/cardano-ledger-api/src/Cardano/Ledger/Api.hs Outdated Show resolved Hide resolved
libs/cardano-ledger-api/src/Cardano/Ledger/Api/Tx/Out.hs Outdated Show resolved Hide resolved
* Created the `Cardano.Ledger.Api` module which should export anything
  the end-user will need in order to build and inspect transactions.

* Added some new modules in `cardano-ledger-api`, but it is still not
  complete.

* Completing some missing exports in lower modules

* Bootstrapped very simple documentation on how to build and inspect transactions
@koslambrou koslambrou force-pushed the cardano-ledger-api-explore branch from 9f43f45 to 5038486 Compare December 2, 2022 19:35
@koslambrou
Copy link
Collaborator Author

koslambrou commented Dec 2, 2022

Thanks for reviewing @lehins :)

More to come.

@lehins lehins merged commit eb12e78 into IntersectMBO:master Dec 2, 2022
@koslambrou koslambrou deleted the cardano-ledger-api-explore branch December 3, 2022 00:22
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