neo-devpack-solidity 0.22.0

Production-focused Solidity-to-NeoVM compilation system
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
#[test]
fn self_contract_calls_do_not_require_wildcard_permissions() {
    let source = r#"
    pragma solidity ^0.8.20;

    contract SelfCallHarness {
        function dispatch(string calldata methodName) public {
            bytes memory params = abi.encode(uint256(1));
            // Self-calls are allowed on Neo N3 and should not force wildcard permissions.
            Syscalls.contractCall(address(this), methodName, params);
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let manifest = &artifacts[0].manifest;
    let permissions = manifest["permissions"]
        .as_array()
        .expect("permissions array");

    assert!(
        permissions
            .iter()
            .all(|entry| entry["contract"] != Value::String("*".into())),
        "self contract calls should not require wildcard permissions"
    );
}

#[test]
fn self_contract_calls_preserve_state_for_following_calls() {
    let source = r#"
    pragma solidity ^0.8.19;

    contract SelfThenNative {
        function run() public returns (bytes memory) {
            bytes memory params = abi.encode(uint256(1));
            bytes memory ignored = Syscalls.contractCall(address(this), "localPing", params);
            return Syscalls.contractCall(NativeCalls.GAS_CONTRACT, "totalSupply", ignored);
        }

        function localPing(uint256 value) public pure returns (uint256) {
            return value + 1;
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    let gas_hash_le = super::bytecode::native_contract_hash(neo_devpack_solidity::ir::NativeContract::Gas);
    let gas_hash_be: Vec<u8> = gas_hash_le.iter().rev().copied().collect();
    let gas_contract = format!("0x{}", hex::encode(gas_hash_be));

    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == Value::String(gas_contract.clone())
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "totalSupply"))
        }),
        "expected explicit permission for the native GAS totalSupply call"
    );

    assert!(
        permissions
            .iter()
            .all(|entry| !(entry["contract"] == Value::String("*".into())
                && entry["methods"] == "*")),
        "self call followed by native call should not degrade to full wildcard permissions"
    );
}

#[test]
fn syscalls_contract_call_dynamic_method_restricts_to_contract() {
    let source = r#"
    pragma solidity ^0.8.19;

    contract CallsNativeViaContractCall {
        function callGas(address /*ignored*/, string memory method) public returns (bytes memory) {
            return Syscalls.contractCall(
                NativeCalls.GAS_CONTRACT,
                method,
                abi.encode()
            );
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let manifest = &artifacts[0].manifest;
    let permissions = manifest["permissions"]
        .as_array()
        .expect("permissions array");

    let gas_hash_le = super::bytecode::native_contract_hash(neo_devpack_solidity::ir::NativeContract::Gas);
    let gas_hash_be: Vec<u8> = gas_hash_le.iter().rev().copied().collect();
    let gas_contract = format!("0x{}", hex::encode(gas_hash_be));

    assert!(
        permissions
            .iter()
            .any(|entry| entry["contract"] == gas_contract && entry["methods"] == "*"),
        "expected GAS wildcard methods (methods='*') when the method name is dynamic"
    );

    assert!(
        permissions
            .iter()
            .all(|entry| entry["contract"] != Value::String("*".into())),
        "dynamic method name alone should not force wildcard contract permissions"
    );
}

#[test]
fn external_contract_call_dynamic_target_restricts_to_method() {
    let source = r#"
    pragma solidity ^0.8.19;

    interface IFace {
        function ping(uint256 value) external returns (uint256);
    }

    contract ExternalCallPermissionHarness {
        function callPing(address target, uint256 value) public returns (uint256) {
            return IFace(target).ping(value);
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let manifest = &artifacts[0].manifest;
    let permissions = manifest["permissions"]
        .as_array()
        .expect("permissions array");

    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == Value::String("*".into())
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "ping"))
        }),
        "expected wildcard contract permission restricted to ping() method"
    );

    assert!(
        permissions
            .iter()
            .all(|entry| !(entry["contract"] == Value::String("*".into())
                && entry["methods"] == "*")),
        "expected no full wildcard permissions for external call with static method name"
    );
}

#[test]
fn deny_wildcard_contracts_rejects_dynamic_target_permissions() {
    let source = r#"
    pragma solidity ^0.8.19;

    interface IFace {
        function ping(uint256 value) external returns (uint256);
    }

    contract ExternalCallPermissionHarness {
        function callPing(address target, uint256 value) public returns (uint256) {
            return IFace(target).ping(value);
        }
    }
    "#;

    let err = compile_contracts_with_options(
        source,
        false,
        CompileOptions {
            optimizer_level: 2,
            use_callt: false,
            deny_wildcard_permissions: false,
            deny_wildcard_contracts: true,
            deny_wildcard_methods: false,
            manifest_permissions: None,
        },
    )
    .expect_err("expected manifest wildcard contract error");

    match err {
        CompileError::Manifest(message) => {
            assert!(
                message
                    .to_ascii_lowercase()
                    .contains("wildcard contract manifest permissions"),
                "unexpected error message: {message}"
            );
        }
        other => panic!("unexpected error variant: {other:?}"),
    }
}

#[test]
fn manifest_permissions_replace_wildcards_allows_deny_wildcard_contracts() {
    let source = r#"
    pragma solidity ^0.8.19;

    interface IFace {
        function ping(uint256 value) external returns (uint256);
    }

    contract ExternalCallPermissionHarness {
        function callPing(address target, uint256 value) public returns (uint256) {
            return IFace(target).ping(value);
        }
    }
    "#;

    let temp = tempdir().expect("tempdir");
    let permissions_path = temp.path().join("permissions.json");
    std::fs::write(
        &permissions_path,
        r#"[{"contract":"0x0102030405060708090a0b0c0d0e0f1011121314","methods":["ping"]}]"#,
    )
    .expect("write permissions");

    let override_permissions = load_manifest_permissions_override(
        permissions_path.to_str().expect("permissions path"),
        "replace-wildcards",
    )
    .expect("permissions override parse");

    let artifacts = compile_contracts_with_options(
        source,
        false,
        CompileOptions {
            optimizer_level: 2,
            use_callt: false,
            deny_wildcard_permissions: false,
            deny_wildcard_contracts: true,
            deny_wildcard_methods: false,
            manifest_permissions: Some(override_permissions),
        },
    )
    .expect("expected compilation to succeed with wildcard replacement");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    assert!(
        permissions
            .iter()
            .all(|entry| entry["contract"] != Value::String("*".into())),
        "expected wildcard contract permissions to be replaced"
    );

    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == Value::String("0x0102030405060708090a0b0c0d0e0f1011121314".into())
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "ping"))
        }),
        "expected explicit allowlist entry for the target contract"
    );
}

#[test]
fn branch_selected_known_targets_do_not_require_wildcard_contract_permissions() {
    let source = r#"
    pragma solidity ^0.8.19;

    contract BranchSelectedTargets {
        function callEither(bool useGas, address account) public returns (bytes memory) {
            address target;
            if (useGas) {
                target = NativeCalls.GAS_CONTRACT;
            } else {
                target = NativeCalls.NEO_CONTRACT;
            }
            return Syscalls.contractCall(target, "balanceOf", abi.encode(account));
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    let gas_hash_le = super::bytecode::native_contract_hash(neo_devpack_solidity::ir::NativeContract::Gas);
    let gas_hash_be: Vec<u8> = gas_hash_le.iter().rev().copied().collect();
    let gas_contract = Value::String(format!("0x{}", hex::encode(gas_hash_be)));

    let neo_hash_le = super::bytecode::native_contract_hash(neo_devpack_solidity::ir::NativeContract::Neo);
    let neo_hash_be: Vec<u8> = neo_hash_le.iter().rev().copied().collect();
    let neo_contract = Value::String(format!("0x{}", hex::encode(neo_hash_be)));

    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == gas_contract
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "balanceOf"))
        }),
        "expected explicit GAS permission"
    );
    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == neo_contract
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "balanceOf"))
        }),
        "expected explicit NEO permission"
    );
    assert!(
        permissions
            .iter()
            .all(|entry| entry["contract"] != Value::String("*".into())),
        "branch-selected known targets should not require wildcard contract permissions"
    );
}

#[test]
fn correlated_branch_selected_target_and_method_do_not_cross_product_permissions() {
    let source = r#"
    pragma solidity ^0.8.19;

    contract CorrelatedTargetAndMethod {
        function callEither(bool useGas) public returns (bytes memory) {
            address target;
            string memory method;
            if (useGas) {
                target = NativeCalls.GAS_CONTRACT;
                method = "totalSupply";
            } else {
                target = NativeCalls.NEO_CONTRACT;
                method = "getCommittee";
            }
            return Syscalls.contractCall(target, method, abi.encode());
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    let gas_hash_le = super::bytecode::native_contract_hash(neo_devpack_solidity::ir::NativeContract::Gas);
    let gas_hash_be: Vec<u8> = gas_hash_le.iter().rev().copied().collect();
    let gas_contract = Value::String(format!("0x{}", hex::encode(gas_hash_be)));

    let neo_hash_le = super::bytecode::native_contract_hash(neo_devpack_solidity::ir::NativeContract::Neo);
    let neo_hash_be: Vec<u8> = neo_hash_le.iter().rev().copied().collect();
    let neo_contract = Value::String(format!("0x{}", hex::encode(neo_hash_be)));

    let gas_entry = permissions
        .iter()
        .find(|entry| entry["contract"] == gas_contract)
        .expect("gas permission entry");
    let neo_entry = permissions
        .iter()
        .find(|entry| entry["contract"] == neo_contract)
        .expect("neo permission entry");

    let gas_methods = gas_entry["methods"].as_array().expect("gas methods array");
    let neo_methods = neo_entry["methods"].as_array().expect("neo methods array");

    assert!(gas_methods.iter().any(|method| method == "totalSupply"));
    assert!(!gas_methods.iter().any(|method| method == "getCommittee"));
    assert!(neo_methods.iter().any(|method| method == "getCommittee"));
    assert!(!neo_methods.iter().any(|method| method == "totalSupply"));
}

#[test]
fn natspec_manifest_permissions_replace_dynamic_wildcards_under_strict_flags() {
    let source = r#"
    pragma solidity ^0.8.19;

    /**
     * @custom:neo.manifest.permissions [
     *   {"contract":"0xd2a4cff31913016155e38e474a2c06d08be276cf","methods":["balanceOf"]}
     * ]
     */
    contract DynamicPermissionOverride {
        function callAny(address target, string memory method, address account) public returns (bytes memory) {
            return Syscalls.contractCall(target, method, abi.encode(account));
        }
    }
    "#;

    let artifacts = compile_contracts_with_options(
        source,
        false,
        CompileOptions {
            optimizer_level: 2,
            use_callt: false,
            deny_wildcard_permissions: true,
            deny_wildcard_contracts: true,
            deny_wildcard_methods: true,
            manifest_permissions: None,
        },
    )
    .expect("expected NatSpec permissions override to satisfy strict flags");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    let gas_contract = Value::String("0xd2a4cff31913016155e38e474a2c06d08be276cf".into());
    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == gas_contract
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "balanceOf"))
        }),
        "expected explicit NatSpec allowlist entry"
    );
    assert!(
        permissions
            .iter()
            .all(|entry| entry["contract"] != Value::String("*".into()) && entry["methods"] != "*"),
        "expected NatSpec override to remove wildcard permissions"
    );
}

#[test]
fn natspec_manifest_permissions_mode_merge_preserves_wildcards() {
    let source = r#"
    pragma solidity ^0.8.19;

    /**
     * @custom:neo.manifest.permissions [{"contract":"0xd2a4cff31913016155e38e474a2c06d08be276cf","methods":["balanceOf"]}]
     * @custom:neo.manifest.permissionsmode "merge"
     */
    contract DynamicPermissionMerge {
        function callAny(address target, string memory method, address account) public returns (bytes memory) {
            return Syscalls.contractCall(target, method, abi.encode(account));
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == Value::String("*".into()) && entry["methods"] == "*"
        }),
        "merge mode should preserve inferred wildcard permissions"
    );
}

#[test]
fn address_constants_in_contract_calls_infer_explicit_contract_permissions() {
    let source = r#"
    pragma solidity ^0.8.19;

    contract ConstantTargetCallHarness {
        address constant TARGET = 0xd2a4cff31913016155e38e474a2c06d08be276cf;

        function callSupply() public view returns (bytes memory) {
            return Syscalls.contractCall(TARGET, "totalSupply", abi.encode());
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    assert_eq!(artifacts.len(), 1);

    let permissions = artifacts[0].manifest["permissions"]
        .as_array()
        .expect("permissions array");

    assert!(
        permissions.iter().any(|entry| {
            entry["contract"] == Value::String("0xd2a4cff31913016155e38e474a2c06d08be276cf".into())
                && entry["methods"]
                    .as_array()
                    .is_some_and(|methods| methods.iter().any(|m| m == "totalSupply"))
        }),
        "expected explicit GAS contract permission for totalSupply"
    );

    assert!(
        permissions
            .iter()
            .all(|entry| entry["contract"] != Value::String("*".into())),
        "address constants should not degrade into wildcard contract permissions"
    );
}