mv-binary-format 0.3.0

Move Binary Format
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

// Copyright (c) The Move Contributors
// SPDX-License-Identifier: Apache-2.0

use std::convert::TryFrom;

use crate::{compatibility::Compatibility, file_format::*, normalized};
use move_core_types::{account_address::AccountAddress, identifier::Identifier};

fn mk_module(vis: u8) -> normalized::Module {
    let (visibility, is_entry) = if vis == Visibility::DEPRECATED_SCRIPT {
        (Visibility::Public, true)
    } else {
        (Visibility::try_from(vis).unwrap(), false)
    };
    let m = CompiledModule {
        version: crate::file_format_common::VERSION_4,
        module_handles: vec![
            // only self module
            ModuleHandle {
                address: AddressIdentifierIndex(0),
                name: IdentifierIndex(0),
            },
        ],
        self_module_handle_idx: ModuleHandleIndex(0),
        identifiers: vec![
            Identifier::new("M").unwrap(),  // Module name
            Identifier::new("fn").unwrap(), // Function name
        ],
        address_identifiers: vec![
            AccountAddress::ZERO, // Module address
        ],
        function_handles: vec![
            // fun fn()
            FunctionHandle {
                module: ModuleHandleIndex(0),
                name: IdentifierIndex(1),
                parameters: SignatureIndex(0),
                return_: SignatureIndex(0),
                type_parameters: vec![],
            },
        ],
        function_defs: vec![
            // public(script) fun fn() { return; }
            FunctionDefinition {
                function: FunctionHandleIndex(0),
                visibility,
                is_entry,
                acquires_global_resources: vec![],
                code: Some(CodeUnit {
                    locals: SignatureIndex(0),
                    code: vec![Bytecode::Ret],
                }),
            },
        ],
        signatures: vec![
            Signature(vec![]), // void
        ],
        struct_defs: vec![],
        struct_handles: vec![],
        constant_pool: vec![],
        metadata: vec![],
        field_handles: vec![],
        friend_decls: vec![],
        struct_def_instantiations: vec![],
        function_instantiations: vec![],
        field_instantiations: vec![],
    };
    normalized::Module::new(&m)
}

const NON_COMPATIBLE: Compatibility = Compatibility {
    struct_and_function_linking: false,
    struct_layout: true,
};

const COMPATIBLE: Compatibility = Compatibility {
    struct_and_function_linking: true,
    struct_layout: true,
};

#[test]
fn deprecated_unchanged_script_visibility() {
    let script_module = mk_module(Visibility::DEPRECATED_SCRIPT);
    assert_eq!(
        Compatibility::check(&script_module, &script_module,),
        COMPATIBLE
    );
}

#[test]
fn deprecated_remove_script_visibility() {
    let script_module = mk_module(Visibility::DEPRECATED_SCRIPT);
    // script -> private, not allowed
    let private_module = mk_module(Visibility::Private as u8);
    assert_eq!(
        Compatibility::check(&script_module, &private_module),
        NON_COMPATIBLE
    );
    // script -> public, not allowed
    let public_module = mk_module(Visibility::Public as u8);
    assert_eq!(
        Compatibility::check(&script_module, &public_module),
        NON_COMPATIBLE
    );
    // script -> friend, not allowed
    let friend_module = mk_module(Visibility::Friend as u8);
    assert_eq!(
        Compatibility::check(&script_module, &friend_module),
        NON_COMPATIBLE
    );
}

#[test]
fn deprecated_add_script_visibility() {
    let script_module = mk_module(Visibility::DEPRECATED_SCRIPT);
    // private -> script, allowed
    let private_module = mk_module(Visibility::Private as u8);
    assert_eq!(
        Compatibility::check(&private_module, &script_module,),
        COMPATIBLE
    );
    // public -> script, not allowed
    let public_module = mk_module(Visibility::Public as u8);
    assert_eq!(
        Compatibility::check(&public_module, &script_module),
        NON_COMPATIBLE
    );
    // friend -> script, not allowed
    let friend_module = mk_module(Visibility::Friend as u8);
    assert_eq!(
        Compatibility::check(&friend_module, &script_module),
        NON_COMPATIBLE
    );
}