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
#[test]
fn native_calls_contract_constants_lower_to_native_hash_bytes() {
    let source = r#"
    pragma solidity ^0.8.19;

    contract NativeCallsConstHarness {
        function value() public pure returns (address) {
            return NativeCalls.GAS_CONTRACT;
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(result.is_success(), "expected constant-return to succeed");

    let expected = super::bytecode::native_contract_hash(ir::NativeContract::Gas);
    assert_eq!(
        result.return_data,
        expected.to_vec(),
        "expected GAS native contract hash (UInt160 little-endian) on the VM stack"
    );
}

#[test]
fn native_contracts_constants_match_nativecalls_and_syscalls() {
    let checks = [
        "NativeContracts.NEO_CONTRACT == NativeCalls.NEO_CONTRACT",
        "NativeContracts.GAS_CONTRACT == NativeCalls.GAS_CONTRACT",
        "NativeContracts.CONTRACT_MANAGEMENT == NativeCalls.CONTRACT_MANAGEMENT",
        "NativeContracts.POLICY_CONTRACT == NativeCalls.POLICY_CONTRACT",
        "NativeContracts.ORACLE_CONTRACT == NativeCalls.ORACLE_CONTRACT",
        "NativeContracts.ROLE_MANAGEMENT == NativeCalls.ROLE_MANAGEMENT",
        "NativeContracts.NOTARY_CONTRACT == NativeCalls.NOTARY_CONTRACT",
        "NativeContracts.TREASURY_CONTRACT == NativeCalls.TREASURY_CONTRACT",
        "NativeContracts.LEDGER_CONTRACT == NativeCalls.LEDGER_CONTRACT",
        "NativeContracts.CRYPTO_LIB == NativeCalls.CRYPTO_LIB",
        "NativeContracts.STD_LIB == NativeCalls.STD_LIB",
        "NativeContracts.CONTRACT_MANAGEMENT == Syscalls.CONTRACT_MANAGEMENT",
        "NativeContracts.POLICY_CONTRACT == Syscalls.POLICY_CONTRACT",
        "NativeContracts.ORACLE_CONTRACT == Syscalls.ORACLE_CONTRACT",
        "NativeContracts.ROLE_MANAGEMENT == Syscalls.ROLE_MANAGEMENT",
        "NativeContracts.LEDGER_CONTRACT == Syscalls.LEDGER_CONTRACT",
        "NativeContracts.CRYPTO_LIB == Syscalls.CRYPTO_LIB",
        "NativeContracts.STD_LIB == Syscalls.STD_LIB",
    ];

    for check in checks {
        let source = [
            include_str!("../../../../devpack/contracts/NativeContracts.sol"),
            &format!(
                r#"
                pragma solidity ^0.8.19;

                contract NativeContractsParityHarness {{
                    function ok() public pure returns (bool) {{
                        return {check};
                    }}
                }}
                "#
            ),
        ]
        .join("\n");

        let artifacts = compile_contracts(&source, false, 2).expect("compilation failed");
        let harness = artifacts
            .iter()
            .find(|artifact| artifact.metadata.name == "NativeContractsParityHarness")
            .expect("expected NativeContractsParityHarness artifact");

        let result = execute_bytecode(&harness.bytecode);
        assert!(
            result.is_success(),
            "expected parity check execution to succeed: {check}"
        );
        assert_eq!(result.return_data, vec![1u8], "parity mismatch: {check}");
    }
}

#[test]
fn native_contracts_gas_constant_matches_native_hash_bytes() {
    let source = [
        include_str!("../../../../devpack/contracts/NativeContracts.sol"),
        r#"
        pragma solidity ^0.8.19;

        contract NativeContractsConstHarness {
            function value() public pure returns (address) {
                return NativeContracts.GAS_CONTRACT;
            }
        }
        "#,
    ]
    .join("\n");

    let artifacts = compile_contracts(&source, false, 2).expect("compilation failed");
    let harness = artifacts
        .iter()
        .find(|artifact| artifact.metadata.name == "NativeContractsConstHarness")
        .expect("expected NativeContractsConstHarness artifact");

    let result = execute_bytecode(&harness.bytecode);
    assert!(
        result.is_success(),
        "expected NativeContracts constant-return to succeed"
    );

    let expected = super::bytecode::native_contract_hash(ir::NativeContract::Gas);
    assert_eq!(
        result.return_data,
        expected.to_vec(),
        "expected GAS native contract hash bytes for NativeContracts.GAS_CONTRACT"
    );
}

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

    contract ChainIdHarness {
        function id() public view returns (uint256) {
            return block.chainid;
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(result.is_success(), "expected execution to succeed");
    assert_eq!(result.return_data, (0x4F454Eu64).to_le_bytes().to_vec());
}

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

    contract ExternalCallHarness {
        function supply() public view returns (uint256) {
            return NativeCalls.GAS_CONTRACT.totalSupply();
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(result.is_success(), "expected contract call to succeed");

    assert_eq!(
        result.return_data,
        30_000_000_000u64.to_le_bytes().to_vec(),
        "expected GAS.totalSupply result (u64 little-endian) to be returned directly"
    );
}

#[test]
fn native_contracts_member_call_returns_native_stack_item() {
    let source = [
        include_str!("../../../../devpack/contracts/NativeContracts.sol"),
        r#"
        pragma solidity ^0.8.19;

        contract NativeContractsCallHarness {
            function supply() public view returns (uint256) {
                return NativeContracts.GAS_CONTRACT.totalSupply();
            }
        }
        "#,
    ]
    .join("\n");

    let artifacts = compile_contracts(&source, false, 2).expect("compilation failed");
    let harness = artifacts
        .iter()
        .find(|artifact| artifact.metadata.name == "NativeContractsCallHarness")
        .expect("expected NativeContractsCallHarness artifact");

    let result = execute_bytecode(&harness.bytecode);
    assert!(
        result.is_success(),
        "expected NativeContracts member call to succeed"
    );

    assert_eq!(
        result.return_data,
        30_000_000_000u64.to_le_bytes().to_vec(),
        "expected GAS.totalSupply result (u64 little-endian) for NativeContracts target"
    );
}

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

    contract AccountStateHarness {
        function isDefault() public view returns (bool) {
            NativeCalls.AccountState memory state = NativeCalls.getAccountState(address(1));
            return state.balance == 0
                && state.balanceHeight == 0
                && state.lastGasPerVote == 0
                && state.voteTo.length == 0;
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    let failure = result
        .exception
        .as_ref()
        .map(|ex| ex.message.as_str())
        .unwrap_or("<no exception>");
    assert!(
        result.is_success(),
        "expected account state helper to succeed, got: {failure}"
    );
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract AccountStateNonNullHarness {
        function ok() public view returns (bool) {
            address selfHash = Syscalls.getExecutingScriptHash();
            NativeCalls.AccountState memory state = NativeCalls.getAccountState(selfHash);
            // The embedded runtime seeds NEO balance for the executing script hash.
            // The NeoToken.getAccountState response may contain a null voteTo; the compiler
            // helper normalizes that to an empty byte string.
            return state.balance > 0 && state.voteTo.length == 0;
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    let failure = result
        .exception
        .as_ref()
        .map(|ex| ex.message.as_str())
        .unwrap_or("<no exception>");
    assert!(
        result.is_success(),
        "expected non-null account state helper to succeed, got: {failure}"
    );
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract CandidatesHarness {
        function ok() public view returns (bool) {
            NativeCalls.NeoCandidate[] memory candidates = NativeCalls.getCandidates();
            return candidates.length > 0
                && candidates[0].votes == 1000
                && candidates[0].publicKey.length == 33;
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    let failure = result
        .exception
        .as_ref()
        .map(|ex| ex.message.as_str())
        .unwrap_or("<no exception>");
    assert!(
        result.is_success(),
        "expected candidates helper to succeed, got: {failure}"
    );
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract CommitteeHarness {
        function firstIsCommittee() public view returns (bool) {
            address[] memory committee = Neo.getCommittee();
            return Neo.isCommittee(committee[0]);
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(result.is_success(), "expected committee helper to succeed");
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract ValidatorHarness {
        function firstIsValidator() public view returns (bool) {
            address[] memory validators = Neo.getValidators();
            return Neo.isValidator(validators[0]);
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(result.is_success(), "expected validator helper to succeed");
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract NativeCommitteeHarness {
        function matches() public view returns (bool) {
            address[] memory a = NativeCalls.getCommittee();
            address[] memory b = Neo.getCommittee();
            return a[0] == b[0];
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(
        result.is_success(),
        "expected committee conversion to succeed"
    );
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract NativeValidatorHarness {
        function matches() public view returns (bool) {
            address[] memory a = NativeCalls.getNextBlockValidators();
            address[] memory b = Neo.getValidators();
            return a[0] == b[0];
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let result = execute_bytecode(&artifacts[0].bytecode);
    assert!(
        result.is_success(),
        "expected validator conversion to succeed"
    );
    assert_eq!(result.return_data, vec![1u8]);
}

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

    contract RuntimeMultisigDuplicateHarness {
        function run(address[] memory signers) public view returns (bool) {
            return Runtime.checkMultiSigWitness(signers, 1);
        }
    }
    "#;

    let artifacts = compile_contracts(source, false, 2).expect("compilation failed");
    let message = b"Runtime: duplicate signer";
    assert!(
        artifacts[0]
            .bytecode
            .windows(message.len())
            .any(|window| window == message),
        "expected bytecode to include duplicate-signer guard message"
    );
}

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

    contract CalltRuntimeHarness {
        function supply() public view returns (uint256) {
            return NativeCalls.gasTotalSupply();
        }
    }
    "#;

    let artifacts = compile_contracts_with_options(
        source,
        false,
        CompileOptions {
            optimizer_level: 2,
            use_callt: true,
            deny_wildcard_permissions: false,
            deny_wildcard_contracts: false,
            deny_wildcard_methods: false,
            manifest_permissions: None,
        },
    )
    .expect("compilation failed");

    let artifact = &artifacts[0];
    assert!(
        !artifact.tokens.is_empty(),
        "expected method tokens to be emitted when --callt is enabled"
    );

    let result = execute_bytecode_with_tokens(&artifact.bytecode, &artifact.tokens);
    assert!(result.is_success(), "expected CALLT execution to succeed");
    assert_eq!(result.return_data, 30_000_000_000u64.to_le_bytes().to_vec());
}