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

Jump to bottom

Redesign claim action #2929

Merged
merged 5 commits into from
Oct 25, 2024
Merged

Redesign claim action #2929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0bb5744
feat: Redesign claim action
OnedgeLee Oct 23, 2024
0af93ed
chore: Remove GuildValidatorRepository prop from GuildParticipant
OnedgeLee Oct 24, 2024
23f2d6d
fix: Fix maldesigned guild delegation
OnedgeLee Oct 25, 2024
3daaa16
test: Add ClaimRewardGuildTest
OnedgeLee Oct 25, 2024
3fc3130
test: Add SkipDuplicatedClaim test
OnedgeLee Oct 25, 2024
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
12 changes: 6 additions & 6 deletions .Lib9c.Tests/Action/Guild/BanGuildMemberTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public void Execute()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress, 1L);

var banGuildMember = new BanGuildMember(targetGuildMemberAddress);
var actionContext = new ActionContext
Expand Down Expand Up @@ -71,9 +71,9 @@ public void Ban_By_GuildMaster()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress, 1L);
world = EnsureToMakeGuild(world, otherGuildAddress, otherGuildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, otherGuildAddress, otherGuildMemberAddress);
world = EnsureToJoinGuild(world, otherGuildAddress, otherGuildMemberAddress, 1L);

var repository = new GuildRepository(world, new ActionContext());
// Guild
Expand Down Expand Up @@ -169,8 +169,8 @@ public void Ban_By_GuildMember()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress, 1L);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress, 1L);

var repository = new GuildRepository(world, new ActionContext());

Expand Down Expand Up @@ -213,7 +213,7 @@ public void Ban_By_Other()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress, 1L);

var repository = new GuildRepository(world, new ActionContext());

Expand Down
145 changes: 145 additions & 0 deletions .Lib9c.Tests/Action/Guild/ClaimRewardGuildTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
namespace Lib9c.Tests.Action.Guild
{
using System.Linq;
using Lib9c.Tests.Util;
using Libplanet.Action.State;
using Libplanet.Crypto;
using Nekoyume.Action.ValidatorDelegation;
using Nekoyume.Model.Guild;
using Nekoyume.Model.Stake;
using Xunit;

public class ClaimRewardGuildTest : GuildTestBase
{
[Fact]
public void Serialization()
{
var action = new ClaimRewardGuild();
var plainValue = action.PlainValue;

var deserialized = new ClaimRewardGuild();
deserialized.LoadPlainValue(plainValue);
}

[Fact]
public void Execute()
{
// Given
var validatorKey = new PrivateKey();
var agentAddress = AddressUtil.CreateAgentAddress();
var guildMasterAddress = AddressUtil.CreateAgentAddress();
var guildAddress = AddressUtil.CreateGuildAddress();
var nParticipants = 10;
var guildParticipantAddresses = Enumerable.Range(0, nParticipants).Select(
_ => AddressUtil.CreateAgentAddress()).ToList();

IWorld world = World;
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMintAsset(world, StakeState.DeriveAddress(guildMasterAddress), GG * 100);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = guildParticipantAddresses.Select((addr, idx) => (addr, idx)).Aggregate(world, (w, item) =>
{
w = EnsureToMintAsset(w, item.addr, Mead * 100);
w = EnsureToMintAsset(w, StakeState.DeriveAddress(item.addr), GG * ((item.idx + 1) * 100));
return EnsureToJoinGuild(w, guildAddress, item.addr, 1L);
});

// When
var repository = new GuildRepository(world, new ActionContext());
var guild = repository.GetGuild(guildAddress);
var reward = NCG * 1000;
repository.UpdateWorld(EnsureToMintAsset(repository.World, guild.RewardPoolAddress, reward));
guild.CollectRewards(1);
world = repository.World;

for (var i = 0; i < nParticipants; i++)
{
var claimRewardGuild = new ClaimRewardGuild();
var actionContext = new ActionContext
{
PreviousState = world,
Signer = guildParticipantAddresses[i],
BlockIndex = 2L,
};
world = claimRewardGuild.Execute(actionContext);
}

//Then
var expectedRepository = new GuildRepository(world, new ActionContext());
for (var i = 0; i < nParticipants; i++)
{
var expectedGuild = expectedRepository.GetGuild(guildAddress);
var bond = expectedRepository.GetBond(expectedGuild, guildParticipantAddresses[i]);
var expectedReward = (reward * bond.Share).DivRem(expectedGuild.TotalShares).Quotient;
var actualReward = world.GetBalance(guildParticipantAddresses[i], NCG);

Assert.Equal(expectedReward, actualReward);
}
}

[Fact]
public void SkipDuplicatedClaim()
{
// Given
var validatorKey = new PrivateKey();
var agentAddress = AddressUtil.CreateAgentAddress();
var guildMasterAddress = AddressUtil.CreateAgentAddress();
var guildAddress = AddressUtil.CreateGuildAddress();
var nParticipants = 10;
var guildParticipantAddresses = Enumerable.Range(0, nParticipants).Select(
_ => AddressUtil.CreateAgentAddress()).ToList();

IWorld world = World;
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMintAsset(world, StakeState.DeriveAddress(guildMasterAddress), GG * 100);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = guildParticipantAddresses.Select((addr, idx) => (addr, idx)).Aggregate(world, (w, item) =>
{
w = EnsureToMintAsset(w, item.addr, Mead * 100);
w = EnsureToMintAsset(w, StakeState.DeriveAddress(item.addr), GG * ((item.idx + 1) * 100));
return EnsureToJoinGuild(w, guildAddress, item.addr, 1L);
});

// When
var repository = new GuildRepository(world, new ActionContext());
var guild = repository.GetGuild(guildAddress);
var reward = NCG * 1000;
repository.UpdateWorld(EnsureToMintAsset(repository.World, guild.RewardPoolAddress, reward));
guild.CollectRewards(1);
world = repository.World;

var claimRewardGuild = new ClaimRewardGuild();
world = claimRewardGuild.Execute(new ActionContext
{
PreviousState = world,
Signer = guildParticipantAddresses[0],
BlockIndex = 2L,
});

world = claimRewardGuild.Execute(new ActionContext
{
PreviousState = world,
Signer = guildParticipantAddresses[0],
BlockIndex = 2L,
});

world = claimRewardGuild.Execute(new ActionContext
{
PreviousState = world,
Signer = guildParticipantAddresses[0],
BlockIndex = 3L,
});

//Then
var expectedRepository = new GuildRepository(world, new ActionContext());
var expectedGuild = expectedRepository.GetGuild(guildAddress);
var bond = expectedRepository.GetBond(expectedGuild, guildParticipantAddresses[0]);
var expectedReward = (reward * bond.Share).DivRem(expectedGuild.TotalShares).Quotient;
var actualReward = world.GetBalance(guildParticipantAddresses[0], NCG);

Assert.Equal(expectedReward, actualReward);
}
}
}
11 changes: 8 additions & 3 deletions .Lib9c.Tests/Action/Guild/GuildTestBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ protected static IWorld EnsureToMakeGuild(
var actionContext = new ActionContext
{
Signer = guildMasterAddress,
BlockIndex = 0L,
};
var repository = new GuildRepository(world, actionContext);
repository.MakeGuild(guildAddress, validatorAddress);
Expand All @@ -74,14 +75,18 @@ protected static IWorld EnsureToMakeGuild(
protected static IWorld EnsureToJoinGuild(
IWorld world,
GuildAddress guildAddress,
AgentAddress agentAddress)
AgentAddress guildParticipantAddress,
long blockHeight)
{
var actionContext = new ActionContext
{
Signer = agentAddress,
PreviousState = world,
BlockIndex = blockHeight,
Signer = guildParticipantAddress,
};

var repository = new GuildRepository(world, actionContext);
repository.JoinGuild(guildAddress, agentAddress);
repository.JoinGuild(guildAddress, guildParticipantAddress);
return repository.World;
}

Expand Down
2 changes: 1 addition & 1 deletion .Lib9c.Tests/Action/Guild/MoveGuildTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public void Execute()
world = EnsureToCreateValidator(world, validatorKey2.PublicKey);
world = EnsureToMakeGuild(world, guildAddress1, guildMasterAddress1, validatorKey1.Address);
world = EnsureToMakeGuild(world, guildAddress2, guildMasterAddress2, validatorKey2.Address);
world = EnsureToJoinGuild(world, guildAddress1, agentAddress);
world = EnsureToJoinGuild(world, guildAddress1, agentAddress, 1L);

var moveGuild = new MoveGuild(guildAddress2);
var actionContext = new ActionContext
Expand Down
2 changes: 1 addition & 1 deletion .Lib9c.Tests/Action/Guild/QuitGuildTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ public void Execute()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, agentAddress);
world = EnsureToJoinGuild(world, guildAddress, agentAddress, 1L);

var quitGuild = new QuitGuild();
var actionContext = new ActionContext
Expand Down
6 changes: 3 additions & 3 deletions .Lib9c.Tests/Action/Guild/RemoveGuildTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public void Execute_ByGuildMember_Throw()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress, 1L);

var actionContext = new ActionContext
{
Expand All @@ -90,7 +90,7 @@ public void Execute_WhenDelegationExists_Throw()
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMintAsset(world, StakeState.DeriveAddress(guildMasterAddress), GG * 100);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, guildParticipantAddress);
world = EnsureToJoinGuild(world, guildAddress, guildParticipantAddress, 1L);

var actionContext = new ActionContext
{
Expand Down Expand Up @@ -137,7 +137,7 @@ public void Execute_ResetBannedAddresses()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, bannedAddress);
world = EnsureToJoinGuild(world, guildAddress, bannedAddress, 1L);
world = EnsureToBanGuildMember(world, guildAddress, guildMasterAddress, bannedAddress);

var actionContext = new ActionContext
Expand Down
11 changes: 3 additions & 8 deletions .Lib9c.Tests/Action/Guild/UnbanGuildMemberTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,8 @@ namespace Lib9c.Tests.Action.Guild
using Lib9c.Tests.Util;
using Libplanet.Action.State;
using Libplanet.Crypto;
using Libplanet.Mocks;
using Libplanet.Types.Assets;
using Nekoyume;
using Nekoyume.Action.Guild;
using Nekoyume.Model.Guild;
using Nekoyume.Model.State;
using Nekoyume.Module;
using Nekoyume.Module.Guild;
using Xunit;

Expand Down Expand Up @@ -40,7 +35,7 @@ public void Execute()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress, 1L);
world = EnsureToBanGuildMember(world, guildAddress, guildMasterAddress, targetGuildMemberAddress);

var unbanGuildMember = new UnbanGuildMember(targetGuildMemberAddress);
Expand Down Expand Up @@ -71,7 +66,7 @@ public void Unban_By_GuildMember()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, guildMemberAddress, 1L);
world = EnsureToBanGuildMember(world, guildAddress, guildMasterAddress, targetGuildMemberAddress);

var repository = new GuildRepository(world, new ActionContext());
Expand Down Expand Up @@ -105,7 +100,7 @@ public void Unban_By_GuildMaster()
world = EnsureToMintAsset(world, validatorKey.Address, GG * 100);
world = EnsureToCreateValidator(world, validatorKey.PublicKey);
world = EnsureToMakeGuild(world, guildAddress, guildMasterAddress, validatorKey.Address);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress);
world = EnsureToJoinGuild(world, guildAddress, targetGuildMemberAddress, 1L);
world = EnsureToBanGuildMember(world, guildAddress, guildMasterAddress, targetGuildMemberAddress);

var repository = new GuildRepository(world, new ActionContext());
Expand Down
Loading
Loading