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

fix: normalize addresses used as inputs from rpcs #240

Merged
merged 1 commit into from
Feb 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
16 changes: 12 additions & 4 deletions pkg/rpcServer/rewardsHandlers.go
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,13 @@ func (rpc *RpcServer) GetAvailableRewardsTokens(ctx context.Context, req *reward
}, nil
}

func withDefaultValue(value string, defaultValue string) string {
if value == "" {
return defaultValue
}
return value
}

func (rpc *RpcServer) GetSummarizedRewardsForEarner(ctx context.Context, req *rewardsV1.GetSummarizedRewardsForEarnerRequest) (*rewardsV1.GetSummarizedRewardsForEarnerResponse, error) {
earner := req.GetEarnerAddress()
blockHeight := req.GetBlockHeight()
Expand All @@ -329,12 +336,13 @@ func (rpc *RpcServer) GetSummarizedRewardsForEarner(ctx context.Context, req *re

return &rewardsV1.GetSummarizedRewardsForEarnerResponse{
Rewards: utils.Map(summarizedRewards, func(r *rewardsDataService.SummarizedReward, i uint64) *rewardsV1.SummarizedEarnerReward {

return &rewardsV1.SummarizedEarnerReward{
Token: r.Token,
Earned: r.Earned,
Active: r.Active,
Claimed: r.Claimed,
Claimable: r.Claimable,
Earned: withDefaultValue(r.Earned, "0"),
Active: withDefaultValue(r.Active, "0"),
Claimed: withDefaultValue(r.Claimed, "0"),
Claimable: withDefaultValue(r.Claimable, "0"),
}
}),
}, nil
Expand Down
42 changes: 27 additions & 15 deletions pkg/service/rewardsDataService/rewards.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,17 +56,29 @@ type TotalClaimedReward struct {
Amount string
}

func lowercaseTokenList(tokens []string) []string {
return utils.Map(tokens, func(token string, i uint64) string {
return strings.ToLower(token)
})
}

func (rds *RewardsDataService) GetTotalClaimedRewards(ctx context.Context, earner string, tokens []string, blockHeight uint64) ([]*TotalClaimedReward, error) {
blockHeight, err := rds.BaseDataService.GetCurrentBlockHeightIfNotPresent(ctx, blockHeight)
if err != nil {
return nil, err
}

if earner == "" {
return nil, fmt.Errorf("earner is required")
}
earner = strings.ToLower(earner)
tokens = lowercaseTokenList(tokens)

query := `
select
earner,
token,
sum(claimed_amount) as amount
coalesce(sum(claimed_amount), 0) as amount
from rewards_claimed as rc
where
earner = @earner
Expand Down Expand Up @@ -134,14 +146,12 @@ func (rds *RewardsDataService) ListClaimedRewardsByBlockRange(
}
if earner != "" {
query += " and earner = @earner"
args = append(args, sql.Named("earner", earner))
args = append(args, sql.Named("earner", strings.ToLower(earner)))
}
if len(tokens) > 0 {
query += " and token in (?)"
formattedTokens := utils.Map(tokens, func(token string, i uint64) string {
return strings.ToLower(token)
})
args = append(args, sql.Named("tokens", formattedTokens))
tokens = lowercaseTokenList(tokens)
args = append(args, sql.Named("tokens", tokens))
}
query += " order by block_number, log_index"

Expand Down Expand Up @@ -170,6 +180,7 @@ func (rds *RewardsDataService) GetTotalRewardsForEarner(
if earner == "" {
return nil, fmt.Errorf("earner is required")
}
earner = strings.ToLower(earner)

snapshot, err := rds.findDistributionRootClosestToBlockHeight(blockHeight, claimable)
if err != nil {
Expand All @@ -192,7 +203,7 @@ func (rds *RewardsDataService) GetTotalRewardsForEarner(
)
select
token,
sum(amount) as amount
coalesce(sum(amount), 0) as amount
from token_snapshots
group by 1
`
Expand All @@ -202,10 +213,8 @@ func (rds *RewardsDataService) GetTotalRewardsForEarner(
}
if len(tokens) > 0 {
query += " and token in (?)"
formattedTokens := utils.Map(tokens, func(token string, i uint64) string {
return strings.ToLower(token)
})
args = append(args, sql.Named("tokens", formattedTokens))
tokens = lowercaseTokenList(tokens)
args = append(args, sql.Named("tokens", tokens))
}

rewardAmounts := make([]*RewardAmount, 0)
Expand All @@ -232,6 +241,8 @@ func (rds *RewardsDataService) GetClaimableRewardsForEarner(
if earner == "" {
return nil, nil, fmt.Errorf("earner is required")
}
earner = strings.ToLower(earner)

snapshot, err := rds.findDistributionRootClosestToBlockHeight(blockHeight, true)
if err != nil {
return nil, nil, err
Expand Down Expand Up @@ -281,10 +292,8 @@ func (rds *RewardsDataService) GetClaimableRewardsForEarner(
}
if len(tokens) > 0 {
query += " and token in (?)"
formattedTokens := utils.Map(tokens, func(token string, i uint64) string {
return strings.ToLower(token)
})
args = append(args, sql.Named("tokens", formattedTokens))
tokens = lowercaseTokenList(tokens)
args = append(args, sql.Named("tokens", tokens))
}

claimableRewards := make([]*RewardAmount, 0)
Expand Down Expand Up @@ -372,6 +381,8 @@ func (rds *RewardsDataService) GetSummarizedRewards(ctx context.Context, earner
if earner == "" {
return nil, fmt.Errorf("earner is required")
}
earner = strings.ToLower(earner)
tokens = lowercaseTokenList(tokens)

blockHeight, err := rds.BaseDataService.GetCurrentBlockHeightIfNotPresent(context.Background(), blockHeight)
if err != nil {
Expand Down Expand Up @@ -487,6 +498,7 @@ func (rds *RewardsDataService) ListAvailableRewardsTokens(ctx context.Context, e
if earner == "" {
return nil, fmt.Errorf("earner is required")
}
earner = strings.ToLower(earner)

blockHeight, err := rds.BaseDataService.GetCurrentBlockHeightIfNotPresent(ctx, blockHeight)
if err != nil {
Expand Down
4 changes: 4 additions & 0 deletions pkg/service/rewardsDataService/rewards_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ func Test_RewardsDataService(t *testing.T) {
r, err := rds.GetSummarizedRewards(context.Background(), earner, nil, blockNumber)
assert.Nil(t, err)
assert.NotNil(t, r)
fmt.Printf("Summarized rewards: %+v\n", r)
for _, sr := range r {
fmt.Printf(" %+v\n", sr)
}
})

t.Run("Test ListAvailableRewardsTokens", func(t *testing.T) {
Expand Down