Debian Codegraph @

autotests/html/test.sol.html

raw
1 <!DOCTYPE html>
2 <html><head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
4 <title>test.sol</title>
5 <meta name="generator" content="KF5::SyntaxHighlighting - Definition (Solidity) - Theme (Breeze Light)"/>
6 </head><body style="background-color:#ffffff;color:#1f1c1b"><pre>
7 <span style="color:#898887;">// Solidity Sample File</span>
8 <span style="color:#898887;">// https://solidity.readthedocs.io/en/latest/solidity-by-example.html#voting</span>
9
10 <span style="font-weight:bold;">pragma</span> <span style="color:#644a9b;font-weight:bold;">solidity</span> &gt;=0.4.22 &lt;0.7.0;
11
12 <span style="color:#898887;">/// </span><span style="color:#ca60ca;">@title</span><span style="color:#898887;"> Voting with delegation.</span>
13 <span style="font-weight:bold;">contract</span> Ballot <span style="color:#ca60ca;">{</span>
14 <span style="color:#898887;">// This declares a new complex type which will</span>
15 <span style="color:#898887;">// be used for variables later.</span>
16 <span style="color:#898887;">// It will represent a single voter.</span>
17 <span style="font-weight:bold;">struct</span> Voter <span style="color:#ca60ca;">{</span>
18 <span style="color:#0057ae;">uint</span> weight<span style="color:#ca60ca;">;</span> <span style="color:#898887;">// weight is accumulated by delegation</span>
19 <span style="color:#0057ae;">bool</span> voted<span style="color:#ca60ca;">;</span> <span style="color:#898887;">// if true, that person already voted</span>
20 <span style="color:#0057ae;">address</span> delegate<span style="color:#ca60ca;">;</span> <span style="color:#898887;">// person delegated to</span>
21 <span style="color:#0057ae;">uint</span> vote<span style="color:#ca60ca;">;</span> <span style="color:#898887;">// index of the voted proposal</span>
22 <span style="color:#ca60ca;">}</span>
23
24 <span style="color:#898887;">// This is a type for a single proposal.</span>
25 <span style="font-weight:bold;">struct</span> Proposal <span style="color:#ca60ca;">{</span>
26 <span style="color:#0057ae;">bytes32</span> name<span style="color:#ca60ca;">;</span> <span style="color:#898887;">// short name (up to 32 bytes)</span>
27 <span style="color:#0057ae;">uint</span> voteCount<span style="color:#ca60ca;">;</span> <span style="color:#898887;">// number of accumulated votes</span>
28 <span style="color:#ca60ca;">}</span>
29
30 <span style="color:#0057ae;">address</span> <span style="font-weight:bold;">public</span> chairperson<span style="color:#ca60ca;">;</span>
31
32 <span style="color:#898887;">// This declares a state variable that</span>
33 <span style="color:#898887;">// stores a `Voter` struct for each possible address.</span>
34 <span style="color:#0057ae;">mapping</span><span style="color:#ca60ca;">(</span><span style="color:#0057ae;">address</span> <span style="color:#ca60ca;">=&gt;</span> Voter<span style="color:#ca60ca;">)</span> <span style="font-weight:bold;">public</span> voters<span style="color:#ca60ca;">;</span>
35
36 <span style="color:#898887;">// A dynamically-sized array of `Proposal` structs.</span>
37 Proposal<span style="color:#ca60ca;">[]</span> <span style="font-weight:bold;">public</span> proposals<span style="color:#ca60ca;">;</span>
38
39 <span style="color:#898887;">/// Create a new ballot to choose one of `proposalNames`.</span>
40 <span style="font-weight:bold;">constructor</span><span style="color:#ca60ca;">(</span><span style="color:#0057ae;">bytes32</span><span style="color:#ca60ca;">[]</span> <span style="font-weight:bold;">memory</span> proposalNames<span style="color:#ca60ca;">)</span> <span style="font-weight:bold;">public</span> <span style="color:#ca60ca;">{</span>
41 chairperson <span style="color:#ca60ca;">=</span> <span style="color:#644a9b;font-weight:bold;">msg</span><span style="color:#ca60ca;">.</span>sender<span style="color:#ca60ca;">;</span>
42 voters<span style="color:#ca60ca;">[</span>chairperson<span style="color:#ca60ca;">].</span>weight <span style="color:#ca60ca;">=</span> <span style="color:#b08000;">1</span><span style="color:#ca60ca;">;</span>
43
44 <span style="color:#898887;">// For each of the provided proposal names,</span>
45 <span style="color:#898887;">// create a new proposal object and add it</span>
46 <span style="color:#898887;">// to the end of the array.</span>
47 <span style="font-weight:bold;">for</span> <span style="color:#ca60ca;">(</span><span style="color:#0057ae;">uint</span> i <span style="color:#ca60ca;">=</span> <span style="color:#b08000;">0</span><span style="color:#ca60ca;">;</span> i <span style="color:#ca60ca;">&lt;</span> proposalNames<span style="color:#ca60ca;">.</span>length<span style="color:#ca60ca;">;</span> i<span style="color:#644a9b;font-weight:bold;">++</span><span style="color:#ca60ca;">)</span> <span style="color:#ca60ca;">{</span>
48 <span style="color:#898887;">// `Proposal({...})` creates a temporary</span>
49 <span style="color:#898887;">// Proposal object and `proposals.push(...)`</span>
50 <span style="color:#898887;">// appends it to the end of `proposals`.</span>
51 proposals<span style="color:#ca60ca;">.</span>push<span style="color:#ca60ca;">(</span>Proposal<span style="color:#ca60ca;">({</span>
52 name<span style="color:#ca60ca;">:</span> proposalNames<span style="color:#ca60ca;">[</span>i<span style="color:#ca60ca;">],</span>
53 voteCount<span style="color:#ca60ca;">:</span> <span style="color:#b08000;">0</span>
54 <span style="color:#ca60ca;">}));</span>
55 <span style="color:#ca60ca;">}</span>
56 <span style="color:#ca60ca;">}</span>
57
58 <span style="color:#898887;">// Give `voter` the right to vote on this ballot.</span>
59 <span style="color:#898887;">// May only be called by `chairperson`.</span>
60 <span style="font-weight:bold;">function</span> giveRightToVote<span style="color:#ca60ca;">(</span><span style="color:#0057ae;">address</span> voter<span style="color:#ca60ca;">)</span> <span style="font-weight:bold;">public</span> <span style="color:#ca60ca;">{</span>
61 <span style="color:#898887;">// If the first argument of `require` evaluates</span>
62 <span style="color:#898887;">// to `false`, execution terminates and all</span>
63 <span style="color:#898887;">// changes to the state and to Ether balances</span>
64 <span style="color:#898887;">// are reverted.</span>
65 <span style="color:#898887;">// This used to consume all gas in old EVM versions, but</span>
66 <span style="color:#898887;">// not anymore.</span>
67 <span style="color:#898887;">// It is often a good idea to use `require` to check if</span>
68 <span style="color:#898887;">// functions are called correctly.</span>
69 <span style="color:#898887;">// As a second argument, you can also provide an</span>
70 <span style="color:#898887;">// explanation about what went wrong.</span>
71 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(</span>
72 <span style="color:#644a9b;font-weight:bold;">msg</span><span style="color:#ca60ca;">.</span>sender <span style="color:#ca60ca;">==</span> chairperson<span style="color:#ca60ca;">,</span>
73 <span style="color:#bf0303;">&quot;Only chairperson can give right to vote.&quot;</span>
74 <span style="color:#ca60ca;">);</span>
75 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(</span>
76 <span style="color:#ca60ca;">!</span>voters<span style="color:#ca60ca;">[</span>voter<span style="color:#ca60ca;">].</span>voted<span style="color:#ca60ca;">,</span>
77 <span style="color:#bf0303;">&quot;The voter already voted.&quot;</span>
78 <span style="color:#ca60ca;">);</span>
79 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(</span>voters<span style="color:#ca60ca;">[</span>voter<span style="color:#ca60ca;">].</span>weight <span style="color:#ca60ca;">==</span> <span style="color:#b08000;">0</span><span style="color:#ca60ca;">);</span>
80 voters<span style="color:#ca60ca;">[</span>voter<span style="color:#ca60ca;">].</span>weight <span style="color:#ca60ca;">=</span> <span style="color:#b08000;">1</span><span style="color:#ca60ca;">;</span>
81 <span style="color:#ca60ca;">}</span>
82
83 <span style="color:#898887;">/// Delegate your vote to the voter `to`.</span>
84 <span style="font-weight:bold;">function</span> delegate<span style="color:#ca60ca;">(</span><span style="color:#0057ae;">address</span> to<span style="color:#ca60ca;">)</span> <span style="font-weight:bold;">public</span> <span style="color:#ca60ca;">{</span>
85 <span style="color:#898887;">// assigns reference</span>
86 Voter <span style="font-weight:bold;">storage</span> sender <span style="color:#ca60ca;">=</span> voters<span style="color:#ca60ca;">[</span><span style="color:#644a9b;font-weight:bold;">msg</span><span style="color:#ca60ca;">.</span>sender<span style="color:#ca60ca;">];</span>
87 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(!</span>sender<span style="color:#ca60ca;">.</span>voted<span style="color:#ca60ca;">,</span> <span style="color:#bf0303;">&quot;You already voted.&quot;</span><span style="color:#ca60ca;">);</span>
88
89 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(</span>to <span style="color:#ca60ca;">!=</span> <span style="color:#644a9b;font-weight:bold;">msg</span><span style="color:#ca60ca;">.</span>sender<span style="color:#ca60ca;">,</span> <span style="color:#bf0303;">&quot;Self-delegation is disallowed.&quot;</span><span style="color:#ca60ca;">);</span>
90
91 <span style="color:#898887;">// Forward the delegation as long as</span>
92 <span style="color:#898887;">// `to` also delegated.</span>
93 <span style="color:#898887;">// In general, such loops are very dangerous,</span>
94 <span style="color:#898887;">// because if they run too long, they might</span>
95 <span style="color:#898887;">// need more gas than is available in a block.</span>
96 <span style="color:#898887;">// In this case, the delegation will not be executed,</span>
97 <span style="color:#898887;">// but in other situations, such loops might</span>
98 <span style="color:#898887;">// cause a contract to get &quot;stuck&quot; completely.</span>
99 <span style="font-weight:bold;">while</span> <span style="color:#ca60ca;">(</span>voters<span style="color:#ca60ca;">[</span>to<span style="color:#ca60ca;">].</span>delegate <span style="color:#ca60ca;">!=</span> <span style="color:#0057ae;">address</span><span style="color:#ca60ca;">(</span><span style="color:#b08000;">0</span><span style="color:#ca60ca;">))</span> <span style="color:#ca60ca;">{</span>
100 to <span style="color:#ca60ca;">=</span> voters<span style="color:#ca60ca;">[</span>to<span style="color:#ca60ca;">].</span>delegate<span style="color:#ca60ca;">;</span>
101
102 <span style="color:#898887;">// We found a loop in the delegation, not allowed.</span>
103 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(</span>to <span style="color:#ca60ca;">!=</span> <span style="color:#644a9b;font-weight:bold;">msg</span><span style="color:#ca60ca;">.</span>sender<span style="color:#ca60ca;">,</span> <span style="color:#bf0303;">&quot;Found loop in delegation.&quot;</span><span style="color:#ca60ca;">);</span>
104 <span style="color:#ca60ca;">}</span>
105
106 <span style="color:#898887;">// Since `sender` is a reference, this</span>
107 <span style="color:#898887;">// modifies `voters[msg.sender].voted`</span>
108 sender<span style="color:#ca60ca;">.</span>voted <span style="color:#ca60ca;">=</span> <span style="font-weight:bold;">true</span><span style="color:#ca60ca;">;</span>
109 sender<span style="color:#ca60ca;">.</span>delegate <span style="color:#ca60ca;">=</span> to<span style="color:#ca60ca;">;</span>
110 Voter <span style="font-weight:bold;">storage</span> delegate_ <span style="color:#ca60ca;">=</span> voters<span style="color:#ca60ca;">[</span>to<span style="color:#ca60ca;">];</span>
111 <span style="font-weight:bold;">if</span> <span style="color:#ca60ca;">(</span>delegate_<span style="color:#ca60ca;">.</span>voted<span style="color:#ca60ca;">)</span> <span style="color:#ca60ca;">{</span>
112 <span style="color:#898887;">// If the delegate already voted,</span>
113 <span style="color:#898887;">// directly add to the number of votes</span>
114 proposals<span style="color:#ca60ca;">[</span>delegate_<span style="color:#ca60ca;">.</span>vote<span style="color:#ca60ca;">].</span>voteCount <span style="color:#ca60ca;">+=</span> sender<span style="color:#ca60ca;">.</span>weight<span style="color:#ca60ca;">;</span>
115 <span style="color:#ca60ca;">}</span> <span style="font-weight:bold;">else</span> <span style="color:#ca60ca;">{</span>
116 <span style="color:#898887;">// If the delegate did not vote yet,</span>
117 <span style="color:#898887;">// add to her weight.</span>
118 delegate_<span style="color:#ca60ca;">.</span>weight <span style="color:#ca60ca;">+=</span> sender<span style="color:#ca60ca;">.</span>weight<span style="color:#ca60ca;">;</span>
119 <span style="color:#ca60ca;">}</span>
120 <span style="color:#ca60ca;">}</span>
121
122 <span style="color:#898887;">/// Give your vote (including votes delegated to you)</span>
123 <span style="color:#898887;">/// to proposal `proposals[proposal].name`.</span>
124 <span style="font-weight:bold;">function</span> vote<span style="color:#ca60ca;">(</span><span style="color:#0057ae;">uint</span> proposal<span style="color:#ca60ca;">)</span> <span style="font-weight:bold;">public</span> <span style="color:#ca60ca;">{</span>
125 Voter <span style="font-weight:bold;">storage</span> sender <span style="color:#ca60ca;">=</span> voters<span style="color:#ca60ca;">[</span><span style="color:#644a9b;font-weight:bold;">msg</span><span style="color:#ca60ca;">.</span>sender<span style="color:#ca60ca;">];</span>
126 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(</span>sender<span style="color:#ca60ca;">.</span>weight <span style="color:#ca60ca;">!=</span> <span style="color:#b08000;">0</span><span style="color:#ca60ca;">,</span> <span style="color:#bf0303;">&quot;Has no right to vote&quot;</span><span style="color:#ca60ca;">);</span>
127 <span style="color:#644a9b;font-weight:bold;">require</span><span style="color:#ca60ca;">(!</span>sender<span style="color:#ca60ca;">.</span>voted<span style="color:#ca60ca;">,</span> <span style="color:#bf0303;">&quot;Already voted.&quot;</span><span style="color:#ca60ca;">);</span>
128 sender<span style="color:#ca60ca;">.</span>voted <span style="color:#ca60ca;">=</span> <span style="font-weight:bold;">true</span><span style="color:#ca60ca;">;</span>
129 sender<span style="color:#ca60ca;">.</span>vote <span style="color:#ca60ca;">=</span> proposal<span style="color:#ca60ca;">;</span>
130
131 <span style="color:#898887;">// If `proposal` is out of the range of the array,</span>
132 <span style="color:#898887;">// this will throw automatically and revert all</span>
133 <span style="color:#898887;">// changes.</span>
134 proposals<span style="color:#ca60ca;">[</span>proposal<span style="color:#ca60ca;">].</span>voteCount <span style="color:#ca60ca;">+=</span> sender<span style="color:#ca60ca;">.</span>weight<span style="color:#ca60ca;">;</span>
135 <span style="color:#ca60ca;">}</span>
136
137 <span style="color:#898887;">/// </span><span style="color:#ca60ca;">@dev</span><span style="color:#898887;"> Computes the winning proposal taking all</span>
138 <span style="color:#898887;">/// previous votes into account.</span>
139 <span style="font-weight:bold;">function</span> winningProposal<span style="color:#ca60ca;">()</span> <span style="font-weight:bold;">public</span> <span style="font-weight:bold;">view</span>
140 <span style="font-weight:bold;">returns</span> <span style="color:#ca60ca;">(</span><span style="color:#0057ae;">uint</span> winningProposal_<span style="color:#ca60ca;">)</span>
141 <span style="color:#ca60ca;">{</span>
142 <span style="color:#0057ae;">uint</span> winningVoteCount <span style="color:#ca60ca;">=</span> <span style="color:#b08000;">0</span><span style="color:#ca60ca;">;</span>
143 <span style="font-weight:bold;">for</span> <span style="color:#ca60ca;">(</span><span style="color:#0057ae;">uint</span> p <span style="color:#ca60ca;">=</span> <span style="color:#b08000;">0</span><span style="color:#ca60ca;">;</span> p <span style="color:#ca60ca;">&lt;</span> proposals<span style="color:#ca60ca;">.</span>length<span style="color:#ca60ca;">;</span> p<span style="color:#644a9b;font-weight:bold;">++</span><span style="color:#ca60ca;">)</span> <span style="color:#ca60ca;">{</span>
144 <span style="font-weight:bold;">if</span> <span style="color:#ca60ca;">(</span>proposals<span style="color:#ca60ca;">[</span>p<span style="color:#ca60ca;">].</span>voteCount <span style="color:#ca60ca;">&gt;</span> winningVoteCount<span style="color:#ca60ca;">)</span> <span style="color:#ca60ca;">{</span>
145 winningVoteCount <span style="color:#ca60ca;">=</span> proposals<span style="color:#ca60ca;">[</span>p<span style="color:#ca60ca;">].</span>voteCount<span style="color:#ca60ca;">;</span>
146 winningProposal_ <span style="color:#ca60ca;">=</span> p<span style="color:#ca60ca;">;</span>
147 <span style="color:#ca60ca;">}</span>
148 <span style="color:#ca60ca;">}</span>
149 <span style="color:#ca60ca;">}</span>
150
151 <span style="color:#898887;">// Calls winningProposal() function to get the index</span>
152 <span style="color:#898887;">// of the winner contained in the proposals array and then</span>
153 <span style="color:#898887;">// returns the name of the winner</span>
154 <span style="font-weight:bold;">function</span> winnerName<span style="color:#ca60ca;">()</span> <span style="font-weight:bold;">public</span> <span style="font-weight:bold;">view</span>
155 <span style="font-weight:bold;">returns</span> <span style="color:#ca60ca;">(</span><span style="color:#0057ae;">bytes32</span> winnerName_<span style="color:#ca60ca;">)</span>
156 <span style="color:#ca60ca;">{</span>
157 winnerName_ <span style="color:#ca60ca;">=</span> proposals<span style="color:#ca60ca;">[</span>winningProposal<span style="color:#ca60ca;">()].</span>name<span style="color:#ca60ca;">;</span>
158 <span style="color:#ca60ca;">}</span>
159 <span style="color:#ca60ca;">}</span>
160 </pre></body></html>