Skip to content

Add function to convert a PlutusData object into a Plutus Blueprint Schema #276

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

Add function to convert a PlutusData object into a Plutus Blueprint Schema #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a95e40
Add basic structure to convert data to plutus schema
nielstron Oct 26, 2023
4deaf0f
Add constructor to plutus data
nielstron Oct 26, 2023
140873a
Add test case
nielstron Oct 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions pycardano/plutus.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -902,3 +902,65 @@ class Unit(PlutusData):
"""The default "Unit type" with a 0 constructor ID"""

CONSTR_ID = 0


def to_plutus_schema(cls: Type[Datum]) -> dict:
"""
Convert to a dictionary representing a json schema according to CIP 57 Plutus Blueprint
Reference of the core structure:
https://cips.cardano.org/cips/cip57/#corevocabulary

Args:
**kwargs: Extra key word arguments to be passed to `json.dumps()`

Returns:
dict: a dict representing the schema of this class.
"""
if hasattr(cls, "__origin__") and cls.__origin__ is list:
return {
"dataType": "list",
**(
{"items": to_plutus_schema(cls.__args__[0])}
if hasattr(cls, "__args__")
else {}
),
}
elif hasattr(cls, "__origin__") and cls.__origin__ is dict:
return {
"dataType": "map",
**(
{
"keys": to_plutus_schema(cls.__args__[0]),
"values": to_plutus_schema(cls.__args__[1]),
}
if hasattr(cls, "__args__")
else {}
),
}
elif hasattr(cls, "__origin__") and cls.__origin__ is Union:
return {
"anyOf": [to_plutus_schema(t) for t in cls.__args__]
if hasattr(cls, "__args__")
else []
}
elif issubclass(cls, PlutusData):
fields = []
for field_value in cls.__dataclass_fields__.values():
if field_value.name == "CONSTR_ID":
continue
field_schema = to_plutus_schema(field_value.type)
field_schema["title"] = field_value.name
fields.append(field_schema)
return {
"dataType": "constructor",
"index": cls.CONSTR_ID,
"fields": fields,
}
elif issubclass(cls, bytes) or issubclass(cls, ByteString):
return {"dataType": "bytes"}
elif issubclass(cls, int):
return {"dataType": "integer"}
elif issubclass(cls, IndefiniteList) or issubclass(cls, list):
return {"dataType": "list"}
else:
return {}
123 changes: 123 additions & 0 deletions test/pycardano/test_plutus.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
id_map,
Datum,
Unit,
to_plutus_schema,
)
from pycardano.serialization import IndefiniteList, RawCBOR, ByteString

Expand Down Expand Up @@ -446,3 +447,125 @@ class A(PlutusData):
assert (
A_tmp.to_cbor_hex() == quote_hex
), "Long metadata bytestring is encoded incorrectly."


def test_to_plutus_schema_basic():
@dataclass
class A(PlutusData):
CONSTR_ID = 0
a: int
b: bytes
c: ByteString
d: List[int]

@dataclass
class C(PlutusData):
x: RawPlutusData
y: RawCBOR
z: Datum
w: IndefiniteList

@dataclass
class B(PlutusData):
a: int
c: A
d: Dict[bytes, C]
e: Union[A, C]

schema = to_plutus_schema(B)
assert schema == {
"dataType": "constructor",
"index": 3809077817,
"fields": [
{"dataType": "integer", "title": "a"},
{
"dataType": "constructor",
"index": 0,
"fields": [
{"dataType": "integer", "title": "a"},
{"dataType": "bytes", "title": "b"},
{"dataType": "bytes", "title": "c"},
{
"dataType": "list",
"items": {"dataType": "integer"},
"title": "d",
},
],
"title": "c",
},
{
"dataType": "map",
"keys": {"dataType": "bytes"},
"values": {
"dataType": "constructor",
"index": 892310804,
"fields": [
{"title": "x"},
{"title": "y"},
{
"anyOf": [
{
"dataType": "constructor",
"index": 3577940042,
"fields": [],
},
{},
{"dataType": "integer"},
{"dataType": "bytes"},
{"dataType": "list"},
{},
{},
],
"title": "z",
},
{"dataType": "list", "title": "w"},
],
},
"title": "d",
},
{
"anyOf": [
{
"dataType": "constructor",
"index": 0,
"fields": [
{"dataType": "integer", "title": "a"},
{"dataType": "bytes", "title": "b"},
{"dataType": "bytes", "title": "c"},
{
"dataType": "list",
"items": {"dataType": "integer"},
"title": "d",
},
],
},
{
"dataType": "constructor",
"index": 892310804,
"fields": [
{"title": "x"},
{"title": "y"},
{
"anyOf": [
{
"dataType": "constructor",
"index": 3577940042,
"fields": [],
},
{},
{"dataType": "integer"},
{"dataType": "bytes"},
{"dataType": "list"},
{},
{},
],
"title": "z",
},
{"dataType": "list", "title": "w"},
],
},
],
"title": "e",
},
],
}