Пространство имен Capital::Projects

Пространства имен
namespace	Status
	Константы статусов проекта

Функции
eosio::asset	sync_total_debt (eosio::name coopname, uint64_t project_id)
	Пересчитывает total_debt_amount проекта обходом его сегментов. Подробнее...
eosio::asset	calculate_min_invest_pool_for_debts (eosio::name coopname, const project &prj)
	Минимальный invest_pool, при котором ни у кого provisional_amount не упадёт ниже долга. Подробнее...
eosio::asset	calculate_max_deallocatable (eosio::name coopname, const project &prj)
	Максимальная сумма, которую можно вернуть из проекта в глобальный пул программы. Подробнее...
std::optional< project >	get_project (eosio::name coopname, const checksum256 &project_hash)
	Получает проект по хэшу Подробнее...
project	get_project_or_fail (eosio::name coopname, const checksum256 &project_hash)
	Получает проект по хэшу, если проект не найден, выбрасывает исключение Подробнее...
project	get_project_by_id_or_fail (eosio::name coopname, const uint64_t project_id)
	Получает проект по id. Подробнее...
bool	has_component_projects (eosio::name coopname, const checksum256 &project_hash)
	Есть ли у проекта дочерние проекты-компоненты (их parent_hash совпадает с хэшем родителя) Подробнее...
void	validate_parent_hash (eosio::name coopname, const checksum256 &parent_hash)
	Проверяет валидность parent_hash согласно правилам проектов Подробнее...
void	create_project (eosio::name coopname, const checksum256 &project_hash, const checksum256 &parent_hash, const std::string &title, const std::string &description, const std::string &invite, const std::string &meta, const std::string &data)
	Создает проект Подробнее...
void	edit_project (eosio::name coopname, uint64_t project_id, const std::string &title, const std::string &description, const std::string &invite, const std::string &meta, const std::string &data)
	Редактирует существующий проект Подробнее...
void	add_property_base (eosio::name coopname, uint64_t project_id, const eosio::asset &property_amount)
	Добавляет имущественный взнос к проекту. Подробнее...
void	add_commit (eosio::name coopname, uint64_t project_id, const generation_amounts &delta)
	Добавляет коммит к проекту, обновляя фактические показатели и счетчик коммитов. Подробнее...
void	set_master (eosio::name coopname, uint64_t project_id, eosio::name master)
	Назначает мастера проекта Подробнее...
void	update_status (eosio::name coopname, uint64_t project_id, eosio::name new_status)
	Обновляет статус проекта. Подробнее...
void	set_plan (eosio::name coopname, uint64_t project_id, const plan_pool &calculated_plan)
	Устанавливает плановые показатели проекта. Подробнее...
void	add_investments (eosio::name coopname, uint64_t project_id, const eosio::asset &amount)
	Добавляет инвестицию к проекту. Подробнее...
void	expand_expense_pool (eosio::name coopname, uint64_t project_id, const eosio::asset &additional_amount)
	Увеличивает целевой размер пула расходов проекта. Подробнее...
void	open_project (eosio::name coopname, uint64_t project_id)
	Открывает проект для инвестиций, копируя плановые показатели расходов в фактические. Подробнее...
void	close_project (eosio::name coopname, uint64_t project_id)
	Закрывает проект от инвестиций, устанавливая флаг is_opened = false. Подробнее...
void	reserve_expense_funds (eosio::name coopname, uint64_t project_id, const eosio::asset &amount)
	Резервирует средства для расхода, уменьшая accumulated_expense_pool. Подробнее...
void	return_expense_funds (eosio::name coopname, uint64_t project_id, const eosio::asset &amount)
	Возвращает зарезервированные средства в accumulated_expense_pool. Подробнее...
void	complete_expense (eosio::name coopname, uint64_t project_id, const eosio::asset &amount)
	Завершает расход, добавляя сумму в used_expense_pool. Подробнее...
void	increment_total_propertors (eosio::name coopname, uint64_t project_id)
	Увеличивает количество проперторов в проекте на 1. Подробнее...
void	increment_total_investors (eosio::name coopname, uint64_t project_id)
	Увеличивает количество инвесторов в проекте на 1. Подробнее...
void	increment_total_contributors (eosio::name coopname, uint64_t project_id)
	Увеличивает количество зарегистрированных участников в проекте на 1. Подробнее...
void	increment_total_contributor_shares (eosio::name coopname, uint64_t project_id, eosio::asset shares)
	Увеличивает количество вкладчических долей в проекте на указанное количество Подробнее...
void	increment_total_authors (eosio::name coopname, uint64_t project_id)
	Увеличивает количество авторов в проекте на 1. Подробнее...
void	increment_total_coordinators (eosio::name coopname, uint64_t project_id)
	Увеличивает количество координаторов в проекте на 1. Подробнее...
void	increment_total_creators (eosio::name coopname, uint64_t project_id)
	Увеличивает количество создателей в проекте на 1. Подробнее...
void	increment_total_unique_participants (eosio::name coopname, uint64_t project_id)
	Увеличивает количество уникальных участников в проекте на 1. Подробнее...
void	increment_votes_received (eosio::name coopname, uint64_t project_id)
	Увеличивает счетчик полученных голосов в проекте Подробнее...
void	increase_total_returned_investments (eosio::name coopname, const uint64_t &project_id, const eosio::asset &amount)
void	add_used_for_compensation (eosio::name coopname, uint64_t project_id, const eosio::asset &amount)
	Увеличивает сумму использованных для компенсации инвестиций Подробнее...
void	subtract_used_for_compensation (eosio::name coopname, uint64_t project_id, const eosio::asset &amount)
	Уменьшает сумму использованных для компенсации инвестиций Подробнее...
void	increment_converted_segments (eosio::name coopname, uint64_t project_id)
	Инкрементирует счётчик сконвертированных сегментов Подробнее...
bool	are_all_segments_converted (eosio::name coopname, uint64_t project_id)
	Проверяет завершили ли все участники конвертацию сегментов Подробнее...
eosio::asset	calculate_unused_investments (const project &prj)
	Считает неиспользованные проектом инвестиции Подробнее...
eosio::asset	debt_ext_or_zero (const eosio::binary_extension< eosio::asset > &v)
	Значение binary_extension<asset> total_debt_amount или ноль в RUB. Подробнее...
void	delete_project (eosio::name coopname, uint64_t project_id)
	Удаляет проект Подробнее...
void	authorize_project (eosio::name coopname, uint64_t project_id, const document2 &decision)
	Устанавливает авторизацию проекта советом Подробнее...
void	revoke_authorization (eosio::name coopname, uint64_t project_id)
	Сбрасывает авторизацию проекта Устанавливает флаг авторизации в false и очищает документ авторизации Подробнее...
void	increment_total_voters (eosio::name coopname, uint64_t project_id)
	Увеличивает счетчик общего количества участников голосования в проекте Подробнее...

Подробное описание

Агрегат ссуд проекта и границы деаллокации.

Функции живут отдельно от domain/entities/projects.hpp намеренно: они ходят в таблицу segments, а segments.hpp сам ссылается на Capital::project и поэтому обязан включаться ПОСЛЕ него. Положить обход сегментов прямо в projects.hpp нельзя — получается цикл заголовков. Здесь, на уровне core, обе сущности уже объявлены.

Функции

add_commit()

void Capital::Projects::add_commit ( eosio::name  coopname, uint64_t  project_id, const generation_amounts &  delta  )

inline

Добавляет коммит к проекту, обновляя фактические показатели и счетчик коммитов.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.
delta	Фактические показатели взноса в проект.

add_investments()

void Capital::Projects::add_investments ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  amount  )

inline

Добавляет инвестицию к проекту.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.
amount	Сумма инвестиции для добавления.

add_property_base()

void Capital::Projects::add_property_base ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  property_amount  )

inline

Добавляет имущественный взнос к проекту.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.
property_amount	Стоимость имущественного взноса.

add_used_for_compensation()

void Capital::Projects::add_used_for_compensation ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  amount  )

inline

Увеличивает сумму использованных для компенсации инвестиций

Аргументы

coopname	Имя кооператива
project_id	ID проекта
amount	Сумма использованных инвестиций

are_all_segments_converted()

bool Capital::Projects::are_all_segments_converted ( eosio::name  coopname, uint64_t  project_id  )

inline

Проверяет завершили ли все участники конвертацию сегментов

Аргументы

coopname	Имя кооператива
project_id	ID проекта

Возвращает

true если все участники сконвертировали сегменты

authorize_project()

void Capital::Projects::authorize_project ( eosio::name  coopname, uint64_t  project_id, const document2 &  decision  )

inline

Устанавливает авторизацию проекта советом

calculate_max_deallocatable()

eosio::asset Capital::Projects::calculate_max_deallocatable ( eosio::name  coopname, const project &  prj  )

inline

Максимальная сумма, которую можно вернуть из проекта в глобальный пул программы.

Ограничений три, берём минимум:

1. Возвращаем только программные средства — не больше program_invest_pool. Прямые инвестиции пайщиков лично им не возвращаются (они уже в «Благоросте»).
2. Нельзя вернуть уже потраченное: total_received минус выплаты участникам (total_used_for_compensation, туда попадают и выданные ссуды) минус оплаченные расходы (used_expense_pool).
3. Нельзя опустить invest_pool ниже границы из calculate_min_invest_pool_for_debts, иначе у заёмщика перестанет обновляться сегмент.

Аргументы

coopname	Имя кооператива
prj	Проект

Возвращает

Предельная сумма деаллокации (никогда не отрицательная)

calculate_min_invest_pool_for_debts()

eosio::asset Capital::Projects::calculate_min_invest_pool_for_debts ( eosio::name  coopname, const project &  prj  )

inline

Минимальный invest_pool, при котором ни у кого provisional_amount не упадёт ниже долга.

provisional_amount пересчитывается в refresh_provisional_amount как base_i * return_base_percent / 100, а сам процент — это invest_pool / work_costs * 100 (с потолком 100). Значит выплата участнику линейна по invest_pool: provisional_i = base_i * invest_pool / work_costs.

Инвариант update_segment_total_cost требует provisional_i >= debt_i. Подставляя, получаем invest_pool >= work_costs * max_i(debt_i / base_i). Берём максимум по всем сегментам с ненулевым долгом и округляем вверх, чтобы усечение double->int64 в refresh_provisional_amount не увело нас на квант ниже границы.

Участник с долгом, но без трудовой базы, заблокировал бы деаллокацию полностью (его provisional равен нулю при любом invest_pool) — такого состояния createdebt не создаёт, но проверяем явно.

Аргументы

coopname	Имя кооператива
prj	Проект

Возвращает

Нижняя граница invest_pool (ноль, если ссуд в проекте нет)

calculate_unused_investments()

eosio::asset Capital::Projects::calculate_unused_investments ( const project &  prj )

inline

Считает неиспользованные проектом инвестиции

Неиспользованный остаток = все полученные инвестиции минус то, что проект фактически израсходовал: выплаты участникам при конвертации сегментов (total_used_for_compensation) и оплаченные расходы (used_expense_pool). В сумму входят и прямые инвестиции пайщиков, и аллоцированные программные средства — возврат идёт единым остатком в глобальный пул программы, потому что деньги инвесторов уже находятся в «Благоросте» и лично им не возвращаются.

Единая точка расчёта для сценариев полного возврата остатка: финализация (finalizeproj), удаление (delproject) и отклонение советом (declprj). Остановка проекта (stopproject) средств не возвращает — она только переводит проект в pending и снимает авторизацию.

Частичный возврат по решению кооператива идёт другим путём — action diallocate, см. calculate_max_deallocatable.

Аргументы

prj

Проект

Возвращает

Неиспользованный остаток (никогда не отрицательный)

close_project()

void Capital::Projects::close_project ( eosio::name  coopname, uint64_t  project_id  )

inline

Закрывает проект от инвестиций, устанавливая флаг is_opened = false.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.

complete_expense()

void Capital::Projects::complete_expense ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  amount  )

inline

Завершает расход, добавляя сумму в used_expense_pool.

Аргументы

coopname	Имя кооператива.
project_id	ID проекта.
amount	Сумма расхода.

create_project()

void Capital::Projects::create_project ( eosio::name  coopname, const checksum256 &  project_hash, const checksum256 &  parent_hash, const std::string &  title, const std::string &  description, const std::string &  invite, const std::string &  meta, const std::string &  data  )

inline

Создает проект

Аргументы

coopname	Имя кооператива
project_hash	Хэш проекта
parent_hash	Хэш родительского проекта (если есть)
title	Название проекта
description	Описание проекта
invite	Приглашение к проекту
meta	Метаданные проекта
data	Шаблон/данные проекта

debt_ext_or_zero()

eosio::asset Capital::Projects::debt_ext_or_zero ( const eosio::binary_extension< eosio::asset > &  v )

inline

Значение binary_extension<asset> total_debt_amount или ноль в RUB.

Проекты, записанные до появления поля, отдают absent. Материализованный asset с пустым символом — след default-constructed asset() при записи пустого extension; при нулевой сумме нормализуем, при ненулевой падаем, потому что это уже потеря данных, а не отсутствие поля.

delete_project()

void Capital::Projects::delete_project ( eosio::name  coopname, uint64_t  project_id  )

inline

Удаляет проект

Аргументы

coopname	Имя кооператива
project_id	ID проекта

edit_project()

void Capital::Projects::edit_project ( eosio::name  coopname, uint64_t  project_id, const std::string &  title, const std::string &  description, const std::string &  invite, const std::string &  meta, const std::string &  data  )

inline

Редактирует существующий проект

Аргументы

coopname	Имя кооператива
project_id	ID проекта для редактирования
title	Новое название проекта
description	Новое описание проекта
invite	Новое приглашение к проекту
meta	Новые метаданные проекта
data	Новые данные/шаблон проекта

expand_expense_pool()

void Capital::Projects::expand_expense_pool ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  additional_amount  )

inline

Увеличивает целевой размер пула расходов проекта.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.
additional_amount	Дополнительная сумма для увеличения цели расходов.

get_project()

std::optional< project > Capital::Projects::get_project ( eosio::name  coopname, const checksum256 &  project_hash  )

inline

Получает проект по хэшу

Аргументы

coopname	Имя кооператива
project_hash	Хэш проекта

Возвращает

Опциональный проект

get_project_by_id_or_fail()

project Capital::Projects::get_project_by_id_or_fail ( eosio::name  coopname, const uint64_t  project_id  )

inline

Получает проект по id.

Аргументы

coopname	Имя кооператива
project_id	ID проекта

Возвращает

Проект

get_project_or_fail()

project Capital::Projects::get_project_or_fail ( eosio::name  coopname, const checksum256 &  project_hash  )

inline

Получает проект по хэшу, если проект не найден, выбрасывает исключение

Аргументы

coopname	Имя кооператива
project_hash	Хэш проекта

Возвращает

project

has_component_projects()

bool Capital::Projects::has_component_projects ( eosio::name  coopname, const checksum256 &  project_hash  )

inline

Есть ли у проекта дочерние проекты-компоненты (их parent_hash совпадает с хэшем родителя)

Аргументы

coopname	Имя кооператива
project_hash	Хэш родительского проекта

increase_total_returned_investments()

void Capital::Projects::increase_total_returned_investments ( eosio::name  coopname, const uint64_t &  project_id, const eosio::asset &  amount  )

inline

increment_converted_segments()

void Capital::Projects::increment_converted_segments ( eosio::name  coopname, uint64_t  project_id  )

inline

Инкрементирует счётчик сконвертированных сегментов

Аргументы

coopname	Имя кооператива
project_id	ID проекта

increment_total_authors()

void Capital::Projects::increment_total_authors ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество авторов в проекте на 1.

increment_total_contributor_shares()

void Capital::Projects::increment_total_contributor_shares ( eosio::name  coopname, uint64_t  project_id, eosio::asset  shares  )

inline

Увеличивает количество вкладчических долей в проекте на указанное количество

increment_total_contributors()

void Capital::Projects::increment_total_contributors ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество зарегистрированных участников в проекте на 1.

increment_total_coordinators()

void Capital::Projects::increment_total_coordinators ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество координаторов в проекте на 1.

increment_total_creators()

void Capital::Projects::increment_total_creators ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество создателей в проекте на 1.

increment_total_investors()

void Capital::Projects::increment_total_investors ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество инвесторов в проекте на 1.

increment_total_propertors()

void Capital::Projects::increment_total_propertors ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество проперторов в проекте на 1.

increment_total_unique_participants()

void Capital::Projects::increment_total_unique_participants ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает количество уникальных участников в проекте на 1.

increment_total_voters()

void Capital::Projects::increment_total_voters ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает счетчик общего количества участников голосования в проекте

increment_votes_received()

void Capital::Projects::increment_votes_received ( eosio::name  coopname, uint64_t  project_id  )

inline

Увеличивает счетчик полученных голосов в проекте

open_project()

void Capital::Projects::open_project ( eosio::name  coopname, uint64_t  project_id  )

inline

Открывает проект для инвестиций, копируя плановые показатели расходов в фактические.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.

reserve_expense_funds()

void Capital::Projects::reserve_expense_funds ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  amount  )

inline

Резервирует средства для расхода, уменьшая accumulated_expense_pool.

Аргументы

coopname	Имя кооператива.
project_id	ID проекта.
amount	Сумма для резервирования.

return_expense_funds()

void Capital::Projects::return_expense_funds ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  amount  )

inline

Возвращает зарезервированные средства в accumulated_expense_pool.

Аргументы

coopname	Имя кооператива.
project_id	ID проекта.
amount	Сумма для возврата.

revoke_authorization()

void Capital::Projects::revoke_authorization ( eosio::name  coopname, uint64_t  project_id  )

inline

Сбрасывает авторизацию проекта Устанавливает флаг авторизации в false и очищает документ авторизации

Аргументы

coopname	Наименование кооператива
project_id	ID проекта

set_master()

void Capital::Projects::set_master ( eosio::name  coopname, uint64_t  project_id, eosio::name  master  )

inline

Назначает мастера проекта

Аргументы

coopname	Имя кооператива
project_id	ID проекта
master	Имя мастера

set_plan()

void Capital::Projects::set_plan ( eosio::name  coopname, uint64_t  project_id, const plan_pool &  calculated_plan  )

inline

Устанавливает плановые показатели проекта.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_id	ID проекта.
calculated_plan	Рассчитанные плановые показатели.

subtract_used_for_compensation()

void Capital::Projects::subtract_used_for_compensation ( eosio::name  coopname, uint64_t  project_id, const eosio::asset &  amount  )

inline

Уменьшает сумму использованных для компенсации инвестиций

Аргументы

coopname	Имя кооператива
project_id	ID проекта
amount	Сумма использованных инвестиций

sync_total_debt()

eosio::asset Capital::Projects::sync_total_debt ( eosio::name  coopname, uint64_t  project_id  )

inline

Пересчитывает total_debt_amount проекта обходом его сегментов.

Поле — производная от segments, поэтому единственный честный способ его получить — сложить debt_amount по индексу byproject. Обход стоит O(n) по числу участников проекта (десятки), поэтому вызывается только в редких точках: migrate, выдача/отклонение ссуды, конвертация сегмента, deallocate.

Аргументы

coopname	Имя кооператива
project_id	ID проекта

Возвращает

Пересчитанная сумма непогашенных ссуд

update_status()

void Capital::Projects::update_status ( eosio::name  coopname, uint64_t  project_id, eosio::name  new_status  )

inline

Обновляет статус проекта.

Аргументы

coopname	Имя кооператива (scope таблицы).
project_hash	Хэш проекта.
new_status	Новый статус проекта.

validate_parent_hash()

void Capital::Projects::validate_parent_hash ( eosio::name  coopname, const checksum256 &  parent_hash  )

inline

Проверяет валидность parent_hash согласно правилам проектов

Аргументы

coopname	Имя кооператива
parent_hash	Хэш родительского проекта для проверки