ipld-eth-server/pkg/super_node/config/config.go

// VulcanizeDB
// Copyright © 2019 Vulcanize

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.

// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package config

import (
	"fmt"
	"os"
	"path/filepath"
	"time"

	"github.com/ethereum/go-ethereum/ethclient"
	"github.com/ethereum/go-ethereum/rpc"
	"github.com/spf13/viper"

	"github.com/vulcanize/vulcanizedb/pkg/config"
	"github.com/vulcanize/vulcanizedb/pkg/core"
	"github.com/vulcanize/vulcanizedb/pkg/datastore/postgres"
	"github.com/vulcanize/vulcanizedb/pkg/eth"
	"github.com/vulcanize/vulcanizedb/pkg/eth/client"
	vRpc "github.com/vulcanize/vulcanizedb/pkg/eth/converters/rpc"
	"github.com/vulcanize/vulcanizedb/pkg/eth/node"
	"github.com/vulcanize/vulcanizedb/utils"
)

// SuperNode config struct
type SuperNode struct {
	// Ubiquitous fields
	Chain    ChainType
	IPFSPath string
	DB       *postgres.DB
	Quit     chan bool
	// Server fields
	Serve       bool
	WSEndpoint  string
	IPCEndpoint string
	// Sync params
	Sync     bool
	Workers  int
	WSClient core.RPCClient
	NodeInfo core.Node
	// Backfiller params
	BackFill         bool
	BackFillSettings *BackFill
}

// NewSuperNodeConfig is used to initialize a SuperNode config
func NewSuperNodeConfig() (*SuperNode, error) {
	dbConfig := config.Database{
		Name:     viper.GetString("superNode.database.name"),
		Hostname: viper.GetString("superNode.database.hostname"),
		Port:     viper.GetInt("superNode.database.port"),
		User:     viper.GetString("superNode.database.user"),
		Password: viper.GetString("superNode.database.password"),
	}
	sn := new(SuperNode)
	var err error
	sn.Chain, err = NewChainType(viper.GetString("superNode.chain"))
	if err != nil {
		return nil, err
	}
	ipfsPath := viper.GetString("superNode.ipfsPath")
	if ipfsPath == "" {
		home, err := os.UserHomeDir()
		if err != nil {
			return nil, err
		}
		ipfsPath = filepath.Join(home, ".ipfs")
	}
	sn.IPFSPath = ipfsPath
	sn.Serve = viper.GetBool("superNode.server.on")
	sn.Sync = viper.GetBool("superNode.sync.on")
	if sn.Sync {
		workers := viper.GetInt("superNode.sync.workers")
		if workers < 1 {
			workers = 1
		}
		sn.Workers = workers
		sn.NodeInfo, sn.WSClient, err = getNodeAndClient(sn.Chain, viper.GetString("superNode.sync.wsPath"))
	}
	if sn.Serve {
		wsPath := viper.GetString("superNode.server.wsPath")
		if wsPath == "" {
			wsPath = "127.0.0.1:8080"
		}
		sn.WSEndpoint = wsPath
		ipcPath := viper.GetString("superNode.server.ipcPath")
		if ipcPath == "" {
			home, err := os.UserHomeDir()
			if err != nil {
				return nil, err
			}
			ipcPath = filepath.Join(home, ".vulcanize/vulcanize.ipc")
		}
		sn.IPCEndpoint = ipcPath
	}
	db := utils.LoadPostgres(dbConfig, sn.NodeInfo)
	sn.DB = &db
	sn.Quit = make(chan bool)
	if viper.GetBool("superNode.backFill.on") {
		sn.BackFill = true
		sn.BackFillSettings, err = NewBackFillerConfig(dbConfig)
	}
	return sn, err
}

// BackFill config struct
type BackFill struct {
	Chain      ChainType
	IPFSPath   string
	DB         *postgres.DB
	HTTPClient core.RPCClient
	Frequency  time.Duration
	BatchSize  uint64
}

// newBackFillerConfig is used to initialize a backfiller config
func NewBackFillerConfig(dbConfig config.Database) (*BackFill, error) {
	bf := new(BackFill)
	var err error
	bf.Chain, err = NewChainType(viper.GetString("superNode.chain"))
	if err != nil {
		return nil, err
	}
	ipfsPath := viper.GetString("superNode.ipfsPath")
	if ipfsPath == "" {
		home, homeDirErr := os.UserHomeDir()
		if homeDirErr != nil {
			return nil, err
		}
		ipfsPath = filepath.Join(home, ".ipfs")
	}
	bf.IPFSPath = ipfsPath
	node, httpClient, err := getNodeAndClient(bf.Chain, viper.GetString("superNode.backFill.httpPath"))
	db := utils.LoadPostgres(dbConfig, node)
	bf.DB = &db
	bf.HTTPClient = httpClient
	freq := viper.GetInt("superNode.backFill.frequency")
	var frequency time.Duration
	if freq <= 0 {
		frequency = time.Minute * 5
	} else {
		frequency = time.Duration(freq)
	}
	bf.Frequency = frequency
	return bf, nil
}

func getNodeAndClient(chain ChainType, path string) (core.Node, core.RPCClient, error) {
	switch chain {
	case Ethereum:
		rawRPCClient, err := rpc.Dial(path)
		if err != nil {
			return core.Node{}, nil, err
		}
		rpcClient := client.NewRPCClient(rawRPCClient, path)
		ethClient := ethclient.NewClient(rawRPCClient)
		vdbEthClient := client.NewEthClient(ethClient)
		vdbNode := node.MakeNode(rpcClient)
		transactionConverter := vRpc.NewRPCTransactionConverter(ethClient)
		blockChain := eth.NewBlockChain(vdbEthClient, rpcClient, vdbNode, transactionConverter)
		return blockChain.Node(), rpcClient, nil
	default:
		return core.Node{}, nil, fmt.Errorf("unrecognized chain type %s", chain.String())
	}
}