component

Documentation

Overview

Package component contains types for runtime components.

Index

• Variables
• type ID
  • func (c ID) IsRONL() bool
  • func (c ID) MarshalText() ([]byte, error)
  • func (c ID) String() string
  • func (c *ID) UnmarshalText(text []byte) error
• type Kind
• type TEEKind
  • func (tk TEEKind) String() string

Variables

var ID_RONL = ID{Kind: RONL, Name: ""} //nolint: revive

ID_RONL is the identifier of the RONL component.

Types

type ID

type ID struct {
	// Kind is the component kind.
	Kind Kind `json:"kind"`

	// Name is an optional component name.
	Name string `json:"name,omitempty"`
}

ID is a unique component identifier.

func (ID) IsRONL

func (c ID) IsRONL() bool

IsRONL returns true iff the component identifier is the special RONL component identifier.

func (ID) MarshalText

func (c ID) MarshalText() ([]byte, error)

MarshalText serializes the component identifier into text form.

func (ID) String

func (c ID) String() string

String returns a string representation of the component identifier.

func (*ID) UnmarshalText

func (c *ID) UnmarshalText(text []byte) error

UnmarshalText deserializes the component identifier from text form.

type Kind

type Kind string

Kind is the kind of a component.

const (
	// RONL is the on-chain logic component.
	RONL Kind = "ronl"
	// ROFL is the off-chain logic component.
	ROFL Kind = "rofl"
)

type TEEKind

type TEEKind uint8

TEEKind is the kind of Trusted Execution Environment (TEE) supported by the component.

const (
	TEEKindNone TEEKind = 0
	TEEKindSGX  TEEKind = 1
	TEEKindTDX  TEEKind = 2
)

func (TEEKind) String

func (tk TEEKind) String() string

String returns a string representation of the TEE kind.