solar-lsp 0.2.0

Solidity LSP
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

use super::support::RequestFixture;
use snapbox::str;

#[test]
fn indexes_function_and_state_references() {
    let fixture = RequestFixture::new(
        r#"
        //- /Symbols.sol
        contract C {
            uint256 $2stateValue;

            function $1target(uint256 input) public returns (uint256 output) {
                uint256 localValue = input + stateValue;
                output = localValue;
            }

            function caller() public {
                uint256 callerLocal = target(stateValue);
            }
        }
        "#,
        "/Symbols.sol",
    );

    fixture.check_references(
        "$1",
        true,
        str![[r#"
/Symbols.sol:2:13 function target(uint256 input) public returns (uint256 output) {
/Symbols.sol:7:30 uint256 callerLocal = target(stateValue);

"#]],
    );
    fixture.check_references(
        "$2",
        true,
        str![[r#"
/Symbols.sol:1:12 uint256 stateValue;
/Symbols.sol:3:37 uint256 localValue = input + stateValue;
/Symbols.sol:7:37 uint256 callerLocal = target(stateValue);

"#]],
    );
}

#[test]
fn indexes_member_references() {
    let fixture = RequestFixture::new(
        r#"
        //- /Members.sol
        contract C {
            enum Choice { A, B }
            struct Data { uint256 $1field; }

            function read(Data memory data) public pure returns (uint256) {
                Choice choice = Choice.A;
                return data.field;
            }
        }
        "#,
        "/Members.sol",
    );

    fixture.check_references(
        "$1",
        true,
        str![[r#"
/Members.sol:2:26 struct Data { uint256 field; }
/Members.sol:5:20 return data.field;

"#]],
    );
}

#[test]
fn skips_generated_getter_references() {
    let fixture = RequestFixture::new(
        r#"
        //- /Getter.sol
        contract C {
            uint256 public $1x;

            function read() external view returns (uint256) {
                return x;
            }
        }
        "#,
        "/Getter.sol",
    );

    fixture.check_references(
        "$1",
        true,
        str![[r#"
/Getter.sol:1:19 uint256 public x;
/Getter.sol:3:15 return x;

"#]],
    );
}

#[test]
fn indexes_selected_overload_references() {
    let fixture = RequestFixture::new(
        r#"
        //- /Overload.sol
        contract C {
            function $1f(uint256) public {}
            function $2f(string memory) public {}
            function g() public {
                f(uint256(1));
            }
        }
        "#,
        "/Overload.sol",
    );

    fixture.check_references(
        "$1",
        true,
        str![[r#"
/Overload.sol:1:13 function f(uint256) public {}
/Overload.sol:4:8 f(uint256(1));

"#]],
    );
    fixture.check_references(
        "$2",
        true,
        str![[r#"
/Overload.sol:2:13 function f(string memory) public {}

"#]],
    );
}

#[test]
fn indexes_using_directive_references() {
    let fixture = RequestFixture::new(
        r#"
        //- /Using.sol
        library $1L {
            function inc(uint256 value) internal pure returns (uint256) {
                return value + 1;
            }
        }

        using L for uint256;

        contract C {
            function f(uint256 value) public pure returns (uint256) {
                return value.inc();
            }
        }
        "#,
        "/Using.sol",
    );

    fixture.check_references(
        "$1",
        true,
        str![[r#"
/Using.sol:0:8 library L {
/Using.sol:5:6 using L for uint256;

"#]],
    );
}