Add artifacts command (#73)

Author: ferranbt

internal/artifacts.go

@@ -91,7 +91,7 @@ type Artifacts struct {
 }
 
 func (b *ArtifactsBuilder) Build() (*Artifacts, error) {
-	homeDir, err := getHomeDir()
+	homeDir, err := GetHomeDir()
 	if err != nil {
 		return nil, err
 	}
@@ -523,7 +523,7 @@ type sszObject interface {
 	MarshalSSZ() ([]byte, error)
 }
 
-func getHomeDir() (string, error) {
+func GetHomeDir() (string, error) {
 	homeDir, err := os.UserHomeDir()
 	if err != nil {
 		return "", fmt.Errorf("error getting user home directory: %w", err)

internal/catalog.go

@@ -0,0 +1,28 @@
+package internal
+
+var components = []Service{}
+
+func register(component Service) {
+	components = append(components, component)
+}
+
+func init() {
+	register(&OpBatcher{})
+	register(&OpGeth{})
+	register(&OpNode{})
+	register(&RethEL{})
+	register(&LighthouseBeaconNode{})
+	register(&LighthouseValidator{})
+	register(&ClProxy{})
+	register(&MevBoostRelay{})
+	register(&RollupBoost{})
+}
+
+func FindComponent(name string) Service {
+	for _, component := range components {
+		if component.Name() == name {
+			return component
+		}
+	}
+	return nil
+}

internal/components.go

@@ -28,6 +28,10 @@ func (r *RollupBoost) Run(service *service, ctx *ExContext) {
 		)
 }
 
+func (r *RollupBoost) Name() string {
+	return "rollup-boost"
+}
+
 type OpBatcher struct {
 	L1Node     string
 	L2Node     string
@@ -51,6 +55,10 @@ func (o *OpBatcher) Run(service *service, ctx *ExContext) {
 		)
 }
 
+func (o *OpBatcher) Name() string {
+	return "op-batcher"
+}
+
 type OpNode struct {
 	L1Node   string
 	L1Beacon string
@@ -90,6 +98,10 @@ func (o *OpNode) Run(service *service, ctx *ExContext) {
 		)
 }
 
+func (o *OpNode) Name() string {
+	return "op-node"
+}
+
 type OpGeth struct {
 	UseDeterministicP2PKey bool
 
@@ -159,6 +171,10 @@ func (o *OpGeth) Run(service *service, ctx *ExContext) {
 		)
 }
 
+func (o *OpGeth) Name() string {
+	return "op-geth"
+}
+
 var _ ServiceReady = &OpGeth{}
 
 func (o *OpGeth) Ready(out io.Writer, service *service, ctx context.Context) error {
@@ -262,6 +278,10 @@ func (r *RethEL) Run(svc *service, ctx *ExContext) {
 	}
 }
 
+func (r *RethEL) Name() string {
+	return "reth"
+}
+
 var _ ServiceWatchdog = &RethEL{}
 
 func (r *RethEL) Watchdog(out io.Writer, service *service, ctx context.Context) error {
@@ -318,6 +338,10 @@ func (l *LighthouseBeaconNode) Run(svc *service, ctx *ExContext) {
 	}
 }
 
+func (l *LighthouseBeaconNode) Name() string {
+	return "lighthouse-beacon-node"
+}
+
 var _ ServiceReady = &LighthouseBeaconNode{}
 
 func (l *LighthouseBeaconNode) Ready(logOutput io.Writer, service *service, ctx context.Context) error {
@@ -351,6 +375,10 @@ func (l *LighthouseValidator) Run(service *service, ctx *ExContext) {
 		)
 }
 
+func (l *LighthouseValidator) Name() string {
+	return "lighthouse-validator"
+}
+
 type ClProxy struct {
 	PrimaryBuilder   string
 	SecondaryBuilder string
@@ -368,6 +396,10 @@ func (c *ClProxy) Run(service *service, ctx *ExContext) {
 		)
 }
 
+func (c *ClProxy) Name() string {
+	return "cl-proxy"
+}
+
 type MevBoostRelay struct {
 	BeaconClient     string
 	ValidationServer string
@@ -389,6 +421,10 @@ func (m *MevBoostRelay) Run(service *service, ctx *ExContext) {
 	}
 }
 
+func (m *MevBoostRelay) Name() string {
+	return "mev-boost-relay"
+}
+
 var _ ServiceWatchdog = &MevBoostRelay{}
 
 func (m *MevBoostRelay) Watchdog(out io.Writer, service *service, ctx context.Context) error {

internal/manifest.go

@@ -77,6 +77,7 @@ type ExContext struct {
 
 type Service interface {
 	Run(service *service, ctx *ExContext)
+	Name() string
 }
 
 type ServiceReady interface {
@@ -213,7 +214,7 @@ func (s *Manifest) Validate() error {
 				return fmt.Errorf("service '%s' must implement the ReleaseService interface", ss.Name)
 			}
 			releaseArtifact := releaseService.ReleaseArtifact()
-			bin, err := downloadRelease(s.out.homeDir, releaseArtifact)
+			bin, err := DownloadRelease(s.out.homeDir, releaseArtifact)
 			if err != nil {
 				return fmt.Errorf("failed to download release artifact for service '%s': %w", ss.Name, err)
 			}

internal/releases.go

@@ -20,7 +20,7 @@ type release struct {
 	Arch    func(string, string) string
 }
 
-func downloadRelease(outputFolder string, artifact *release) (string, error) {
+func DownloadRelease(outputFolder string, artifact *release) (string, error) {
 	goos := runtime.GOOS
 	goarch := runtime.GOARCH
 

main.go

@@ -45,6 +45,39 @@ var cookCmd = &cobra.Command{
 	},
 }
 
+var artifactsCmd = &cobra.Command{
+	Use:   "artifacts",
+	Short: "List available artifacts",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return fmt.Errorf("please specify a service name")
+		}
+		serviceName := args[0]
+		component := internal.FindComponent(serviceName)
+		if component == nil {
+			return fmt.Errorf("service %s not found", serviceName)
+		}
+		releaseService, ok := component.(internal.ReleaseService)
+		if !ok {
+			return fmt.Errorf("service %s is not a release service", serviceName)
+		}
+		output := outputFlag
+		if output == "" {
+			homeDir, err := internal.GetHomeDir()
+			if err != nil {
+				return fmt.Errorf("failed to get home directory: %w", err)
+			}
+			output = homeDir
+		}
+		location, err := internal.DownloadRelease(output, releaseService.ReleaseArtifact())
+		if err != nil {
+			return fmt.Errorf("failed to download release: %w", err)
+		}
+		fmt.Println(location)
+		return nil
+	},
+}
+
 var recipes = []internal.Recipe{
 	&internal.L1Recipe{},
 	&internal.OpRecipe{},
@@ -75,7 +108,12 @@ func main() {
 		cookCmd.AddCommand(recipeCmd)
 	}
 
+	// reuse the same output flag for the artifacts command
+	artifactsCmd.Flags().StringVar(&outputFlag, "output", "", "Output folder for the artifacts")
+
 	rootCmd.AddCommand(cookCmd)
+	rootCmd.AddCommand(artifactsCmd)
+
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)
 		os.Exit(1)