versionedblindedbeaconblock.go

// Copyright © 2022 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

import (
	"errors"

	apiv1bellatrix "github.com/attestantio/go-eth2-client/api/v1/bellatrix"
	apiv1capella "github.com/attestantio/go-eth2-client/api/v1/capella"
	"github.com/attestantio/go-eth2-client/spec"
	"github.com/attestantio/go-eth2-client/spec/bellatrix"
	"github.com/attestantio/go-eth2-client/spec/phase0"
)

// VersionedBlindedBeaconBlock contains a versioned blinded beacon block.
type VersionedBlindedBeaconBlock struct {
	Version   spec.DataVersion
	Bellatrix *apiv1bellatrix.BlindedBeaconBlock
	Capella   *apiv1capella.BlindedBeaconBlock
}

// IsEmpty returns true if there is no block.
func (v *VersionedBlindedBeaconBlock) IsEmpty() bool {
	return v.Bellatrix == nil
}

// Slot returns the slot of the beacon block.
func (v *VersionedBlindedBeaconBlock) Slot() (phase0.Slot, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return 0, errors.New("no bellatrix block")
		}
		return v.Bellatrix.Slot, nil
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return 0, errors.New("no capella block")
		}
		return v.Capella.Slot, nil
	default:
		return 0, errors.New("unsupported version")
	}
}

// Attestations returns the attestations of the beacon block.
func (v *VersionedBlindedBeaconBlock) Attestations() ([]*phase0.Attestation, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil || v.Bellatrix.Body == nil {
			return nil, errors.New("no bellatrix block")
		}
		return v.Bellatrix.Body.Attestations, nil
	case spec.DataVersionCapella:
		if v.Capella == nil || v.Capella.Body == nil {
			return nil, errors.New("no capella block")
		}
		return v.Capella.Body.Attestations, nil
	default:
		return nil, errors.New("unsupported version")
	}
}

// Root returns the root of the beacon block.
func (v *VersionedBlindedBeaconBlock) Root() (phase0.Root, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return phase0.Root{}, errors.New("no bellatrix block")
		}
		return v.Bellatrix.HashTreeRoot()
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return phase0.Root{}, errors.New("no capella block")
		}
		return v.Capella.HashTreeRoot()
	default:
		return phase0.Root{}, errors.New("unsupported version")
	}
}

// BodyRoot returns the body root of the beacon block.
func (v *VersionedBlindedBeaconBlock) BodyRoot() (phase0.Root, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return phase0.Root{}, errors.New("no bellatrix block")
		}
		return v.Bellatrix.Body.HashTreeRoot()
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return phase0.Root{}, errors.New("no capella block")
		}
		return v.Capella.Body.HashTreeRoot()
	default:
		return phase0.Root{}, errors.New("unsupported version")
	}
}

// ParentRoot returns the parent root of the beacon block.
func (v *VersionedBlindedBeaconBlock) ParentRoot() (phase0.Root, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return phase0.Root{}, errors.New("no bellatrix block")
		}
		return v.Bellatrix.ParentRoot, nil
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return phase0.Root{}, errors.New("no capella block")
		}
		return v.Capella.ParentRoot, nil
	default:
		return phase0.Root{}, errors.New("unsupported version")
	}
}

// StateRoot returns the state root of the beacon block.
func (v *VersionedBlindedBeaconBlock) StateRoot() (phase0.Root, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return phase0.Root{}, errors.New("no bellatrix block")
		}
		return v.Bellatrix.StateRoot, nil
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return phase0.Root{}, errors.New("no capella block")
		}
		return v.Capella.StateRoot, nil
	default:
		return phase0.Root{}, errors.New("unsupported version")
	}
}

// TransactionsRoot returns the transactions root of the beacon block.
func (v *VersionedBlindedBeaconBlock) TransactionsRoot() (phase0.Root, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return phase0.Root{}, errors.New("no bellatrix block")
		}
		if v.Bellatrix.Body == nil {
			return phase0.Root{}, errors.New("no bellatrix block body")
		}
		if v.Bellatrix.Body.ExecutionPayloadHeader == nil {
			return phase0.Root{}, errors.New("no bellatrix block body execution payload header")
		}
		return v.Bellatrix.Body.ExecutionPayloadHeader.TransactionsRoot, nil
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return phase0.Root{}, errors.New("no capella block")
		}
		if v.Capella.Body == nil {
			return phase0.Root{}, errors.New("no capella block body")
		}
		if v.Capella.Body.ExecutionPayloadHeader == nil {
			return phase0.Root{}, errors.New("no capella block body execution payload header")
		}
		return v.Capella.Body.ExecutionPayloadHeader.TransactionsRoot, nil
	default:
		return phase0.Root{}, errors.New("unsupported version")
	}
}

// FeeRecipient returns the fee recipient of the blinded beacon block.
func (v *VersionedBlindedBeaconBlock) FeeRecipient() (bellatrix.ExecutionAddress, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return bellatrix.ExecutionAddress{}, errors.New("no bellatrix block")
		}
		if v.Bellatrix.Body == nil {
			return bellatrix.ExecutionAddress{}, errors.New("no bellatrix block body")
		}
		if v.Bellatrix.Body.ExecutionPayloadHeader == nil {
			return bellatrix.ExecutionAddress{}, errors.New("no bellatrix block body execution payload header")
		}
		return v.Bellatrix.Body.ExecutionPayloadHeader.FeeRecipient, nil
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return bellatrix.ExecutionAddress{}, errors.New("no capella block")
		}
		if v.Capella.Body == nil {
			return bellatrix.ExecutionAddress{}, errors.New("no capella block body")
		}
		if v.Capella.Body.ExecutionPayloadHeader == nil {
			return bellatrix.ExecutionAddress{}, errors.New("no capella block body execution payload header")
		}
		return v.Capella.Body.ExecutionPayloadHeader.FeeRecipient, nil
	default:
		return bellatrix.ExecutionAddress{}, errors.New("unsupported version")
	}
}

// Timestamp returns the timestamp of the blinded beacon block.
func (v *VersionedBlindedBeaconBlock) Timestamp() (uint64, error) {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return 0, errors.New("no bellatrix block")
		}
		if v.Bellatrix.Body == nil {
			return 0, errors.New("no bellatrix block body")
		}
		if v.Bellatrix.Body.ExecutionPayloadHeader == nil {
			return 0, errors.New("no bellatrix block body execution payload header")
		}
		return v.Bellatrix.Body.ExecutionPayloadHeader.Timestamp, nil
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return 0, errors.New("no capella block")
		}
		if v.Capella.Body == nil {
			return 0, errors.New("no capella block body")
		}
		if v.Capella.Body.ExecutionPayloadHeader == nil {
			return 0, errors.New("no capella block body execution payload header")
		}
		return v.Capella.Body.ExecutionPayloadHeader.Timestamp, nil
	default:
		return 0, errors.New("unsupported version")
	}
}

// String returns a string version of the structure.
func (v *VersionedBlindedBeaconBlock) String() string {
	switch v.Version {
	case spec.DataVersionBellatrix:
		if v.Bellatrix == nil {
			return ""
		}
		return v.Bellatrix.String()
	case spec.DataVersionCapella:
		if v.Capella == nil {
			return ""
		}
		return v.Capella.String()
	default:
		return "unknown version"
	}
}