github.com/anthdm/go-ethereum@v1.8.4-0.20180412101906-60516c83b011/cmd/faucet/faucet.go (about)

     1  // Copyright 2017 The go-ethereum Authors
     2  // This file is part of go-ethereum.
     3  //
     4  // go-ethereum is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // go-ethereum is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU General Public License
    15  // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  // faucet is a Ether faucet backed by a light client.
    18  package main
    19  
    20  //go:generate go-bindata -nometadata -o website.go faucet.html
    21  //go:generate gofmt -w -s website.go
    22  
    23  import (
    24  	"bytes"
    25  	"context"
    26  	"encoding/json"
    27  	"errors"
    28  	"flag"
    29  	"fmt"
    30  	"html/template"
    31  	"io/ioutil"
    32  	"math"
    33  	"math/big"
    34  	"net/http"
    35  	"net/url"
    36  	"os"
    37  	"path/filepath"
    38  	"regexp"
    39  	"strconv"
    40  	"strings"
    41  	"sync"
    42  	"time"
    43  
    44  	"github.com/ethereum/go-ethereum/accounts"
    45  	"github.com/ethereum/go-ethereum/accounts/keystore"
    46  	"github.com/ethereum/go-ethereum/common"
    47  	"github.com/ethereum/go-ethereum/core"
    48  	"github.com/ethereum/go-ethereum/core/types"
    49  	"github.com/ethereum/go-ethereum/eth"
    50  	"github.com/ethereum/go-ethereum/eth/downloader"
    51  	"github.com/ethereum/go-ethereum/ethclient"
    52  	"github.com/ethereum/go-ethereum/ethstats"
    53  	"github.com/ethereum/go-ethereum/les"
    54  	"github.com/ethereum/go-ethereum/log"
    55  	"github.com/ethereum/go-ethereum/node"
    56  	"github.com/ethereum/go-ethereum/p2p"
    57  	"github.com/ethereum/go-ethereum/p2p/discover"
    58  	"github.com/ethereum/go-ethereum/p2p/discv5"
    59  	"github.com/ethereum/go-ethereum/p2p/nat"
    60  	"github.com/ethereum/go-ethereum/params"
    61  	"golang.org/x/net/websocket"
    62  )
    63  
    64  var (
    65  	genesisFlag = flag.String("genesis", "", "Genesis json file to seed the chain with")
    66  	apiPortFlag = flag.Int("apiport", 8080, "Listener port for the HTTP API connection")
    67  	ethPortFlag = flag.Int("ethport", 30303, "Listener port for the devp2p connection")
    68  	bootFlag    = flag.String("bootnodes", "", "Comma separated bootnode enode URLs to seed with")
    69  	netFlag     = flag.Uint64("network", 0, "Network ID to use for the Ethereum protocol")
    70  	statsFlag   = flag.String("ethstats", "", "Ethstats network monitoring auth string")
    71  
    72  	netnameFlag = flag.String("faucet.name", "", "Network name to assign to the faucet")
    73  	payoutFlag  = flag.Int("faucet.amount", 1, "Number of Ethers to pay out per user request")
    74  	minutesFlag = flag.Int("faucet.minutes", 1440, "Number of minutes to wait between funding rounds")
    75  	tiersFlag   = flag.Int("faucet.tiers", 3, "Number of funding tiers to enable (x3 time, x2.5 funds)")
    76  
    77  	accJSONFlag = flag.String("account.json", "", "Key json file to fund user requests with")
    78  	accPassFlag = flag.String("account.pass", "", "Decryption password to access faucet funds")
    79  
    80  	githubUser  = flag.String("github.user", "", "GitHub user to authenticate with for Gist access")
    81  	githubToken = flag.String("github.token", "", "GitHub personal token to access Gists with")
    82  
    83  	captchaToken  = flag.String("captcha.token", "", "Recaptcha site key to authenticate client side")
    84  	captchaSecret = flag.String("captcha.secret", "", "Recaptcha secret key to authenticate server side")
    85  
    86  	noauthFlag = flag.Bool("noauth", false, "Enables funding requests without authentication")
    87  	logFlag    = flag.Int("loglevel", 3, "Log level to use for Ethereum and the faucet")
    88  )
    89  
    90  var (
    91  	ether = new(big.Int).Exp(big.NewInt(10), big.NewInt(18), nil)
    92  )
    93  
    94  func main() {
    95  	// Parse the flags and set up the logger to print everything requested
    96  	flag.Parse()
    97  	log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(*logFlag), log.StreamHandler(os.Stderr, log.TerminalFormat(true))))
    98  
    99  	// Construct the payout tiers
   100  	amounts := make([]string, *tiersFlag)
   101  	periods := make([]string, *tiersFlag)
   102  	for i := 0; i < *tiersFlag; i++ {
   103  		// Calculate the amount for the next tier and format it
   104  		amount := float64(*payoutFlag) * math.Pow(2.5, float64(i))
   105  		amounts[i] = fmt.Sprintf("%s Ethers", strconv.FormatFloat(amount, 'f', -1, 64))
   106  		if amount == 1 {
   107  			amounts[i] = strings.TrimSuffix(amounts[i], "s")
   108  		}
   109  		// Calculate the period for the next tier and format it
   110  		period := *minutesFlag * int(math.Pow(3, float64(i)))
   111  		periods[i] = fmt.Sprintf("%d mins", period)
   112  		if period%60 == 0 {
   113  			period /= 60
   114  			periods[i] = fmt.Sprintf("%d hours", period)
   115  
   116  			if period%24 == 0 {
   117  				period /= 24
   118  				periods[i] = fmt.Sprintf("%d days", period)
   119  			}
   120  		}
   121  		if period == 1 {
   122  			periods[i] = strings.TrimSuffix(periods[i], "s")
   123  		}
   124  	}
   125  	// Load up and render the faucet website
   126  	tmpl, err := Asset("faucet.html")
   127  	if err != nil {
   128  		log.Crit("Failed to load the faucet template", "err", err)
   129  	}
   130  	website := new(bytes.Buffer)
   131  	err = template.Must(template.New("").Parse(string(tmpl))).Execute(website, map[string]interface{}{
   132  		"Network":   *netnameFlag,
   133  		"Amounts":   amounts,
   134  		"Periods":   periods,
   135  		"Recaptcha": *captchaToken,
   136  		"NoAuth":    *noauthFlag,
   137  	})
   138  	if err != nil {
   139  		log.Crit("Failed to render the faucet template", "err", err)
   140  	}
   141  	// Load and parse the genesis block requested by the user
   142  	blob, err := ioutil.ReadFile(*genesisFlag)
   143  	if err != nil {
   144  		log.Crit("Failed to read genesis block contents", "genesis", *genesisFlag, "err", err)
   145  	}
   146  	genesis := new(core.Genesis)
   147  	if err = json.Unmarshal(blob, genesis); err != nil {
   148  		log.Crit("Failed to parse genesis block json", "err", err)
   149  	}
   150  	// Convert the bootnodes to internal enode representations
   151  	var enodes []*discv5.Node
   152  	for _, boot := range strings.Split(*bootFlag, ",") {
   153  		if url, err := discv5.ParseNode(boot); err == nil {
   154  			enodes = append(enodes, url)
   155  		} else {
   156  			log.Error("Failed to parse bootnode URL", "url", boot, "err", err)
   157  		}
   158  	}
   159  	// Load up the account key and decrypt its password
   160  	if blob, err = ioutil.ReadFile(*accPassFlag); err != nil {
   161  		log.Crit("Failed to read account password contents", "file", *accPassFlag, "err", err)
   162  	}
   163  	pass := string(blob)
   164  
   165  	ks := keystore.NewKeyStore(filepath.Join(os.Getenv("HOME"), ".faucet", "keys"), keystore.StandardScryptN, keystore.StandardScryptP)
   166  	if blob, err = ioutil.ReadFile(*accJSONFlag); err != nil {
   167  		log.Crit("Failed to read account key contents", "file", *accJSONFlag, "err", err)
   168  	}
   169  	acc, err := ks.Import(blob, pass, pass)
   170  	if err != nil {
   171  		log.Crit("Failed to import faucet signer account", "err", err)
   172  	}
   173  	ks.Unlock(acc, pass)
   174  
   175  	// Assemble and start the faucet light service
   176  	faucet, err := newFaucet(genesis, *ethPortFlag, enodes, *netFlag, *statsFlag, ks, website.Bytes())
   177  	if err != nil {
   178  		log.Crit("Failed to start faucet", "err", err)
   179  	}
   180  	defer faucet.close()
   181  
   182  	if err := faucet.listenAndServe(*apiPortFlag); err != nil {
   183  		log.Crit("Failed to launch faucet API", "err", err)
   184  	}
   185  }
   186  
   187  // request represents an accepted funding request.
   188  type request struct {
   189  	Avatar  string             `json:"avatar"`  // Avatar URL to make the UI nicer
   190  	Account common.Address     `json:"account"` // Ethereum address being funded
   191  	Time    time.Time          `json:"time"`    // Timestamp when the request was accepted
   192  	Tx      *types.Transaction `json:"tx"`      // Transaction funding the account
   193  }
   194  
   195  // faucet represents a crypto faucet backed by an Ethereum light client.
   196  type faucet struct {
   197  	config *params.ChainConfig // Chain configurations for signing
   198  	stack  *node.Node          // Ethereum protocol stack
   199  	client *ethclient.Client   // Client connection to the Ethereum chain
   200  	index  []byte              // Index page to serve up on the web
   201  
   202  	keystore *keystore.KeyStore // Keystore containing the single signer
   203  	account  accounts.Account   // Account funding user faucet requests
   204  	nonce    uint64             // Current pending nonce of the faucet
   205  	price    *big.Int           // Current gas price to issue funds with
   206  
   207  	conns    []*websocket.Conn    // Currently live websocket connections
   208  	timeouts map[string]time.Time // History of users and their funding timeouts
   209  	reqs     []*request           // Currently pending funding requests
   210  	update   chan struct{}        // Channel to signal request updates
   211  
   212  	lock sync.RWMutex // Lock protecting the faucet's internals
   213  }
   214  
   215  func newFaucet(genesis *core.Genesis, port int, enodes []*discv5.Node, network uint64, stats string, ks *keystore.KeyStore, index []byte) (*faucet, error) {
   216  	// Assemble the raw devp2p protocol stack
   217  	stack, err := node.New(&node.Config{
   218  		Name:    "geth",
   219  		Version: params.Version,
   220  		DataDir: filepath.Join(os.Getenv("HOME"), ".faucet"),
   221  		P2P: p2p.Config{
   222  			NAT:              nat.Any(),
   223  			NoDiscovery:      true,
   224  			DiscoveryV5:      true,
   225  			ListenAddr:       fmt.Sprintf(":%d", port),
   226  			MaxPeers:         25,
   227  			BootstrapNodesV5: enodes,
   228  		},
   229  	})
   230  	if err != nil {
   231  		return nil, err
   232  	}
   233  	// Assemble the Ethereum light client protocol
   234  	if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
   235  		cfg := eth.DefaultConfig
   236  		cfg.SyncMode = downloader.LightSync
   237  		cfg.NetworkId = network
   238  		cfg.Genesis = genesis
   239  		return les.New(ctx, &cfg)
   240  	}); err != nil {
   241  		return nil, err
   242  	}
   243  	// Assemble the ethstats monitoring and reporting service'
   244  	if stats != "" {
   245  		if err := stack.Register(func(ctx *node.ServiceContext) (node.Service, error) {
   246  			var serv *les.LightEthereum
   247  			ctx.Service(&serv)
   248  			return ethstats.New(stats, nil, serv)
   249  		}); err != nil {
   250  			return nil, err
   251  		}
   252  	}
   253  	// Boot up the client and ensure it connects to bootnodes
   254  	if err := stack.Start(); err != nil {
   255  		return nil, err
   256  	}
   257  	for _, boot := range enodes {
   258  		old, _ := discover.ParseNode(boot.String())
   259  		stack.Server().AddPeer(old)
   260  	}
   261  	// Attach to the client and retrieve and interesting metadatas
   262  	api, err := stack.Attach()
   263  	if err != nil {
   264  		stack.Stop()
   265  		return nil, err
   266  	}
   267  	client := ethclient.NewClient(api)
   268  
   269  	return &faucet{
   270  		config:   genesis.Config,
   271  		stack:    stack,
   272  		client:   client,
   273  		index:    index,
   274  		keystore: ks,
   275  		account:  ks.Accounts()[0],
   276  		timeouts: make(map[string]time.Time),
   277  		update:   make(chan struct{}, 1),
   278  	}, nil
   279  }
   280  
   281  // close terminates the Ethereum connection and tears down the faucet.
   282  func (f *faucet) close() error {
   283  	return f.stack.Stop()
   284  }
   285  
   286  // listenAndServe registers the HTTP handlers for the faucet and boots it up
   287  // for service user funding requests.
   288  func (f *faucet) listenAndServe(port int) error {
   289  	go f.loop()
   290  
   291  	http.HandleFunc("/", f.webHandler)
   292  	http.Handle("/api", websocket.Handler(f.apiHandler))
   293  
   294  	return http.ListenAndServe(fmt.Sprintf(":%d", port), nil)
   295  }
   296  
   297  // webHandler handles all non-api requests, simply flattening and returning the
   298  // faucet website.
   299  func (f *faucet) webHandler(w http.ResponseWriter, r *http.Request) {
   300  	w.Write(f.index)
   301  }
   302  
   303  // apiHandler handles requests for Ether grants and transaction statuses.
   304  func (f *faucet) apiHandler(conn *websocket.Conn) {
   305  	// Start tracking the connection and drop at the end
   306  	defer conn.Close()
   307  
   308  	f.lock.Lock()
   309  	f.conns = append(f.conns, conn)
   310  	f.lock.Unlock()
   311  
   312  	defer func() {
   313  		f.lock.Lock()
   314  		for i, c := range f.conns {
   315  			if c == conn {
   316  				f.conns = append(f.conns[:i], f.conns[i+1:]...)
   317  				break
   318  			}
   319  		}
   320  		f.lock.Unlock()
   321  	}()
   322  	// Gather the initial stats from the network to report
   323  	var (
   324  		head    *types.Header
   325  		balance *big.Int
   326  		nonce   uint64
   327  		err     error
   328  	)
   329  	for {
   330  		// Attempt to retrieve the stats, may error on no faucet connectivity
   331  		ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
   332  		head, err = f.client.HeaderByNumber(ctx, nil)
   333  		if err == nil {
   334  			balance, err = f.client.BalanceAt(ctx, f.account.Address, head.Number)
   335  			if err == nil {
   336  				nonce, err = f.client.NonceAt(ctx, f.account.Address, nil)
   337  			}
   338  		}
   339  		cancel()
   340  
   341  		// If stats retrieval failed, wait a bit and retry
   342  		if err != nil {
   343  			if err = sendError(conn, errors.New("Faucet offline: "+err.Error())); err != nil {
   344  				log.Warn("Failed to send faucet error to client", "err", err)
   345  				return
   346  			}
   347  			time.Sleep(3 * time.Second)
   348  			continue
   349  		}
   350  		// Initial stats reported successfully, proceed with user interaction
   351  		break
   352  	}
   353  	// Send over the initial stats and the latest header
   354  	if err = send(conn, map[string]interface{}{
   355  		"funds":    balance.Div(balance, ether),
   356  		"funded":   nonce,
   357  		"peers":    f.stack.Server().PeerCount(),
   358  		"requests": f.reqs,
   359  	}, 3*time.Second); err != nil {
   360  		log.Warn("Failed to send initial stats to client", "err", err)
   361  		return
   362  	}
   363  	if err = send(conn, head, 3*time.Second); err != nil {
   364  		log.Warn("Failed to send initial header to client", "err", err)
   365  		return
   366  	}
   367  	// Keep reading requests from the websocket until the connection breaks
   368  	for {
   369  		// Fetch the next funding request and validate against github
   370  		var msg struct {
   371  			URL     string `json:"url"`
   372  			Tier    uint   `json:"tier"`
   373  			Captcha string `json:"captcha"`
   374  		}
   375  		if err = websocket.JSON.Receive(conn, &msg); err != nil {
   376  			return
   377  		}
   378  		if !*noauthFlag && !strings.HasPrefix(msg.URL, "https://gist.github.com/") && !strings.HasPrefix(msg.URL, "https://twitter.com/") &&
   379  			!strings.HasPrefix(msg.URL, "https://plus.google.com/") && !strings.HasPrefix(msg.URL, "https://www.facebook.com/") {
   380  			if err = sendError(conn, errors.New("URL doesn't link to supported services")); err != nil {
   381  				log.Warn("Failed to send URL error to client", "err", err)
   382  				return
   383  			}
   384  			continue
   385  		}
   386  		if msg.Tier >= uint(*tiersFlag) {
   387  			if err = sendError(conn, errors.New("Invalid funding tier requested")); err != nil {
   388  				log.Warn("Failed to send tier error to client", "err", err)
   389  				return
   390  			}
   391  			continue
   392  		}
   393  		log.Info("Faucet funds requested", "url", msg.URL, "tier", msg.Tier)
   394  
   395  		// If captcha verifications are enabled, make sure we're not dealing with a robot
   396  		if *captchaToken != "" {
   397  			form := url.Values{}
   398  			form.Add("secret", *captchaSecret)
   399  			form.Add("response", msg.Captcha)
   400  
   401  			res, err := http.PostForm("https://www.google.com/recaptcha/api/siteverify", form)
   402  			if err != nil {
   403  				if err = sendError(conn, err); err != nil {
   404  					log.Warn("Failed to send captcha post error to client", "err", err)
   405  					return
   406  				}
   407  				continue
   408  			}
   409  			var result struct {
   410  				Success bool            `json:"success"`
   411  				Errors  json.RawMessage `json:"error-codes"`
   412  			}
   413  			err = json.NewDecoder(res.Body).Decode(&result)
   414  			res.Body.Close()
   415  			if err != nil {
   416  				if err = sendError(conn, err); err != nil {
   417  					log.Warn("Failed to send captcha decode error to client", "err", err)
   418  					return
   419  				}
   420  				continue
   421  			}
   422  			if !result.Success {
   423  				log.Warn("Captcha verification failed", "err", string(result.Errors))
   424  				if err = sendError(conn, errors.New("Beep-bop, you're a robot!")); err != nil {
   425  					log.Warn("Failed to send captcha failure to client", "err", err)
   426  					return
   427  				}
   428  				continue
   429  			}
   430  		}
   431  		// Retrieve the Ethereum address to fund, the requesting user and a profile picture
   432  		var (
   433  			username string
   434  			avatar   string
   435  			address  common.Address
   436  		)
   437  		switch {
   438  		case strings.HasPrefix(msg.URL, "https://gist.github.com/"):
   439  			if err = sendError(conn, errors.New("GitHub authentication discontinued at the official request of GitHub")); err != nil {
   440  				log.Warn("Failed to send GitHub deprecation to client", "err", err)
   441  				return
   442  			}
   443  			continue
   444  		case strings.HasPrefix(msg.URL, "https://twitter.com/"):
   445  			username, avatar, address, err = authTwitter(msg.URL)
   446  		case strings.HasPrefix(msg.URL, "https://plus.google.com/"):
   447  			username, avatar, address, err = authGooglePlus(msg.URL)
   448  		case strings.HasPrefix(msg.URL, "https://www.facebook.com/"):
   449  			username, avatar, address, err = authFacebook(msg.URL)
   450  		case *noauthFlag:
   451  			username, avatar, address, err = authNoAuth(msg.URL)
   452  		default:
   453  			err = errors.New("Something funky happened, please open an issue at https://github.com/ethereum/go-ethereum/issues")
   454  		}
   455  		if err != nil {
   456  			if err = sendError(conn, err); err != nil {
   457  				log.Warn("Failed to send prefix error to client", "err", err)
   458  				return
   459  			}
   460  			continue
   461  		}
   462  		log.Info("Faucet request valid", "url", msg.URL, "tier", msg.Tier, "user", username, "address", address)
   463  
   464  		// Ensure the user didn't request funds too recently
   465  		f.lock.Lock()
   466  		var (
   467  			fund    bool
   468  			timeout time.Time
   469  		)
   470  		if timeout = f.timeouts[username]; time.Now().After(timeout) {
   471  			// User wasn't funded recently, create the funding transaction
   472  			amount := new(big.Int).Mul(big.NewInt(int64(*payoutFlag)), ether)
   473  			amount = new(big.Int).Mul(amount, new(big.Int).Exp(big.NewInt(5), big.NewInt(int64(msg.Tier)), nil))
   474  			amount = new(big.Int).Div(amount, new(big.Int).Exp(big.NewInt(2), big.NewInt(int64(msg.Tier)), nil))
   475  
   476  			tx := types.NewTransaction(f.nonce+uint64(len(f.reqs)), address, amount, 21000, f.price, nil)
   477  			signed, err := f.keystore.SignTx(f.account, tx, f.config.ChainId)
   478  			if err != nil {
   479  				f.lock.Unlock()
   480  				if err = sendError(conn, err); err != nil {
   481  					log.Warn("Failed to send transaction creation error to client", "err", err)
   482  					return
   483  				}
   484  				continue
   485  			}
   486  			// Submit the transaction and mark as funded if successful
   487  			if err := f.client.SendTransaction(context.Background(), signed); err != nil {
   488  				f.lock.Unlock()
   489  				if err = sendError(conn, err); err != nil {
   490  					log.Warn("Failed to send transaction transmission error to client", "err", err)
   491  					return
   492  				}
   493  				continue
   494  			}
   495  			f.reqs = append(f.reqs, &request{
   496  				Avatar:  avatar,
   497  				Account: address,
   498  				Time:    time.Now(),
   499  				Tx:      signed,
   500  			})
   501  			f.timeouts[username] = time.Now().Add(time.Duration(*minutesFlag*int(math.Pow(3, float64(msg.Tier)))) * time.Minute)
   502  			fund = true
   503  		}
   504  		f.lock.Unlock()
   505  
   506  		// Send an error if too frequent funding, othewise a success
   507  		if !fund {
   508  			if err = sendError(conn, fmt.Errorf("%s left until next allowance", common.PrettyDuration(timeout.Sub(time.Now())))); err != nil { // nolint: gosimple
   509  				log.Warn("Failed to send funding error to client", "err", err)
   510  				return
   511  			}
   512  			continue
   513  		}
   514  		if err = sendSuccess(conn, fmt.Sprintf("Funding request accepted for %s into %s", username, address.Hex())); err != nil {
   515  			log.Warn("Failed to send funding success to client", "err", err)
   516  			return
   517  		}
   518  		select {
   519  		case f.update <- struct{}{}:
   520  		default:
   521  		}
   522  	}
   523  }
   524  
   525  // loop keeps waiting for interesting events and pushes them out to connected
   526  // websockets.
   527  func (f *faucet) loop() {
   528  	// Wait for chain events and push them to clients
   529  	heads := make(chan *types.Header, 16)
   530  	sub, err := f.client.SubscribeNewHead(context.Background(), heads)
   531  	if err != nil {
   532  		log.Crit("Failed to subscribe to head events", "err", err)
   533  	}
   534  	defer sub.Unsubscribe()
   535  
   536  	// Start a goroutine to update the state from head notifications in the background
   537  	update := make(chan *types.Header)
   538  
   539  	go func() {
   540  		for head := range update {
   541  			// New chain head arrived, query the current stats and stream to clients
   542  			var (
   543  				balance *big.Int
   544  				nonce   uint64
   545  				price   *big.Int
   546  				err     error
   547  			)
   548  			ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
   549  			balance, err = f.client.BalanceAt(ctx, f.account.Address, head.Number)
   550  			if err == nil {
   551  				nonce, err = f.client.NonceAt(ctx, f.account.Address, nil)
   552  				if err == nil {
   553  					price, err = f.client.SuggestGasPrice(ctx)
   554  				}
   555  			}
   556  			cancel()
   557  
   558  			// If querying the data failed, try for the next block
   559  			if err != nil {
   560  				log.Warn("Failed to update faucet state", "block", head.Number, "hash", head.Hash(), "err", err)
   561  				continue
   562  			} else {
   563  				log.Info("Updated faucet state", "block", head.Number, "hash", head.Hash(), "balance", balance, "nonce", nonce, "price", price)
   564  			}
   565  			// Faucet state retrieved, update locally and send to clients
   566  			balance = new(big.Int).Div(balance, ether)
   567  
   568  			f.lock.Lock()
   569  			f.price, f.nonce = price, nonce
   570  			for len(f.reqs) > 0 && f.reqs[0].Tx.Nonce() < f.nonce {
   571  				f.reqs = f.reqs[1:]
   572  			}
   573  			f.lock.Unlock()
   574  
   575  			f.lock.RLock()
   576  			for _, conn := range f.conns {
   577  				if err := send(conn, map[string]interface{}{
   578  					"funds":    balance,
   579  					"funded":   f.nonce,
   580  					"peers":    f.stack.Server().PeerCount(),
   581  					"requests": f.reqs,
   582  				}, time.Second); err != nil {
   583  					log.Warn("Failed to send stats to client", "err", err)
   584  					conn.Close()
   585  					continue
   586  				}
   587  				if err := send(conn, head, time.Second); err != nil {
   588  					log.Warn("Failed to send header to client", "err", err)
   589  					conn.Close()
   590  				}
   591  			}
   592  			f.lock.RUnlock()
   593  		}
   594  	}()
   595  	// Wait for various events and assing to the appropriate background threads
   596  	for {
   597  		select {
   598  		case head := <-heads:
   599  			// New head arrived, send if for state update if there's none running
   600  			select {
   601  			case update <- head:
   602  			default:
   603  			}
   604  
   605  		case <-f.update:
   606  			// Pending requests updated, stream to clients
   607  			f.lock.RLock()
   608  			for _, conn := range f.conns {
   609  				if err := send(conn, map[string]interface{}{"requests": f.reqs}, time.Second); err != nil {
   610  					log.Warn("Failed to send requests to client", "err", err)
   611  					conn.Close()
   612  				}
   613  			}
   614  			f.lock.RUnlock()
   615  		}
   616  	}
   617  }
   618  
   619  // sends transmits a data packet to the remote end of the websocket, but also
   620  // setting a write deadline to prevent waiting forever on the node.
   621  func send(conn *websocket.Conn, value interface{}, timeout time.Duration) error {
   622  	if timeout == 0 {
   623  		timeout = 60 * time.Second
   624  	}
   625  	conn.SetWriteDeadline(time.Now().Add(timeout))
   626  	return websocket.JSON.Send(conn, value)
   627  }
   628  
   629  // sendError transmits an error to the remote end of the websocket, also setting
   630  // the write deadline to 1 second to prevent waiting forever.
   631  func sendError(conn *websocket.Conn, err error) error {
   632  	return send(conn, map[string]string{"error": err.Error()}, time.Second)
   633  }
   634  
   635  // sendSuccess transmits a success message to the remote end of the websocket, also
   636  // setting the write deadline to 1 second to prevent waiting forever.
   637  func sendSuccess(conn *websocket.Conn, msg string) error {
   638  	return send(conn, map[string]string{"success": msg}, time.Second)
   639  }
   640  
   641  // authGitHub tries to authenticate a faucet request using GitHub gists, returning
   642  // the username, avatar URL and Ethereum address to fund on success.
   643  func authGitHub(url string) (string, string, common.Address, error) {
   644  	// Retrieve the gist from the GitHub Gist APIs
   645  	parts := strings.Split(url, "/")
   646  	req, _ := http.NewRequest("GET", "https://api.github.com/gists/"+parts[len(parts)-1], nil)
   647  	if *githubUser != "" {
   648  		req.SetBasicAuth(*githubUser, *githubToken)
   649  	}
   650  	res, err := http.DefaultClient.Do(req)
   651  	if err != nil {
   652  		return "", "", common.Address{}, err
   653  	}
   654  	var gist struct {
   655  		Owner struct {
   656  			Login string `json:"login"`
   657  		} `json:"owner"`
   658  		Files map[string]struct {
   659  			Content string `json:"content"`
   660  		} `json:"files"`
   661  	}
   662  	err = json.NewDecoder(res.Body).Decode(&gist)
   663  	res.Body.Close()
   664  	if err != nil {
   665  		return "", "", common.Address{}, err
   666  	}
   667  	if gist.Owner.Login == "" {
   668  		return "", "", common.Address{}, errors.New("Anonymous Gists not allowed")
   669  	}
   670  	// Iterate over all the files and look for Ethereum addresses
   671  	var address common.Address
   672  	for _, file := range gist.Files {
   673  		content := strings.TrimSpace(file.Content)
   674  		if len(content) == 2+common.AddressLength*2 {
   675  			address = common.HexToAddress(content)
   676  		}
   677  	}
   678  	if address == (common.Address{}) {
   679  		return "", "", common.Address{}, errors.New("No Ethereum address found to fund")
   680  	}
   681  	// Validate the user's existence since the API is unhelpful here
   682  	if res, err = http.Head("https://github.com/" + gist.Owner.Login); err != nil {
   683  		return "", "", common.Address{}, err
   684  	}
   685  	res.Body.Close()
   686  
   687  	if res.StatusCode != 200 {
   688  		return "", "", common.Address{}, errors.New("Invalid user... boom!")
   689  	}
   690  	// Everything passed validation, return the gathered infos
   691  	return gist.Owner.Login + "@github", fmt.Sprintf("https://github.com/%s.png?size=64", gist.Owner.Login), address, nil
   692  }
   693  
   694  // authTwitter tries to authenticate a faucet request using Twitter posts, returning
   695  // the username, avatar URL and Ethereum address to fund on success.
   696  func authTwitter(url string) (string, string, common.Address, error) {
   697  	// Ensure the user specified a meaningful URL, no fancy nonsense
   698  	parts := strings.Split(url, "/")
   699  	if len(parts) < 4 || parts[len(parts)-2] != "status" {
   700  		return "", "", common.Address{}, errors.New("Invalid Twitter status URL")
   701  	}
   702  	// Twitter's API isn't really friendly with direct links. Still, we don't
   703  	// want to do ask read permissions from users, so just load the public posts and
   704  	// scrape it for the Ethereum address and profile URL.
   705  	res, err := http.Get(url)
   706  	if err != nil {
   707  		return "", "", common.Address{}, err
   708  	}
   709  	defer res.Body.Close()
   710  
   711  	// Resolve the username from the final redirect, no intermediate junk
   712  	parts = strings.Split(res.Request.URL.String(), "/")
   713  	if len(parts) < 4 || parts[len(parts)-2] != "status" {
   714  		return "", "", common.Address{}, errors.New("Invalid Twitter status URL")
   715  	}
   716  	username := parts[len(parts)-3]
   717  
   718  	body, err := ioutil.ReadAll(res.Body)
   719  	if err != nil {
   720  		return "", "", common.Address{}, err
   721  	}
   722  	address := common.HexToAddress(string(regexp.MustCompile("0x[0-9a-fA-F]{40}").Find(body)))
   723  	if address == (common.Address{}) {
   724  		return "", "", common.Address{}, errors.New("No Ethereum address found to fund")
   725  	}
   726  	var avatar string
   727  	if parts = regexp.MustCompile("src=\"([^\"]+twimg.com/profile_images[^\"]+)\"").FindStringSubmatch(string(body)); len(parts) == 2 {
   728  		avatar = parts[1]
   729  	}
   730  	return username + "@twitter", avatar, address, nil
   731  }
   732  
   733  // authGooglePlus tries to authenticate a faucet request using GooglePlus posts,
   734  // returning the username, avatar URL and Ethereum address to fund on success.
   735  func authGooglePlus(url string) (string, string, common.Address, error) {
   736  	// Ensure the user specified a meaningful URL, no fancy nonsense
   737  	parts := strings.Split(url, "/")
   738  	if len(parts) < 4 || parts[len(parts)-2] != "posts" {
   739  		return "", "", common.Address{}, errors.New("Invalid Google+ post URL")
   740  	}
   741  	username := parts[len(parts)-3]
   742  
   743  	// Google's API isn't really friendly with direct links. Still, we don't
   744  	// want to do ask read permissions from users, so just load the public posts and
   745  	// scrape it for the Ethereum address and profile URL.
   746  	res, err := http.Get(url)
   747  	if err != nil {
   748  		return "", "", common.Address{}, err
   749  	}
   750  	defer res.Body.Close()
   751  
   752  	body, err := ioutil.ReadAll(res.Body)
   753  	if err != nil {
   754  		return "", "", common.Address{}, err
   755  	}
   756  	address := common.HexToAddress(string(regexp.MustCompile("0x[0-9a-fA-F]{40}").Find(body)))
   757  	if address == (common.Address{}) {
   758  		return "", "", common.Address{}, errors.New("No Ethereum address found to fund")
   759  	}
   760  	var avatar string
   761  	if parts = regexp.MustCompile("src=\"([^\"]+googleusercontent.com[^\"]+photo.jpg)\"").FindStringSubmatch(string(body)); len(parts) == 2 {
   762  		avatar = parts[1]
   763  	}
   764  	return username + "@google+", avatar, address, nil
   765  }
   766  
   767  // authFacebook tries to authenticate a faucet request using Facebook posts,
   768  // returning the username, avatar URL and Ethereum address to fund on success.
   769  func authFacebook(url string) (string, string, common.Address, error) {
   770  	// Ensure the user specified a meaningful URL, no fancy nonsense
   771  	parts := strings.Split(url, "/")
   772  	if len(parts) < 4 || parts[len(parts)-2] != "posts" {
   773  		return "", "", common.Address{}, errors.New("Invalid Facebook post URL")
   774  	}
   775  	username := parts[len(parts)-3]
   776  
   777  	// Facebook's Graph API isn't really friendly with direct links. Still, we don't
   778  	// want to do ask read permissions from users, so just load the public posts and
   779  	// scrape it for the Ethereum address and profile URL.
   780  	res, err := http.Get(url)
   781  	if err != nil {
   782  		return "", "", common.Address{}, err
   783  	}
   784  	defer res.Body.Close()
   785  
   786  	body, err := ioutil.ReadAll(res.Body)
   787  	if err != nil {
   788  		return "", "", common.Address{}, err
   789  	}
   790  	address := common.HexToAddress(string(regexp.MustCompile("0x[0-9a-fA-F]{40}").Find(body)))
   791  	if address == (common.Address{}) {
   792  		return "", "", common.Address{}, errors.New("No Ethereum address found to fund")
   793  	}
   794  	var avatar string
   795  	if parts = regexp.MustCompile("src=\"([^\"]+fbcdn.net[^\"]+)\"").FindStringSubmatch(string(body)); len(parts) == 2 {
   796  		avatar = parts[1]
   797  	}
   798  	return username + "@facebook", avatar, address, nil
   799  }
   800  
   801  // authNoAuth tries to interpret a faucet request as a plain Ethereum address,
   802  // without actually performing any remote authentication. This mode is prone to
   803  // Byzantine attack, so only ever use for truly private networks.
   804  func authNoAuth(url string) (string, string, common.Address, error) {
   805  	address := common.HexToAddress(regexp.MustCompile("0x[0-9a-fA-F]{40}").FindString(url))
   806  	if address == (common.Address{}) {
   807  		return "", "", common.Address{}, errors.New("No Ethereum address found to fund")
   808  	}
   809  	return address.Hex() + "@noauth", "", address, nil
   810  }