Skip to content

feat: ARC56 field descriptions #666

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

Open
iglosiggio wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: ARC56 field descriptions #666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77df0bd
feat: Add descriptions to wtype struct fields
iglosiggio Feb 21, 2026
dfe9a14
fix: Update awst.json files to use the new format
iglosiggio Mar 5, 2026
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
6 changes: 6 additions & 0 deletions examples/arc_28/contract.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,18 @@


class Swapped(arc4.Struct):
"""This is a docstring for Swapped"""

a: arc4.UInt64
b: arc4.UInt64
"""These are field docs for Swapped.b"""


class NativeSwapped(Struct):
"""This is a docstring for NativeSwapped"""

a: UInt64
"These are field docs for NativeSwapped.a"
b: UInt64


Expand Down
2 changes: 1 addition & 1 deletion examples/arc_28/out/EventEmitter.approval.puya.map
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions examples/arc_28/out/EventEmitter.approval.teal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// algopy.arc4.ARC4Contract.approval_program() -> uint64:
main:
intcblock 8 1
// arc_28/contract.py:16
// arc_28/contract.py:22
// class EventEmitter(ARC4Contract):
txn NumAppArgs
bz main___algopy_default_create@10
Expand All @@ -29,7 +29,7 @@ main___algopy_default_create@10:

// examples.arc_28.contract.EventEmitter.emit_swapped[routing]() -> void:
emit_swapped:
// arc_28/contract.py:17
// arc_28/contract.py:23
// @arc4.abimethod
txna ApplicationArgs 1
dup
Expand All @@ -43,7 +43,7 @@ emit_swapped:
intc_0 // 8
==
assert // invalid number of bytes for arc4.uint64
// arc_28/contract.py:19
// arc_28/contract.py:25
// arc4.emit(Swapped(b, a))
swap
concat
Expand All @@ -52,22 +52,22 @@ emit_swapped:
concat
dup
log
// arc_28/contract.py:20
// arc_28/contract.py:26
// arc4.emit("Swapped(uint64,uint64)", b, a)
dup
log
// arc_28/contract.py:21
// arc_28/contract.py:27
// arc4.emit("Swapped", b, a)
log
// arc_28/contract.py:17
// arc_28/contract.py:23
// @arc4.abimethod
intc_1 // 1
return


// examples.arc_28.contract.EventEmitter.emit_native_swapped[routing]() -> void:
emit_native_swapped:
// arc_28/contract.py:23
// arc_28/contract.py:29
// @arc4.abimethod
txna ApplicationArgs 1
dup
Expand All @@ -83,7 +83,7 @@ emit_native_swapped:
==
assert // invalid number of bytes for arc4.uint64
btoi
// arc_28/contract.py:25
// arc_28/contract.py:31
// arc4.emit(NativeSwapped(a=b, b=a))
itob
swap
Expand All @@ -93,15 +93,15 @@ emit_native_swapped:
swap
concat
log
// arc_28/contract.py:23
// arc_28/contract.py:29
// @arc4.abimethod
intc_1 // 1
return


// examples.arc_28.contract.EventEmitter.emit_ufixed[routing]() -> void:
emit_ufixed:
// arc_28/contract.py:27
// arc_28/contract.py:33
// @arc4.abimethod()
txna ApplicationArgs 1
dup
Expand All @@ -115,14 +115,14 @@ emit_ufixed:
intc_0 // 8
==
assert // invalid number of bytes for arc4.ufixed64x2
// arc_28/contract.py:33
// arc_28/contract.py:39
// arc4.emit("AnEvent(ufixed256x16,ufixed64x2)", a, b)
concat
pushbytes 0x7389b1ba // method "AnEvent(ufixed256x16,ufixed64x2)"
swap
concat
log
// arc_28/contract.py:27
// arc_28/contract.py:33
// @arc4.abimethod()
intc_1 // 1
return
26 changes: 17 additions & 9 deletions examples/arc_28/out/EventEmitter.arc56.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,11 @@
},
{
"type": "uint64",
"name": "b"
"name": "b",
"desc": "These are field docs for Swapped.b"
}
]
],
"desc": "This is a docstring for Swapped"
},
{
"name": "Swapped",
Expand Down Expand Up @@ -82,13 +84,15 @@
"args": [
{
"type": "uint64",
"name": "a"
"name": "a",
"desc": "These are field docs for NativeSwapped.a"
},
{
"type": "uint64",
"name": "b"
}
]
],
"desc": "This is a docstring for NativeSwapped"
}
],
"recommendations": {}
Expand Down Expand Up @@ -199,7 +203,7 @@
}
},
"source": {
"approval": "I3ByYWdtYSB2ZXJzaW9uIDExCiNwcmFnbWEgdHlwZXRyYWNrIGZhbHNlCgovLyBhbGdvcHkuYXJjNC5BUkM0Q29udHJhY3QuYXBwcm92YWxfcHJvZ3JhbSgpIC0+IHVpbnQ2NDoKbWFpbjoKICAgIGludGNibG9jayA4IDEKICAgIC8vIGFyY18yOC9jb250cmFjdC5weToxNgogICAgLy8gY2xhc3MgRXZlbnRFbWl0dGVyKEFSQzRDb250cmFjdCk6CiAgICB0eG4gTnVtQXBwQXJncwogICAgYnogbWFpbl9fX2FsZ29weV9kZWZhdWx0X2NyZWF0ZUAxMAogICAgdHhuIE9uQ29tcGxldGlvbgogICAgIQogICAgYXNzZXJ0CiAgICB0eG4gQXBwbGljYXRpb25JRAogICAgYXNzZXJ0CiAgICBwdXNoYnl0ZXNzIDB4MGE5NTQyY2QgMHg3OWM1YmEzMiAweDcxYTMxNTFmIC8vIG1ldGhvZCAiZW1pdF9zd2FwcGVkKHVpbnQ2NCx1aW50NjQpdm9pZCIsIG1ldGhvZCAiZW1pdF9uYXRpdmVfc3dhcHBlZCh1aW50NjQsdWludDY0KXZvaWQiLCBtZXRob2QgImVtaXRfdWZpeGVkKHVmaXhlZDI1NngxNix1Zml4ZWQ2NHgyKXZvaWQiCiAgICB0eG5hIEFwcGxpY2F0aW9uQXJncyAwCiAgICBtYXRjaCBlbWl0X3N3YXBwZWQgZW1pdF9uYXRpdmVfc3dhcHBlZCBlbWl0X3VmaXhlZAogICAgZXJyCgptYWluX19fYWxnb3B5X2RlZmF1bHRfY3JlYXRlQDEwOgogICAgdHhuIE9uQ29tcGxldGlvbgogICAgIQogICAgdHhuIEFwcGxpY2F0aW9uSUQKICAgICEKICAgICYmCiAgICByZXR1cm4KCgovLyBleGFtcGxlcy5hcmNfMjguY29udHJhY3QuRXZlbnRFbWl0dGVyLmVtaXRfc3dhcHBlZFtyb3V0aW5nXSgpIC0+IHZvaWQ6CmVtaXRfc3dhcHBlZDoKICAgIC8vIGFyY18yOC9jb250cmFjdC5weToxNwogICAgLy8gQGFyYzQuYWJpbWV0aG9kCiAgICB0eG5hIEFwcGxpY2F0aW9uQXJncyAxCiAgICBkdXAKICAgIGxlbgogICAgaW50Y18wIC8vIDgKICAgID09CiAgICBhc3NlcnQgLy8gaW52YWxpZCBudW1iZXIgb2YgYnl0ZXMgZm9yIGFyYzQudWludDY0CiAgICB0eG5hIEFwcGxpY2F0aW9uQXJncyAyCiAgICBkdXAKICAgIGxlbgogICAgaW50Y18wIC8vIDgKICAgID09CiAgICBhc3NlcnQgLy8gaW52YWxpZCBudW1iZXIgb2YgYnl0ZXMgZm9yIGFyYzQudWludDY0CiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MTkKICAgIC8vIGFyYzQuZW1pdChTd2FwcGVkKGIsIGEpKQogICAgc3dhcAogICAgY29uY2F0CiAgICBwdXNoYnl0ZXMgMHgxY2NiZDkyNSAvLyBtZXRob2QgIlN3YXBwZWQodWludDY0LHVpbnQ2NCkiCiAgICBzd2FwCiAgICBjb25jYXQKICAgIGR1cAogICAgbG9nCiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjAKICAgIC8vIGFyYzQuZW1pdCgiU3dhcHBlZCh1aW50NjQsdWludDY0KSIsIGIsIGEpCiAgICBkdXAKICAgIGxvZwogICAgLy8gYXJjXzI4L2NvbnRyYWN0LnB5OjIxCiAgICAvLyBhcmM0LmVtaXQoIlN3YXBwZWQiLCBiLCBhKQogICAgbG9nCiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MTcKICAgIC8vIEBhcmM0LmFiaW1ldGhvZAogICAgaW50Y18xIC8vIDEKICAgIHJldHVybgoKCi8vIGV4YW1wbGVzLmFyY18yOC5jb250cmFjdC5FdmVudEVtaXR0ZXIuZW1pdF9uYXRpdmVfc3dhcHBlZFtyb3V0aW5nXSgpIC0+IHZvaWQ6CmVtaXRfbmF0aXZlX3N3YXBwZWQ6CiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjMKICAgIC8vIEBhcmM0LmFiaW1ldGhvZAogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMQogICAgZHVwCiAgICBsZW4KICAgIGludGNfMCAvLyA4CiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVpbnQ2NAogICAgYnRvaQogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMgogICAgZHVwCiAgICBsZW4KICAgIGludGNfMCAvLyA4CiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVpbnQ2NAogICAgYnRvaQogICAgLy8gYXJjXzI4L2NvbnRyYWN0LnB5OjI1CiAgICAvLyBhcmM0LmVtaXQoTmF0aXZlU3dhcHBlZChhPWIsIGI9YSkpCiAgICBpdG9iCiAgICBzd2FwCiAgICBpdG9iCiAgICBjb25jYXQKICAgIHB1c2hieXRlcyAweDliN2FkODU1IC8vIG1ldGhvZCAiTmF0aXZlU3dhcHBlZCh1aW50NjQsdWludDY0KSIKICAgIHN3YXAKICAgIGNvbmNhdAogICAgbG9nCiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjMKICAgIC8vIEBhcmM0LmFiaW1ldGhvZAogICAgaW50Y18xIC8vIDEKICAgIHJldHVybgoKCi8vIGV4YW1wbGVzLmFyY18yOC5jb250cmFjdC5FdmVudEVtaXR0ZXIuZW1pdF91Zml4ZWRbcm91dGluZ10oKSAtPiB2b2lkOgplbWl0X3VmaXhlZDoKICAgIC8vIGFyY18yOC9jb250cmFjdC5weToyNwogICAgLy8gQGFyYzQuYWJpbWV0aG9kKCkKICAgIHR4bmEgQXBwbGljYXRpb25BcmdzIDEKICAgIGR1cAogICAgbGVuCiAgICBwdXNoaW50IDMyCiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVmaXhlZDI1NngxNgogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMgogICAgZHVwCiAgICBsZW4KICAgIGludGNfMCAvLyA4CiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVmaXhlZDY0eDIKICAgIC8vIGFyY18yOC9jb250cmFjdC5weTozMwogICAgLy8gYXJjNC5lbWl0KCJBbkV2ZW50KHVmaXhlZDI1NngxNix1Zml4ZWQ2NHgyKSIsIGEsIGIpCiAgICBjb25jYXQKICAgIHB1c2hieXRlcyAweDczODliMWJhIC8vIG1ldGhvZCAiQW5FdmVudCh1Zml4ZWQyNTZ4MTYsdWZpeGVkNjR4MikiCiAgICBzd2FwCiAgICBjb25jYXQKICAgIGxvZwogICAgLy8gYXJjXzI4L2NvbnRyYWN0LnB5OjI3CiAgICAvLyBAYXJjNC5hYmltZXRob2QoKQogICAgaW50Y18xIC8vIDEKICAgIHJldHVybgo=",
"approval": "I3ByYWdtYSB2ZXJzaW9uIDExCiNwcmFnbWEgdHlwZXRyYWNrIGZhbHNlCgovLyBhbGdvcHkuYXJjNC5BUkM0Q29udHJhY3QuYXBwcm92YWxfcHJvZ3JhbSgpIC0+IHVpbnQ2NDoKbWFpbjoKICAgIGludGNibG9jayA4IDEKICAgIC8vIGFyY18yOC9jb250cmFjdC5weToyMgogICAgLy8gY2xhc3MgRXZlbnRFbWl0dGVyKEFSQzRDb250cmFjdCk6CiAgICB0eG4gTnVtQXBwQXJncwogICAgYnogbWFpbl9fX2FsZ29weV9kZWZhdWx0X2NyZWF0ZUAxMAogICAgdHhuIE9uQ29tcGxldGlvbgogICAgIQogICAgYXNzZXJ0CiAgICB0eG4gQXBwbGljYXRpb25JRAogICAgYXNzZXJ0CiAgICBwdXNoYnl0ZXNzIDB4MGE5NTQyY2QgMHg3OWM1YmEzMiAweDcxYTMxNTFmIC8vIG1ldGhvZCAiZW1pdF9zd2FwcGVkKHVpbnQ2NCx1aW50NjQpdm9pZCIsIG1ldGhvZCAiZW1pdF9uYXRpdmVfc3dhcHBlZCh1aW50NjQsdWludDY0KXZvaWQiLCBtZXRob2QgImVtaXRfdWZpeGVkKHVmaXhlZDI1NngxNix1Zml4ZWQ2NHgyKXZvaWQiCiAgICB0eG5hIEFwcGxpY2F0aW9uQXJncyAwCiAgICBtYXRjaCBlbWl0X3N3YXBwZWQgZW1pdF9uYXRpdmVfc3dhcHBlZCBlbWl0X3VmaXhlZAogICAgZXJyCgptYWluX19fYWxnb3B5X2RlZmF1bHRfY3JlYXRlQDEwOgogICAgdHhuIE9uQ29tcGxldGlvbgogICAgIQogICAgdHhuIEFwcGxpY2F0aW9uSUQKICAgICEKICAgICYmCiAgICByZXR1cm4KCgovLyBleGFtcGxlcy5hcmNfMjguY29udHJhY3QuRXZlbnRFbWl0dGVyLmVtaXRfc3dhcHBlZFtyb3V0aW5nXSgpIC0+IHZvaWQ6CmVtaXRfc3dhcHBlZDoKICAgIC8vIGFyY18yOC9jb250cmFjdC5weToyMwogICAgLy8gQGFyYzQuYWJpbWV0aG9kCiAgICB0eG5hIEFwcGxpY2F0aW9uQXJncyAxCiAgICBkdXAKICAgIGxlbgogICAgaW50Y18wIC8vIDgKICAgID09CiAgICBhc3NlcnQgLy8gaW52YWxpZCBudW1iZXIgb2YgYnl0ZXMgZm9yIGFyYzQudWludDY0CiAgICB0eG5hIEFwcGxpY2F0aW9uQXJncyAyCiAgICBkdXAKICAgIGxlbgogICAgaW50Y18wIC8vIDgKICAgID09CiAgICBhc3NlcnQgLy8gaW52YWxpZCBudW1iZXIgb2YgYnl0ZXMgZm9yIGFyYzQudWludDY0CiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjUKICAgIC8vIGFyYzQuZW1pdChTd2FwcGVkKGIsIGEpKQogICAgc3dhcAogICAgY29uY2F0CiAgICBwdXNoYnl0ZXMgMHgxY2NiZDkyNSAvLyBtZXRob2QgIlN3YXBwZWQodWludDY0LHVpbnQ2NCkiCiAgICBzd2FwCiAgICBjb25jYXQKICAgIGR1cAogICAgbG9nCiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjYKICAgIC8vIGFyYzQuZW1pdCgiU3dhcHBlZCh1aW50NjQsdWludDY0KSIsIGIsIGEpCiAgICBkdXAKICAgIGxvZwogICAgLy8gYXJjXzI4L2NvbnRyYWN0LnB5OjI3CiAgICAvLyBhcmM0LmVtaXQoIlN3YXBwZWQiLCBiLCBhKQogICAgbG9nCiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjMKICAgIC8vIEBhcmM0LmFiaW1ldGhvZAogICAgaW50Y18xIC8vIDEKICAgIHJldHVybgoKCi8vIGV4YW1wbGVzLmFyY18yOC5jb250cmFjdC5FdmVudEVtaXR0ZXIuZW1pdF9uYXRpdmVfc3dhcHBlZFtyb3V0aW5nXSgpIC0+IHZvaWQ6CmVtaXRfbmF0aXZlX3N3YXBwZWQ6CiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjkKICAgIC8vIEBhcmM0LmFiaW1ldGhvZAogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMQogICAgZHVwCiAgICBsZW4KICAgIGludGNfMCAvLyA4CiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVpbnQ2NAogICAgYnRvaQogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMgogICAgZHVwCiAgICBsZW4KICAgIGludGNfMCAvLyA4CiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVpbnQ2NAogICAgYnRvaQogICAgLy8gYXJjXzI4L2NvbnRyYWN0LnB5OjMxCiAgICAvLyBhcmM0LmVtaXQoTmF0aXZlU3dhcHBlZChhPWIsIGI9YSkpCiAgICBpdG9iCiAgICBzd2FwCiAgICBpdG9iCiAgICBjb25jYXQKICAgIHB1c2hieXRlcyAweDliN2FkODU1IC8vIG1ldGhvZCAiTmF0aXZlU3dhcHBlZCh1aW50NjQsdWludDY0KSIKICAgIHN3YXAKICAgIGNvbmNhdAogICAgbG9nCiAgICAvLyBhcmNfMjgvY29udHJhY3QucHk6MjkKICAgIC8vIEBhcmM0LmFiaW1ldGhvZAogICAgaW50Y18xIC8vIDEKICAgIHJldHVybgoKCi8vIGV4YW1wbGVzLmFyY18yOC5jb250cmFjdC5FdmVudEVtaXR0ZXIuZW1pdF91Zml4ZWRbcm91dGluZ10oKSAtPiB2b2lkOgplbWl0X3VmaXhlZDoKICAgIC8vIGFyY18yOC9jb250cmFjdC5weTozMwogICAgLy8gQGFyYzQuYWJpbWV0aG9kKCkKICAgIHR4bmEgQXBwbGljYXRpb25BcmdzIDEKICAgIGR1cAogICAgbGVuCiAgICBwdXNoaW50IDMyCiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVmaXhlZDI1NngxNgogICAgdHhuYSBBcHBsaWNhdGlvbkFyZ3MgMgogICAgZHVwCiAgICBsZW4KICAgIGludGNfMCAvLyA4CiAgICA9PQogICAgYXNzZXJ0IC8vIGludmFsaWQgbnVtYmVyIG9mIGJ5dGVzIGZvciBhcmM0LnVmaXhlZDY0eDIKICAgIC8vIGFyY18yOC9jb250cmFjdC5weTozOQogICAgLy8gYXJjNC5lbWl0KCJBbkV2ZW50KHVmaXhlZDI1NngxNix1Zml4ZWQ2NHgyKSIsIGEsIGIpCiAgICBjb25jYXQKICAgIHB1c2hieXRlcyAweDczODliMWJhIC8vIG1ldGhvZCAiQW5FdmVudCh1Zml4ZWQyNTZ4MTYsdWZpeGVkNjR4MikiCiAgICBzd2FwCiAgICBjb25jYXQKICAgIGxvZwogICAgLy8gYXJjXzI4L2NvbnRyYWN0LnB5OjMzCiAgICAvLyBAYXJjNC5hYmltZXRob2QoKQogICAgaW50Y18xIC8vIDEKICAgIHJldHVybgo=",
"clear": "I3ByYWdtYSB2ZXJzaW9uIDExCiNwcmFnbWEgdHlwZXRyYWNrIGZhbHNlCgovLyBhbGdvcHkuYXJjNC5BUkM0Q29udHJhY3QuY2xlYXJfc3RhdGVfcHJvZ3JhbSgpIC0+IHVpbnQ2NDoKbWFpbjoKICAgIHB1c2hpbnQgMQogICAgcmV0dXJuCg=="
},
"byteCode": {
Expand All @@ -224,9 +228,11 @@
},
{
"type": "uint64",
"name": "b"
"name": "b",
"desc": "These are field docs for Swapped.b"
}
]
],
"desc": "This is a docstring for Swapped"
},
{
"name": "Swapped",
Expand All @@ -246,13 +252,15 @@
"args": [
{
"type": "uint64",
"name": "a"
"name": "a",
"desc": "These are field docs for NativeSwapped.a"
},
{
"type": "uint64",
"name": "b"
}
]
],
"desc": "This is a docstring for NativeSwapped"
},
{
"name": "AnEvent",
Expand Down
32 changes: 16 additions & 16 deletions examples/arc_28/out/EventEmitter.ir/EventEmitter.approval.000.ssa.ir
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading