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

Optimize vote reward data #2841

Merged
merged 7 commits into from
Mar 15, 2023
Merged

Optimize vote reward data #2841

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f74638f
optimize vote reward
Jan 10, 2023
9b1c33e
rm end when calculate bonus
Jan 12, 2023
298b87e
fix ut
Jan 12, 2023
e475f6c
Merge branch 'master' into fix-vote-reward
Feb 3, 2023
21fc509
revert UnclaimGas interface, check end instead, fix ut
Feb 6, 2023
1ba5e05
Merge branch 'master' into fix-vote-reward
Feb 13, 2023
538c272
Merge branch 'master' into fix-vote-reward
Mar 14, 2023
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
72 changes: 40 additions & 32 deletions src/Neo/SmartContract/Native/NeoToken.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@

#pragma warning disable IDE0051

using System;
using System.Buffers.Binary;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using Neo.Cryptography.ECC;
using Neo.IO;
using Neo.Persistence;
using Neo.SmartContract.Iterators;
using Neo.SmartContract.Manifest;
using Neo.VM;
using Neo.VM.Types;
using System;
using System.Buffers.Binary;
using System.Collections.Generic;
using System.Linq;
using System.Numerics;

namespace Neo.SmartContract.Native
{
Expand Down Expand Up @@ -149,9 +149,14 @@ private GasDistribution DistributeGas(ApplicationEngine engine, UInt160 account,
// PersistingBlock is null when running under the debugger
if (engine.PersistingBlock is null) return null;

BigInteger gas = CalculateBonus(engine.Snapshot, state.VoteTo, state.Balance, state.BalanceHeight, engine.PersistingBlock.Index);
BigInteger gas = CalculateBonus(engine.Snapshot, state, engine.PersistingBlock.Index);
state.BalanceHeight = engine.PersistingBlock.Index;

if (state.VoteTo is not null)
{
var keyLastest = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(state.VoteTo);
var latestGasPerVote = engine.Snapshot.TryGet(keyLastest) ?? BigInteger.Zero;
state.LastGasPerVote = latestGasPerVote;
}
if (gas == 0) return null;
return new GasDistribution
{
Expand All @@ -160,24 +165,19 @@ private GasDistribution DistributeGas(ApplicationEngine engine, UInt160 account,
};
}

private BigInteger CalculateBonus(DataCache snapshot, ECPoint vote, BigInteger value, uint start, uint end)
private BigInteger CalculateBonus(DataCache snapshot, NeoAccountState state, uint end)
ZhangTao1596 marked this conversation as resolved.
Show resolved Hide resolved
{
if (value.IsZero || start >= end) return BigInteger.Zero;
if (value.Sign < 0) throw new ArgumentOutOfRangeException(nameof(value));

BigInteger neoHolderReward = CalculateNeoHolderReward(snapshot, value, start, end);
if (vote is null) return neoHolderReward;
if (state.Balance.IsZero || state.BalanceHeight >= end) return BigInteger.Zero;
if (state.Balance.Sign < 0) throw new ArgumentOutOfRangeException(nameof(state.Balance));

byte[] border = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(vote).ToArray();
byte[] keyStart = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(vote).AddBigEndian(start).ToArray();
(_, var item) = snapshot.FindRange(keyStart, border, SeekDirection.Backward).FirstOrDefault();
BigInteger startRewardPerNeo = item ?? BigInteger.Zero;
BigInteger neoHolderReward = CalculateNeoHolderReward(snapshot, state.Balance, state.BalanceHeight, end);
if (state.VoteTo is null) return neoHolderReward;

byte[] keyEnd = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(vote).AddBigEndian(end).ToArray();
(_, item) = snapshot.FindRange(keyEnd, border, SeekDirection.Backward).FirstOrDefault();
BigInteger endRewardPerNeo = item ?? BigInteger.Zero;
var keyLastest = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(state.VoteTo);
var latestGasPerVote = snapshot.TryGet(keyLastest) ?? BigInteger.Zero;
var voteReward = state.Balance * (latestGasPerVote - state.LastGasPerVote) / 100000000L;

return neoHolderReward + value * (endRewardPerNeo - startRewardPerNeo) / 100000000L;
return neoHolderReward + voteReward;
}

private BigInteger CalculateNeoHolderReward(DataCache snapshot, BigInteger value, uint start, uint end)
Expand All @@ -203,8 +203,7 @@ private void CheckCandidate(DataCache snapshot, ECPoint pubkey, CandidateState c
{
if (!candidate.Registered && candidate.Votes.IsZero)
{
foreach (var (rewardKey, _) in snapshot.Find(CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(pubkey).ToArray()).ToArray())
snapshot.Delete(rewardKey);
snapshot.Delete(CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(pubkey));
snapshot.Delete(CreateStorageKey(Prefix_Candidate).Add(pubkey));
}
}
Expand Down Expand Up @@ -260,16 +259,14 @@ internal override async ContractTask PostPersist(ApplicationEngine engine)
BigInteger voterRewardOfEachCommittee = gasPerBlock * VoterRewardRatio * 100000000L * m / (m + n) / 100; // Zoom in 100000000 times, and the final calculation should be divided 100000000L
for (index = 0; index < committee.Count; index++)
{
var member = committee[index];
var (PublicKey, Votes) = committee[index];
var factor = index < n ? 2 : 1; // The `voter` rewards of validator will double than other committee's
if (member.Votes > 0)
if (Votes > 0)
{
BigInteger voterSumRewardPerNEO = factor * voterRewardOfEachCommittee / member.Votes;
StorageKey voterRewardKey = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(member.PublicKey).AddBigEndian(engine.PersistingBlock.Index + 1);
byte[] border = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(member.PublicKey).ToArray();
(_, var item) = engine.Snapshot.FindRange(voterRewardKey.ToArray(), border, SeekDirection.Backward).FirstOrDefault();
voterSumRewardPerNEO += (item ?? BigInteger.Zero);
engine.Snapshot.Add(voterRewardKey, new StorageItem(voterSumRewardPerNEO));
BigInteger voterSumRewardPerNEO = factor * voterRewardOfEachCommittee / Votes;
StorageKey voterRewardKey = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(PublicKey);
StorageItem lastRewardPerNeo = engine.Snapshot.GetAndChange(voterRewardKey, () => new StorageItem(BigInteger.Zero));
lastRewardPerNeo.Add(voterSumRewardPerNEO);
}
}
}
Expand Down Expand Up @@ -339,7 +336,7 @@ public BigInteger UnclaimedGas(DataCache snapshot, UInt160 account, uint end)
StorageItem storage = snapshot.TryGet(CreateStorageKey(Prefix_Account).Add(account));
if (storage is null) return BigInteger.Zero;
NeoAccountState state = storage.GetInteroperable<NeoAccountState>();
return CalculateBonus(snapshot, state.VoteTo, state.Balance, state.BalanceHeight, end);
return CalculateBonus(snapshot, state, end);
}

[ContractMethod(RequiredCallFlags = CallFlags.States)]
Expand Down Expand Up @@ -406,8 +403,15 @@ private async ContractTask<bool> Vote(ApplicationEngine engine, UInt160 account,
state_validator.Votes -= state_account.Balance;
CheckCandidate(engine.Snapshot, state_account.VoteTo, state_validator);
}
if (voteTo != null && voteTo != state_account.VoteTo)
{
StorageKey voterRewardKey = CreateStorageKey(Prefix_VoterRewardPerCommittee).Add(voteTo);
var latestGasPerVote = engine.Snapshot.TryGet(voterRewardKey) ?? BigInteger.Zero;
state_account.LastGasPerVote = latestGasPerVote;
}
ECPoint from = state_account.VoteTo;
state_account.VoteTo = voteTo;

if (validator_new != null)
{
validator_new.Votes += state_account.Balance;
Expand Down Expand Up @@ -572,19 +576,23 @@ public class NeoAccountState : AccountState
/// </summary>
public ECPoint VoteTo;

public BigInteger LastGasPerVote;

public override void FromStackItem(StackItem stackItem)
{
base.FromStackItem(stackItem);
Struct @struct = (Struct)stackItem;
BalanceHeight = (uint)@struct[1].GetInteger();
VoteTo = @struct[2].IsNull ? null : ECPoint.DecodePoint(@struct[2].GetSpan(), ECCurve.Secp256r1);
LastGasPerVote = @struct[3].GetInteger();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will fork the chain

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes and no. We'll get a different NEO contract state, true. We may have some problem with getAccountState method, but that's easy to solve (strip the third struct item, return only the old two ones to stay compatible, we can add getAccountStateV2 that will return everything, but we might as well not do that, I don't see a lot of uses for this data). But anything else will just work: balances, transfer data, GAS calculations, etc. So it looks more like a regular DB resync to me.

}

public override StackItem ToStackItem(ReferenceCounter referenceCounter)
{
Struct @struct = (Struct)base.ToStackItem(referenceCounter);
@struct.Add(BalanceHeight);
@struct.Add(VoteTo?.ToArray() ?? StackItem.Null);
@struct.Add(LastGasPerVote);
return @struct;
}
}
Expand Down