config.go

package config

import (
	"time"

	env "github.com/caarlos0/env/v6"
	"github.com/joho/godotenv"
	log "github.com/sirupsen/logrus"
)

type Config struct {
	// -- Admin (or the PDS) account --

	AdminAddress           string `env:"FLOW_PDS_ADMIN_ADDRESS,notEmpty"`
	AdminPrivateKey        string `env:"FLOW_PDS_ADMIN_PRIVATE_KEY,notEmpty"`
	AdminPrivateKeyIndexes []int  `env:"FLOW_PDS_ADMIN_PRIVATE_KEY_INDEXES,notEmpty" envDefault:"0" envSeparator:","`
	AdminPrivateKeyType    string `env:"FLOW_PDS_ADMIN_PRIVATE_KEY_TYPE,notEmpty" envDefault:"local"`

	// -- Flow addresses --
	// Address of the PDS account, usually this should equal to 'AdminAddress'
	PDSAddress              string `env:"PDS_ADDRESS,notEmpty"`
	NonFungibleTokenAddress string `env:"NON_FUNGIBLE_TOKEN_ADDRESS,notEmpty"`

	// -- Database --

	DatabaseDSN  string `env:"FLOW_PDS_DATABASE_DSN" envDefault:"postgresql://pds:pds@localhost:5432/pds"`
	DatabaseType string `env:"FLOW_PDS_DATABASE_TYPE" envDefault:"psql"`

	// -- Host and chain access --

	Host          string `env:"FLOW_PDS_HOST"`
	Port          int    `env:"FLOW_PDS_PORT" envDefault:"3000"`
	AccessAPIHost string `env:"FLOW_PDS_ACCESS_API_HOST" envDefault:"localhost:3569"`

	// -- Rates etc. ---

	// How many transactions to send per second at max
	TransactionSendRate int    `env:"FLOW_PDS_SEND_RATE" envDefault:"10"`
	TransactionGasLimit uint64 `env:"FLOW_PDS_GAS_LIMIT" envDefault:"9999"`
	// Going much above 40 will cause the transactions to use more than 9999 gas
	SettlementBatchSize int `env:"FLOW_PDS_SETTLEMENT_BATCH_SIZE" envDefault:"40"`
	MintingBatchSize    int `env:"FLOW_PDS_MINTING_BATCH_SIZE" envDefault:"40"`
	// Transaction result poll interval and time out
	TransactionPollInterval time.Duration `env:"FLOW_PDS_TX_POLL_INTERVAL" envDefault:"3s"`
	TransactionTimeout      time.Duration `env:"FLOW_PDS_TX_TIMEOUT" envDefault:"10m"`

	// The batch sizes for database batch handling (big inserts or batch processing)
	BatchInsertSize  int `env:"FLOW_PDS_BATCH_INSERT_SIZE" envDefault:"1000"`
	BatchProcessSize int `env:"FLOW_PDS_BATCH_PROCESS_SIZE" envDefault:"1000"`

	// Maximum number of blocks to query for when fetching events from Flow gateway
	MaxBlocksPerCheck uint64 `env:"FLOW_PDS_MAX_BLOCKS_PER_CHECK" envDefault:"10"`

	// -- Testing --

	TestPackCount int `env:"TEST_PACK_COUNT" envDefault:"4"`

	// -- Which loops should this PDS instance run? See `configurable_loops.go` for available options
	LoopsToRun []ConfigurableLoop `env:"LOOPS_TO_RUN" envSeparator:"," envDefault:"minting,packContractEvents,sentTransactions,sendableTransactions"`
}

type ConfigOptions struct {
	EnvFilePath string
}

// ParseConfig parses environment variables and flags to a valid Config.
func ParseConfig(opt *ConfigOptions) (*Config, error) {
	if opt != nil && opt.EnvFilePath != "" {
		// Load variables from a file to the environment of the process
		if err := godotenv.Load(opt.EnvFilePath); err != nil {
			log.Printf("Could not load environment variables from file.\n%s\nIf running inside a docker container this can be ignored.\n\n", err)
		}
	}

	cfg := Config{}
	if err := env.Parse(&cfg); err != nil {
		return nil, err
	}

	return &cfg, nil
}