feat: x-algokit-byte-length support and block model restructuring for cross-SDK alignment

[aorumbayev]

Summary

Adds fixed-length byte validation using x-algokit-byte-length vendor extension and restructures block models to align with js-algorand-sdk v3.

Key Changes

Fixed-Length Byte Validation

• Added x-algokit-byte-length OpenAPI vendor extension support
• Validates 32-byte fields (genesis_hash, previous_block_hash, transaction roots) during (de)serialization
• Raises errors on length mismatches

Block Model Restructuring (Breaking)

• GetBlock → BlockResponse
• BlockHeader fields reorganized into nested dataclasses:
  • TxnCommitments - transaction roots (SHA256/512)
  • RewardState - fee_sink, rewards_pool, rewards_level, etc.
  • UpgradeState - current/next protocol versions
  • UpgradeVote - upgrade proposals
• Renamed BlockEvalDelta.bytes → bytes_value (Python keyword conflict)
• All block types remain publicly exported for type hints and isinstance checks

AVM Debugger Source Map (Bug Fix)

• Fixed JSON key: sha512_256 → hash (restores standard AVM debugger format compatibility)
• Added Python snapshot tests for AVM debugger format validation

Wire Format

• Msgpack encoding unchanged - fully backward compatible with nodes
• Only Python API structure changed

Migration Example

# Before
response: GetBlock = algod.get_block(round)
fee_sink = response.block.header.fee_sink

# After  
response: BlockResponse = algod.get_block(round)
fee_sink = response.block.header.reward_state.fee_sink

See MIGRATION-NOTES.md for complete field mapping.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src/algokit_abi
_arc32_to_arc56.py	104	2	98%	109, 126
_arc56_serde.py	108	3	97%	31, 36, 154
abi.py	474	31	93%	76–82, 85, 88, 113, 121, 177, 192, 201–204, 225, 258, 279–281, 284, 295, 382, 403, 488, 516, 529, 555, 634, 651, 665
arc32.py	96	8	92%	201–210
arc56.py	475	31	93%	87, 100, 155–156, 321, 342, 352, 365–367, 386, 391, 691, 711, 730–732, 747, 750–752, 765–766, 768–769, 808–821
src/algokit_algod_client
client.py	683	234	66%	63, 69, 75, 79, 85, 93, 96–101, 116, 134–147, 182, 249, 275–276, 290, 341, 357, 375, 391, 421, 451, 488, 518, 527–545, 575, 602, 635, 645–668, 698, 709–732, 744–769, 796, 806–826, 853, 880, 907, 917–940, 954–984, 1011, 1038, 1071, 1082–1102, 1112–1132, 1179, 1209, 1253, 1263–1293, 1302–1320, 1337, 1341, 1387, 1392, 1394, 1399, 1403, 1408, 1479, 1492–1497, 1502, 1505–1509, 1516–1528, 1536–1541, 1566–1576, 1582–1584
exceptions.py	43	13	70%	14, 18–21, 27, 31–32, 44–48
src/algokit_algod_client/models
_block.py	159	32	80%	49–51, 59–65, 71–73, 82–88, 92–99, 104, 116–118
_ledger_state_delta.py	174	15	91%	48–52, 56–62, 68–70
_serde_helpers.py	171	78	54%	19, 21, 37, 42–45, 52, 65–67, 72, 76–77, 79, 86, 90–91, 100–110, 115–123, 128, 132, 139, 149–156, 160–169, 178–196, 206, 218, 228
src/algokit_common
address.py	26	5	81%	9, 12, 17, 23, 31
source_map.py	56	5	91%	19, 78, 122, 153–154
src/algokit_common/serde
_core.py	346	54	84%	86, 168, 187, 269–298, 303, 316, 328, 341, 345, 348–349, 391–394, 414, 419, 430–432, 439–440, 447–448, 450, 456–457, 497, 525–526, 563, 571, 577, 586, 592, 601, 607
_primitives.py	73	23	68%	5–7, 11–13, 17, 23, 35–37, 41–43, 47–49, 55, 60–61, 122, 126, 130
src/algokit_indexer_client
client.py	674	253	62%	62, 68, 74, 78, 82–84, 91–104, 115, 128–146, 175, 198, 201, 204, 207, 223, 244, 247, 250, 253, 269, 289, 292, 295, 311, 332, 335, 338, 341, 357, 378, 381, 384, 387, 403, 435, 438, 441, 444, 447, 450, 453, 456, 459, 462, 465, 468, 471, 474, 477, 493, 526, 544, 560, 583, 586, 589, 592, 595, 598, 614, 636, 639, 642, 645, 648, 664, 682, 698, 732, 735, 738, 741, 744, 747, 750, 753, 756, 759, 762, 765, 768, 771, 774, 777, 780, 796, 814, 830, 887, 893, 896, 899, 902, 905, 908, 911, 914, 917, 933, 952, 955, 971, 996, 1002, 1018, 1039, 1045, 1048, 1051, 1054, 1057, 1073, 1100, 1103, 1106, 1109, 1112, 1115, 1118, 1121, 1137, 1175, 1181, 1184, 1187, 1193, 1199, 1202, 1205, 1208, 1211, 1214, 1223, 1226, 1245, 1254–1270, 1273–1280, 1350, 1355–1369, 1373, 1376–1380, 1384–1415, 1418–1423, 1427–1456
exceptions.py	43	13	70%	14, 18–21, 27, 31–32, 44–48
src/algokit_indexer_client/models
_serde_helpers.py	171	121	29%	18–22, 26, 31, 35–37, 42–45, 52, 57–67, 71–81, 86, 90–91, 100–110, 115–123, 127–134, 139, 149–156, 160–169, 178–196, 205–213, 217–219, 227–230, 238–241
src/algokit_kmd_client
client.py	495	322	35%	61, 67, 73, 77, 81–83, 90–103, 114, 127–145, 187, 197–227, 237–267, 307, 317–347, 357–387, 427, 438–468, 478–508, 518–548, 558–588, 628, 668, 678–708, 736, 749, 789, 799–829, 839–869, 879–909, 919–949, 959–989, 999–1029, 1041–1047, 1050–1054, 1058, 1061–1064, 1134, 1139–1153, 1157, 1160–1164, 1168–1199, 1202–1207, 1211–1240
exceptions.py	43	37	14%	13–50, 55–59
src/algokit_kmd_client/models
_serde_helpers.py	171	130	24%	18–22, 26, 31, 35–37, 42–45, 50–53, 57–67, 71–81, 85–93, 100–110, 115–123, 127–134, 139, 149–156, 160–169, 178–196, 205–213, 217–219, 227–230, 238–241
src/algokit_transact
logicsig.py	107	60	44%	59–65, 70, 75, 80, 85–89, 94, 99–101, 104–132, 144–147, 159–160, 172–173, 187–191, 199–220
signer.py	82	21	74%	120–124, 127–128, 131–132, 162–164, 169–170, 184–195
src/algokit_transact/codec
signed.py	42	10	76%	19, 21, 24, 40, 44, 53–57
transaction.py	41	2	95%	16, 65
src/algokit_transact/models
app_call.py	328	204	38%	25, 29, 77–91, 95–98, 106, 108, 111, 124, 129, 135, 142–154, 158–261, 305–308, 322–324, 336, 340–342, 351, 364–365, 371–372, 376, 379–385, 388–399, 402–406, 409–412, 415–423, 426–436, 439–446
state_proof.py	104	21	80%	94, 102, 114, 120, 127–138, 144–150
transaction.py	54	1	98%	35
src/algokit_transact/ops
group.py	21	2	90%	15, 22
validate.py	209	3	99%	60, 74, 76
src/algokit_transact/signing
multisig.py	55	8	85%	17, 19, 21, 41, 61, 67, 69, 74
types.py	28	3	89%	10, 14, 24
validation.py	22	19	14%	36–63
src/algokit_utils
_debugging.py	159	21	87%	43–45, 57, 84, 88, 97, 134, 182, 184, 212, 217, 224, 230, 255–265, 270
algo25.py	2	2	0%	13–29
algorand.py	105	14	87%	67–68, 80–81, 111–112, 139–140, 175–176, 323, 346, 362, 381
config.py	78	18	77%	23, 30–34, 73–74, 100, 105, 111–116, 141, 149, 151
src/algokit_utils/accounts
account_manager.py	277	50	82%	174, 204, 207, 210, 213, 239–243, 259, 262, 265, 268, 291–296, 334–344, 362, 369–371, 388–391, 461, 507, 527–531, 544–545, 615, 633, 636, 639, 642, 813, 916, 990, 997, 1035
kmd_account_manager.py	97	18	81%	45–51, 83, 86–90, 115, 119, 155, 193, 206
src/algokit_utils/applications
abi.py	125	47	62%	31, 66, 75–79, 83–84, 104–106, 113–117, 141, 151, 161, 180–181, 193–195, 203–208, 235–244, 259–270
app_client.py	796	223	72%	125, 133, 320–323, 326, 329, 332, 335, 347–350, 353, 356, 359, 362, 374, 383, 392, 395–456, 469–525, 549–551, 568–571, 579–582, 590–593, 601–604, 612–615, 628–631, 644, 740–743, 777, 789, 801, 813, 825, 842, 859, 869, 879, 889, 899, 909, 946–959, 975, 992, 1009, 1026, 1047, 1068, 1158, 1222, 1364, 1430–1431, 1480, 1482, 1488, 1541–1549, 1582–1585, 1588–1591, 1612, 1660, 1725–1727, 1740–1751, 1796, 1813, 1815, 1818, 1820, 1965–1979, 2008, 2021–2023, 2027, 2038–2039, 2073, 2078, 2091–2093, 2096–2109, 2115–2116, 2127–2129, 2131–2132, 2139–2141, 2146–2150, 2157–2162, 2182, 2185
app_deployer.py	263	38	86%	96, 270, 277, 287–292, 295–299, 375–376, 496, 589, 601–615, 627, 632–635, 644, 658, 665, 672, 701, 730–758, 776, 787
app_factory.py	280	30	89%	176, 432, 453, 462, 654, 664, 714, 946, 960–965, 976–977, 1010, 1048, 1066–1067, 1089, 1092, 1120–1136
app_manager.py	214	17	92%	256, 277–278, 347–348, 393–396, 443–444, 476, 504–507, 539, 548
src/algokit_utils/assets
asset_manager.py	126	13	90%	158, 289–290, 299, 305–329, 340
src/algokit_utils/clients
client_manager.py	178	54	70%	77–84, 109, 141–143, 200, 207, 220–221, 232–235, 260, 299, 334–339, 374–376, 408, 429, 450, 495–498, 538–541, 582–585, 622–625, 647–672, 710, 723, 735
dispenser_api_client.py	89	20	78%	87, 91, 132–133, 137–140, 181–191, 201–212
src/algokit_utils/errors
logic_error.py	70	27	61%	92, 115–160
src/algokit_utils/models
amount.py	100	13	87%	36, 43, 101, 117–118, 150–153, 156–159
src/algokit_utils/transactions
composer_resources.py	293	75	74%	21, 25, 27, 29, 71, 74, 114, 125, 164, 175, 190, 197–198, 202–209, 234–262, 296, 309–311, 317–319, 325, 367–378, 381–392
transaction_composer.py	774	90	88%	146, 393–396, 414–426, 446, 451, 492–495, 552–562, 595, 657–668, 677, 679, 688, 707, 729, 764, 898, 988, 991, 1239, 1256, 1270, 1290, 1310, 1338, 1341, 1350, 1365, 1374, 1381, 1384, 1408–1409, 1411, 1435–1438, 1477–1483, 1503–1521, 1533, 1535, 1540, 1543–1544, 1550–1555, 1571–1574
transaction_creator.py	79	7	91%	394, 427, 482, 520, 557, 590, 688
transaction_sender.py	178	17	90%	105–109, 115, 285, 318, 331–332, 440, 734–739, 744–745, 910
src/algokit_utils/transactions/builders
app.py	57	2	96%	163–168
common.py	125	13	90%	86, 152, 154, 176, 183, 187–197, 213–214
keyreg.py	46	16	65%	75, 77, 80–81, 86, 89, 92–93, 95, 97–103
method_call.py	132	37	72%	260, 262, 269, 294, 299–310, 315, 330–336, 340–346, 350–354, 358–364, 374–375
TOTAL	13019	2626	80%

Tests	Skipped	Failures	Errors	Time
843	47 💤	0 ❌	0 🔥	1m 51s ⏱️