-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
legacy.go
147 lines (116 loc) · 5.43 KB
/
legacy.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
package evm
import (
"encoding/json"
"fmt"
"math/big"
"net/url"
"sort"
"github.com/pkg/errors"
"gopkg.in/guregu/null.v4"
"github.com/smartcontractkit/sqlx"
evmtypes "github.com/smartcontractkit/chainlink/core/chains/evm/types"
"github.com/smartcontractkit/chainlink/core/logger"
"github.com/smartcontractkit/chainlink/core/services/pg"
"github.com/smartcontractkit/chainlink/core/utils"
)
type LegacyEthNodeConfig interface {
DefaultChainID() *big.Int
EthereumURL() string
EthereumHTTPURL() *url.URL
EthereumSecondaryURLs() []url.URL
EthereumNodes() string
pg.QConfig
}
const missingEthChainIDMsg = `missing ETH_CHAIN_ID; this env var is required if ETH_URL is set
PLEASE READ THIS ADDITIONAL INFO
Chainlink now supports multiple chains, so the way ETH nodes are configured has changed. From version 1.1.0 and up, eth node configuration is stored in the database.
The following environment variables are DEPRECATED:
- ETH_URL
- ETH_HTTP_URL
- ETH_SECONDARY_URLS
Setting ETH_URL will cause Chainlink to automatically overwrite the database records with the given ENV values every time Chainlink boots. This behavior is used mainly to ease the process of upgrading from older versions, and on subsequent runs (once your old settings have been written to the database) it is recommended to unset these ENV vars and use the API commands exclusively to administer chains and nodes.
If you wish to continue using these environment variables (as it used to work in 1.0.x and below) you must ensure that the following are set:
- ETH_CHAIN_ID (mandatory) <--- CURRENTLY MISSING
- ETH_URL (mandatory)
- ETH_HTTP_URL (optional)
- ETH_SECONDARY_URLS (optional)
If, instead, you wish to use the API/CLI/GUI to configure your chains and eth nodes (recommended) you must REMOVE the following environment variables:
- ETH_URL
- ETH_HTTP_URL
- ETH_SECONDARY_URLS
This will cause Chainlink to use the database for its node configuration.
NOTE: ETH_CHAIN_ID remains optional if ETH_URL is left unset. If provided, it specifies the default chain to use in a multichain environment (if you leave ETH_CHAIN_ID unset, the default chain is simply the "first").
For more information on configuring your node, check the docs: https://docs.chain.link/docs/configuration-variables/
`
func ClobberDBFromEnv(db *sqlx.DB, config LegacyEthNodeConfig, lggr logger.Logger) error {
if err := SetupNodes(db, config, lggr); err != nil {
return errors.Wrap(err, "failed to setup EVM nodes")
}
primaryWS := config.EthereumURL()
if primaryWS == "" {
return nil
}
ethChainID := utils.NewBig(config.DefaultChainID())
if ethChainID == nil {
return errors.New(missingEthChainIDMsg)
}
lggr.Warnw(fmt.Sprintf("ETH_URL was set, automatically inserting/updating chain %s and its primary/send-only nodes. It is recommended "+
"to unset ETH_URL on subsequent runs and use the API to administer chains/nodes instead", ethChainID.String()),
"evmChainID", ethChainID.String())
if _, err := db.Exec("INSERT INTO evm_chains (id, created_at, updated_at) VALUES ($1, NOW(), NOW()) ON CONFLICT DO NOTHING;", ethChainID.String()); err != nil {
return errors.Wrap(err, "failed to insert evm_chain")
}
if _, err := db.Exec("DELETE FROM evm_nodes WHERE evm_chain_id = $1", ethChainID.String()); err != nil {
return errors.Wrap(err, "failed to delete evm_node")
}
stmt := `INSERT INTO evm_nodes (name, evm_chain_id, ws_url, http_url, send_only, created_at, updated_at) VALUES ($1,$2,$3,$4,$5,NOW(),NOW())`
var primaryHTTP null.String
if config.EthereumHTTPURL() != nil {
primaryHTTP = null.StringFrom(config.EthereumHTTPURL().String())
}
if _, err := db.Exec(stmt, fmt.Sprintf("primary-0-%s", ethChainID), ethChainID, primaryWS, primaryHTTP, false); err != nil {
return errors.Wrap(err, "failed to upsert primary-0")
}
for i, url := range config.EthereumSecondaryURLs() {
if config.EthereumHTTPURL() != nil && url.String() == config.EthereumHTTPURL().String() {
lggr.Errorf("Got secondary URL %s which is already specified as a primary node HTTP URL. It does not make any sense to have both primary and sendonly nodes sharing the same URL and does not grant any extra redundancy. This sendonly RPC url will be ignored.", url.String())
continue
}
name := fmt.Sprintf("sendonly-%d-%s", i, ethChainID)
if _, err := db.Exec(stmt, name, ethChainID, nil, url.String(), true); err != nil {
return errors.Wrapf(err, "failed to upsert %s", name)
}
}
return nil
}
// SetupNodes is a hack/shim method to allow node operators to specify multiple nodes via ENV.
// See: https://app.shortcut.com/chainlinklabs/epic/33587/overhaul-config?cf_workflow=500000005&ct_workflow=all
func SetupNodes(db *sqlx.DB, cfg LegacyEthNodeConfig, lggr logger.Logger) (err error) {
if cfg.EthereumNodes() == "" {
return nil
}
var nodes []evmtypes.Node
if err = json.Unmarshal([]byte(cfg.EthereumNodes()), &nodes); err != nil {
return errors.Wrapf(err, "invalid EVM_NODES json, got: %q", cfg.EthereumNodes())
}
// Sorting gives a consistent insert ordering
sort.Slice(nodes, func(i, j int) bool {
return nodes[i].Name < nodes[j].Name
})
lggr.Info("EVM_NODES was set; clobbering evm_nodes table")
orm := NewORM(db, lggr, cfg)
return orm.SetupNodes(nodes, uniqueIDs(nodes))
}
func uniqueIDs(ns []evmtypes.Node) (ids []utils.Big) {
m := make(map[string]struct{})
for _, n := range ns {
id := n.EVMChainID
sid := id.String()
if _, ok := m[sid]; ok {
continue
}
ids = append(ids, id)
m[sid] = struct{}{}
}
return
}