Major refactor, listing important pieces:

- Conversation has now a generic type constraint on ConversationState, so some common state can be shared (this breaks the fact that converation should be agnostic, but make the overall work within codegen easier by sharing lot's of logic)
- Added a BaseConversationState that everyone can embedded to gain much of the standard state management needed for a new codegen
- Added Pre & Post shared flow that can be used by the various codegen
- Improved sink choice flow to report instructions within the standard finish instructions
- Improved Docker compose file render, now added to project standard files
- UserLocalFile can now report the error that happened on the client, if any
- Fixed a bunch of Rust warnings in generated code
- Fixed NEAR hello world to actually work
- Fixed Starknet Events to compile properly
- Move integration to use testcontainers for easier Docker management

Author: maoueh

.github/workflows/main.yaml

@@ -54,8 +54,8 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Run Tests
-        run: go test -v ./... -timeout 1800s
-
       - name: Build
         run: go build ./...
+
+      - name: Run Tests
+        run: go test -v ./... -timeout 1800s

README.md

@@ -16,6 +16,18 @@ Install reflex `go install github.com/cespare/reflex@latest` and do
 reflex -c .reflex
 ```
 
+### Integration Tests
+
+Requires Docker, simply do:
+
+```
+RUN_INTEGRATION_TESTS=true INTEGRATION_TESTS_IN_DOCKER=true go test ./tests -v -parallel 6
+```
+
+You can try with higher value for parallel (controls how many tests runs in parallel). I had errors with the default value (`GOMAXPROCS`) and changing it to `-parallel 6` made it work properly.
+
+It's possible to set `INTEGRATION_TESTS_IN_DOCKER=false` to run the tests on your machine directly, less recommended because this is not how the GitHub CI is configured, but should has a faster runtime.
+
 ## Principles
 
 You write a `Conversation` (or `Convo` for short) struct.

base/state.go base_state.gobase/state.go renamed to base_state.go

@@ -1,42 +1,66 @@
-package base
+package codegen
 
 import (
 	"strings"
 
 	registry "github.com/pinax-network/graph-networks-libs/packages/golang/lib"
 	networks "github.com/streamingfast/firehose-networks"
-	codegen "github.com/streamingfast/substreams-codegen"
 )
 
-var _ codegen.ConversationState = (*ConversationState)(nil)
+var _ ConversationState = (*BaseConversationState)(nil)
 
 // ConversationState implements common fields to implement the ConversationState interface
-type ConversationState struct {
+type BaseConversationState struct {
 	Name string `json:"name"`
 	// ChainName while named with `name` does contain actually the network registry chain ID.
 	ChainName string `json:"chainName"`
+
+	// SubstreamsSinkChoice holds the user's choice of Substreams sink.
+	SubstreamsSinkChoice *SubstreamsSinkChoice `json:"substreamsSinkChoice,omitempty"`
+}
+
+func (p *BaseConversationState) GetSubstreamsSinkChoice() *SubstreamsSinkChoice {
+	return p.SubstreamsSinkChoice
 }
 
-func (p *ConversationState) IsValidChainInput(input string) bool {
-	return networks.GetSubstreamsRegistry().Has(input)
+func (p *BaseConversationState) SetSubstreamsSinkChoice(choice SubstreamsSinkChoice) {
+	p.SubstreamsSinkChoice = &choice
 }
 
 // GetChainName implements codegen.ConversationState.
-func (p *ConversationState) GetChainName() string {
+func (p *BaseConversationState) GetChainName() string {
 	return p.ChainName
 }
 
+// SetChainName implements codegen.ConversationState.
+func (p *BaseConversationState) SetChainName(name string) {
+	p.ChainName = name
+}
+
+// SetProjectName implements ConversationState.
+func (p *BaseConversationState) SetProjectName(name string) {
+	p.Name = name
+}
+
 // GetModuleName implements codegen.ConversationState.
-func (p *ConversationState) GetModuleName() string {
+func (p *BaseConversationState) GetModuleName() string {
 	return strings.ReplaceAll(p.Name, "-", "_")
 }
 
+// Generate implements codegen.ConversationState, generate nothing by defaults for now.
+func (p *BaseConversationState) Generate() ReturnGenerate {
+	return ReturnGenerate{
+		Err:          nil,
+		ProjectFiles: make(map[string][]byte, 0),
+	}
+}
+
 // GetChainNetwork is a legacy name used in templates that returns the Substreams
 // value that should be put in the `network` field of the `substreams.yaml` file.
 // It uses the ChainName field to lookup the network in the registry and return
 // its FullName. If ChainName is empty or the config cannot be found, an empty
 // string is returned.
-func (p *ConversationState) GetChainNetwork() string {
+func (p *BaseConversationState) GetChainNetwork() string {
 	if network := p.FindNetworkFromChainName(); network != nil {
 		return network.ID
 	}
@@ -46,17 +70,21 @@ func (p *ConversationState) GetChainNetwork() string {
 // GetChainNetwork returns the chain config from the registry based on the ChainName field.
 // If ChainName is empty, nil is returned right away, otherwise it attempts to find the config
 // in the registry by doing `networks.GetSubstreamsRegistry().Find(p.ChainName)`.
-func (p *ConversationState) FindNetworkFromChainName() *registry.Network {
+func (p *BaseConversationState) FindNetworkFromChainName() *registry.Network {
 	if p.ChainName == "" {
 		return nil
 	}
 
 	return networks.GetSubstreamsRegistry().Find(p.ChainName)
 }
 
+func (p *BaseConversationState) GetChainDisplayName() string {
+	return p.ChainDisplayName()
+}
+
 // ChainDisplayName returns the display name of the chain from the registry based on the ChainName field.
 // If ChainName is empty or the config cannot be found, an empty string is returned.
-func (p *ConversationState) ChainDisplayName() string {
+func (p *BaseConversationState) ChainDisplayName() string {
 	if network := p.FindNetworkFromChainName(); network != nil {
 		return network.FullName
 	}
@@ -65,7 +93,7 @@ func (p *ConversationState) ChainDisplayName() string {
 
 // ChainExplorerLink returns the explorer link of the chain from the registry based on the ChainName field.
 // If ChainName is empty or the config cannot be found, an empty string is returned.
-func (p *ConversationState) ChainExplorerLink() string {
+func (p *BaseConversationState) ChainExplorerLink() string {
 	if network := p.FindNetworkFromChainName(); network != nil && len(network.ExplorerUrls) > 0 {
 		return network.ExplorerUrls[0]
 	}
@@ -74,9 +102,13 @@ func (p *ConversationState) ChainExplorerLink() string {
 }
 
 // IsChainTestnet returns true if the chain is a testnet according to the registry information.
-func (p *ConversationState) IsChainTestnet() bool {
+func (p *BaseConversationState) IsChainTestnet() bool {
 	if network := p.FindNetworkFromChainName(); network != nil {
 		return network.NetworkType == registry.Testnet
 	}
 	return false
 }
+
+func (c *BaseConversationState) IsValidChainInput(input string) bool {
+	return networks.GetSubstreamsRegistry().Find(input) != nil
+}

chains/filter.go

@@ -0,0 +1,40 @@
+package chains
+
+import (
+	"regexp"
+
+	registry "github.com/pinax-network/graph-networks-libs/packages/golang/lib"
+	networks "github.com/streamingfast/firehose-networks"
+)
+
+var solanaNetworkRegexp = regexp.MustCompile(`^solana`)
+var nearNetworkRegexp = regexp.MustCompile(`^near`)
+var tronNetworkRegexp = regexp.MustCompile(`^tron`)
+var stellarNetworkRegexp = regexp.MustCompile(`^stellar`)
+
+func SolanaNetworks() []*registry.Network {
+	return excludeSolanaAccounts(networks.GetSubstreamsRegistry().Search(solanaNetworkRegexp))
+}
+
+func NearNetworks() []*registry.Network {
+	return networks.GetSubstreamsRegistry().Search(nearNetworkRegexp)
+}
+
+func TronNetworks() []*registry.Network {
+	return networks.GetSubstreamsRegistry().Search(tronNetworkRegexp)
+}
+
+func StellarNetworks() []*registry.Network {
+	return networks.GetSubstreamsRegistry().Search(stellarNetworkRegexp)
+}
+
+func excludeSolanaAccounts(networks []*registry.Network) []*registry.Network {
+	var filteredNetworks []*registry.Network
+	for _, net := range networks {
+		if net.ID == "solana-accounts" {
+			continue
+		}
+		filteredNetworks = append(filteredNetworks, net)
+	}
+	return filteredNetworks
+}