dash/src/qt/proposalmodel.cpp at develop · dashpay/dash · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
// Copyright (c) 2021-2026 The Dash Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <qt/proposalmodel.h>

#include <governance/object.h>
#include <governance/superblock.h>
#include <governance/vote.h>

#include <qt/clientmodel.h>
#include <qt/guiutil.h>

#include <chainparams.h>
#include <interfaces/node.h>

#include <univalue.h>

#include <algorithm>
#include <cmath>

Proposal::Proposal(ClientModel& client_model, const CGovernanceObject& govObj,
                   const interfaces::GOV::GovernanceInfo& govInfo, int collateral_confs,
                   bool is_broadcast) :
    m_is_broadcast{is_broadcast},
    m_block_height{client_model.getNumBlocks()},
    m_collateral_confs{collateral_confs},
    m_gov_info{govInfo},
    m_date_collateral{QDateTime::fromSecsSinceEpoch(govObj.GetCreationTime())},
    m_hash_collateral{QString::fromStdString(govObj.GetCollateralHash().ToString())},
    m_hash_object{QString::fromStdString(govObj.GetHash().ToString())},
    m_hash_parent{QString::fromStdString(govObj.Object().hashParent.ToString())},
    m_json{QString::fromStdString(govObj.GetInnerJson().write(2))},
    m_objHash{govObj.GetHash()}
{
    UniValue prop_data;
    if (!prop_data.read(govObj.GetDataAsPlainString())) {
        return;
    }

    m_funded_height = client_model.node().gov().getProposalFundedHeight(govObj.GetHash());
    m_votes = client_model.node().gov().getObjVotes(govObj, VOTE_SIGNAL_FUNDING);

    if (const UniValue& titleValue = prop_data.find_value("name"); titleValue.isStr()) {
        m_title = QString::fromStdString(titleValue.get_str());
    }

    if (const UniValue& paymentStartValue = prop_data.find_value("start_epoch"); paymentStartValue.isNum()) {
        m_startDate = QDateTime::fromSecsSinceEpoch(paymentStartValue.getInt<int64_t>());
    }

    if (const UniValue& paymentEndValue = prop_data.find_value("end_epoch"); paymentEndValue.isNum()) {
        m_endDate = QDateTime::fromSecsSinceEpoch(paymentEndValue.getInt<int64_t>());
    }

    if (const UniValue& addressValue = prop_data.find_value("payment_address"); addressValue.isStr()) {
        m_address = QString::fromStdString(addressValue.get_str());
    }

    if (const UniValue& amountValue = prop_data.find_value("payment_amount"); amountValue.isNum()) {
        m_paymentAmount = llround(amountValue.get_real() * COIN);
    }

    if (const UniValue& urlValue = prop_data.find_value("url"); urlValue.isStr()) {
        m_url = QString::fromStdString(urlValue.get_str());
    }
}

int Proposal::paymentsRequested() const
{
    if (!m_startDate.isValid() || !m_endDate.isValid()) {
        return 1;
    }
    const auto& consensus_params = Params().GetConsensus();
    const int64_t superblock_cycle = consensus_params.nPowTargetSpacing * consensus_params.nSuperblockCycle;
    const int64_t proposal_duration = m_endDate.toSecsSinceEpoch() - m_startDate.toSecsSinceEpoch();
    return std::max<int>(1, ((proposal_duration + superblock_cycle - 1) / superblock_cycle));
}

QString Proposal::toHtml(const BitcoinUnit& unit) const
{
    QString ret;
    ret.reserve(4000);
    ret += "<html>";
    ret += "<b>" + QObject::tr("Title") + ":</b> " + GUIUtil::HtmlEscape(m_title) + "<br>";
    if (!m_url.isEmpty()) {
        ret += "<b>" + QObject::tr("URL") + ":</b> " + GUIUtil::HtmlEscape(m_url) + "<br>";
    }
    ret += "<b>" + QObject::tr("Destination Address") + ":</b> " + GUIUtil::HtmlEscape(m_address) + "<br>";
    ret += "<b>" + QObject::tr("Payment Amount") + ":</b> " + BitcoinUnits::formatHtmlWithUnit(unit, m_paymentAmount) + "<br>";
    ret += "<b>" + QObject::tr("Payments Requested") + ":</b> " + QString::number(paymentsRequested()) + "<br>";
    ret += "<b>" + QObject::tr("Payment Start") + ":</b> " + GUIUtil::dateTimeStr(m_startDate) + "<br>";
    ret += "<b>" + QObject::tr("Payment End") + ":</b> " + GUIUtil::dateTimeStr(m_endDate) + "<br>";
    ret += "<b>" + QObject::tr("Object Hash") + ":</b> " + m_hash_object + "<br>";
    ret += "<b>" + QObject::tr("Parent Hash") + ":</b> " + m_hash_parent + "<br>";
    ret += "<b>" + QObject::tr("Collateral Date") + ":</b> " + GUIUtil::dateTimeStr(m_date_collateral) + "<br>";
    ret += "<b>" + QObject::tr("Collateral Hash") + ":</b> " + m_hash_collateral + "<br>";
    ret += "<br>";
    ret += "</html>";
    return ret;
}

int Proposal::blocksUntilSuperblock() const
{
    return m_gov_info.nextsuperblock - m_block_height;
}

int Proposal::collateralConfs() const
{
    return m_collateral_confs;
}

int Proposal::requiredConfs() const
{
    return m_gov_info.requiredConfs;
}

ProposalStatus Proposal::status(bool is_fundable) const
{
    if (getFundedHeight().has_value()) {
        return ProposalStatus::Funded;
    }
    if (QDateTime::currentDateTime() >= endDate()) {
        return ProposalStatus::Lapsed;
    }
    if (m_collateral_confs < m_gov_info.requiredConfs) {
        return ProposalStatus::Confirming;
    }
    if (!m_is_broadcast) {
        return ProposalStatus::Pending;
    }
    if (m_gov_info.superblockcycle <= 0) {
        return ProposalStatus::Voting;
    }
    if (m_block_height % m_gov_info.superblockcycle >= m_gov_info.superblockcycle - m_gov_info.superblockmaturitywindow) {
        return is_fundable ? ProposalStatus::Passing : ProposalStatus::Failing;
    }
    if (getAbsoluteYesCount() < m_gov_info.fundingthreshold) {
        return ProposalStatus::Voting;
    }
    return is_fundable ? ProposalStatus::Passing : ProposalStatus::Unfunded;
}

///
/// Proposal Model
///

ProposalModel::ProposalModel(QObject* parent) :
    QAbstractTableModel(parent)
{
    refreshIcons();
}

void ProposalModel::refreshIcons()
{
    m_icon_confirming = {
        GUIUtil::getIcon("transaction_0", GUIUtil::ThemedColor::ORANGE),
        GUIUtil::getIcon("transaction_1", GUIUtil::ThemedColor::ORANGE),
        GUIUtil::getIcon("transaction_2", GUIUtil::ThemedColor::ORANGE),
        GUIUtil::getIcon("transaction_3", GUIUtil::ThemedColor::ORANGE),
        GUIUtil::getIcon("transaction_4", GUIUtil::ThemedColor::ORANGE),
        GUIUtil::getIcon("transaction_5", GUIUtil::ThemedColor::ORANGE)
    };
    m_icon_failing = GUIUtil::getIcon("voting", GUIUtil::ThemedColor::RED);
    m_icon_lapsed = GUIUtil::getIcon("transaction_6", GUIUtil::ThemedColor::RED);
    m_icon_passing = GUIUtil::getIcon("synced", GUIUtil::ThemedColor::GREEN);
    m_icon_pending = GUIUtil::getIcon("voting", GUIUtil::ThemedColor::BLUE);
    m_icon_unfunded = GUIUtil::getIcon("voting", GUIUtil::ThemedColor::RED);
    m_icon_voting = GUIUtil::getIcon("voting", GUIUtil::ThemedColor::ORANGE);
}

int ProposalModel::rowCount(const QModelIndex& index) const
{
    return static_cast<int>(m_data.size());
}

int ProposalModel::columnCount(const QModelIndex& index) const
{
    return Column::_COUNT;
}

QVariant ProposalModel::data(const QModelIndex& index, int role) const
{
    if (!index.isValid() || !isValidRow(index.row())) {
        return {};
    }
    if (index.column() == Column::HASH) {
        if (role == Qt::FontRole) {
            return GUIUtil::fixedPitchFont();
        }
        if (role == Qt::ForegroundRole) {
            return QVariant::fromValue(GUIUtil::getThemedQColor(GUIUtil::ThemedColor::UNCONFIRMED));
        }
    }
    if (role != Qt::DisplayRole && role != Qt::DecorationRole && role != Qt::EditRole && role != Qt::ToolTipRole) {
        return {};
    }

    const auto* proposal = m_data[index.row()].get();
    const bool isFundable = m_fundable_hashes.count(proposal->objHash()) > 0;
    switch(role) {
    case Qt::DisplayRole:
    {
        switch (index.column()) {
        case Column::STATUS:
            return {};
        case Column::HASH:
            return proposal->hash();
        case Column::TITLE:
            return proposal->title();
        case Column::START_DATE:
            return proposal->startDate().date();
        case Column::END_DATE:
            return proposal->endDate().date();
        case Column::PAYMENT_AMOUNT: {
            return BitcoinUnits::floorWithUnit(m_display_unit, proposal->paymentAmount(), false,
                                               BitcoinUnits::SeparatorStyle::ALWAYS);
        }
        case Column::VOTING_STATUS: {
            const int margin = proposal->getAbsoluteYesCount() - nAbsVoteReq;
            return QString("%1Y, %2N, %3A (%4%5)").arg(proposal->getYesCount()).arg(proposal->getNoCount())
                                                  .arg(proposal->getAbstainCount()).arg(margin > 0 ? "+" : "")
                                                  .arg(margin);

        }
        default:
            return {};
        };
        break;
    }
    case Qt::EditRole:
    {
        // Edit role is used for sorting, so return the raw values where possible
        switch (index.column()) {
        case Column::STATUS: {
            // Two-level sort: status group (passing before failing), then
            // vote margin within each group (winning by most sorts first).
            // Clamp to 16 bits so the value stays within its group window
            // and doesn't bleed into an adjacent group's key range.
            const int deficit{std::clamp(nAbsVoteReq - proposal->getAbsoluteYesCount(), -32768, 32767)};
            switch (proposal->status(isFundable)) {
            case ProposalStatus::Funded:      return (0 << 16) + deficit;
            case ProposalStatus::Passing:     return (1 << 16) + deficit;
            case ProposalStatus::Unfunded:    return (2 << 16) + deficit;
            case ProposalStatus::Voting:      return (3 << 16) + deficit;
            case ProposalStatus::Confirming:  return (4 << 16) + deficit;
            case ProposalStatus::Pending:     return (5 << 16) + deficit;
            case ProposalStatus::Failing:     return (6 << 16) + deficit;
            case ProposalStatus::Lapsed:      return (7 << 16) + deficit;
            } // no default case, so the compiler can warn about missing cases
            return 0;
        }
        case Column::HASH:
            return proposal->hash();
        case Column::TITLE:
            return proposal->title();
        case Column::START_DATE:
            return proposal->startDate();
        case Column::END_DATE:
            return proposal->endDate();
        case Column::PAYMENT_AMOUNT:
            return qlonglong(proposal->paymentAmount());
        case Column::VOTING_STATUS:
            return proposal->getAbsoluteYesCount();
        default:
            return {};
        };
        break;
    }
    case Qt::ToolTipRole:
    {
        if (index.column() == Column::STATUS) {
            switch (proposal->status(isFundable)) {
            case ProposalStatus::Confirming: {
                return tr("Pending, %1 of %2 confirmations").arg(proposal->collateralConfs()).arg(proposal->requiredConfs());
            }
            case ProposalStatus::Voting: {
                const int margin = nAbsVoteReq - proposal->getAbsoluteYesCount();
                return tr("Voting, needs %1 more votes for funding").arg(std::max(0, margin));
            }
            case ProposalStatus::Passing: {
                return tr("Passing with %1 votes").arg(proposal->getAbsoluteYesCount());
            }
            case ProposalStatus::Unfunded: {
                return tr("Passing with %1 votes but budget saturated, may not be funded").arg(proposal->getAbsoluteYesCount());
            }
            case ProposalStatus::Failing: {
                const int margin = nAbsVoteReq - proposal->getAbsoluteYesCount();
                return tr("Failed, needed %1 more votes").arg(std::max(0, margin));
            }
            case ProposalStatus::Funded: {
                const auto height{proposal->getFundedHeight()};
                return height.has_value() ? tr("Funded at block %1").arg(height.value()) : tr("Funded");
            }
            case ProposalStatus::Lapsed: {
                return tr("Lapsed, past proposal end date");
            }
            case ProposalStatus::Pending: {
                return tr("Ready to broadcast, check \"Resume Proposal\" dialog");
            }
            } // no default case, so the compiler can warn about missing cases
        }
        if (index.column() == Column::VOTING_STATUS) {
            const int margin = proposal->getAbsoluteYesCount() - nAbsVoteReq;
            return tr("%1 Yes, %2 No, %3 Abstain, %4").arg(proposal->getYesCount()).arg(proposal->getNoCount())
                                                      .arg(proposal->getAbstainCount())
                                                      .arg((margin >= 0 ? tr("passing with %1 votes") : tr("needs %1 more votes")).arg(std::abs(margin)));
        }
        return {};
    }
    case Qt::DecorationRole:
    {
        if (index.column() == Column::STATUS) {
            switch (proposal->status(isFundable)) {
            case ProposalStatus::Confirming:
                return m_icon_confirming[std::clamp<int>(proposal->collateralConfs(), 0, 5)];
            case ProposalStatus::Voting:
                return m_icon_voting;
            case ProposalStatus::Unfunded:
                return m_icon_unfunded;
            case ProposalStatus::Failing:
                return m_icon_failing;
            case ProposalStatus::Passing:
            case ProposalStatus::Funded:
                return m_icon_passing;
            case ProposalStatus::Pending:
                return m_icon_pending;
            case ProposalStatus::Lapsed:
                return m_icon_lapsed;
            } // no default case, so the compiler can warn about missing cases
        }
        return {};
    }
    }
    return {};
}

QVariant ProposalModel::headerData(int section, Qt::Orientation orientation, int role) const
{
    if (orientation != Qt::Horizontal || role != Qt::DisplayRole) {
        return {};
    }

    switch (section) {
    case Column::STATUS:
        return {};
    case Column::HASH:
        return tr("Hash");
    case Column::TITLE:
        return tr("Title");
    case Column::START_DATE:
        return tr("Start");
    case Column::END_DATE:
        return tr("End");
    case Column::PAYMENT_AMOUNT:
        return tr("Amount");
    case Column::VOTING_STATUS:
        return tr("Votes");
    default:
        return {};
    }
}

void ProposalModel::append(std::shared_ptr<Proposal>&& proposal)
{
    beginInsertRows({}, rowCount(), rowCount());
    m_data.push_back(std::move(proposal));
    endInsertRows();
}

void ProposalModel::remove(int row)
{
    if (!isValidRow(row)) {
        return;
    }
    beginRemoveRows({}, row, row);
    m_data.erase(m_data.begin() + row);
    endRemoveRows();
}

void ProposalModel::reconcile(Proposals&& proposals, Uint256HashSet&& fundable_hashes)
{
    m_fundable_hashes = std::move(fundable_hashes);

    // Track which existing proposals to keep. After processing new proposals,
    // remove any existing proposals that weren't found in the new set.
    const int original_sz{rowCount()};
    std::vector<bool> keep_index(original_sz, false);

    for (auto& proposal : proposals) {
        auto it{std::ranges::find_if(m_data, [&proposal](const auto& existing) {
            return existing->hash() == proposal->hash();
        })};

        if (it != m_data.end()) {
            const auto idx{static_cast<int>(std::distance(m_data.begin(), it))};
            keep_index[static_cast<size_t>(idx)] = true;
            // Always replace: block height, vote breakdown, and broadcast status
            // can all change between cycles without a single cheap sentinel.
            *it = std::move(proposal);
            Q_EMIT dataChanged(createIndex(idx, Column::STATUS), createIndex(idx, Column::VOTING_STATUS));
        } else {
            append(std::move(proposal));
        }
    }

    // Remove in reverse order to preserve indices during removal
    for (int idx{original_sz}; idx-- > 0;) {
        if (!keep_index[static_cast<size_t>(idx)]) {
            remove(idx);
        }
    }

}

void ProposalModel::setDisplayUnit(const BitcoinUnit& display_unit)
{
    m_display_unit = display_unit;
    if (!m_data.empty()) {
        Q_EMIT dataChanged(createIndex(0, Column::PAYMENT_AMOUNT), createIndex(rowCount() - 1, Column::PAYMENT_AMOUNT));
    }
}

void ProposalModel::setVotingParams(int newAbsVoteReq)
{
    if (this->nAbsVoteReq == newAbsVoteReq) {
        return;
    }

    // Changing either of the voting params may change the voting status
    // column. Emit signal to force recalculation.
    this->nAbsVoteReq = newAbsVoteReq;
    if (!m_data.empty()) {
        // STATUS also embeds nAbsVoteReq in its sort key, so both columns need invalidating
        Q_EMIT dataChanged(createIndex(0, Column::STATUS), createIndex(rowCount() - 1, Column::VOTING_STATUS));
    }
}

const Proposal* ProposalModel::getProposalAt(const QModelIndex& index) const
{
    if (!index.isValid() || !isValidRow(index.row())) {
        return nullptr;
    }
    return m_data[index.row()].get();
}