Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve spec of several modules #25

Merged
merged 2 commits into from
May 7, 2022
Merged

Improve spec of several modules #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
067a4ef
Improve spec of several modules
xudon9 May 6, 2022
dbb897f
Run build script
xudon9 May 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion build/StarcoinFramework/BuildInfo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ compiled_package_info:
? address: "0x00000000000000000000000000000001"
name: YieldFarmingV2
: StarcoinFramework
source_digest: 474424D9D46208E41316F8EC90B53E54C4ACAF882152E7F474C387C7342035F1
source_digest: 54034AEB5CDBFFF340E2E96579A13CF5046A4E3EDF6512B45ADD5B82AC29F11B
build_flags:
dev_mode: false
test_mode: false
Expand Down
Binary file modified build/StarcoinFramework/bytecode_modules/Treasury.mv
View file
Open in desktop
Binary file not shown.
112 changes: 85 additions & 27 deletions build/StarcoinFramework/docs/Config.md
View file
Open in desktop

Large diffs are not rendered by default.

102 changes: 67 additions & 35 deletions build/StarcoinFramework/docs/Dao.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ Configuration of the <code><a href="Token.md#0x1_Token">Token</a></code>'s DAO.
<code>voting_delay: u64</code>
</dt>
<dd>
after proposal created, how long use should wait before he can vote.
after proposal created, how long use should wait before he can vote (in milliseconds)
</dd>
<dt>
<code>voting_period: u64</code>
</dt>
<dd>
how long the voting window is.
how long the voting window is (in milliseconds).
</dd>
<dt>
<code>voting_quorum_rate: u8</code>
Expand All @@ -139,7 +139,7 @@ Configuration of the <code><a href="Token.md#0x1_Token">Token</a></code>'s DAO.
<code>min_action_delay: u64</code>
</dt>
<dd>
how long the proposal should wait before it can be executed.
how long the proposal should wait before it can be executed (in milliseconds).
</dd>
</dl>

Expand Down Expand Up @@ -234,7 +234,7 @@ emitted when user vote/revoke_vote.
<code>agree: bool</code>
</dt>
<dd>
agree or againest.
agree with the proposal or not
</dd>
<dt>
<code>vote: u128</code>
Expand Down Expand Up @@ -292,13 +292,13 @@ Proposal data struct.
<code>for_votes: u128</code>
</dt>
<dd>
count of votes for agree.
count of voters who agree with the proposal
</dd>
<dt>
<code>against_votes: u128</code>
</dt>
<dd>
count of votes for againest.
count of voters who're against the proposal
</dd>
<dt>
<code>eta: u64</code>
Expand Down Expand Up @@ -539,7 +539,7 @@ Proposal state
## Function `plugin`

plugin function, can only be called by token issuer.
Any token who wants to has gov functionality
Any token who wants to have gov functionality
can optin this module by call this <code>register function</code>.


Expand Down Expand Up @@ -587,15 +587,11 @@ can optin this module by call this <code>register function</code>.



<pre><code><b>aborts_if</b> voting_delay == 0;
<b>aborts_if</b> voting_period == 0;
<b>aborts_if</b> voting_quorum_rate == 0 || voting_quorum_rate &gt; 100;
<b>aborts_if</b> min_action_delay == 0;
<b>let</b> sender = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
<pre><code><b>let</b> sender = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
<b>aborts_if</b> sender != <a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>();
<b>include</b> <a href="Dao.md#0x1_Dao_NewDaoConfigParamSchema">NewDaoConfigParamSchema</a>&lt;TokenT&gt;;
<b>include</b> <a href="Config.md#0x1_Config_PublishNewConfigAbortsIf">Config::PublishNewConfigAbortsIf</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a>&lt;TokenT&gt;&gt;{account: signer};
<b>aborts_if</b> <b>exists</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(sender);
<b>aborts_if</b> <b>exists</b>&lt;<a href="Config.md#0x1_Config_Config">Config::Config</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a>&lt;TokenT&gt;&gt;&gt;(sender);
<b>aborts_if</b> <b>exists</b>&lt;<a href="Config.md#0x1_Config_ModifyConfigCapabilityHolder">Config::ModifyConfigCapabilityHolder</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a>&lt;TokenT&gt;&gt;&gt;(sender);
</code></pre>


Expand Down Expand Up @@ -692,7 +688,10 @@ create a dao config
): <a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a>&lt;TokenT&gt; {
<b>assert</b>!(voting_delay &gt; 0, <a href="Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="Dao.md#0x1_Dao_ERR_CONFIG_PARAM_INVALID">ERR_CONFIG_PARAM_INVALID</a>));
<b>assert</b>!(voting_period &gt; 0, <a href="Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="Dao.md#0x1_Dao_ERR_CONFIG_PARAM_INVALID">ERR_CONFIG_PARAM_INVALID</a>));
<b>assert</b>!(voting_quorum_rate &gt; 0 && <a href="Dao.md#0x1_Dao_voting_quorum_rate">voting_quorum_rate</a> &lt;= 100, <a href="Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="Dao.md#0x1_Dao_ERR_CONFIG_PARAM_INVALID">ERR_CONFIG_PARAM_INVALID</a>));
<b>assert</b>!(
voting_quorum_rate &gt; 0 && <a href="Dao.md#0x1_Dao_voting_quorum_rate">voting_quorum_rate</a> &lt;= 100,
<a href="Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="Dao.md#0x1_Dao_ERR_CONFIG_PARAM_INVALID">ERR_CONFIG_PARAM_INVALID</a>),
);
<b>assert</b>!(min_action_delay &gt; 0, <a href="Errors.md#0x1_Errors_invalid_argument">Errors::invalid_argument</a>(<a href="Dao.md#0x1_Dao_ERR_CONFIG_PARAM_INVALID">ERR_CONFIG_PARAM_INVALID</a>));
<a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a> { voting_delay, voting_period, voting_quorum_rate, min_action_delay }
}
Expand All @@ -707,10 +706,25 @@ create a dao config



<pre><code><b>aborts_if</b> voting_delay == 0;
<b>aborts_if</b> voting_period == 0;
<b>aborts_if</b> voting_quorum_rate == 0 || voting_quorum_rate &gt; 100;
<b>aborts_if</b> min_action_delay == 0;
<pre><code><b>include</b> <a href="Dao.md#0x1_Dao_NewDaoConfigParamSchema">NewDaoConfigParamSchema</a>&lt;TokenT&gt;;
</code></pre>




<a name="0x1_Dao_NewDaoConfigParamSchema"></a>


<pre><code><b>schema</b> <a href="Dao.md#0x1_Dao_NewDaoConfigParamSchema">NewDaoConfigParamSchema</a>&lt;TokenT&gt; {
voting_delay: u64;
voting_period: u64;
voting_quorum_rate: u8;
min_action_delay: u64;
<b>aborts_if</b> voting_delay == 0;
<b>aborts_if</b> voting_period == 0;
<b>aborts_if</b> voting_quorum_rate == 0 || voting_quorum_rate &gt; 100;
<b>aborts_if</b> min_action_delay == 0;
}
</code></pre>


Expand Down Expand Up @@ -758,7 +772,7 @@ propose a proposal.
against_votes: 0,
eta: 0,
action_delay,
quorum_votes: quorum_votes,
quorum_votes,
action: <a href="Option.md#0x1_Option_some">Option::some</a>(action),
};
<b>move_to</b>(signer, proposal);
Expand All @@ -780,7 +794,10 @@ propose a proposal.



<pre><code><b>pragma</b> addition_overflow_unchecked;
<pre><code><b>pragma</b> verify = <b>false</b>;
<b>let</b> proposer = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
<b>include</b> <a href="Dao.md#0x1_Dao_GenerateNextProposalIdSchema">GenerateNextProposalIdSchema</a>&lt;TokenT&gt;;
<b>pragma</b> addition_overflow_unchecked = <b>true</b>;
<b>include</b> <a href="Dao.md#0x1_Dao_AbortIfDaoConfigNotExist">AbortIfDaoConfigNotExist</a>&lt;TokenT&gt;;
<b>include</b> <a href="Dao.md#0x1_Dao_AbortIfDaoInfoNotExist">AbortIfDaoInfoNotExist</a>&lt;TokenT&gt;;
<b>aborts_if</b> !<b>exists</b>&lt;<a href="Timestamp.md#0x1_Timestamp_CurrentTimeMilliseconds">Timestamp::CurrentTimeMilliseconds</a>&gt;(<a href="CoreAddresses.md#0x1_CoreAddresses_GENESIS_ADDRESS">CoreAddresses::GENESIS_ADDRESS</a>());
Expand Down Expand Up @@ -1005,7 +1022,8 @@ Let user change their vote during the voting time.



<pre><code><b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_ACTIVE">ACTIVE</a>);
<pre><code><b>pragma</b> verify = <b>false</b>;
<b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_ACTIVE">ACTIVE</a>);
<b>include</b> <a href="Dao.md#0x1_Dao_CheckProposalStates">CheckProposalStates</a>&lt;TokenT, ActionT&gt;{expected_states};
<b>let</b> sender = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
<b>aborts_if</b> !<b>exists</b>&lt;<a href="Dao.md#0x1_Dao_Vote">Vote</a>&lt;TokenT&gt;&gt;(sender);
Expand Down Expand Up @@ -1137,7 +1155,8 @@ Revoke some voting powers from vote on <code>proposal_id</code> of <code>propose



<pre><code><b>include</b> <a href="Dao.md#0x1_Dao_AbortIfDaoInfoNotExist">AbortIfDaoInfoNotExist</a>&lt;TokenT&gt;;
<pre><code><b>pragma</b> verify = <b>false</b>;
<b>include</b> <a href="Dao.md#0x1_Dao_AbortIfDaoInfoNotExist">AbortIfDaoInfoNotExist</a>&lt;TokenT&gt;;
<b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_ACTIVE">ACTIVE</a>);
<b>include</b> <a href="Dao.md#0x1_Dao_CheckProposalStates">CheckProposalStates</a>&lt;TokenT, ActionT&gt; {expected_states};
<b>let</b> sender = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
Expand Down Expand Up @@ -1258,7 +1277,8 @@ Retrieve back my staked token voted for a proposal.



<pre><code><b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_DEFEATED">DEFEATED</a>);
<pre><code><b>pragma</b> verify = <b>false</b>;
<b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_DEFEATED">DEFEATED</a>);
<b>let</b> expected_states1 = concat(expected_states,vec(<a href="Dao.md#0x1_Dao_AGREED">AGREED</a>));
<b>let</b> expected_states2 = concat(expected_states1,vec(<a href="Dao.md#0x1_Dao_QUEUED">QUEUED</a>));
<b>let</b> expected_states3 = concat(expected_states2,vec(<a href="Dao.md#0x1_Dao_EXECUTABLE">EXECUTABLE</a>));
Expand Down Expand Up @@ -1321,7 +1341,8 @@ queue agreed proposal to execute.



<pre><code><b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_AGREED">AGREED</a>);
<pre><code><b>pragma</b> verify = <b>false</b>;
<b>let</b> expected_states = vec(<a href="Dao.md#0x1_Dao_AGREED">AGREED</a>);
<b>include</b> <a href="Dao.md#0x1_Dao_CheckProposalStates">CheckProposalStates</a>&lt;TokenT, ActionT&gt;{expected_states};
<b>let</b> proposal = <b>global</b>&lt;<a href="Dao.md#0x1_Dao_Proposal">Proposal</a>&lt;TokenT, ActionT&gt;&gt;(proposer_address);
<b>aborts_if</b> <a href="Timestamp.md#0x1_Timestamp_spec_now_millseconds">Timestamp::spec_now_millseconds</a>() + proposal.action_delay &gt; MAX_U64;
Expand Down Expand Up @@ -1768,16 +1789,27 @@ Check whether voter has voted on proposal with <code>proposal_id</code> of <code



<pre><code><b>pragma</b> addition_overflow_unchecked;
<b>modifies</b> <b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>());
<b>ensures</b>
<b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).next_proposal_id ==
<b>old</b>(<b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).next_proposal_id) + 1;
<pre><code><b>include</b> <a href="Dao.md#0x1_Dao_GenerateNextProposalIdSchema">GenerateNextProposalIdSchema</a>&lt;TokenT&gt;;
<b>ensures</b> result == <b>old</b>(<b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).next_proposal_id);
</code></pre>




<a name="0x1_Dao_GenerateNextProposalIdSchema"></a>


<pre><code><b>schema</b> <a href="Dao.md#0x1_Dao_GenerateNextProposalIdSchema">GenerateNextProposalIdSchema</a>&lt;TokenT&gt; {
<b>aborts_if</b> <b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).next_proposal_id &gt;= MAX_U64;
<b>modifies</b> <b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>());
<b>ensures</b>
<b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).next_proposal_id ==
<b>old</b>(<b>global</b>&lt;<a href="Dao.md#0x1_Dao_DaoGlobalInfo">DaoGlobalInfo</a>&lt;TokenT&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).next_proposal_id) + 1;
}
</code></pre>



</details>

<a name="0x1_Dao_voting_delay"></a>
Expand Down Expand Up @@ -1889,7 +1921,8 @@ Quorum votes to make proposal pass.



<pre><code><b>include</b> <a href="Dao.md#0x1_Dao_CheckQuorumVotes">CheckQuorumVotes</a>&lt;TokenT&gt;;
<pre><code><b>pragma</b> verify = <b>false</b>;
<b>include</b> <a href="Dao.md#0x1_Dao_CheckQuorumVotes">CheckQuorumVotes</a>&lt;TokenT&gt;;
</code></pre>


Expand Down Expand Up @@ -2015,7 +2048,7 @@ Get the min_action_delay of the DAO.


<pre><code><b>aborts_if</b> <b>false</b>;
<b>ensures</b> result == <b>global</b>&lt;<a href="Config.md#0x1_Config_Config">Config::Config</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a>&lt;TokenT&gt;&gt;&gt;((<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>())).payload;
<b>ensures</b> result == <b>global</b>&lt;<a href="Config.md#0x1_Config_Config">Config::Config</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">DaoConfig</a>&lt;TokenT&gt;&gt;&gt;(<a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>()).payload;
</code></pre>


Expand Down Expand Up @@ -2292,7 +2325,6 @@ set min action delay



<pre><code><b>pragma</b> verify = <b>false</b>;
<b>pragma</b> aborts_if_is_partial = <b>false</b>;
<b>pragma</b> aborts_if_is_strict = <b>true</b>;
<pre><code><b>pragma</b> verify;
<b>pragma</b> aborts_if_is_strict;
</code></pre>
2 changes: 1 addition & 1 deletion build/StarcoinFramework/docs/ModifyDaoConfigProposal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Should be called by token issuer.
<pre><code><b>pragma</b> aborts_if_is_partial = <b>false</b>;
<b>let</b> sender = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
<b>aborts_if</b> sender != <a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>();
<b>include</b> <a href="Config.md#0x1_Config_AbortsIfCapNotExist">Config::AbortsIfCapNotExist</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">Dao::DaoConfig</a>&lt;TokenT&gt;&gt;{account: sender};
<b>include</b> <a href="Config.md#0x1_Config_AbortsIfCapNotExist">Config::AbortsIfCapNotExist</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">Dao::DaoConfig</a>&lt;TokenT&gt;&gt;{<b>address</b>: sender};
<b>let</b> config_cap = <a href="Config.md#0x1_Config_spec_cap">Config::spec_cap</a>&lt;<a href="Dao.md#0x1_Dao_DaoConfig">Dao::DaoConfig</a>&lt;TokenT&gt;&gt;(sender);
<b>aborts_if</b> <a href="Option.md#0x1_Option_is_none">Option::is_none</a>(config_cap);
<b>aborts_if</b> <a href="Option.md#0x1_Option_borrow">Option::borrow</a>(config_cap).account_address != sender;
Expand Down
2 changes: 1 addition & 1 deletion build/StarcoinFramework/docs/OnChainConfigDao.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Should be called by token issuer.
<pre><code><b>pragma</b> aborts_if_is_partial = <b>false</b>;
<b>let</b> sender = <a href="Signer.md#0x1_Signer_address_of">Signer::address_of</a>(signer);
<b>aborts_if</b> sender != <a href="Token.md#0x1_Token_SPEC_TOKEN_TEST_ADDRESS">Token::SPEC_TOKEN_TEST_ADDRESS</a>();
<b>include</b> <a href="Config.md#0x1_Config_AbortsIfCapNotExist">Config::AbortsIfCapNotExist</a>&lt;ConfigT&gt;{account: sender};
<b>include</b> <a href="Config.md#0x1_Config_AbortsIfCapNotExist">Config::AbortsIfCapNotExist</a>&lt;ConfigT&gt;{<b>address</b>: sender};
<b>aborts_if</b> <b>exists</b>&lt;<a href="OnChainConfigDao.md#0x1_OnChainConfigDao_WrappedConfigModifyCapability">WrappedConfigModifyCapability</a>&lt;TokenT, ConfigT&gt;&gt;(sender);
<b>ensures</b> <b>exists</b>&lt;<a href="OnChainConfigDao.md#0x1_OnChainConfigDao_WrappedConfigModifyCapability">WrappedConfigModifyCapability</a>&lt;TokenT, ConfigT&gt;&gt;(sender);
</code></pre>
Expand Down
Loading