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.

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

Add PoE staking query plugin #170

Merged
merged 6 commits into from
Nov 8, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
60 changes: 60 additions & 0 deletions x/poe/contract/tg4_stake_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,66 @@ func TestQueryUnbondingPeriod(t *testing.T) {
assert.Equal(t, configuredTime, res)
}

func TestQueryStakedAmount(t *testing.T) {
// setup contracts and seed some data
ctx, example, _ := setupPoEContracts(t)
contractKeeper := example.TWasmKeeper.GetContractKeeper()
stakingContractAddr, err := example.PoEKeeper.GetPoEContractAddress(ctx, types.PoEContractTypeStaking)
require.NoError(t, err)
contractAdapter := contract.NewStakeContractAdapter(stakingContractAddr, example.TWasmKeeper, nil)

// fund account
var myOperatorAddr sdk.AccAddress = rand.Bytes(sdk.AddrLen)
example.BankKeeper.SetBalances(ctx, myOperatorAddr, sdk.NewCoins(sdk.NewCoin(types.DefaultBondDenom, sdk.NewInt(100))))

var oneInt = sdk.OneInt()
specs := map[string]struct {
Copy link
Contributor

Choose a reason for hiding this comment

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

good set of queries and high-level integration test for the contracts

addr sdk.AccAddress
expAmount *sdk.Int
setup func(ctx sdk.Context)
expErr bool
}{
"address has staked amount": {
addr: myOperatorAddr,
setup: func(ctx sdk.Context) {
err := contract.BondDelegation(ctx, stakingContractAddr, myOperatorAddr, sdk.NewCoins(sdk.NewCoin("utgd", sdk.OneInt())), contractKeeper)
require.NoError(t, err)
},
expAmount: &oneInt,
},
"address had formerly staked amount": {
addr: myOperatorAddr,
setup: func(ctx sdk.Context) {
err := contract.BondDelegation(ctx, stakingContractAddr, myOperatorAddr, sdk.NewCoins(sdk.NewCoin("utgd", sdk.OneInt())), contractKeeper)
require.NoError(t, err)
err = contract.UnbondDelegation(ctx, stakingContractAddr, myOperatorAddr, sdk.OneInt(), contractKeeper)
require.NoError(t, err)
},
expAmount: nil,
},
"unknown address": {
addr: rand.Bytes(sdk.AddrLen),
setup: func(ctx sdk.Context) {},
expAmount: nil,
},
}
for name, spec := range specs {
t.Run(name, func(t *testing.T) {
tCtx, _ := ctx.CacheContext()
spec.setup(tCtx)
// when
gotAmount, gotErr := contractAdapter.QueryStakedAmount(tCtx, spec.addr)
// then
if spec.expErr {
require.Error(t, gotErr)
return
}
require.NoError(t, gotErr)
assert.Equal(t, spec.expAmount, gotAmount, "exp %s but got %s", spec.expAmount, gotAmount)
})
}
}

func TestQueryValidatorUnboding(t *testing.T) {
// setup contracts and seed some data
ctx, example, vals := setupPoEContracts(t)
Expand Down
3 changes: 3 additions & 0 deletions x/poe/keeper/contracts.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
)

type DistributionContract interface {
// ValidatorOutstandingReward returns amount or 0 for an unknown address
ValidatorOutstandingReward(ctx sdk.Context, addr sdk.AccAddress) (sdk.Coin, error)
}

Expand All @@ -31,8 +32,10 @@ func (k Keeper) ValsetContract(ctx sdk.Context) ValsetContract {
}

type StakeContract interface {
// QueryStakedAmount returns amount in default denom or nil value for an unknown address
QueryStakedAmount(ctx sdk.Context, opAddr sdk.AccAddress) (*sdk.Int, error)
QueryStakingUnbondingPeriod(ctx sdk.Context) (time.Duration, error)
// QueryStakingUnbonding returns the unbondings or empty list for an unknown address
QueryStakingUnbonding(ctx sdk.Context, opAddr sdk.AccAddress) ([]stakingtypes.UnbondingDelegationEntry, error)
}

Expand Down
29 changes: 17 additions & 12 deletions x/poe/wasm/query_plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,11 @@ func StakingQuerier(poeKeeper ViewKeeper) func(ctx sdk.Context, request *wasmvmt
}
var res wasmvmtypes.AllDelegationsResponse
if stakedAmount != nil {
res.Delegations = append(res.Delegations, wasmvmtypes.Delegation{
res.Delegations = []wasmvmtypes.Delegation{{
Delegator: delegator.String(),
Validator: delegator.String(),
Amount: wasmvmtypes.NewCoin(stakedAmount.Uint64(), poeKeeper.GetBondDenom(ctx)),
})
}}
}
return json.Marshal(res)
}
Expand All @@ -102,22 +102,27 @@ func StakingQuerier(poeKeeper ViewKeeper) func(ctx sdk.Context, request *wasmvmt
stakeContract := poeKeeper.StakeContract(ctx)
stakedAmount, err := stakeContract.QueryStakedAmount(ctx, delegator)
if err != nil {
return nil, err
return nil, sdkerrors.Wrap(err, "query staked amount")
}
if stakedAmount != nil {
stakedCoin := wasmvmtypes.NewCoin(stakedAmount.Uint64(), poeKeeper.GetBondDenom(ctx))
reward, err := poeKeeper.DistributionContract(ctx).ValidatorOutstandingReward(ctx, delegator)
if err != nil {
return nil, sdkerrors.Wrap(err, "query outstanding reward")
}
if stakedAmount == nil {
zeroInt := sdk.ZeroInt()
stakedAmount = &zeroInt
}
// there can be unclaimed rewards while all stacked amounts were unbound
if stakedAmount.GT(sdk.ZeroInt()) || reward.Amount.GT(sdk.ZeroInt()) {
bondDenom := poeKeeper.GetBondDenom(ctx)
stakedCoin := wasmvmtypes.NewCoin(stakedAmount.Uint64(), bondDenom)
res.Delegation = &wasmvmtypes.FullDelegation{
Delegator: delegator.String(),
Validator: delegator.String(),
Amount: stakedCoin,
CanRedelegate: stakedCoin,
AccumulatedRewards: nil,
}
reward, err := poeKeeper.DistributionContract(ctx).ValidatorOutstandingReward(ctx, delegator)
if err != nil {
return nil, err
CanRedelegate: wasmvmtypes.NewCoin(0, bondDenom),
Copy link
Contributor

Choose a reason for hiding this comment

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

looks good

AccumulatedRewards: wasmvmtypes.Coins{wasmvmtypes.NewCoin(reward.Amount.Uint64(), reward.Denom)},
}
res.Delegation.AccumulatedRewards = wasmvmtypes.Coins{wasmvmtypes.NewCoin(reward.Amount.Uint64(), reward.Denom)}
}
return json.Marshal(res)
}
Expand Down
61 changes: 43 additions & 18 deletions x/poe/wasm/query_plugin_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -164,35 +164,43 @@ func TestStakingQuerier(t *testing.T) {
],
"can_redelegate": {
"denom": "alx",
"amount": "1"
"amount": "0"
}
}
}
`,
},
"query delegation - address do not match - return empty result": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3", Validator: "cosmos17emnuddq662fpxpnd43ch0396452d48vc8ufsw"}},
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3", Validator: "cosmos17emnuddq662fpxpnd43ch0396452d48vc8ufsw"}},
expJson: `{}`,
},
"query delegation - unknown address return empty result": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3", Validator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3"}},
mock: ViewKeeperMock{
StakeContractFn: func(ctx sdk.Context) keeper.StakeContract {
return poetesting.StakeContractMock{
QueryStakedAmountFn: func(ctx sdk.Context, opAddr sdk.AccAddress) (*sdk.Int, error) {
myValue := sdk.OneInt()
return &myValue, nil
return nil, nil
},
}
},
GetBondDenomFn: func(ctx sdk.Context) string {
return "alx"
},
DistributionContractFn: func(ctx sdk.Context) keeper.DistributionContract {
return poetesting.DistributionContractMock{ValidatorOutstandingRewardFn: func(ctx sdk.Context, addr sdk.AccAddress) (sdk.Coin, error) {
return sdk.NewCoin("alx", sdk.NewInt(2)), nil
return sdk.NewCoin("alx", sdk.ZeroInt()), nil
}}
},
},
expJson: `{}`,
},
"query delegation - unknown address return empty result": {
"query delegation - invalid delegator address": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "not a valid address", Validator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3"}},
expErr: true,
},
"query delegation - invalid validator address": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3", Validator: "not a valid address"}},
expErr: true,
},
"query delegation - no staking, pending rewards": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3", Validator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3"}},
mock: ViewKeeperMock{
StakeContractFn: func(ctx sdk.Context) keeper.StakeContract {
Expand All @@ -205,16 +213,33 @@ func TestStakingQuerier(t *testing.T) {
GetBondDenomFn: func(ctx sdk.Context) string {
return "alx"
},
DistributionContractFn: func(ctx sdk.Context) keeper.DistributionContract {
return poetesting.DistributionContractMock{ValidatorOutstandingRewardFn: func(ctx sdk.Context, addr sdk.AccAddress) (sdk.Coin, error) {
return sdk.NewCoin("alx", sdk.NewInt(2)), nil
}}
},
},
expJson: `{}`,
},
"query delegation - invalid delegator address": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "not a valid address", Validator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3"}},
expErr: true,
},
"query delegation - invalid validator address": {
src: wasmvmtypes.StakingQuery{Delegation: &wasmvmtypes.DelegationQuery{Delegator: "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3", Validator: "not a valid address"}},
expErr: true,
expJson: `{
"delegation": {
"delegator": "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3",
"validator": "cosmos1yq8zt83jznmp94jkj65yvfz9n52akmxt52ehm3",
"amount": {
"denom": "alx",
"amount": "0"
},
"accumulated_rewards": [
{
"denom": "alx",
"amount": "2"
}
],
"can_redelegate": {
"denom": "alx",
"amount": "0"
}
}
}
`,
},
"unknown query": {
src: wasmvmtypes.StakingQuery{},
Expand Down