Skip to content

add go.md #978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jmank88 wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

add go.md #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
320 changes: 320 additions & 0 deletions go.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
# smartcontractkit Go modules
## Main module
```mermaid
flowchart LR

ccip-contract-examples/chains/evm
click ccip-contract-examples/chains/evm href "https://github.com/smartcontractkit/ccip-contract-examples"
ccip-owner-contracts --> chain-selectors
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-ccip
click chainlink-ccip href "https://github.com/smartcontractkit/chainlink-ccip"
chainlink-ccip/chains/evm --> ccip-contract-examples/chains/evm
chainlink-ccip/chains/evm --> chainlink-ccip/deployment
chainlink-ccip/chains/evm --> chainlink-deployments-framework
chainlink-ccip/chains/evm --> chainlink-evm
chainlink-ccip/chains/evm --> chainlink-evm/gethwrappers
chainlink-ccip/chains/evm --> chainlink-evm/gethwrappers/helpers
click chainlink-ccip/chains/evm href "https://github.com/smartcontractkit/chainlink-ccip"
chainlink-ccip/chains/solana --> chainlink-ccip
chainlink-ccip/chains/solana --> chainlink-ccip/chains/solana/gobindings
chainlink-ccip/chains/solana --> chainlink-common
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-ccip/deployment
click chainlink-ccip/deployment href "https://github.com/smartcontractkit/chainlink-ccip"
chainlink-common --> chainlink-common/pkg/chipingress
chainlink-common --> chainlink-protos/billing/go
chainlink-common --> chainlink-protos/cre/go
chainlink-common --> chainlink-protos/linking-service/go
chainlink-common --> chainlink-protos/node-platform
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
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-deployments-framework --> ccip-owner-contracts
chainlink-deployments-framework --> chainlink-ccip/chains/evm
chainlink-deployments-framework --> chainlink-protos/job-distributor
chainlink-deployments-framework --> chainlink-protos/op-catalog
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
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-evm/gethwrappers/helpers
click chainlink-evm/gethwrappers/helpers href "https://github.com/smartcontractkit/chainlink-evm"
chainlink-framework/metrics
click chainlink-framework/metrics 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 --> chain-selectors
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/linking-service/go
click chainlink-protos/linking-service/go href "https://github.com/smartcontractkit/chainlink-protos"
chainlink-protos/node-platform
click chainlink-protos/node-platform href "https://github.com/smartcontractkit/chainlink-protos"
chainlink-protos/op-catalog
click chainlink-protos/op-catalog 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-sui --> chainlink-aptos
chainlink-sui --> chainlink-ccip
click chainlink-sui href "https://github.com/smartcontractkit/chainlink-sui"
chainlink-testing-framework/framework --> chainlink-testing-framework/lib/grafana
chainlink-testing-framework/framework --> chainlink-testing-framework/wasp
click chainlink-testing-framework/framework 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/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-ton --> chainlink-ccip
chainlink-ton --> chainlink-common
chainlink-ton --> chainlink-common/pkg/monitoring
chainlink-ton --> chainlink-framework/metrics
click chainlink-ton href "https://github.com/smartcontractkit/chainlink-ton"
chainlink-tron/relayer --> chainlink-common
chainlink-tron/relayer --> chainlink-common/pkg/values
click chainlink-tron/relayer href "https://github.com/smartcontractkit/chainlink-tron"
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-ccip/chains/solana
mcms --> chainlink-sui
mcms --> chainlink-testing-framework/framework
mcms --> chainlink-ton
click mcms href "https://github.com/smartcontractkit/mcms"

subgraph chainlink-ccip-repo[chainlink-ccip]
chainlink-ccip
chainlink-ccip/chains/evm
chainlink-ccip/chains/solana
chainlink-ccip/chains/solana/gobindings
chainlink-ccip/deployment
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
chainlink-evm/gethwrappers/helpers
end
click chainlink-evm-repo href "https://github.com/smartcontractkit/chainlink-evm"

subgraph chainlink-protos-repo[chainlink-protos]
chainlink-protos/billing/go
chainlink-protos/cre/go
chainlink-protos/job-distributor
chainlink-protos/linking-service/go
chainlink-protos/node-platform
chainlink-protos/op-catalog
chainlink-protos/storage-service
chainlink-protos/workflows/go
end
click chainlink-protos-repo href "https://github.com/smartcontractkit/chainlink-protos"

subgraph chainlink-testing-framework-repo[chainlink-testing-framework]
chainlink-testing-framework/framework
chainlink-testing-framework/lib/grafana
chainlink-testing-framework/seth
chainlink-testing-framework/wasp
end
click chainlink-testing-framework-repo href "https://github.com/smartcontractkit/chainlink-testing-framework"

classDef outline stroke-dasharray:6,fill:none;
class chainlink-ccip-repo,chainlink-common-repo,chainlink-evm-repo,chainlink-protos-repo,chainlink-testing-framework-repo outline
```
## All modules
```mermaid
flowchart LR

ccip-contract-examples/chains/evm
click ccip-contract-examples/chains/evm href "https://github.com/smartcontractkit/ccip-contract-examples"
ccip-owner-contracts --> chain-selectors
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-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/evm --> ccip-contract-examples/chains/evm
chainlink-ccip/chains/evm --> chainlink-ccip/deployment
chainlink-ccip/chains/evm --> chainlink-deployments-framework
chainlink-ccip/chains/evm --> chainlink-evm
chainlink-ccip/chains/evm --> chainlink-evm/gethwrappers
chainlink-ccip/chains/evm --> chainlink-evm/gethwrappers/helpers
click chainlink-ccip/chains/evm 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-ccip/deployment
click chainlink-ccip/deployment href "https://github.com/smartcontractkit/chainlink-ccip"
chainlink-common --> chainlink-common/pkg/chipingress
chainlink-common --> chainlink-protos/billing/go
chainlink-common --> chainlink-protos/cre/go
chainlink-common --> chainlink-protos/linking-service/go
chainlink-common --> chainlink-protos/node-platform
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
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-deployments-framework --> ccip-owner-contracts
chainlink-deployments-framework --> chainlink-ccip/chains/evm
chainlink-deployments-framework --> chainlink-protos/job-distributor
chainlink-deployments-framework --> chainlink-protos/op-catalog
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-deployments/domains/testdomain --> chainlink-deployments-framework
click chainlink-deployments/domains/testdomain href "https://github.com/smartcontractkit/chainlink-deployments"
chainlink-evm
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-evm/gethwrappers/helpers
click chainlink-evm/gethwrappers/helpers href "https://github.com/smartcontractkit/chainlink-evm"
chainlink-framework/metrics
click chainlink-framework/metrics 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 --> chain-selectors
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/linking-service/go
click chainlink-protos/linking-service/go href "https://github.com/smartcontractkit/chainlink-protos"
chainlink-protos/node-platform
click chainlink-protos/node-platform href "https://github.com/smartcontractkit/chainlink-protos"
chainlink-protos/op-catalog
click chainlink-protos/op-catalog 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-sui --> chainlink-aptos
chainlink-sui --> chainlink-ccip
click chainlink-sui href "https://github.com/smartcontractkit/chainlink-sui"
chainlink-testing-framework/framework --> chainlink-testing-framework/lib/grafana
chainlink-testing-framework/framework --> chainlink-testing-framework/wasp
click chainlink-testing-framework/framework 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/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-ton --> chainlink-ccip
chainlink-ton --> chainlink-common/pkg/monitoring
chainlink-ton --> chainlink-framework/metrics
click chainlink-ton href "https://github.com/smartcontractkit/chainlink-ton"
chainlink-tron/relayer --> chainlink-common
chainlink-tron/relayer --> chainlink-common/pkg/values
click chainlink-tron/relayer href "https://github.com/smartcontractkit/chainlink-tron"
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-ccip/chains/solana
mcms --> chainlink-sui
mcms --> chainlink-testing-framework/framework
mcms --> chainlink-ton
click mcms href "https://github.com/smartcontractkit/mcms"

subgraph chainlink-ccip-repo[chainlink-ccip]
chainlink-ccip
chainlink-ccip/chains/evm
chainlink-ccip/chains/solana
chainlink-ccip/chains/solana/gobindings
chainlink-ccip/deployment
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
chainlink-evm/gethwrappers/helpers
end
click chainlink-evm-repo href "https://github.com/smartcontractkit/chainlink-evm"

subgraph chainlink-protos-repo[chainlink-protos]
chainlink-protos/billing/go
chainlink-protos/cre/go
chainlink-protos/job-distributor
chainlink-protos/linking-service/go
chainlink-protos/node-platform
chainlink-protos/op-catalog
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"

subgraph chainlink-testing-framework-repo[chainlink-testing-framework]
chainlink-testing-framework/framework
chainlink-testing-framework/lib/grafana
chainlink-testing-framework/seth
chainlink-testing-framework/wasp
end
click chainlink-testing-framework-repo href "https://github.com/smartcontractkit/chainlink-testing-framework"

classDef outline stroke-dasharray:6,fill:none;
class chainlink-ccip-repo,chainlink-common-repo,chainlink-evm-repo,chainlink-protos-repo,chainlink-testing-framework-repo outline
```
20 changes: 20 additions & 0 deletions scripts/modgraph
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 "\`\`\`"
Loading