feat: init command support for starknet

cmd/substreams/init.go

@@ -33,6 +33,7 @@ var (
 	devInitProtocol                = os.Getenv("SUBSTREAMS_DEV_INIT_PROTOCOL")
 	devInitEthereumTrackedContract = os.Getenv("SUBSTREAMS_DEV_INIT_ETHEREUM_TRACKED_CONTRACT")
 	devInitEthereumChain           = os.Getenv("SUBSTREAMS_DEV_INIT_ETHEREUM_CHAIN")
+	devInitStarknetChain           = os.Getenv("SUBSTREAMS_DEV_INIT_STARKNET_CHAIN")
 )
 
 var errInitUnsupportedChain = errors.New("unsupported chain")
@@ -173,6 +174,43 @@ func runSubstreamsInitE(cmd *cobra.Command, args []string) error {
 			return fmt.Errorf("render Ethereum %s project: %w", chain.DisplayName, err)
 		}
 
+	case codegen.ProtocolStarknet:
+		chainSelected, err := promptStarknetChain()
+		if err != nil {
+			return fmt.Errorf("running chain prompt: %w", err)
+		}
+		if chainSelected == codegen.StarknetChainOther {
+			fmt.Println()
+			fmt.Println("We haven't added any templates for your selected chain quite yet")
+			fmt.Println()
+			fmt.Println("Come join us in discord at https://discord.gg/u8amUbGBgF and suggest templates/chains you want to see!")
+			fmt.Println()
+			return errInitUnsupportedChain
+		}
+
+		// Since Starknet contract ABI decoding has not been implemented yet, for any chain selected we
+		// would simply generate a template that collects block information. Unlike with Ethereum,  We
+		// don't need to prompt users for any additional info here.
+
+		chain := templates.StarknetChainsByID[chainSelected.String()]
+		if chain == nil {
+			return fmt.Errorf("unknown chain: %s", chainSelected.String())
+		}
+
+		fmt.Println("Writing project files")
+		project, err := templates.NewStarknetProject(
+			projectName,
+			moduleName,
+			chain,
+		)
+		if err != nil {
+			return fmt.Errorf("new Starknet %s project: %w", chain.DisplayName, err)
+		}
+
+		if err := renderProjectFilesIn(project, absoluteProjectDir); err != nil {
+			return fmt.Errorf("render Starknet %s project: %w", chain.DisplayName, err)
+		}
+
 	case codegen.ProtocolOther:
 		fmt.Println()
 		fmt.Println("We haven't added any templates for your selected protocol quite yet")
@@ -579,6 +617,44 @@ func promptEthereumChain() (codegen.EthereumChain, error) {
 	return chain, nil
 }
 
+func promptStarknetChain() (codegen.StarknetChain, error) {
+	if devInitStarknetChain != "" {
+		// It's ok to panic, we expect the dev to put in a valid Starknet chain
+		chain, err := codegen.ParseStarknetChain(devInitStarknetChain)
+		if err != nil {
+			panic(fmt.Errorf("invalid chain: %w", err))
+		}
+
+		return chain, nil
+	}
+
+	choice := promptui.Select{
+		Label: "Select Starknet chain",
+		Items: codegen.StarknetChainNames(),
+		Templates: &promptui.SelectTemplates{
+			Selected: `{{ "Starknet chain:" | faint }} {{ . }}`,
+		},
+		HideHelp: true,
+	}
+
+	_, selection, err := choice.Run()
+	if err != nil {
+		if errors.Is(err, promptui.ErrInterrupt) {
+			// We received Ctrl-C, users wants to abort, nothing else to do, quit immediately
+			os.Exit(1)
+		}
+
+		return codegen.StarknetChainOther, fmt.Errorf("running chain prompt: %w", err)
+	}
+
+	var chain codegen.StarknetChain
+	if err := chain.UnmarshalText([]byte(selection)); err != nil {
+		panic(fmt.Errorf("impossible, selecting hard-coded value from enum itself, something is really wrong here"))
+	}
+
+	return chain, nil
+}
+
 type promptOptions struct {
 	Validate        promptui.ValidateFunc
 	IsConfirm       bool

codegen/protocol.go

@@ -5,6 +5,7 @@ package codegen
 // ENUM(
 //
 //	Ethereum
+//	Starknet
 //	Other
 //
 // )

codegen/starknet_chain.go

@@ -0,0 +1,12 @@
+package codegen
+
+//go:generate go-enum -f=$GOFILE --marshal --names --nocase
+
+// ENUM(
+//
+// Mainnet
+// Sepolia
+// Other
+//
+// )
+type StarknetChain uint

codegen/templates/starknet/.gitignore

@@ -0,0 +1,4 @@
+/build/
+/target/
+buf.gen.yaml
+*.spkg

codegen/templates/starknet/Cargo.toml.gotmpl

@@ -0,0 +1,21 @@
+[package]
+name = "{{ .name }}"
+version = "0.0.1"
+edition = "2021"
+
+[lib]
+name = "substreams"
+crate-type = ["cdylib"]
+
+[dependencies]
+prost = "0.11"
+prost-types = "0.11"
+substreams = "0.5"
+substreams-database-change = "1"
+substreams-entity-change = "1"
+substreams-starknet = "0.1"
+
+[profile.release]
+lto = true
+opt-level = 's'
+strip = "debuginfo"

codegen/templates/starknet/Makefile.gotmpl

@@ -0,0 +1,26 @@
+CARGO_VERSION := $(shell cargo version 2>/dev/null)
+
+.PHONY: build
+build:
+ifdef CARGO_VERSION
+	cargo build --target wasm32-unknown-unknown --release
+else
+	@echo "Building substreams target using Docker. To speed up this step, install a Rust development environment."
+	docker run --rm -ti --init -v ${PWD}:/usr/src --workdir /usr/src/ rust:bullseye cargo build --target wasm32-unknown-unknown --release
+endif
+
+.PHONY: run
+run: build
+	substreams run substreams.yaml $(if $(MODULE),$(MODULE),map_blocks) $(if $(START_BLOCK),-s $(START_BLOCK)) $(if $(STOP_BLOCK),-t $(STOP_BLOCK))
+
+.PHONY: gui
+gui: build
+	substreams gui substreams.yaml $(if $(MODULE),$(MODULE),map_blocks) $(if $(START_BLOCK),-s $(START_BLOCK)) $(if $(STOP_BLOCK),-t $(STOP_BLOCK))
+
+.PHONY: protogen
+protogen:
+	substreams protogen ./substreams.yaml --exclude-paths="sf/substreams,google"
+
+.PHONY: pack
+pack: build
+	substreams pack substreams.yaml

codegen/templates/starknet/proto/block.proto.gotmpl

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+import "google/protobuf/timestamp.proto";
+
+package block.v1;
+
+message Block {
+    uint64 height = 1;
+    bytes hash = 2;
+    bytes prev_hash = 3;
+    uint64 timestamp = 4;
+    uint64 tx_count = 5;
+    uint64 event_count = 6;
+}

codegen/templates/starknet/rust-toolchain.toml

@@ -0,0 +1,4 @@
+[toolchain]
+channel = "1.77"
+components = ["rustfmt"]
+targets = ["wasm32-unknown-unknown"]

codegen/templates/starknet/schema.clickhouse.sql.gotmpl

@@ -0,0 +1,8 @@
+CREATE TABLE IF NOT EXISTS block (
+    "height" INT,
+    "hash" VARCHAR(64),
+    "prev_hash" VARCHAR(64),
+    "timestamp" INT,
+    "tx_count" INT,
+    "event_count" INT
+) ENGINE = MergeTree PRIMARY KEY ("hash");

codegen/templates/starknet/schema.graphql.gotmpl

@@ -0,0 +1,8 @@
+type Block @entity {
+  id: ID!
+  height: BigInt!
+  prev_hash: Bytes!
+  timestamp: BigInt!
+  tx_count: BigInt!
+  event_count: BigInt!
+}

codegen/templates/starknet/schema.sql.gotmpl

@@ -0,0 +1,9 @@
+CREATE TABLE IF NOT EXISTS block (
+    "height" INT,
+    "hash" VARCHAR(64),
+    "prev_hash" VARCHAR(64),
+    "timestamp" INT,
+    "tx_count" INT,
+    "event_count" INT,
+    PRIMARY KEY(hash)
+);