BitShares-Core  5.0.0
BitShares blockchain implementation and command-line interface software
account_object.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015 Cryptonomex, Inc., and contributors.
3  *
4  * The MIT License
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #pragma once
25 
26 #include <graphene/chain/types.hpp>
29 
30 #include <boost/multi_index/composite_key.hpp>
31 
32 namespace graphene { namespace chain {
33  class database;
34  class account_object;
35  class vesting_balance_object;
36 
46  class account_statistics_object : public graphene::db::abstract_object<account_statistics_object>
47  {
48  public:
49  static constexpr uint8_t space_id = implementation_ids;
50  static constexpr uint8_t type_id = impl_account_statistics_object_type;
51 
52  account_id_type owner;
53 
54  string name;
55 
59  account_transaction_history_id_type most_recent_op;
61  uint64_t total_ops = 0;
63  uint64_t removed_ops = 0;
64 
71 
74 
77 
80 
83 
86 
90 
91  bool has_cashback_vb = false;
92 
93  bool is_voting = false;
94 
95  time_point_sec last_vote_time;
96 
99  uint64_t vp_all = 0;
100  uint64_t vp_active = 0;
101  uint64_t vp_committee = 0;
102  uint64_t vp_witness = 0;
103  uint64_t vp_worker = 0;
104  time_point_sec vote_tally_time;
108 
110  inline bool has_some_core_voting() const
111  {
112  return is_voting && ( total_core_in_orders > 0 || core_in_balance > 0 || has_cashback_vb
113  || total_core_pol > 0 );
114  }
115 
120 
135 
137  inline bool has_pending_fees() const { return pending_fees > 0 || pending_vested_fees > 0; }
138 
140  inline bool need_maintenance() const { return has_some_core_voting() || has_pending_fees(); }
141 
143  void process_fees(const account_object& a, database& d) const;
144 
148  void pay_fee( share_type core_fee, share_type cashback_vesting_threshold );
149  };
150 
158  class account_balance_object : public abstract_object<account_balance_object>
159  {
160  public:
161  static constexpr uint8_t space_id = implementation_ids;
162  static constexpr uint8_t type_id = impl_account_balance_object_type;
163 
164  account_id_type owner;
165  asset_id_type asset_type;
167  bool maintenance_flag = false;
168 
169  asset get_balance()const { return asset(balance, asset_type); }
170  void adjust_balance(const asset& delta);
171  };
172 
173 
182  class account_object : public graphene::db::abstract_object<account_object>
183  {
184  public:
185  static constexpr uint8_t space_id = protocol_ids;
186  static constexpr uint8_t type_id = account_object_type;
187 
197 
199  account_id_type registrar;
201  account_id_type referrer;
203  account_id_type lifetime_referrer;
204 
206  uint16_t network_fee_percentage = GRAPHENE_DEFAULT_NETWORK_PERCENT_OF_FEE;
208  uint16_t lifetime_referrer_fee_percentage = 0;
211  uint16_t referrer_rewards_percentage = 0;
212 
214  string name;
215 
226 
228 
231 
234  account_statistics_id_type statistics;
235 
242  flat_set<account_id_type> whitelisting_accounts;
243 
253  set<account_id_type> whitelisted_accounts;
255  set<account_id_type> blacklisted_accounts;
257 
258 
265  flat_set<account_id_type> blacklisting_accounts;
266 
270  optional<vesting_balance_id_type> cashback_vb;
271 
272  special_authority owner_special_authority = no_special_authority();
273  special_authority active_special_authority = no_special_authority();
274 
279  uint8_t top_n_control_flags = 0;
280  static const uint8_t top_n_control_owner = 1;
281  static const uint8_t top_n_control_active = 2;
282 
288  optional< flat_set<asset_id_type> > allowed_assets;
289 
291  {
292  return (!owner_special_authority.is_type< no_special_authority >())
293  || (!active_special_authority.is_type< no_special_authority >());
294  }
295 
296  template<typename DB>
297  const vesting_balance_object& cashback_balance(const DB& db)const
298  {
299  FC_ASSERT(cashback_vb);
300  return db.get(*cashback_vb);
301  }
302 
304  bool is_lifetime_member()const
305  {
306  return membership_expiration_date == time_point_sec::maximum();
307  }
310  {
311  return now > membership_expiration_date;
312  }
316  {
317  return !is_lifetime_member() && !is_basic_account(now);
318  }
320  bool is_member(time_point_sec now)const
321  {
322  return !is_basic_account(now);
323  }
324 
325  account_id_type get_id()const { return id; }
326  };
327 
333  {
334  public:
335  virtual void object_inserted( const object& obj ) override;
336  virtual void object_removed( const object& obj ) override;
337  virtual void about_to_modify( const object& before ) override;
338  virtual void object_modified( const object& after ) override;
339 
340 
342  map< account_id_type, set<account_id_type> > account_to_account_memberships;
343  map< public_key_type, set<account_id_type>, pubkey_comparator > account_to_key_memberships;
345  map< address, set<account_id_type> > account_to_address_memberships;
346 
347 
348  protected:
349  set<account_id_type> get_account_members( const account_object& a )const;
350  set<public_key_type, pubkey_comparator> get_key_members( const account_object& a )const;
351  set<address> get_address_members( const account_object& a )const;
352 
353  set<account_id_type> before_account_members;
354  set<public_key_type, pubkey_comparator> before_key_members;
356  };
357 
358 
364  {
365  public:
366  virtual void object_inserted( const object& obj ) override;
367  virtual void object_removed( const object& obj ) override;
368  virtual void about_to_modify( const object& before ) override;
369  virtual void object_modified( const object& after ) override;
370 
371  const map< asset_id_type, const account_balance_object* >& get_account_balances( const account_id_type& acct )const;
372  const account_balance_object* get_account_balance( const account_id_type& acct, const asset_id_type& asset )const;
373 
374  private:
375  static const uint8_t bits;
376  static const uint64_t mask;
377 
379  vector< vector< map< asset_id_type, const account_balance_object* > > > balances;
380  std::stack< object_id_type > ids_being_modified;
381  };
382 
383  struct by_asset_balance;
384  struct by_maintenance_flag;
388  typedef multi_index_container<
390  indexed_by<
391  ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
392  ordered_non_unique< tag<by_maintenance_flag>,
393  member< account_balance_object, bool, &account_balance_object::maintenance_flag > >,
394  ordered_unique< tag<by_asset_balance>,
395  composite_key<
396  account_balance_object,
397  member<account_balance_object, asset_id_type, &account_balance_object::asset_type>,
398  member<account_balance_object, share_type, &account_balance_object::balance>,
399  member<account_balance_object, account_id_type, &account_balance_object::owner>
400  >,
401  composite_key_compare<
402  std::less< asset_id_type >,
403  std::greater< share_type >,
404  std::less< account_id_type >
405  >
406  >
407  >
409 
414 
415  struct by_name;
416 
420  typedef multi_index_container<
422  indexed_by<
423  ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
424  ordered_unique< tag<by_name>, member<account_object, string, &account_object::name> >
425  >
427 
432 
433  struct by_maintenance_seq;
434  struct by_voting_power_active;
435 
439  typedef multi_index_container<
441  indexed_by<
442  ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
443  ordered_unique< tag<by_maintenance_seq>,
444  composite_key<
445  account_statistics_object,
446  const_mem_fun<account_statistics_object, bool, &account_statistics_object::need_maintenance>,
447  member<account_statistics_object, string, &account_statistics_object::name>
448  >
449  >,
450  ordered_non_unique< tag<by_voting_power_active>,
451  composite_key<
452  account_statistics_object,
453  member<account_statistics_object, time_point_sec, &account_statistics_object::vote_tally_time>,
454  member<account_statistics_object, uint64_t, &account_statistics_object::vp_active>
455  >,
456  composite_key_compare<
457  std::greater< time_point_sec >,
458  std::greater< uint64_t >
459  >
460  >
461  >
463 
468 
469 }}
470 
474 
478 
bool is_type() const
share_type total_core_pol
Total amount of core token in other tickets.
Tracks the balance of a single account/asset pairThis object is indexed on owner and asset_type so th...
multi_index_container< account_balance_object, indexed_by< ordered_unique< tag< by_id >, member< object, object_id_type,&object::id > >, ordered_non_unique< tag< by_maintenance_flag >, member< account_balance_object, bool,&account_balance_object::maintenance_flag > >, ordered_unique< tag< by_asset_balance >, composite_key< account_balance_object, member< account_balance_object, asset_id_type,&account_balance_object::asset_type >, member< account_balance_object, share_type,&account_balance_object::balance >, member< account_balance_object, account_id_type,&account_balance_object::owner > >, composite_key_compare< std::less< asset_id_type >, std::greater< share_type >, std::less< account_id_type > > > > > account_balance_object_multi_index_type
multi_index_container< account_object, indexed_by< ordered_unique< tag< by_id >, member< object, object_id_type,&object::id > >, ordered_unique< tag< by_name >, member< account_object, string,&account_object::name > > > > account_multi_index_type
generic_index< account_object, account_multi_index_type > account_index
flat_set< account_id_type > blacklisting_accounts
map< public_key_type, set< account_id_type >, pubkey_comparator > account_to_key_memberships
Identifies a weighted set of keys and accounts that must approve operations.
Definition: authority.hpp:34
set< account_id_type > before_account_members
bool is_member(time_point_sec now) const
This class represents an account on the object graphAccounts are the primary unit of authority on the...
tracks the blockchain state in an extensible manner
Definition: database.hpp:70
uint64_t vp_witness
the final voting power for the witnesses.
uint64_t vp_committee
the final voting power for the committees.
Definition: api.cpp:56
#define MAP_OBJECT_ID_TO_TYPE(OBJECT)
Definition: object_id.hpp:98
bool need_maintenance() const
Whether need to process this account during the maintenance interval.
This secondary index will allow fast access to the balance objects that belonging to an account...
bool has_cashback_vb
redundantly store this for better maintenance performance
bool is_annual_member(time_point_sec now) const
#define GRAPHENE_DEFAULT_NETWORK_PERCENT_OF_FEE
Definition: config.hpp:83
share_type total_pol_value
Total value of tickets whose current type is not lock_forever.
const vesting_balance_object & cashback_balance(const DB &db) const
set< public_key_type, pubkey_comparator > before_key_members
FC_REFLECT_TYPENAME(fc::log_message)
optional< flat_set< asset_id_type > > allowed_assets
generic_index< account_balance_object, account_balance_object_multi_index_type > account_balance_index
static time_point_sec maximum()
Definition: time.hpp:86
object_id_type id
Definition: object.hpp:69
multi_index_container< account_statistics_object, indexed_by< ordered_unique< tag< by_id >, member< object, object_id_type,&object::id > >, ordered_unique< tag< by_maintenance_seq >, composite_key< account_statistics_object, const_mem_fun< account_statistics_object, bool,&account_statistics_object::need_maintenance >, member< account_statistics_object, string,&account_statistics_object::name > > >, ordered_non_unique< tag< by_voting_power_active >, composite_key< account_statistics_object, member< account_statistics_object, time_point_sec,&account_statistics_object::vote_tally_time >, member< account_statistics_object, uint64_t,&account_statistics_object::vp_active > >, composite_key_compare< std::greater< time_point_sec >, std::greater< uint64_t > > > > > account_stats_multi_index_type
generic_index< account_statistics_object, account_stats_multi_index_type > account_stats_index
These are the fields which can be updated by the active authority.
Definition: account.hpp:39
#define GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION(type)
Definition: types.hpp:73
share_type total_pob_value
Total value of tickets whose current type is lock_forever.
account_id_type get_id() const
optional< vesting_balance_id_type > cashback_vb
account_id_type lifetime_referrer
The lifetime member at the top of the referral tree. Receives a percentage of referral rewards...
share_type total_core_inactive
Total amount of core token in inactive lock_forever tickets.
string name
redundantly store account name here for better maintenance performance
This secondary index will allow a reverse lookup of all accounts that a particular key or account is ...
#define FC_ASSERT(TEST,...)
Checks a condition and throws an assert_exception if the test is FALSE.
Definition: exception.hpp:345
string name
The account&#39;s name. This name must be unique among all account names on the graph. May not be empty.
bool has_pending_fees() const
Whether this account has pending fees, no matter vested or not.
flat_set< account_id_type > whitelisting_accounts
set< account_id_type > blacklisted_accounts
time_point_sec last_vote_time
last time voted
void pay_fee(share_type core_fee, share_type cashback_vesting_threshold)
Use the Curiously Recurring Template Pattern to automatically add the ability to clone, serialize, and move objects polymorphically.
Definition: object.hpp:86
bool is_basic_account(time_point_sec now) const
uint64_t vp_active
active voting power, if there is no attenuation, it is equal to vp_all.
void process_fees(const account_object &a, database &d) const
Split up and pay out pending_fees and pending_vested_fees.
bool is_voting
redundately store "if this account is voting" for better maintenance performance
account_statistics_id_type statistics
bool has_some_core_voting() const
Whether this account owns some CORE asset and is voting.
account_id_type registrar
The account that paid the fee to register this account. Receives a percentage of referral rewards...
map< address, set< account_id_type > > account_to_address_memberships
uint16_t num_committee_voted
Pre-calculated for better performance on chain maintenance.
account_id_type referrer
The account credited as referring this account. Receives a percentage of referral rewards...
map< account_id_type, set< account_id_type > > account_to_account_memberships
share_type total_core_pob
Total amount of core token in active lock_forever tickets.
account_transaction_history_id_type most_recent_op