proposal_operations.hpp

Go to the documentation of this file.

#pragma once
 
#include <scorum/protocol/base.hpp>
#include <scorum/protocol/types.hpp>
#include <scorum/protocol/asset.hpp>
#include <scorum/protocol/operation_util.hpp>
#include <scorum/protocol/ref.hpp>
#include <fc/static_variant.hpp>
 
namespace scorum {
namespace protocol {
 
enum quorum_type
{
    none_quorum,
    add_member_quorum,
    exclude_member_quorum,
    base_quorum,
    transfer_quorum,
    advertising_moderator_quorum,
    budgets_auction_properties_quorum,
    betting_moderator_quorum,
    betting_resolve_delay_quorum
};
 
inline void validate_quorum(quorum_type t, protocol::percent_type quorum)
{
    FC_ASSERT(t != none_quorum, "Quorum type is not set.");
    FC_ASSERT(quorum >= SCORUM_MIN_QUORUM_VALUE_PERCENT, "Quorum is to small.");
    FC_ASSERT(quorum <= SCORUM_MAX_QUORUM_VALUE_PERCENT, "Quorum is to large.");
}
 
struct committee_i
{
    virtual void add_member(const account_name_type&) = 0;
    virtual void exclude_member(const account_name_type&) = 0;
 
    virtual void change_add_member_quorum(const protocol::percent_type) = 0;
    virtual void change_exclude_member_quorum(const protocol::percent_type) = 0;
    virtual void change_base_quorum(const protocol::percent_type) = 0;
 
    virtual protocol::percent_type get_add_member_quorum() = 0;
    virtual protocol::percent_type get_exclude_member_quorum() = 0;
    virtual protocol::percent_type get_base_quorum() = 0;
 
    virtual bool is_exists(const account_name_type&) const = 0;
    virtual size_t get_members_count() const = 0;
};
 
struct registration_committee_i : public committee_i
{
};
 
struct development_committee_i : public committee_i
{
    virtual void change_transfer_quorum(const protocol::percent_type) = 0;
    virtual void change_advertising_moderator_quorum(const protocol::percent_type) = 0;
    virtual void change_betting_moderator_quorum(const protocol::percent_type) = 0;
    virtual void change_betting_resolve_delay_quorum(const protocol::percent_type) = 0;
    virtual void change_budgets_auction_properties_quorum(const protocol::percent_type) = 0;
 
    virtual protocol::percent_type get_transfer_quorum() = 0;
    virtual protocol::percent_type get_advertising_moderator_quorum() = 0;
    virtual protocol::percent_type get_betting_moderator_quorum() = 0;
    virtual protocol::percent_type get_betting_resolve_delay_quorum() = 0;
    virtual protocol::percent_type get_budgets_auction_properties_quorum() = 0;
};
 
struct committee : public fc::static_variant<utils::ref<registration_committee_i>, utils::ref<development_committee_i>>
{
    template <typename T>
    committee(T&& v)
        : fc::static_variant<utils::ref<registration_committee_i>, utils::ref<development_committee_i>>(
              std::forward<T>(v))
    {
    }
 
    committee_i& as_committee_i() &;
};
 
template <typename CommitteeType> struct proposal_committee_operation
{
    typedef CommitteeType committee_type;
    typedef proposal_committee_operation<CommitteeType> committee_operation_type;
};
 
template <typename OperationType, typename CommitteeType>
struct proposal_base_operation : public proposal_committee_operation<CommitteeType>
{
    typedef OperationType operation_type;
};
 
struct registration_committee_add_member_operation
    : public proposal_base_operation<registration_committee_add_member_operation, registration_committee_i>
{
    account_name_type account_name;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct registration_committee_exclude_member_operation
    : public proposal_base_operation<registration_committee_exclude_member_operation, registration_committee_i>
{
    account_name_type account_name;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct registration_committee_change_quorum_operation
    : public proposal_base_operation<registration_committee_change_quorum_operation, registration_committee_i>
{
    protocol::percent_type quorum = 0u;
    quorum_type committee_quorum = none_quorum;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_add_member_operation
    : public proposal_base_operation<development_committee_add_member_operation, development_committee_i>
{
    account_name_type account_name;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_exclude_member_operation
    : public proposal_base_operation<development_committee_exclude_member_operation, development_committee_i>
{
    account_name_type account_name;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_change_quorum_operation
    : public proposal_base_operation<development_committee_change_quorum_operation, development_committee_i>
{
    protocol::percent_type quorum = 0u;
    quorum_type committee_quorum = none_quorum;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_withdraw_vesting_operation
    : public proposal_base_operation<development_committee_withdraw_vesting_operation, development_committee_i>
{
    asset vesting_shares = asset(0, SP_SYMBOL);
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_transfer_operation
    : public proposal_base_operation<development_committee_withdraw_vesting_operation, development_committee_i>
{
    account_name_type to_account;
    asset amount = asset(0, SCORUM_SYMBOL);
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_empower_advertising_moderator_operation
    : public proposal_base_operation<development_committee_withdraw_vesting_operation, development_committee_i>
{
    account_name_type account;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct development_committee_empower_betting_moderator_operation
    : public proposal_base_operation<development_committee_empower_betting_moderator_operation, development_committee_i>
{
    account_name_type account;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
struct base_development_committee_change_budgets_auction_properties_operation
    : public proposal_base_operation<base_development_committee_change_budgets_auction_properties_operation,
                                     development_committee_i>
{
    std::vector<percent_type> auction_coefficients;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
 
protected:
    base_development_committee_change_budgets_auction_properties_operation() = default;
};
 
template <budget_type type>
struct development_committee_change_budgets_auction_properties_operation
    : public base_development_committee_change_budgets_auction_properties_operation
{
};
 
using development_committee_change_post_budgets_auction_properties_operation
    = development_committee_change_budgets_auction_properties_operation<budget_type::post>;
 
using development_committee_change_banner_budgets_auction_properties_operation
    = development_committee_change_budgets_auction_properties_operation<budget_type::banner>;
 
struct development_committee_change_betting_resolve_delay_operation
    : public proposal_base_operation<development_committee_change_betting_resolve_delay_operation,
                                     development_committee_i>
{
    uint32_t delay_sec = 0;
 
    void validate() const;
 
    protocol::percent_type get_required_quorum(committee_type& committee_service) const;
};
 
using proposal_operation = fc::static_variant<registration_committee_add_member_operation,
                                              registration_committee_exclude_member_operation,
                                              registration_committee_change_quorum_operation,
                                              development_committee_add_member_operation,
                                              development_committee_exclude_member_operation,
                                              development_committee_change_quorum_operation,
                                              development_committee_withdraw_vesting_operation,
                                              development_committee_transfer_operation,
                                              development_committee_empower_advertising_moderator_operation,
                                              development_committee_change_post_budgets_auction_properties_operation,
                                              development_committee_change_banner_budgets_auction_properties_operation,
                                              development_committee_empower_betting_moderator_operation,
                                              development_committee_change_betting_resolve_delay_operation>;
 
void operation_validate(const proposal_operation& op);
protocol::percent_type operation_get_required_quorum(committee& committee_service, const proposal_operation& op);
 
} // namespace protocol
} // namespace scorum
 
// clang-format off
FC_REFLECT_ENUM(scorum::protocol::quorum_type,
                (none_quorum)
                (add_member_quorum)
                (exclude_member_quorum)
                (base_quorum)
                (transfer_quorum)
                (advertising_moderator_quorum)
                (budgets_auction_properties_quorum)
                (betting_moderator_quorum)
                (betting_resolve_delay_quorum)
                )
// clang-format on
 
FC_REFLECT(scorum::protocol::registration_committee_add_member_operation, (account_name))
FC_REFLECT(scorum::protocol::registration_committee_exclude_member_operation, (account_name))
FC_REFLECT(scorum::protocol::registration_committee_change_quorum_operation, (quorum)(committee_quorum))
 
FC_REFLECT(scorum::protocol::development_committee_add_member_operation, (account_name))
FC_REFLECT(scorum::protocol::development_committee_exclude_member_operation, (account_name))
FC_REFLECT(scorum::protocol::development_committee_change_quorum_operation, (quorum)(committee_quorum))
 
FC_REFLECT(scorum::protocol::development_committee_withdraw_vesting_operation, (vesting_shares))
FC_REFLECT(scorum::protocol::development_committee_transfer_operation, (amount)(to_account))
FC_REFLECT(scorum::protocol::development_committee_empower_advertising_moderator_operation, (account))
 
FC_REFLECT(scorum::protocol::development_committee_empower_betting_moderator_operation, (account))
FC_REFLECT(scorum::protocol::development_committee_change_betting_resolve_delay_operation, (delay_sec))
 
FC_REFLECT(scorum::protocol::base_development_committee_change_budgets_auction_properties_operation,
           (auction_coefficients))
FC_REFLECT_DERIVED(scorum::protocol::development_committee_change_post_budgets_auction_properties_operation,
                   (scorum::protocol::base_development_committee_change_budgets_auction_properties_operation),
                   BOOST_PP_SEQ_NIL)
FC_REFLECT_DERIVED(scorum::protocol::development_committee_change_banner_budgets_auction_properties_operation,
                   (scorum::protocol::base_development_committee_change_budgets_auction_properties_operation),
                   BOOST_PP_SEQ_NIL)
 
DECLARE_OPERATION_SERIALIZATOR(scorum::protocol::proposal_operation)
FC_REFLECT_TYPENAME(scorum::protocol::proposal_operation)