Python-Cardano / pycardano

A lightweight Cardano library in Python
https://pycardano.readthedocs.io
MIT License
215 stars 67 forks source link

Seperating primitives and chain contexts / higher level tooling #305

Open nielstron opened 8 months ago

nielstron commented 8 months ago

Is your feature request related to a problem? Please describe. The pycardano library (the primitives definitions) is used by third party tools and respectively the high level tooling could benefit from using third party libraries (like ogmios). This may lead to cyclic dependencies

Describe the solution you'd like Seperate the pycardano package into several packages

This can actually be performed transparently to users of the library by keeping pycardano as a single library that imports from all of the above (and potentially more)

Describe alternatives you've considered The exact structure can be discussed.

Additional context This allows the ogmios package to import the primitives from pycardano and transform Ogmios JSON serialized transactions into pycardano primitive Transactions. Meanwhile it can also implement the Ogmios 6 chain context that can be imported by pycardano.

Another example is uplc/opshin which can import pycardano primitives and implement a MockChainContext which does tx evaluation based on simulation of the Plutus VM.

cffls commented 8 months ago

Thank you for bringing this up! I like this idea a lot. It will remove lots of dependency madness across many packages. Regarding package naming, I think we can come up with shorter names, something like:

pycardano_primitives -> pccore pycardano_chain_contexts -> pccontext pycardano_cips -> pccips

wdyt?

KINGH242 commented 3 days ago

I created the pycardano_chain_contexts package and added some improvements. Check it out here https://github.com/KINGH242/pccontext.

Let me know if it makes sense. I currently use it with PyCardano in another tool that uses various context from time to time.