Reconstructable deterministic constrids #272
Conversation
nielstron
force-pushed
the
feat/reconstructible_det_constrids
branch
from
a5b2245 to
955bab8
Compare
pycardano/plutus.py
Outdated
| def id_map(cls, skip_constructor=False): | ||
| """ | ||
| Constructs a unique representation of a PlutusData type definition. | ||
| Intended for automatic constructor generation. | ||
| """ | ||
| if cls == bytes: | ||
| return "bytes" | ||
| if cls == int: | ||
| return "int" | ||
| if cls == RawCBOR or cls == RawPlutusData or cls == Datum: | ||
| return "any" | ||
| if cls == IndefiniteList: | ||
| return "list" | ||
| if hasattr(cls, "__origin__"): | ||
| origin = getattr(cls, "__origin__") | ||
| if origin == list: | ||
| prefix = "list" | ||
| elif origin == dict: | ||
| prefix = "map" | ||
| elif origin == typing.Union: | ||
| prefix = "union" | ||
| else: | ||
| raise TypeError( | ||
| f"Unexpected parameterized type for automatic constructor generation: {cls}" | ||
| ) | ||
| return prefix + "<" + ",".join(id_map(a) for a in cls.__args__) + ">" | ||
| if issubclass(cls, PlutusData): | ||
| return ( | ||
| "cons[" | ||
| + cls.__name__ | ||
| + "](" | ||
| + (str(cls.CONSTR_ID) if not skip_constructor else "_") | ||
| + ";" | ||
| + ",".join(f.name + ":" + id_map(f.type) for f in fields(cls)) | ||
| + ")" | ||
| ) | ||
| raise TypeError(f"Unexpected type for automatic constructor generation: {cls}") |
There was a problem hiding this comment.
This is nice. Is there a language-agnostic documentation for it?
There was a problem hiding this comment.
No. Basically, this is the reference implementation for this kind of constructor IDs. I could write up a documentation, either in this document (where?), OpShin or in a dedicated CIP
There was a problem hiding this comment.
I will leave you to decide. For me, because this can potentially get adopted by other languages, I think a dedicated CIP is the best choice.
There was a problem hiding this comment.
I have added a CIP here: cardano-foundation/CIPs#608
|
Tried merging from main branch, but failed with this error: Looks like |
nielstron
force-pushed
the
feat/reconstructible_det_constrids
branch
from
798c1e3 to
2809b34
Compare
|
I have added support for |
Codecov Report
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. @@ Coverage Diff @@
## main #272 +/- ##
==========================================
- Coverage 84.75% 84.74% -0.02%
==========================================
Files 26 26
Lines 3044 3067 +23
Branches 740 750 +10
==========================================
+ Hits 2580 2599 +19
- Misses 348 350 +2
- Partials 116 118 +2
|
This resolves #271
Please reach out if there are any remaining questions as to the necessity or implementation of this.