Documentation
¶
Index ¶
- type Config
- type Module
- func (p *Module) ApplyDefaults()
- func (p *Module) DatasourceInfo() []types.DatasourceInfo
- func (p *Module) DefaultEnabled() bool
- func (p *Module) Enabled() bool
- func (p *Module) Examples() map[string]types.ExampleCategory
- func (p *Module) GettingStartedSnippet() string
- func (p *Module) Init(rawConfig []byte) error
- func (p *Module) Name() string
- func (p *Module) PythonAPIDocs() map[string]types.ModuleDoc
- func (p *Module) SandboxEnv() (map[string]string, error)
- func (p *Module) SetCartographoorClient(client cartographoor.CartographoorClient)
- func (p *Module) Start(_ context.Context) error
- func (p *Module) Stop(_ context.Context) error
- func (p *Module) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Enabled controls whether the Dora module is active.
// Defaults to true.
Enabled *bool `yaml:"enabled,omitempty"`
}
Config holds the Dora module configuration. Dora is enabled by default since it's a public service and requires no credentials.
type Module ¶
type Module struct {
// contains filtered or unexported fields
}
Module implements the module.Module interface for the Dora module.
func (*Module) ApplyDefaults ¶
func (p *Module) ApplyDefaults()
func (*Module) DatasourceInfo ¶
func (p *Module) DatasourceInfo() []types.DatasourceInfo
DatasourceInfo returns empty since networks are the datasources, and those come from cartographoor.
func (*Module) DefaultEnabled ¶
DefaultEnabled implements module.DefaultEnabled. Dora is enabled by default since it requires no configuration.
func (*Module) GettingStartedSnippet ¶
func (*Module) SandboxEnv ¶
SandboxEnv returns environment variables for the sandbox. Returns ETHPANDAOPS_DORA_NETWORKS with network->URL mapping from cartographoor.
func (*Module) SetCartographoorClient ¶
func (p *Module) SetCartographoorClient(client cartographoor.CartographoorClient)
SetCartographoorClient implements module.CartographoorAware. This is called by the builder to inject the cartographoor client.