aboutsummaryrefslogblamecommitdiffstats
path: root/node/defaults.go
blob: 71e76334607c6e586ecd18148118206214089ab9 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16















                                                                                  
            

        

                 

                       


                                                 
                                             


       





                                                                                               

 

                                                      



                                                  
                                                  

                                                  
                        


                                      


          



                                                                                  
                         
                       

                                     
                                                                         










                                                                                                 





                                                                              
 
                              





                                                                                     
         
                











                                     








                                                   
// Copyright 2016 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package node

import (
    "os"
    "os/user"
    "path/filepath"
    "runtime"

    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/nat"
    "github.com/ethereum/go-ethereum/rpc"
)

const (
    DefaultHTTPHost    = "localhost" // Default host interface for the HTTP RPC server
    DefaultHTTPPort    = 8545        // Default TCP port for the HTTP RPC server
    DefaultWSHost      = "localhost" // Default host interface for the websocket RPC server
    DefaultWSPort      = 8546        // Default TCP port for the websocket RPC server
    DefaultGraphQLHost = "localhost" // Default host interface for the GraphQL server
    DefaultGraphQLPort = 8547        // Default TCP port for the GraphQL server
)

// DefaultConfig contains reasonable default settings.
var DefaultConfig = Config{
    DataDir:          DefaultDataDir(),
    HTTPPort:         DefaultHTTPPort,
    HTTPModules:      []string{"net", "web3"},
    HTTPVirtualHosts: []string{"localhost"},
    HTTPTimeouts:     rpc.DefaultHTTPTimeouts,
    WSPort:           DefaultWSPort,
    WSModules:        []string{"net", "web3"},
    P2P: p2p.Config{
        ListenAddr: ":30303",
        MaxPeers:   25,
        NAT:        nat.Any(),
    },
}

// DefaultDataDir is the default data directory to use for the databases and other
// persistence requirements.
func DefaultDataDir() string {
    // Try to place the data folder in the user's home dir
    home := homeDir()
    if home != "" {
        switch runtime.GOOS {
        case "darwin":
            return filepath.Join(home, "Library", "Ethereum")
        case "windows":
            // We used to put everything in %HOME%\AppData\Roaming, but this caused
            // problems with non-typical setups. If this fallback location exists and
            // is non-empty, use it, otherwise DTRT and check %LOCALAPPDATA%.
            fallback := filepath.Join(home, "AppData", "Roaming", "Ethereum")
            appdata := windowsAppData()
            if appdata == "" || isNonEmptyDir(fallback) {
                return fallback
            }
            return filepath.Join(appdata, "Ethereum")
        default:
            return filepath.Join(home, ".ethereum")
        }
    }
    // As we cannot guess a stable location, return empty and handle later
    return ""
}

func windowsAppData() string {
    v := os.Getenv("LOCALAPPDATA")
    if v == "" {
        // Windows XP and below don't have LocalAppData. Crash here because
        // we don't support Windows XP and undefining the variable will cause
        // other issues.
        panic("environment variable LocalAppData is undefined")
    }
    return v
}

func isNonEmptyDir(dir string) bool {
    f, err := os.Open(dir)
    if err != nil {
        return false
    }
    names, _ := f.Readdir(1)
    f.Close()
    return len(names) > 0
}

func homeDir() string {
    if home := os.Getenv("HOME"); home != "" {
        return home
    }
    if usr, err := user.Current(); err == nil {
        return usr.HomeDir
    }
    return ""
}