From 02a95ab6a150836859c7ba80908950f802fd3852 Mon Sep 17 00:00:00 2001 From: George Misiakoulis Date: Fri, 20 Sep 2024 16:31:58 +0300 Subject: [PATCH] Add beacon block reward endpoint --- api/beaconblockrewardopts.go | 22 ++++++ api/v1/beaconblockreward.go | 146 +++++++++++++++++++++++++++++++++++ http/beaconblockreward.go | 55 +++++++++++++ http/events.go | 14 ++-- 4 files changed, 232 insertions(+), 5 deletions(-) create mode 100644 api/beaconblockrewardopts.go create mode 100644 api/v1/beaconblockreward.go create mode 100644 http/beaconblockreward.go diff --git a/api/beaconblockrewardopts.go b/api/beaconblockrewardopts.go new file mode 100644 index 00000000..e2f8a2b6 --- /dev/null +++ b/api/beaconblockrewardopts.go @@ -0,0 +1,22 @@ +// Copyright © 2023 Attestant Limited. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package api + +// BeaconBlockHeaderOpts are the options for obtaining beacon block headers. +type BeaconBlockRewardOpts struct { + Common CommonOpts + + // Block is the ID of the block which the data is obtained. + Block string +} diff --git a/api/v1/beaconblockreward.go b/api/v1/beaconblockreward.go new file mode 100644 index 00000000..9c3d6d07 --- /dev/null +++ b/api/v1/beaconblockreward.go @@ -0,0 +1,146 @@ +// Copyright © 2020, 2021 Attestant Limited. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package v1 + +import ( + "encoding/json" + "fmt" + "strconv" + + "github.com/pkg/errors" +) + +// BeaconBlockReward Rewards info for a single block +type BeaconBlockReward struct { + // Proposer of the block, the proposer index who receives these rewards + ProposerIndex uint64 + // Total block reward in gwei, equal to attestations + sync_aggregate + proposer_slashings + attester_slashings + Total uint64 + // Block reward component due to included attestations in gwei + Attestations uint64 + // Block reward component due to included sync_aggregate in gwei + SyncAggregate uint64 + // Block reward component due to included proposer_slashings in gwei + ProposerSlashings uint64 + // Block reward component due to included attester_slashings in gwei + AttesterSlashings uint64 +} + +// beaconBlockRewardJSON is the spec representation of the struct. +type beaconBlockRewardJSON struct { + ProposerIndex string `json:"proposer_index"` + Total string `json:"total"` + Attestations string `json:"attestations"` + SyncAggregate string `json:"sync_aggregate"` + ProposerSlashings string `json:"proposer_slashings"` + AttesterSlashings string `json:"attester_slashings"` +} + +// MarshalJSON implements json.Marshaler. +func (b *BeaconBlockReward) MarshalJSON() ([]byte, error) { + return json.Marshal(&beaconBlockRewardJSON{ + ProposerIndex: fmt.Sprintf("%d", b.ProposerIndex), + Total: fmt.Sprintf("%d", b.Total), + Attestations: fmt.Sprintf("%d", b.Attestations), + SyncAggregate: fmt.Sprintf("%d", b.SyncAggregate), + ProposerSlashings: fmt.Sprintf("%d", b.ProposerSlashings), + AttesterSlashings: fmt.Sprintf("%d", b.AttesterSlashings), + }) +} + +// UnmarshalJSON implements json.Unmarshaler. +func (b *BeaconBlockReward) UnmarshalJSON(input []byte) error { + var err error + + var beaconBlockRewardJSON beaconBlockRewardJSON + if err = json.Unmarshal(input, &beaconBlockRewardJSON); err != nil { + return errors.Wrap(err, "invalid JSON") + } + + return b.unpack(&beaconBlockRewardJSON) +} + +func (b *BeaconBlockReward) unpack(beaconBlockRewardJSON *beaconBlockRewardJSON) error { + if beaconBlockRewardJSON.ProposerIndex == "" { + return errors.New("proposer index missing") + } + + proposerIndex, err := strconv.ParseUint(beaconBlockRewardJSON.ProposerIndex, 10, 64) + if err != nil { + return errors.Wrap(err, "invalid value for proposer index") + } + b.ProposerIndex = proposerIndex + + if beaconBlockRewardJSON.Total == "" { + return errors.New("total missing") + } + + total, err := strconv.ParseUint(beaconBlockRewardJSON.Total, 10, 64) + if err != nil { + return errors.Wrap(err, "invalid value for total") + } + b.Total = total + + if beaconBlockRewardJSON.Attestations == "" { + return errors.New("total missing") + } + + attestations, err := strconv.ParseUint(beaconBlockRewardJSON.Attestations, 10, 64) + if err != nil { + return errors.Wrap(err, "invalid value for attestations") + } + b.Attestations = attestations + + if beaconBlockRewardJSON.SyncAggregate == "" { + return errors.New("sync aggregate missing") + } + + syncAggregate, err := strconv.ParseUint(beaconBlockRewardJSON.SyncAggregate, 10, 64) + if err != nil { + return errors.Wrap(err, "invalid value for sync aggregate") + } + b.SyncAggregate = syncAggregate + + if beaconBlockRewardJSON.ProposerSlashings == "" { + return errors.New("proposer slashing missing") + } + + proposerSlashings, err := strconv.ParseUint(beaconBlockRewardJSON.ProposerSlashings, 10, 64) + if err != nil { + return errors.Wrap(err, "invalid value for proposer slashings") + } + b.ProposerSlashings = proposerSlashings + + if beaconBlockRewardJSON.AttesterSlashings == "" { + return errors.New("proposer slashing missing") + } + + attesterSlashings, err := strconv.ParseUint(beaconBlockRewardJSON.AttesterSlashings, 10, 64) + if err != nil { + return errors.Wrap(err, "invalid value for attester slashings") + } + b.AttesterSlashings = attesterSlashings + + return nil +} + +// String returns a string version of the structure. +func (b *BeaconBlockReward) String() string { + data, err := json.Marshal(b) + if err != nil { + return fmt.Sprintf("ERR: %v", err) + } + + return string(data) +} diff --git a/http/beaconblockreward.go b/http/beaconblockreward.go new file mode 100644 index 00000000..d0cdef9f --- /dev/null +++ b/http/beaconblockreward.go @@ -0,0 +1,55 @@ +// Copyright © 2020 - 2024 Attestant Limited. +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package http + +import ( + "bytes" + "context" + "fmt" + + client "github.com/attestantio/go-eth2-client" + "github.com/attestantio/go-eth2-client/api" + apiv1 "github.com/attestantio/go-eth2-client/api/v1" +) + +// BeaconBlockHeader provides the block header given the opts. +func (s *Service) BeaconBlockReward(ctx context.Context, + opts *api.BeaconBlockRewardOpts, +) ( + *api.Response[*apiv1.BeaconBlockReward], + error, +) { + if err := s.assertIsActive(ctx); err != nil { + return nil, err + } + if opts == nil { + return nil, client.ErrNoOptions + } + + endpoint := fmt.Sprintf("/eth/v1/beacon/rewards/blocks/%s", opts.Block) + httpResponse, err := s.get(ctx, endpoint, "", &opts.Common, false) + if err != nil { + return nil, err + } + + data, metadata, err := decodeJSONResponse(bytes.NewReader(httpResponse.body), apiv1.BeaconBlockReward{}) + if err != nil { + return nil, err + } + + return &api.Response[*apiv1.BeaconBlockReward]{ + Metadata: metadata, + Data: &data, + }, nil +} diff --git a/http/events.go b/http/events.go index b0418c97..739c34ec 100644 --- a/http/events.go +++ b/http/events.go @@ -21,6 +21,7 @@ import ( "math/rand" "net" "net/http" + "net/url" "strings" "time" @@ -53,12 +54,15 @@ func (s *Service) Events(ctx context.Context, topics []string, handler consensus } } - endpoint := "/eth/v1/events" - query := "topics=" + strings.Join(topics, "&topics=") - callURL := urlForCall(s.base, endpoint, query) - log.Trace().Str("url", callURL.String()).Msg("GET request to events stream") + reference, err := url.Parse(fmt.Sprintf("eth/v1/events?topics=%s", strings.Join(topics, "&topics="))) + if err != nil { + return errors.Join(errors.New("invalid endpoint"), err) + } + + callURL := fmt.Sprintf("%s/%s", s.base.String(), reference) + log.Trace().Str("url", callURL).Msg("GET request to events stream") - client := sse.NewClient(callURL.String()) + client := sse.NewClient(callURL) for k, v := range s.extraHeaders { client.Headers[k] = v }