Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

docs

package

v2.11.0 Latest Latest Go to latest Published: May 1, 2024 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/smartcontractkit/chainlink

Links

Open Source Insights

README ¶

Configuration Documentation

core.toml & chains-*.toml files are sources of truth for config docs. Update/add documentation here.
CONFIG.md is generated from (1) by config.GenerateDocs() via docs/main.go. Do not edit this file. Run make config-docs from the root of the repo.

See example.toml and example.md for a minimal example.

Documentation ¶

Index ¶

func CoreDefaults() (c toml.Core)
func GenerateConfig() (string, error)
func GenerateSecrets() (string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CoreDefaults ¶

func CoreDefaults() (c toml.Core)

func GenerateConfig ¶

func GenerateConfig() (string, error)

GenerateConfig returns MarkDown documentation generated from core.toml & chains-*.toml.

func GenerateSecrets ¶

func GenerateSecrets() (string, error)

GenerateSecrets returns MarkDown documentation generated from secrets.toml.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
generate Docs prints core node documentation and/or a list of errors.	Docs prints core node documentation and/or a list of errors.