add module graph

Author: jmank88

Makefile

@@ -124,8 +124,13 @@ mockery: $(mockery) ## Install mockery.
 rm-mocked:
 	grep -rl "^// Code generated by mockery" | grep .go$ | xargs -r rm
 
+.PHONY: modgraph
+modgraph:
+	go install github.com/jmank88/[email protected]
+	./scripts/modgraph.sh > go.md
+
 .PHONY: generate
-generate: mockery gomods
+generate: mockery gomods modgraph
 	gomods -w go generate -x ./...
 	mockery
 

go.md

@@ -0,0 +1,328 @@
+# smartcontractkit Go modules
+## Main module
+```mermaid
+flowchart LR
+
+	chain-selectors
+	click chain-selectors href "https://github.com/smartcontractkit/chain-selectors"
+	chainlink-ccip --> chainlink-common
+	chainlink-ccip --> chainlink-protos/rmn/v1.6/go
+	click chainlink-ccip href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana --> chainlink-ccip
+	click chainlink-ccip/chains/solana href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana/gobindings
+	click chainlink-ccip/chains/solana/gobindings href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-common --> chain-selectors
+	chainlink-common --> chainlink-common/pkg/chipingress
+	chainlink-common --> chainlink-protos/billing/go
+	chainlink-common --> chainlink-protos/cre/go
+	chainlink-common --> chainlink-protos/storage-service
+	chainlink-common --> chainlink-protos/workflows/go
+	chainlink-common --> freeport
+	chainlink-common --> grpc-proxy
+	chainlink-common --> libocr
+	click chainlink-common href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/chipingress
+	click chainlink-common/pkg/chipingress href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/monitoring --> chainlink-common
+	click chainlink-common/pkg/monitoring href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-framework/capabilities --> chainlink-common
+	click chainlink-framework/capabilities href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-framework/metrics --> chainlink-common
+	click chainlink-framework/metrics href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-framework/multinode --> chainlink-framework/metrics
+	click chainlink-framework/multinode href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-protos/billing/go
+	click chainlink-protos/billing/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/cre/go
+	click chainlink-protos/cre/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/rmn/v1.6/go
+	click chainlink-protos/rmn/v1.6/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/storage-service
+	click chainlink-protos/storage-service href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/workflows/go
+	click chainlink-protos/workflows/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-solana --> chainlink-ccip/chains/solana
+	chainlink-solana --> chainlink-ccip/chains/solana/gobindings
+	chainlink-solana --> chainlink-common/pkg/monitoring
+	chainlink-solana --> chainlink-framework/capabilities
+	chainlink-solana --> chainlink-framework/multinode
+	click chainlink-solana href "https://github.com/smartcontractkit/chainlink-solana"
+	freeport
+	click freeport href "https://github.com/smartcontractkit/freeport"
+	grpc-proxy
+	click grpc-proxy href "https://github.com/smartcontractkit/grpc-proxy"
+	libocr
+	click libocr href "https://github.com/smartcontractkit/libocr"
+
+	subgraph chainlink-ccip-repo[chainlink-ccip]
+		 chainlink-ccip
+		 chainlink-ccip/chains/solana
+		 chainlink-ccip/chains/solana/gobindings
+	end
+	click chainlink-ccip-repo href "https://github.com/smartcontractkit/chainlink-ccip"
+
+	subgraph chainlink-common-repo[chainlink-common]
+		 chainlink-common
+		 chainlink-common/pkg/chipingress
+		 chainlink-common/pkg/monitoring
+	end
+	click chainlink-common-repo href "https://github.com/smartcontractkit/chainlink-common"
+
+	subgraph chainlink-framework-repo[chainlink-framework]
+		 chainlink-framework/capabilities
+		 chainlink-framework/metrics
+		 chainlink-framework/multinode
+	end
+	click chainlink-framework-repo href "https://github.com/smartcontractkit/chainlink-framework"
+
+	subgraph chainlink-protos-repo[chainlink-protos]
+		 chainlink-protos/billing/go
+		 chainlink-protos/cre/go
+		 chainlink-protos/rmn/v1.6/go
+		 chainlink-protos/storage-service
+		 chainlink-protos/workflows/go
+	end
+	click chainlink-protos-repo href "https://github.com/smartcontractkit/chainlink-protos"
+
+	classDef outline stroke-dasharray:6,fill:none;
+	class chainlink-ccip-repo,chainlink-common-repo,chainlink-framework-repo,chainlink-protos-repo outline
+```
+## All modules
+```mermaid
+flowchart LR
+
+	ccip-owner-contracts
+	click ccip-owner-contracts href "https://github.com/smartcontractkit/ccip-owner-contracts"
+	chain-selectors
+	click chain-selectors href "https://github.com/smartcontractkit/chain-selectors"
+	chainlink-aptos --> chainlink-common
+	click chainlink-aptos href "https://github.com/smartcontractkit/chainlink-aptos"
+	chainlink-automation --> chainlink-common
+	click chainlink-automation href "https://github.com/smartcontractkit/chainlink-automation"
+	chainlink-ccip --> chainlink-common
+	chainlink-ccip --> chainlink-common/pkg/values
+	chainlink-ccip --> chainlink-protos/rmn/v1.6/go
+	click chainlink-ccip href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana --> chainlink-ccip
+	chainlink-ccip/chains/solana --> chainlink-ccip/chains/solana/gobindings
+	click chainlink-ccip/chains/solana href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-ccip/chains/solana/gobindings
+	click chainlink-ccip/chains/solana/gobindings href "https://github.com/smartcontractkit/chainlink-ccip"
+	chainlink-common --> chain-selectors
+	chainlink-common --> chainlink-common/pkg/chipingress
+	chainlink-common --> chainlink-protos/billing/go
+	chainlink-common --> chainlink-protos/cre/go
+	chainlink-common --> chainlink-protos/storage-service
+	chainlink-common --> freeport
+	chainlink-common --> grpc-proxy
+	chainlink-common --> libocr
+	click chainlink-common href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/chipingress
+	click chainlink-common/pkg/chipingress href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/monitoring --> chainlink-common
+	click chainlink-common/pkg/monitoring href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-common/pkg/values
+	click chainlink-common/pkg/values href "https://github.com/smartcontractkit/chainlink-common"
+	chainlink-data-streams --> chainlink-common
+	click chainlink-data-streams href "https://github.com/smartcontractkit/chainlink-data-streams"
+	chainlink-deployments-framework --> chainlink-evm/gethwrappers
+	chainlink-deployments-framework --> chainlink-protos/chainlink-catalog
+	chainlink-deployments-framework --> chainlink-protos/job-distributor
+	chainlink-deployments-framework --> chainlink-testing-framework/seth
+	chainlink-deployments-framework --> chainlink-tron/relayer
+	chainlink-deployments-framework --> mcms
+	click chainlink-deployments-framework href "https://github.com/smartcontractkit/chainlink-deployments-framework"
+	chainlink-evm --> chainlink-evm/gethwrappers
+	chainlink-evm --> chainlink-framework/capabilities
+	chainlink-evm --> chainlink-framework/chains
+	chainlink-evm --> chainlink-protos/svr
+	chainlink-evm --> chainlink-tron/relayer
+	click chainlink-evm href "https://github.com/smartcontractkit/chainlink-evm"
+	chainlink-evm/gethwrappers
+	click chainlink-evm/gethwrappers href "https://github.com/smartcontractkit/chainlink-evm"
+	chainlink-feeds --> chainlink-common
+	click chainlink-feeds href "https://github.com/smartcontractkit/chainlink-feeds"
+	chainlink-framework/capabilities --> chainlink-common
+	click chainlink-framework/capabilities href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-framework/chains --> chainlink-framework/multinode
+	click chainlink-framework/chains href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-framework/metrics --> chainlink-common
+	click chainlink-framework/metrics href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-framework/multinode --> chainlink-framework/metrics
+	click chainlink-framework/multinode href "https://github.com/smartcontractkit/chainlink-framework"
+	chainlink-protos/billing/go --> chainlink-protos/workflows/go
+	click chainlink-protos/billing/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/chainlink-catalog
+	click chainlink-protos/chainlink-catalog href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/cre/go
+	click chainlink-protos/cre/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/job-distributor
+	click chainlink-protos/job-distributor href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/orchestrator --> wsrpc
+	click chainlink-protos/orchestrator href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/rmn/v1.6/go
+	click chainlink-protos/rmn/v1.6/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/storage-service
+	click chainlink-protos/storage-service href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/svr
+	click chainlink-protos/svr href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-protos/workflows/go
+	click chainlink-protos/workflows/go href "https://github.com/smartcontractkit/chainlink-protos"
+	chainlink-solana --> chainlink-ccip/chains/solana
+	chainlink-solana --> chainlink-common/pkg/monitoring
+	chainlink-solana --> chainlink-framework/capabilities
+	chainlink-solana --> chainlink-framework/multinode
+	click chainlink-solana href "https://github.com/smartcontractkit/chainlink-solana"
+	chainlink-solana/integration-tests --> chainlink/integration-tests
+	click chainlink-solana/integration-tests href "https://github.com/smartcontractkit/chainlink-solana"
+	chainlink-testing-framework/framework
+	click chainlink-testing-framework/framework href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/havoc
+	click chainlink-testing-framework/havoc href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/lib --> chainlink-testing-framework/parrot
+	chainlink-testing-framework/lib --> chainlink-testing-framework/seth
+	click chainlink-testing-framework/lib href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/lib/grafana
+	click chainlink-testing-framework/lib/grafana href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/parrot
+	click chainlink-testing-framework/parrot href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/sentinel
+	click chainlink-testing-framework/sentinel href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/seth
+	click chainlink-testing-framework/seth href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-testing-framework/wasp
+	click chainlink-testing-framework/wasp href "https://github.com/smartcontractkit/chainlink-testing-framework"
+	chainlink-tron/relayer --> chainlink-common
+	chainlink-tron/relayer --> chainlink-common/pkg/values
+	click chainlink-tron/relayer href "https://github.com/smartcontractkit/chainlink-tron"
+	chainlink/deployment --> ccip-owner-contracts
+	chainlink/deployment --> chainlink-deployments-framework
+	chainlink/deployment --> chainlink-testing-framework/lib
+	chainlink/deployment --> chainlink/v2
+	click chainlink/deployment href "https://github.com/smartcontractkit/chainlink"
+	chainlink/integration-tests --> chainlink-testing-framework/havoc
+	chainlink/integration-tests --> chainlink-testing-framework/lib/grafana
+	chainlink/integration-tests --> chainlink-testing-framework/sentinel
+	chainlink/integration-tests --> chainlink-testing-framework/wasp
+	chainlink/integration-tests --> chainlink/deployment
+	click chainlink/integration-tests href "https://github.com/smartcontractkit/chainlink"
+	chainlink/v2 --> chainlink-aptos
+	chainlink/v2 --> chainlink-automation
+	chainlink/v2 --> chainlink-data-streams
+	chainlink/v2 --> chainlink-evm
+	chainlink/v2 --> chainlink-feeds
+	chainlink/v2 --> chainlink-protos/orchestrator
+	chainlink/v2 --> chainlink-solana
+	chainlink/v2 --> cre-sdk-go
+	chainlink/v2 --> cre-sdk-go/capabilities/networking/http
+	chainlink/v2 --> cre-sdk-go/capabilities/scheduler/cron
+	chainlink/v2 --> tdh2/go/ocr2/decryptionplugin
+	click chainlink/v2 href "https://github.com/smartcontractkit/chainlink"
+	cre-sdk-go
+	click cre-sdk-go href "https://github.com/smartcontractkit/cre-sdk-go"
+	cre-sdk-go/capabilities/networking/http
+	click cre-sdk-go/capabilities/networking/http href "https://github.com/smartcontractkit/cre-sdk-go"
+	cre-sdk-go/capabilities/scheduler/cron
+	click cre-sdk-go/capabilities/scheduler/cron href "https://github.com/smartcontractkit/cre-sdk-go"
+	freeport
+	click freeport href "https://github.com/smartcontractkit/freeport"
+	grpc-proxy
+	click grpc-proxy href "https://github.com/smartcontractkit/grpc-proxy"
+	libocr
+	click libocr href "https://github.com/smartcontractkit/libocr"
+	mcms --> chainlink-aptos
+	mcms --> chainlink-ccip/chains/solana
+	mcms --> chainlink-testing-framework/framework
+	click mcms href "https://github.com/smartcontractkit/mcms"
+	tdh2/go/ocr2/decryptionplugin --> libocr
+	tdh2/go/ocr2/decryptionplugin --> tdh2/go/tdh2
+	click tdh2/go/ocr2/decryptionplugin href "https://github.com/smartcontractkit/tdh2"
+	tdh2/go/tdh2
+	click tdh2/go/tdh2 href "https://github.com/smartcontractkit/tdh2"
+	wsrpc
+	click wsrpc href "https://github.com/smartcontractkit/wsrpc"
+
+	subgraph chainlink-repo[chainlink]
+		 chainlink/deployment
+		 chainlink/integration-tests
+		 chainlink/v2
+	end
+	click chainlink-repo href "https://github.com/smartcontractkit/chainlink"
+
+	subgraph chainlink-ccip-repo[chainlink-ccip]
+		 chainlink-ccip
+		 chainlink-ccip/chains/solana
+		 chainlink-ccip/chains/solana/gobindings
+	end
+	click chainlink-ccip-repo href "https://github.com/smartcontractkit/chainlink-ccip"
+
+	subgraph chainlink-common-repo[chainlink-common]
+		 chainlink-common
+		 chainlink-common/pkg/chipingress
+		 chainlink-common/pkg/monitoring
+		 chainlink-common/pkg/values
+	end
+	click chainlink-common-repo href "https://github.com/smartcontractkit/chainlink-common"
+
+	subgraph chainlink-evm-repo[chainlink-evm]
+		 chainlink-evm
+		 chainlink-evm/gethwrappers
+	end
+	click chainlink-evm-repo href "https://github.com/smartcontractkit/chainlink-evm"
+
+	subgraph chainlink-framework-repo[chainlink-framework]
+		 chainlink-framework/capabilities
+		 chainlink-framework/chains
+		 chainlink-framework/metrics
+		 chainlink-framework/multinode
+	end
+	click chainlink-framework-repo href "https://github.com/smartcontractkit/chainlink-framework"
+
+	subgraph chainlink-protos-repo[chainlink-protos]
+		 chainlink-protos/billing/go
+		 chainlink-protos/chainlink-catalog
+		 chainlink-protos/cre/go
+		 chainlink-protos/job-distributor
+		 chainlink-protos/orchestrator
+		 chainlink-protos/rmn/v1.6/go
+		 chainlink-protos/storage-service
+		 chainlink-protos/svr
+		 chainlink-protos/workflows/go
+	end
+	click chainlink-protos-repo href "https://github.com/smartcontractkit/chainlink-protos"
+
+	subgraph chainlink-solana-repo[chainlink-solana]
+		 chainlink-solana
+		 chainlink-solana/integration-tests
+	end
+	click chainlink-solana-repo href "https://github.com/smartcontractkit/chainlink-solana"
+
+	subgraph chainlink-testing-framework-repo[chainlink-testing-framework]
+		 chainlink-testing-framework/framework
+		 chainlink-testing-framework/havoc
+		 chainlink-testing-framework/lib
+		 chainlink-testing-framework/lib/grafana
+		 chainlink-testing-framework/parrot
+		 chainlink-testing-framework/sentinel
+		 chainlink-testing-framework/seth
+		 chainlink-testing-framework/wasp
+	end
+	click chainlink-testing-framework-repo href "https://github.com/smartcontractkit/chainlink-testing-framework"
+
+	subgraph cre-sdk-go-repo[cre-sdk-go]
+		 cre-sdk-go
+		 cre-sdk-go/capabilities/networking/http
+		 cre-sdk-go/capabilities/scheduler/cron
+	end
+	click cre-sdk-go-repo href "https://github.com/smartcontractkit/cre-sdk-go"
+
+	subgraph tdh2-repo[tdh2]
+		 tdh2/go/ocr2/decryptionplugin
+		 tdh2/go/tdh2
+	end
+	click tdh2-repo href "https://github.com/smartcontractkit/tdh2"
+
+	classDef outline stroke-dasharray:6,fill:none;
+	class chainlink-repo,chainlink-ccip-repo,chainlink-common-repo,chainlink-evm-repo,chainlink-framework-repo,chainlink-protos-repo,chainlink-solana-repo,chainlink-testing-framework-repo,cre-sdk-go-repo,tdh2-repo outline
+```

scripts/modgraph.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Generates go.md
+
+set -e
+
+echo "# smartcontractkit Go modules
+## Main module
+\`\`\`mermaid
+flowchart LR
+"
+go mod graph | modgraph -prefix github.com/smartcontractkit/
+echo "\`\`\`"
+
+echo "## All modules
+\`\`\`mermaid
+flowchart LR
+"
+gomods graph | modgraph -prefix github.com/smartcontractkit/
+echo "\`\`\`"