prysm/consensus-types/payload-attribute/getters.go

package payloadattribute

import (
	consensus_types "github.com/OffchainLabs/prysm/v6/consensus-types"
	enginev1 "github.com/OffchainLabs/prysm/v6/proto/engine/v1"
	"github.com/OffchainLabs/prysm/v6/runtime/version"
)

// Version returns the version of the payload attribute.
func (a *data) Version() int {
	return a.version
}

// PrevRandao returns the previous randao value of the payload attribute.
func (a *data) PrevRandao() []byte {
	return a.prevRandao
}

// Timestamp returns the timestamp of the payload attribute.
func (a *data) Timestamp() uint64 {
	return a.timeStamp
}

// SuggestedFeeRecipient returns the suggested fee recipient of the payload attribute.
func (a *data) SuggestedFeeRecipient() []byte {
	return a.suggestedFeeRecipient
}

// Withdrawals returns the withdrawals of the payload attribute.
// Support for withdrawals was added in version 2 of the payload attribute.
func (a *data) Withdrawals() ([]*enginev1.Withdrawal, error) {
	if a == nil {
		return nil, errNilPayloadAttribute
	}
	if a.version < version.Capella {
		return nil, consensus_types.ErrNotSupported("Withdrawals", a.version)
	}
	return a.withdrawals, nil
}

func (a *data) ParentBeaconBlockRoot() ([]byte, error) {
	if len(a.parentBeaconBlockRoot) == 0 {
		return nil, errNoParentRoot
	}
	if a.version < version.Deneb {
		return nil, consensus_types.ErrNotSupported("ParentBeaconBlockRoot", a.version)
	}
	return a.parentBeaconBlockRoot, nil
}

// PbV1 returns the payload attribute in version 1.
func (a *data) PbV1() (*enginev1.PayloadAttributes, error) {
	if a == nil {
		return nil, errNilPayloadAttribute
	}
	if a.version != version.Bellatrix {
		return nil, consensus_types.ErrNotSupported("PbV1", a.version)
	}
	if a.timeStamp == 0 && len(a.prevRandao) == 0 {
		return nil, nil
	}
	return &enginev1.PayloadAttributes{
		Timestamp:             a.timeStamp,
		PrevRandao:            a.prevRandao,
		SuggestedFeeRecipient: a.suggestedFeeRecipient,
	}, nil
}

// PbV2 returns the payload attribute in version 2.
func (a *data) PbV2() (*enginev1.PayloadAttributesV2, error) {
	if a == nil {
		return nil, errNilPayloadAttribute
	}
	if a.version != version.Capella {
		return nil, consensus_types.ErrNotSupported("PbV2", a.version)
	}
	if a.timeStamp == 0 && len(a.prevRandao) == 0 {
		return nil, nil
	}
	return &enginev1.PayloadAttributesV2{
		Timestamp:             a.timeStamp,
		PrevRandao:            a.prevRandao,
		SuggestedFeeRecipient: a.suggestedFeeRecipient,
		Withdrawals:           a.withdrawals,
	}, nil
}

// PbV3 returns the payload attribute in version 3.
func (a *data) PbV3() (*enginev1.PayloadAttributesV3, error) {
	if a == nil {
		return nil, errNilPayloadAttribute
	}
	if a.version < version.Deneb {
		return nil, consensus_types.ErrNotSupported("PbV3", a.version)
	}
	if a.timeStamp == 0 && len(a.prevRandao) == 0 && len(a.parentBeaconBlockRoot) == 0 {
		return nil, nil
	}
	return &enginev1.PayloadAttributesV3{
		Timestamp:             a.timeStamp,
		PrevRandao:            a.prevRandao,
		SuggestedFeeRecipient: a.suggestedFeeRecipient,
		Withdrawals:           a.withdrawals,
		ParentBeaconBlockRoot: a.parentBeaconBlockRoot,
	}, nil
}

// IsEmpty returns whether the given payload attribute is empty
func (a *data) IsEmpty() bool {
	if a == nil {
		return true
	}
	if len(a.PrevRandao()) != 0 {
		return false
	}
	if a.Timestamp() != 0 {
		return false
	}
	if len(a.SuggestedFeeRecipient()) != 0 {
		return false
	}
	if a.Version() >= version.Capella && len(a.withdrawals) != 0 {
		return false
	}
	if a.Version() >= version.Deneb && len(a.parentBeaconBlockRoot) != 0 {
		return false
	}
	return true
}