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.

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

Jump to bottom

fix: Identify WTuples by name when treating them as structs in an ABI method #358

Merged
merged 3 commits into from
Nov 27, 2024
Merged

fix: Identify WTuples by name when treating them as structs in an ABI method #358

merged 3 commits into from
Nov 27, 2024

Conversation

tristanmenzel
Copy link
Contributor

WTuples are compared by shape in the type system such that two named tuples with the same structure but different names are considered 'equal'. As a result the logic which builds the unique set of arc4 structs used by a contract was omitting subsequent named tuple types with the structure leading to an error when generating the arc32 spec file which was looking up definitions by name.

Proposed Changes

  • Refactor _wtypes_to_structs function to id wtypes by name instead of using __eq__.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 25, 2024 •
edited
Loading

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/puya_lib
   arc4.py1261260%1–332
   bytes.py990%1–15
   util.py16160%1–33
src/puya
   __main__.py30300%1–42
   arc32.py71297%78, 104
   arc56.py78297%279, 285
   artifact_sorter.py53198%84
   compile.py160895%91–92, 134–137, 157–160, 316, 364
   context.py31197%35
   errors.py35877%40–42, 44–46, 50–51
   log.py1994080%32–35, 69, 89, 123–124, 166–168, 171–173, 175, 188–197, 219, 288–289, 298, 326–328, 341–355
   main.py36360%1–49
   parse.py87594%31, 40, 50, 56, 87
   utils.py2011891%50, 67–68, 77–78, 86–87, 177, 195–197, 204, 212, 226, 249, 251, 274, 309
src/puya/awst
   function_traverser.py292399%76, 372, 378
   nodes.py9954096%100, 104–107, 147, 151–154, 365, 561, 577, 611, 652, 681–682, 732, 759–760, 908, 930, 962, 988, 993, 1148, 1233, 1249, 1298, 1375, 1456, 1510, 1514, 1637, 1782, 1787, 1792, 1800, 1805, 1810
   serialize.py681184%24, 84–89, 95–98
   to_code_visitor.py4341297%131, 242, 279, 325, 579, 586–589, 619, 647, 651
   txn_fields.py98199%48
   wtypes.py3301895%174, 178–181, 195–196, 200, 230, 243, 254, 259–260, 294, 332, 346, 396, 519
src/puya/awst/validation
   arc4_copy.py113199%38
   base_invoker.py47491%55, 62, 72–76
   immutable.py31294%26, 34
   inner_transactions.py187199%161
   labels.py30873%25–27, 32, 36–41
   scratch_slots.py38489%18, 32, 47, 49
src/puya/ir
   arc4_router.py2811993%100, 163, 219, 299, 347, 419, 432, 490–491, 503, 508, 513, 518, 523, 528, 548–552, 685, 722
   avm_ops.py323199%46
   avm_ops_models.py50394%21, 30, 38
   context.py101892%68, 75, 78, 80, 118–119, 129, 135
   main.py3921496%77–83, 93–99, 125, 138, 166, 544, 777–781
   models.py5312296%74, 182, 189, 338, 409–410, 415, 421–425, 438, 482, 511, 567, 613, 693, 709, 750, 753, 760, 763, 852–853
   ssa.py130398%51–52, 150
   to_text_visitor.py152795%123, 212, 219–224
   types_.py1011090%50, 57, 91–95, 116, 152, 157–159
   visitor.py1291787%145, 193, 205, 220, 223, 236, 239, 245, 248, 259, 262, 265, 268, 271, 274, 277, 280
   visitor_mutator.py105298%174–175
   vla.py72199%87
src/puya/ir/builder
   _utils.py136596%229–231, 293–300
   arc4.py5002196%175–180, 479, 482, 540–543, 815–816, 1062, 1086, 1167, 1174, 1210, 1258, 1268, 1323, 1368, 1387, 1407
   assignment.py94793%100, 115, 189, 208, 225–226, 271
   blocks.py140795%55, 92–96, 158, 166, 231
   bytes.py641478%13–45, 129
   callsub.py81594%32–33, 58, 108–109
   flow_control.py95199%56
   iteration.py198597%91–92, 107, 144, 206
   itxn.py3233789%139–140, 142, 156, 164–169, 197, 204, 226–227, 560, 579–597, 666, 670, 684, 693–706
   main.py5987088%127, 267, 271, 276–295, 300–319, 374, 398, 419, 437–438, 440, 448, 490, 577–578, 690, 722, 735–736, 784, 809, 846–848, 859, 924, 1002, 1015, 1056, 1121, 1124, 1132, 1135, 1143, 1174, 1200, 1209, 1333, 1350, 1393–1403
   storage.py83298%101, 154
src/puya/ir/destructure
   coalesce_locals.py1011981%119, 128–129, 132–135, 138–147, 163–166
   parcopy.py84298%47, 83
src/puya/ir/optimize
   collapse_blocks.py92595%65–69
   compiled_reference.py79594%53, 87, 158–163
   control_op_simplification.py104793%47–48, 177, 253–260
   inner_txn.py36197%38
   intrinsic_simplification.py4833194%76, 168–170, 175, 257, 269, 304, 315–316, 340–341, 365, 434, 621, 623, 638, 678, 701, 731, 737, 739, 741, 746, 748, 750, 752, 754, 806–807, 814
   main.py87298%118–119
src/puya/ir/validation
   _base.py30197%28
   compile_reference_validator.py20290%24, 30
   min_avm_version_validator.py15473%16–20
   op_run_mode_validator.py19574%19–29
src/puya/mir
   aligned_writer.py63395%21, 61, 80
   builder.py1571392%71–73, 155, 267–268, 321, 324, 327, 330, 333, 336, 339
   models.py433699%97, 206, 250, 316, 333, 403
src/puya/mir/stack_allocation
   f_stack.py89298%23, 70
   peephole.py48296%47, 49
   x_stack.py205399%32, 336–340
src/puya/teal
   models.py369299%383, 444
src/puya/teal/optimize
   constant_block.py104496%63, 152, 189, 206
   peephole.py127398%162, 168, 251
   repeated_rotations.py51198%16
   repeated_rotations_search.py90693%35, 41–42, 58, 68–69
src/puya/ussemble
   assemble.py171597%134, 202, 219–220, 260
   models.py25196%16
   op_spec_models.py22195%20
src/puyapy
   __main__.py641773%177, 189–203, 207
   client_gen.py1181191%65–66, 84–88, 92, 205, 212–213, 233
   compile.py1502285%59–68, 82, 164–165, 176, 183–184, 201–211, 221–223, 228, 244
   models.py99496%65, 77–79
   parse.py1801393%50–51, 87, 159–164, 168, 268, 272–273, 321, 333, 358
   template.py32875%10–11, 18–19, 27–28, 34, 37
   utils.py21576%16–17, 25–28
src/puyapy/awst_build
   arc4_client.py1042477%46–50, 58, 70, 76, 80, 109, 115–116, 122, 125, 128, 134, 137, 145, 148, 151, 154, 157, 160, 163, 166, 169, 172
   arc4_client_gen.py132894%32, 91–92, 102, 104, 119–120, 187
   arc4_utils.py2884784%42, 45–46, 48, 53–60, 78, 89–93, 109, 111, 114–115, 138, 181–183, 192, 197, 202–203, 229, 233, 245, 252, 254, 268–269, 272–276, 281–282, 288–291, 299, 307, 324, 336, 344, 446, 451, 470
   base_mypy_visitor.py1273969%70–76, 94, 102–115, 129, 131, 133, 145, 150, 154, 157, 160, 166, 188, 191, 194, 201, 205, 208, 211, 215, 233, 237, 241, 245, 249, 253, 257, 261, 265, 269, 273, 277, 281
   context.py2184778%55, 58, 68–69, 87–88, 128, 188, 193, 199–203, 207, 210, 219, 221, 224–226, 228, 235, 237, 248–249, 254–256, 259, 274, 286–287, 299, 313, 316–328
   contract.py3193390%128, 179, 192–196, 236, 238, 242, 246, 254, 262, 264, 284, 339, 342, 354, 362, 365, 368, 371, 374, 377, 380, 383, 386, 389, 449–453, 502–506, 586–590, 661, 684
   intrinsic_models.py49198%55
   main.py36197%30
   module.py4295986%118, 138, 144–148, 163–164, 171, 180–181, 189–193, 215, 244, 264–265, 276, 298–301, 311–313, 319, 336–339, 352, 386, 393, 415–416, 439–444, 498–499, 527, 538, 541, 547, 553, 563, 569, 572, 584, 587, 610, 630, 635, 639, 648–652, 744, 752, 754
   pytypes.py5946090%87, 97–99, 104, 111, 116–118, 122–124, 151–152, 192, 210–216, 239, 259, 301, 339–341, 370, 436, 445, 464, 484, 506–507, 648–650, 664–665, 732–733, 837, 848–849, 898–899, 904, 957–958, 981–982, 1133–1134, 1158, 1186, 1222–1224, 1264, 1274–1275
   subroutine.py6025291%136, 246, 252, 310–313, 319, 370, 375, 378–384, 475, 495, 650, 652–653, 671, 673, 683–684, 693–694, 698, 719, 785, 792, 812–813, 899, 925–926, 943, 959, 983, 991, 1002, 1028–1031, 1137–1138, 1158, 1168, 1170, 1179, 1197, 1205, 1219, 1222, 1225, 1228, 1231
   utils.py1612485%30, 47–51, 69, 104–105, 107, 151–152, 203, 211, 216, 229–233, 238–241, 250, 254, 262
src/puyapy/awst_build/eb
   _base.py1281886%52, 57–59, 64, 71, 76, 81–83, 142, 153, 183, 188, 193, 198, 209, 223–225
   _bytes_backed.py48296%30–31
   _expect.py1222183%25, 36, 85–88, 100–103, 106, 158–159, 217–220, 230–233
   _literals.py1442980%43, 72, 91, 120, 137, 151, 155, 159–165, 175–189, 194
   _type_registry.py40490%251–252, 264–265
   utils.py47394%28–30, 100
   array.py26965%23, 28–33, 43, 47
   biguint.py101694%56, 100, 139, 155–156, 158
   binary_bool_op.py105397%153, 161, 171
   bool.py55984%39–43, 59, 70, 83, 97
   bytes.py1681889%103–104, 131–132, 137–138, 144–145, 148, 156, 199, 234, 266, 270, 287–288, 303–304
   compiled.py70987%86–90, 127–131, 154
   conditional_literal.py1343475%98, 102, 162, 166–169, 178–180, 203–206, 215, 219, 223–226, 241–253, 262–263, 274–277
   contracts.py77890%55, 61, 63, 73, 99, 109, 111, 116
   dict.py27581%24, 32–34, 38
   ensure_budget.py31197%47
   interface.py90397%314–316, 320
   intrinsics.py97694%43, 62, 69, 82, 89, 160
   log.py43491%46–47, 52, 61
   logicsig.py15193%26
   none.py27196%38
   string.py1441391%72, 116–117, 136, 141, 184, 191, 195, 207, 281–283, 303
   struct.py16569%14–16, 25, 29
   subroutine.py801680%47, 51–54, 69, 72–79, 94, 102–103, 105–108, 113
   template_variables.py37295%30, 58
   tuple.py3391396%86, 134, 150, 240–241, 253, 346–347, 466, 535, 546–547, 610
   uint64.py108694%57, 118–119, 167–168, 200
   uint64_enums.py40295%41, 46
   unsigned_builtins.py1552286%74, 81, 105, 129, 133, 137, 141, 149, 153, 157, 161, 165, 175, 179, 185, 196, 202, 208, 247, 279, 291, 303
src/puyapy/awst_build/eb/arc4
   _base.py92397%185–188, 199
   _utils.py141795%119, 127, 138, 178–181, 252, 256
   abi_call.py3171994%118, 124, 145, 215, 228–229, 310, 322, 380, 403, 434, 453–454, 513, 549, 623, 708–709, 726
   address.py73297%57, 116
   bool.py58395%42, 87–88
   dynamic_array.py120992%56, 123–124, 145, 221, 241–242, 245–248
   dynamic_bytes.py68396%99–101
   emit.py34197%36
   static_array.py62198%44
   string.py98793%54–55, 103, 124, 129–132
   struct.py49198%49
   tuple.py931683%45–47, 70, 88–91, 94–95, 134–137, 142, 146–147, 157, 167
   ufixed.py70297%43, 102
src/puyapy/awst_build/eb/reference_types
   account.py79297%65, 175
   application.py45198%40
   asset.py65198%48
src/puyapy/awst_build/eb/storage
   _common.py69396%107, 120–121
   _storage.py1082081%58, 66, 70, 74, 78, 82, 86, 90, 94, 104, 108, 112, 116, 122, 133, 139, 145, 157–159
   _value_proxy.py55787%38, 42, 50, 54, 91, 99, 103
   box_map.py147199%194
   global_state.py127695%104–105, 114–115, 164–165
   local_state.py1371192%99–100, 104, 151, 155, 159, 169, 173, 197, 254, 278
src/puyapy/awst_build/eb/transaction
   base.py39295%23, 43
   group.py53198%48
   inner.py48296%91–92
   inner_params.py77594%64, 74, 78, 138, 140
   itxn_args.py60198%72
TOTAL22732170992% 

Tests Skipped Failures Errors Time
834 2 💤 0 ❌ 0 🔥 5m 58s ⏱️

@daniel-makerx daniel-makerx force-pushed the fix/id-structs-by-name-not-shape branch from 88b3e3b to 339cea9 Compare November 25, 2024 07:02
@tristanmenzel tristanmenzel force-pushed the fix/id-structs-by-name-not-shape branch from 339cea9 to 5d83828 Compare November 27, 2024 04:10
@tristanmenzel tristanmenzel enabled auto-merge (rebase) November 27, 2024 04:10
@tristanmenzel tristanmenzel merged commit e7e7ebf into main Nov 27, 2024
4 checks passed
@tristanmenzel tristanmenzel deleted the fix/id-structs-by-name-not-shape branch November 27, 2024 04:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daniel-makerx daniel-makerx daniel-makerx approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tristanmenzel @daniel-makerx