package evaluators import ( "context" "encoding/base64" "encoding/json" "fmt" "net/http" "github.com/golang/protobuf/ptypes/empty" "github.com/pkg/errors" ethpb "github.com/prysmaticlabs/prysm/v3/proto/prysm/v1alpha1" e2e "github.com/prysmaticlabs/prysm/v3/testing/endtoend/params" "github.com/prysmaticlabs/prysm/v3/testing/endtoend/policies" e2etypes "github.com/prysmaticlabs/prysm/v3/testing/endtoend/types" "google.golang.org/grpc" ) // APIGatewayV1Alpha1VerifyIntegrity of our API gateway for the Prysm v1alpha1 API. // This ensures our gRPC HTTP gateway returns and processes the same data _for the same endpoints_ // as using a gRPC connection to interact with the API. Running this in end-to-end tests helps us // ensure parity between our HTTP gateway for our API and gRPC never breaks. // This evaluator checks a few request/response trips for both GET and POST requests. var APIGatewayV1Alpha1VerifyIntegrity = e2etypes.Evaluator{ Name: "api_gateway_v1alpha1_verify_integrity_epoch_%d", Policy: policies.OnEpoch(2), Evaluation: apiGatewayV1Alpha1Verify, } const ( v1Alpha1GatewayPathTemplate = "http://localhost:%d/eth/v1alpha1" ) type apiComparisonFunc func(beaconNodeIdx int, conn *grpc.ClientConn) error func apiGatewayV1Alpha1Verify(_ e2etypes.EvaluationContext, conns ...*grpc.ClientConn) error { for beaconNodeIdx, conn := range conns { if err := runAPIComparisonFunctions( beaconNodeIdx, conn, withComparePeers, withCompareListAttestations, withCompareValidators, withCompareChainHead, ); err != nil { return err } } return nil } func withComparePeers(beaconNodeIdx int, conn *grpc.ClientConn) error { type peerJSON struct { Address string `json:"address"` Direction string `json:"direction"` ConnectionState string `json:"connectionState"` PeerId string `json:"peerId"` Enr string `json:"enr"` } type peersResponseJSON struct { Peers []*peerJSON `json:"peers"` } ctx := context.Background() nodeClient := ethpb.NewNodeClient(conn) resp, err := nodeClient.ListPeers(ctx, &empty.Empty{}) if err != nil { return err } respJSON := &peersResponseJSON{} if err := doGatewayJSONRequest( "/node/peers", beaconNodeIdx, respJSON, ); err != nil { return err } if len(respJSON.Peers) != len(resp.Peers) { return fmt.Errorf( "HTTP gateway number of peers %d does not match gRPC %d", len(respJSON.Peers), len(resp.Peers), ) } grpcPeerMap := make(map[string]*ethpb.Peer) jsonPeerMap := make(map[string]*peerJSON) for i := 0; i < len(respJSON.Peers); i++ { grpcPeerMap[resp.Peers[i].PeerId] = resp.Peers[i] jsonPeerMap[respJSON.Peers[i].PeerId] = respJSON.Peers[i] } for id, peer := range jsonPeerMap { grpcPeer, ok := grpcPeerMap[id] if !ok { return errors.Errorf("grpc peer %s doesn't exist", id) } if peer.Address != grpcPeer.Address { return fmt.Errorf( "HTTP gateway peer %s with address %s does not match gRPC %s", id, peer.Address, grpcPeer.Address, ) } if peer.Direction != grpcPeer.Direction.String() { return fmt.Errorf( "HTTP gateway peer %s with direction %s does not match gRPC %s", id, peer.Direction, grpcPeer.Direction, ) } if peer.ConnectionState != grpcPeer.ConnectionState.String() { return fmt.Errorf( "HTTP gateway peer %s with connection state %s does not match gRPC %s", id, peer.ConnectionState, grpcPeer.ConnectionState, ) } if peer.PeerId != grpcPeer.PeerId { return fmt.Errorf( "HTTP gateway peer %s with peer id %s does not match gRPC %s", id, peer.PeerId, grpcPeer.PeerId, ) } if peer.Enr != grpcPeer.Enr { return fmt.Errorf( "HTTP gateway peer %s with enr %s does not match gRPC %s", id, peer.Enr, grpcPeer.Enr, ) } } return nil } func withCompareListAttestations(beaconNodeIdx int, conn *grpc.ClientConn) error { type checkpointJSON struct { Epoch string `json:"epoch"` Root string `json:"root"` } type attestationDataJSON struct { Slot string `json:"slot"` CommitteeIndex string `json:"committeeIndex"` BeaconBlockRoot string `json:"beaconBlockRoot"` Source *checkpointJSON `json:"source"` Target *checkpointJSON `json:"target"` } type attestationJSON struct { AggregationBits string `json:"aggregationBits"` Data *attestationDataJSON `json:"data"` Signature string `json:"signature"` } type attestationsResponseJSON struct { Attestations []*attestationJSON `json:"attestations"` NextPageToken string `json:"nextPageToken"` TotalSize int32 `json:"totalSize"` } ctx := context.Background() beaconClient := ethpb.NewBeaconChainClient(conn) resp, err := beaconClient.ListAttestations(ctx, ðpb.ListAttestationsRequest{ QueryFilter: ðpb.ListAttestationsRequest_GenesisEpoch{GenesisEpoch: true}, }) if err != nil { return err } respJSON := &attestationsResponseJSON{} if err := doGatewayJSONRequest( "/beacon/attestations?genesis_epoch=true", beaconNodeIdx, respJSON, ); err != nil { return err } // Begin comparisons. if respJSON.NextPageToken != resp.NextPageToken { return fmt.Errorf( "HTTP gateway next page token %s does not match gRPC %s", respJSON.NextPageToken, resp.NextPageToken, ) } if respJSON.TotalSize != resp.TotalSize { return fmt.Errorf( "HTTP gateway total size %d does not match gRPC %d", respJSON.TotalSize, resp.TotalSize, ) } for i, att := range respJSON.Attestations { grpcAtt := resp.Attestations[i] if att.AggregationBits != base64.StdEncoding.EncodeToString(grpcAtt.AggregationBits) { return fmt.Errorf( "HTTP gateway attestation %d aggregation bits %s does not match gRPC %d", i, att.AggregationBits, grpcAtt.AggregationBits, ) } data := att.Data grpcData := grpcAtt.Data if data.Slot != fmt.Sprintf("%d", grpcData.Slot) { return fmt.Errorf( "HTTP gateway attestation %d slot %s does not match gRPC %d", i, data.Slot, grpcData.Slot, ) } if data.CommitteeIndex != fmt.Sprintf("%d", grpcData.CommitteeIndex) { return fmt.Errorf( "HTTP gateway attestation %d committee index %s does not match gRPC %d", i, data.CommitteeIndex, grpcData.CommitteeIndex, ) } if data.BeaconBlockRoot != base64.StdEncoding.EncodeToString(grpcData.BeaconBlockRoot) { return fmt.Errorf( "HTTP gateway attestation %d beacon block root %s does not match gRPC %d", i, data.BeaconBlockRoot, grpcData.BeaconBlockRoot, ) } if data.Source.Epoch != fmt.Sprintf("%d", grpcData.Source.Epoch) { return fmt.Errorf( "HTTP gateway attestation %d source epoch %s does not match gRPC %d", i, data.Source.Epoch, grpcData.Source.Epoch, ) } if data.Source.Root != base64.StdEncoding.EncodeToString(grpcData.Source.Root) { return fmt.Errorf( "HTTP gateway attestation %d source root %s does not match gRPC %d", i, data.Source.Root, grpcData.Source.Root, ) } if data.Target.Epoch != fmt.Sprintf("%d", grpcData.Target.Epoch) { return fmt.Errorf( "HTTP gateway attestation %d target epoch %s does not match gRPC %d", i, data.Target.Epoch, grpcData.Target.Epoch, ) } if data.Target.Root != base64.StdEncoding.EncodeToString(grpcData.Target.Root) { return fmt.Errorf( "HTTP gateway attestation %d target root %s does not match gRPC %d", i, data.Target.Root, grpcData.Target.Root, ) } if att.Signature != base64.StdEncoding.EncodeToString(grpcAtt.Signature) { return fmt.Errorf( "HTTP gateway attestation %d signature %s does not match gRPC %d", i, att.Signature, grpcAtt.Signature, ) } } return nil } func withCompareValidators(beaconNodeIdx int, conn *grpc.ClientConn) error { type validatorJSON struct { PublicKey string `json:"publicKey"` WithdrawalCredentials string `json:"withdrawalCredentials"` EffectiveBalance string `json:"effectiveBalance"` Slashed bool `json:"slashed"` ActivationEligibilityEpoch string `json:"activationEligibilityEpoch"` ActivationEpoch string `json:"activationEpoch"` ExitEpoch string `json:"exitEpoch"` WithdrawableEpoch string `json:"withdrawableEpoch"` } type validatorContainerJSON struct { Index string `json:"index"` Validator *validatorJSON `json:"validator"` } type validatorsResponseJSON struct { Epoch string `json:"epoch"` ValidatorList []*validatorContainerJSON `json:"validatorList"` NextPageToken string `json:"nextPageToken"` TotalSize int32 `json:"totalSize"` } ctx := context.Background() beaconClient := ethpb.NewBeaconChainClient(conn) resp, err := beaconClient.ListValidators(ctx, ðpb.ListValidatorsRequest{ QueryFilter: ðpb.ListValidatorsRequest_Genesis{ Genesis: true, }, PageSize: 4, }) if err != nil { return err } respJSON := &validatorsResponseJSON{} if err := doGatewayJSONRequest( "/validators?genesis=true&page_size=4", beaconNodeIdx, respJSON, ); err != nil { return err } // Begin comparisons. if respJSON.Epoch != fmt.Sprintf("%d", resp.Epoch) { return fmt.Errorf( "HTTP gateway epoch %s does not match gRPC %d", respJSON.Epoch, resp.Epoch, ) } if respJSON.NextPageToken != resp.NextPageToken { return fmt.Errorf( "HTTP gateway next page token %s does not match gRPC %s", respJSON.NextPageToken, resp.NextPageToken, ) } if respJSON.TotalSize != resp.TotalSize { return fmt.Errorf( "HTTP gateway total size %d does not match gRPC %d", respJSON.TotalSize, resp.TotalSize, ) } // Compare validators. for i, val := range respJSON.ValidatorList { if val.Index != fmt.Sprintf("%d", resp.ValidatorList[i].Index) { return fmt.Errorf( "HTTP gateway validator %d index %s does not match gRPC %d", i, val.Index, resp.ValidatorList[i].Index, ) } httpVal := val.Validator grpcVal := resp.ValidatorList[i].Validator if httpVal.PublicKey != base64.StdEncoding.EncodeToString(grpcVal.PublicKey) { return fmt.Errorf( "HTTP gateway validator %d public key %s does not match gRPC %d", i, httpVal.PublicKey, grpcVal.PublicKey, ) } continue } return nil } // Compares a regular beacon chain head GET request with no arguments gRPC and gRPC gateway. func withCompareChainHead(beaconNodeIdx int, conn *grpc.ClientConn) error { type chainHeadResponseJSON struct { HeadSlot string `json:"headSlot"` HeadEpoch string `json:"headEpoch"` HeadBlockRoot string `json:"headBlockRoot"` FinalizedSlot string `json:"finalizedSlot"` FinalizedEpoch string `json:"finalizedEpoch"` FinalizedBlockRoot string `json:"finalizedBlockRoot"` JustifiedSlot string `json:"justifiedSlot"` JustifiedEpoch string `json:"justifiedEpoch"` JustifiedBlockRoot string `json:"justifiedBlockRoot"` } beaconClient := ethpb.NewBeaconChainClient(conn) ctx := context.Background() resp, err := beaconClient.GetChainHead(ctx, &empty.Empty{}) if err != nil { return err } respJSON := &chainHeadResponseJSON{} if err := doGatewayJSONRequest( "/beacon/chainhead", beaconNodeIdx, respJSON, ); err != nil { return err } if respJSON.HeadSlot != fmt.Sprintf("%d", resp.HeadSlot) { return fmt.Errorf( "HTTP gateway head slot %s does not match gRPC %d", respJSON.HeadSlot, resp.HeadSlot, ) } if respJSON.HeadEpoch != fmt.Sprintf("%d", resp.HeadEpoch) { return fmt.Errorf( "HTTP gateway head epoch %s does not match gRPC %d", respJSON.HeadEpoch, resp.HeadEpoch, ) } if respJSON.HeadBlockRoot != base64.StdEncoding.EncodeToString(resp.HeadBlockRoot) { return fmt.Errorf( "HTTP gateway head block root %s does not match gRPC %s", respJSON.HeadBlockRoot, resp.HeadBlockRoot, ) } if respJSON.FinalizedSlot != fmt.Sprintf("%d", resp.FinalizedSlot) { return fmt.Errorf( "HTTP gateway finalized slot %s does not match gRPC %d", respJSON.FinalizedSlot, resp.FinalizedSlot, ) } if respJSON.FinalizedEpoch != fmt.Sprintf("%d", resp.FinalizedEpoch) { return fmt.Errorf( "HTTP gateway finalized epoch %s does not match gRPC %d", respJSON.FinalizedEpoch, resp.FinalizedEpoch, ) } if respJSON.FinalizedBlockRoot != base64.StdEncoding.EncodeToString(resp.FinalizedBlockRoot) { return fmt.Errorf( "HTTP gateway finalized block root %s does not match gRPC %s", respJSON.FinalizedBlockRoot, resp.FinalizedBlockRoot, ) } if respJSON.JustifiedSlot != fmt.Sprintf("%d", resp.JustifiedSlot) { return fmt.Errorf( "HTTP gateway justified slot %s does not match gRPC %d", respJSON.FinalizedSlot, resp.FinalizedSlot, ) } if respJSON.JustifiedEpoch != fmt.Sprintf("%d", resp.JustifiedEpoch) { return fmt.Errorf( "HTTP gateway justified epoch %s does not match gRPC %d", respJSON.FinalizedEpoch, resp.FinalizedEpoch, ) } if respJSON.JustifiedBlockRoot != base64.StdEncoding.EncodeToString(resp.JustifiedBlockRoot) { return fmt.Errorf( "HTTP gateway justified block root %s does not match gRPC %s", respJSON.JustifiedBlockRoot, resp.JustifiedBlockRoot, ) } return nil } func doGatewayJSONRequest(requestPath string, beaconNodeIdx int, dst interface{}) error { basePath := fmt.Sprintf(v1Alpha1GatewayPathTemplate, e2e.TestParams.Ports.PrysmBeaconNodeGatewayPort+beaconNodeIdx) httpResp, err := http.Get( basePath + requestPath, ) if err != nil { return err } return json.NewDecoder(httpResp.Body).Decode(&dst) } func runAPIComparisonFunctions(beaconNodeIdx int, conn *grpc.ClientConn, fs ...apiComparisonFunc) error { for _, f := range fs { if err := f(beaconNodeIdx, conn); err != nil { return err } } return nil }