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

Craft cardano-client library #1013

Closed
coot opened this issue Sep 11, 2019 · 7 comments
Closed

Craft cardano-client library #1013

coot opened this issue Sep 11, 2019 · 7 comments
Assignees
Labels
daedalus When the wallet switches from cardano-sl to the new node technical debt

Comments

@coot
Copy link
Contributor

coot commented Sep 11, 2019

  • export block, header, tx types from ouroboros-consensus
  • export NodeToClient
  • specialise all the codecs for the current version of consensus
  • export common tx-submission client (which is common for wallet, explorer), and export null tx submission client for explorer
  • prefix modules with Cardano.Client (?)

It should export everything that is required by cardano-explorer and cardano-wallet (in cardano-node), and hide the dependency on ouroboros-network and ouroboros-consensus.

@coot coot added networking consensus issues related to ouroboros-consensus labels Sep 11, 2019
@coot coot changed the title Craft ouroboros-client library Craft cardno-client library Sep 11, 2019
@mrBliss mrBliss changed the title Craft cardno-client library Craft cardano-client library Sep 20, 2019
@mrBliss
Copy link
Contributor

mrBliss commented Nov 7, 2019

@coot Is somebody working on this?

@erikd is this necessary for 1.0.0 or 1.1.0?

@coot
Copy link
Contributor Author

coot commented Nov 8, 2019

@mrBliss not yet; I don't think this is necessary, but it's nice to have.

@erikd
Copy link
Contributor

erikd commented Nov 19, 2019

The time this was really needed was back in July when I started work on the explorer.

Do we need this now? Well that depends on how much the APIs in network (and to a lesser extent node) are going to change. Every time they do change I spend significant amounts of time chasing type errors trying to unbreak the explorer. Since network exposes so much of its internals, much of the code that needs fixing is due to type changes in code that should be in this proposed client library anyway. Ignoring all this extra stuff the interface between network and the explorer is actually really small.

@coot
Copy link
Contributor Author

coot commented Nov 19, 2019

@erikd I am aware that it's still needed, we didn't had time to start working on it. There will be substantial changes in the future, though I am not sure we'll have time to finish cardano-client before they will land. The wallet team will also appreciate a simpler interface.

@dcoutts dcoutts added byron Required for a Byron mainnet: replace the old core nodes with cardano-node daedalus When the wallet switches from cardano-sl to the new node labels Jan 7, 2020
@coot coot added this to the S6 2020-02-13 milestone Jan 9, 2020
@coot coot modified the milestones: S6 2020-02-13, S5 2020-01-30 Jan 22, 2020
@edsko
Copy link
Contributor

edsko commented Feb 13, 2020

I am removing the consensus label from this ticket. Once the networking layer has a clear API, we can use that as a basis for an API for consensus (though consensus already provides a reasonably concise API through run).

@edsko edsko removed the consensus issues related to ouroboros-consensus label Feb 13, 2020
@coot coot modified the milestones: S6 2020-02-13, S7 2020-02-27 Feb 14, 2020
@coot coot modified the milestones: S7 2020-02-27, S8 2020-03-12 Feb 28, 2020
@dcoutts
Copy link
Contributor

dcoutts commented Mar 12, 2020

This is very useful to simplify clients, but it is not release critical.

@coot coot modified the milestones: S8 2020-03-12, S9 2020-03-26 Mar 16, 2020
@coot coot modified the milestones: S9 2020-03-26, S10 2020-04-09 Apr 1, 2020
@coot coot modified the milestones: S10 2020-04-09, S11 2020-04-23 Apr 14, 2020
@coot coot modified the milestones: S11 2020-04-23, S12 2020-05-07 Apr 24, 2020
@coot coot modified the milestones: S12 2020-05-07, S13 2020-05-21 May 8, 2020
@coot coot modified the milestones: S13 2020-05-21, S14 2020-06-04 May 26, 2020
@coot coot removed the byron Required for a Byron mainnet: replace the old core nodes with cardano-node label Jun 3, 2020
@coot coot removed this from the S15 2020-06-18 milestone Jun 17, 2020
@coot
Copy link
Contributor Author

coot commented Oct 22, 2020

This is subsumed by the cardano-cli library in cardano-node repository.

@coot coot closed this as completed Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
daedalus When the wallet switches from cardano-sl to the new node technical debt
Projects
None yet
Development

No branches or pull requests

7 participants