543 lines
481 KiB
Go
543 lines
481 KiB
Go
|
// Copyright 2017 The go-ethereum Authors
|
||
|
|
// This file is part of go-ethereum.
|
||
|
|
//
|
||
|
|
// go-ethereum is free software: you can redistribute it and/or modify
|
||
|
|
// it under the terms of the GNU General Public License as published by
|
||
|
|
// the Free Software Foundation, either version 3 of the License, or
|
||
|
|
// (at your option) any later version.
|
||
|
|
//
|
||
|
|
// go-ethereum 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 General Public License for more details.
|
||
|
|
//
|
||
|
|
// You should have received a copy of the GNU General Public License
|
||
|
|
// along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
package main
|
||
|
|
|
||
|
|
import (
|
||
|
|
"bytes"
|
||
|
|
"fmt"
|
||
|
|
"html/template"
|
||
|
|
"math/rand"
|
||
|
|
"path/filepath"
|
||
|
|
"strings"
|
||
|
|
|
||
|
|
"github.com/ethereum/go-ethereum/log"
|
||
|
|
)
|
||
|
|
|
||
|
|
// dashboardContent is the actual dashboard HTML content to serve up when users
|
||
|
|
// load the dashboard website.
|
||
|
|
var dashboardContent = `
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<!-- Meta, title, CSS, favicons, etc. -->
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
|
||
|
|
<title>{{.NetworkTitle}}: Ethereum Testnet</title>
|
||
|
|
|
||
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet">
|
||
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">
|
||
|
|
<link href="https://cdnjs.cloudflare.com/ajax/libs/gentelella/1.3.0/css/custom.min.css" rel="stylesheet">
|
||
|
|
<style>
|
||
|
|
.vertical-center {
|
||
|
|
min-height: 100%;
|
||
|
|
min-height: 95vh;
|
||
|
|
display: flex;
|
||
|
|
align-items: center;
|
||
|
|
}
|
||
|
|
.nav.side-menu li a {
|
||
|
|
font-size: 18px;
|
||
|
|
}
|
||
|
|
.nav-sm .nav.side-menu li a {
|
||
|
|
font-size: 10px;
|
||
|
|
}
|
||
|
|
pre{
|
||
|
|
white-space: pre-wrap;
|
||
|
|
}
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body class="nav-sm" style="overflow-x: hidden">
|
||
|
|
<div class="container body">
|
||
|
|
<div class="main_container">
|
||
|
|
<div class="col-md-3 left_col">
|
||
|
|
<div class="left_col scroll-view">
|
||
|
|
<div class="navbar nav_title" style="border: 0; margin-top: 8px;">
|
||
|
|
<a class="site_title"><i class="fa fa-globe" style="margin-left: 6px"></i> <span>{{.NetworkTitle}} Testnet</span></a>
|
||
|
|
</div>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
<br />
|
||
|
|
<div id="sidebar-menu" class="main_menu_side hidden-print main_menu">
|
||
|
|
<div class="menu_section">
|
||
|
|
<ul class="nav side-menu">
|
||
|
|
{{if .EthstatsPage}}<li><a onclick="load('//{{.EthstatsPage}}')"><i class="fa fa-tachometer"></i> Network Stats</a></li>{{end}}
|
||
|
|
{{if .ExplorerPage}}<li><a onclick="load('//{{.ExplorerPage}}')"><i class="fa fa-database"></i> Block Explorer</a></li>{{end}}
|
||
|
|
{{if .WalletPage}}<li><a onclick="load('//{{.WalletPage}}')"><i class="fa fa-address-book-o"></i> Browser Wallet</a></li>{{end}}
|
||
|
|
{{if .FaucetPage}}<li><a onclick="load('//{{.FaucetPage}}')"><i class="fa fa-bath"></i> Crypto Faucet</a></li>{{end}}
|
||
|
|
<li id="connect"><a><i class="fa fa-plug"></i> Connect Yourself</a>
|
||
|
|
<ul id="connect_list" class="nav child_menu">
|
||
|
|
<li><a onclick="$('#connect').removeClass('active'); $('#connect_list').toggle(); load('#connect-go-ethereum-geth')">Go Ethereum: Geth</a></li>
|
||
|
|
<li><a onclick="$('#connect').removeClass('active'); $('#connect_list').toggle(); load('#connect-go-ethereum-mist')">Go Ethereum: Wallet & Mist</a></li>
|
||
|
|
<li><a onclick="$('#connect').removeClass('active'); $('#connect_list').toggle(); load('#connect-go-ethereum-mobile')">Go Ethereum: Android & iOS</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><a onclick="load('#about')"><i class="fa fa-heartbeat"></i> About Puppeth</a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="right_col" role="main" style="padding: 0">
|
||
|
|
<div id="connect-go-ethereum-geth" hidden style="padding: 16px;">
|
||
|
|
<div class="page-title">
|
||
|
|
<div class="title_left">
|
||
|
|
<h3>Connect Yourself – Go Ethereum: Geth</h3>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-archive" aria-hidden="true"></i> Archive node <small>Retains all historical data</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>An archive node synchronizes the blockchain by downloading the full chain from the genesis block to the current head block, executing all the transactions contained within. As the node crunches through the transactions, all past historical state is stored on disk, and can be queried for each and every block.</p>
|
||
|
|
<p>Initial processing required to execute all transactions may require non-negligible time and disk capacity required to store all past state may be non-insignificant. High end machines with SSD storage, modern CPUs and 8GB+ RAM are recommended.</p>
|
||
|
|
<br/>
|
||
|
|
<p>To run an archive node, download <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> and start Geth with:
|
||
|
|
<pre>geth --datadir=$HOME/.{{.Network}} init {{.GethGenesis}}</pre>
|
||
|
|
<pre>geth --networkid={{.NetworkID}} --datadir=$HOME/.{{.Network}} --cache=1024 --syncmode=full{{if .Ethstats}} --ethstats='{{.Ethstats}}'{{end}} --bootnodes={{.BootnodesFullFlat}}</pre>
|
||
|
|
</p>
|
||
|
|
<br/>
|
||
|
|
<p>You can download Geth from <a href="https://geth.ethereum.org/downloads/" target="about:blank">https://geth.ethereum.org/downloads/</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-laptop" aria-hidden="true"></i> Full node <small>Retains recent data only</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>A full node synchronizes the blockchain by downloading the full chain from the genesis block to the current head block, but does not execute the transactions. Instead, it downloads all the transactions receipts along with the entire recent state. As the node downloads the recent state directly, historical data can only be queried from that block onward.</p>
|
||
|
|
<p>Initial processing required to synchronize is more bandwidth intensive, but is light on the CPU and has significantly reduced disk requirements. Mid range machines with HDD storage, decent CPUs and 4GB+ RAM should be enough.</p>
|
||
|
|
<br/>
|
||
|
|
<p>To run a full node, download <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> and start Geth with:
|
||
|
|
<pre>geth --datadir=$HOME/.{{.Network}} init {{.GethGenesis}}</pre>
|
||
|
|
<pre>geth --networkid={{.NetworkID}} --datadir=$HOME/.{{.Network}} --cache=512{{if .Ethstats}} --ethstats='{{.Ethstats}}'{{end}} --bootnodes={{.BootnodesFullFlat}}</pre>
|
||
|
|
</p>
|
||
|
|
<br/>
|
||
|
|
<p>You can download Geth from <a href="https://geth.ethereum.org/downloads/" target="about:blank">https://geth.ethereum.org/downloads/</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-mobile" aria-hidden="true"></i> Light node <small>Retrieves data on demand</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>A light node synchronizes the blockchain by downloading and verifying only the chain of headers from the genesis block to the current head, without executing any transactions or retrieving any associated state. As no state is available locally, any interaction with the blockchain relies on on-demand data retrievals from remote nodes.</p>
|
||
|
|
<p>Initial processing required to synchronize is light, as it only verifies the validity of the headers; similarly required disk capacity is small, tallying around 500 bytes per header. Low end machines with arbitrary storage, weak CPUs and 512MB+ RAM should cope well.</p>
|
||
|
|
<br/>
|
||
|
|
<p>To run a light node, download <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> and start Geth with:
|
||
|
|
<pre>geth --datadir=$HOME/.{{.Network}} --light init {{.GethGenesis}}</pre>
|
||
|
|
<pre>geth --networkid={{.NetworkID}} --datadir=$HOME/.{{.Network}} --syncmode=light{{if .Ethstats}} --ethstats='{{.Ethstats}}'{{end}} --bootnodes={{.BootnodesLightFlat}}</pre>
|
||
|
|
</p>
|
||
|
|
<br/>
|
||
|
|
<p>You can download Geth from <a href="https://geth.ethereum.org/downloads/" target="about:blank">https://geth.ethereum.org/downloads/</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-microchip" aria-hidden="true"></i> Embedded node <small>Conserves memory vs. speed</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>An embedded node is a variation of the light node with configuration parameters tuned towards low memory footprint. As such, it may sacrifice processing and disk IO performance to conserve memory. It should be considered an <strong>experimental</strong> direction for now without hard guarantees or bounds on the resources used.</p>
|
||
|
|
<p>Initial processing required to synchronize is light, as it only verifies the validity of the headers; similarly required disk capacity is small, tallying around 500 bytes per header. Embedded machines with arbitrary storage, low power CPUs and 128MB+ RAM may work.</p>
|
||
|
|
<br/>
|
||
|
|
<p>To run an embedded node, download <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> and start Geth with:
|
||
|
|
<pre>geth --datadir=$HOME/.{{.Network}} --light init {{.GethGenesis}}</pre>
|
||
|
|
<pre>geth --networkid={{.NetworkID}} --datadir=$HOME/.{{.Network}} --cache=32 --syncmode=light{{if .Ethstats}} --ethstats='{{.Ethstats}}'{{end}} --bootnodes={{.BootnodesLightFlat}}</pre>
|
||
|
|
</p>
|
||
|
|
<br/>
|
||
|
|
<p>You can download Geth from <a href="https://geth.ethereum.org/downloads/" target="about:blank">https://geth.ethereum.org/downloads/</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="connect-go-ethereum-mist" hidden style="padding: 16px;">
|
||
|
|
<div class="page-title">
|
||
|
|
<div class="title_left">
|
||
|
|
<h3>Connect Yourself – Go Ethereum: Wallet & Mist</h3>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-credit-card" aria-hidden="true"></i> Desktop wallet <small>Interacts with accounts and contracts</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>The Ethereum Wallet is an <a href="https://electron.atom.io/" target="about:blank">Electron</a> based desktop application to manage your Ethereum accounts and funds. Beside the usual account life-cycle operations you would expect to perform, the wallet also provides a means to send transactions from your accounts and to interact with smart contracts deployed on the network.</p>
|
||
|
|
<p>Under the hood the wallet is backed by a go-ethereum full node, meaning that a mid range machine is assumed. Similarly, synchronization is based on <strong>fast-sync</strong>, which will download all blockchain data from the network and make it available to the wallet. Light nodes cannot currently fully back the wallet, but it's a target actively pursued.</p>
|
||
|
|
<br/>
|
||
|
|
<p>To connect with the Ethereum Wallet, you'll need to initialize your private network first via Geth as the wallet does not currently support calling Geth directly. To initialize your local chain, download <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> and run:
|
||
|
|
<pre>geth --datadir=$HOME/.{{.Network}} init {{.GethGenesis}}</pre>
|
||
|
|
</p>
|
||
|
|
<p>With your local chain initialized, you can start the Ethereum Wallet:
|
||
|
|
<pre>ethereumwallet --rpc $HOME/.{{.Network}}/geth.ipc --node-networkid={{.NetworkID}} --node-datadir=$HOME/.{{.Network}}{{if .Ethstats}} --node-ethstats='{{.Ethstats}}'{{end}} --node-bootnodes={{.BootnodesFullFlat}}</pre>
|
||
|
|
<p>
|
||
|
|
<br/>
|
||
|
|
<p>You can download the Ethereum Wallet from <a href="https://github.com/ethereum/mist/releases" target="about:blank">https://github.com/ethereum/mist/releases</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-picture-o" aria-hidden="true"></i> Mist browser <small>Interacts with third party DApps</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>The Mist browser is an <a href="https://electron.atom.io/" target="about:blank">Electron</a> based desktop application to load and interact with Ethereum enabled third party web DApps. Beside all the functionality provided by the Ethereum Wallet, Mist is an extended web-browser where loaded pages have access to the Ethereum network via a web3.js provider, and may also interact with users' own accounts (given proper authorization and confirmation of course).</p>
|
||
|
|
<p>Under the hood the browser is backed by a go-ethereum full node, meaning that a mid range machine is assumed. Similarly, synchronization is based on <strong>fast-sync</strong>, which will download all blockchain data from the network and make it available to the wallet. Light nodes cannot currently fully back the wallet, but it's a target actively pursued.</p>
|
||
|
|
<br/>
|
||
|
|
<p>To connect with the Mist browser, you'll need to initialize your private network first via Geth as Mist does not currently support calling Geth directly. To initialize your local chain, download <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> and run:
|
||
|
|
<pre>geth --datadir=$HOME/.{{.Network}} init {{.GethGenesis}}</pre>
|
||
|
|
</p>
|
||
|
|
<p>With your local chain initialized, you can start Mist:
|
||
|
|
<pre>mist --rpc $HOME/.{{.Network}}/geth.ipc --node-networkid={{.NetworkID}} --node-datadir=$HOME/.{{.Network}}{{if .Ethstats}} --node-ethstats='{{.Ethstats}}'{{end}} --node-bootnodes={{.BootnodesFullFlat}}</pre>
|
||
|
|
<p>
|
||
|
|
<br/>
|
||
|
|
<p>You can download the Mist browser from <a href="https://github.com/ethereum/mist/releases" target="about:blank">https://github.com/ethereum/mist/releases</a>.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="connect-go-ethereum-mobile" hidden style="padding: 16px;">
|
||
|
|
<div class="page-title">
|
||
|
|
<div class="title_left">
|
||
|
|
<h3>Connect Yourself – Go Ethereum: Android & iOS</h3>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
<div class="row">
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-android" aria-hidden="true"></i> Android devices <small>Accesses Ethereum via Java</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>Starting with the 1.5 release of go-ethereum, we've transitioned away from shipping only full blown Ethereum clients and started focusing on releasing the code as reusable packages initially for Go projects, then later for Java based Android projects too. Mobile support is still evolving, hence is bound to change often and hard, but the Ethereum network can nonetheless be accessed from Android too.</p>
|
||
|
|
<p>Under the hood the Android library is backed by a go-ethereum light node, meaning that given a not-too-old Android device, you should be able to join the network without significant issues. Certain functionality is not yet available and rough edges are bound to appear here and there, please report issues if you find any.</p>
|
||
|
|
<br/>
|
||
|
|
<p>The stable Android archives are distributed via Maven Central, and the develop snapshots via the Sonatype repositories. Before proceeding, please ensure you have a recent version configured in your Android project. You can find details in <a href="https://github.com/ethereum/go-ethereum/wiki/Mobile:-Introduction#android-archive" target="about:blank">Mobile: Introduction – Android archive</a>.
|
||
|
|
<p>Before connecting to the Ethereum network, download the <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> genesis json file and either store it in your Android project as a resource file you can access, or save it as a string in a variable. You're going to need to to initialize your client.</p>
|
||
|
|
<p>Inside your Java code you can now import the geth archive and connect to Ethereum:
|
||
|
|
<pre>import org.ethereum.geth.*;</pre>
|
||
|
|
<pre>
|
||
|
|
Enodes bootnodes = new Enodes();{{range .BootnodesLight}}
|
||
|
|
bootnodes.append(new Enode("{{.}}"));{{end}}
|
||
|
|
|
||
|
|
NodeConfig config = new NodeConfig();
|
||
|
|
config.setBootstrapNodes(bootnodes);
|
||
|
|
config.setEthereumNetworkID({{.NetworkID}});
|
||
|
|
config.setEthereumGenesis(genesis);{{if .Ethstats}}
|
||
|
|
config.setEthereumNetStats("{{.Ethstats}}");{{end}}
|
||
|
|
|
||
|
|
Node node = new Node(getFilesDir() + "/.{{.Network}}", config);
|
||
|
|
node.start();
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="col-md-6">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h2><i class="fa fa-apple" aria-hidden="true"></i> iOS devices <small>Accesses Ethereum via ObjC/Swift</small></h2>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div class="x_content">
|
||
|
|
<p>Starting with the 1.5 release of go-ethereum, we've transitioned away from shipping only full blown Ethereum clients and started focusing on releasing the code as reusable packages initially for Go projects, then later for ObjC/Swift based iOS projects too. Mobile support is still evolving, hence is bound to change often and hard, but the Ethereum network can nonetheless be accessed from iOS too.</p>
|
||
|
|
<p>Under the hood the iOS library is backed by a go-ethereum light node, meaning that given a not-too-old Apple device, you should be able to join the network without significant issues. Certain functionality is not yet available and rough edges are bound to appear here and there, please report issues if you find any.</p>
|
||
|
|
<br/>
|
||
|
|
<p>Both stable and develop builds of the iOS framework are available via CocoaPods. Before proceeding, please ensure you have a recent version configured in your iOS project. You can find details in <a href="https://github.com/ethereum/go-ethereum/wiki/Mobile:-Introduction#ios-framework" target="about:blank">Mobile: Introduction – iOS framework</a>.
|
||
|
|
<p>Before connecting to the Ethereum network, download the <a href="/{{.GethGenesis}}"><code>{{.GethGenesis}}</code></a> genesis json file and either store it in your iOS project as a resource file you can access, or save it as a string in a variable. You're going to need to to initialize your client.</p>
|
||
|
|
<p>Inside your Swift code you can now import the geth framework and connect to Ethereum (ObjC should be analogous):
|
||
|
|
<pre>import Geth</pre>
|
||
|
|
<pre>
|
||
|
|
var error: NSError?
|
||
|
|
|
||
|
|
let bootnodes = GethNewEnodesEmpty(){{range .BootnodesLight}}
|
||
|
|
bootnodes?.append(GethNewEnode("{{.}}", &error)){{end}}
|
||
|
|
|
||
|
|
let config = GethNewNodeConfig()
|
||
|
|
config?.setBootstrapNodes(bootnodes)
|
||
|
|
config?.setEthereumNetworkID({{.NetworkID}})
|
||
|
|
config?.setEthereumGenesis(genesis){{if .Ethstats}}
|
||
|
|
config?.setEthereumNetStats("{{.Ethstats}}"){{end}}
|
||
|
|
|
||
|
|
let datadir = NSSearchPathForDirectoriesInDomains(.documentDirectory, .userDomainMask, true)[0]
|
||
|
|
let node = GethNewNode(datadir + "/.{{.Network}}", config, &error);
|
||
|
|
try! node?.start();
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="about" hidden>
|
||
|
|
<div class="row vertical-center">
|
||
|
|
<div style="margin: 0 auto;">
|
||
|
|
<div class="x_panel">
|
||
|
|
<div class="x_title">
|
||
|
|
<h3>Puppeth – Your Ethereum private network manager</h3>
|
||
|
|
<div class="clearfix"></div>
|
||
|
|
</div>
|
||
|
|
<div style="display: inline-block; vertical-align: bottom; width: 623px; margin-top: 16px;">
|
||
|
|
<p>Puppeth is a tool to aid you in creating a new Ethereum network down to the genesis block, bootnodes, signers, ethstats server, crypto faucet, wallet browsers, block explorer, dashboard and more; without the hassle that it would normally entail to manually configure all these services one by one.</p>
|
||
|
|
<p>Puppeth uses ssh to dial in to remote servers, and builds its network components out of docker containers using docker-compose. The user is guided through the process via a command line wizard that does the heavy lifting and topology configuration automatically behind the scenes.</p>
|
||
|
|
<br/>
|
||
|
|
<p>Puppeth is distributed as part of the <a href="https://geth.ethereum.org/downloads/" target="about:blank">Geth & Tools</a> bundles, but can also be installed separately via:<pre>go get github.com/ethereum/go-ethereum/cmd/puppeth</pre></p>
|
||
|
|
<br/>
|
||
|
|
<p><em>Copyright 2017. The go-ethereum Authors.</em></p>
|
||
|
|
</div>
|
||
|
|
<div style="display: inline-block; vertical-align: bottom; width: 217px;">
|
||
|
|
<img src="puppeth.png" style="height: 256px; margin: 16px 16px 16px 16px"></img>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="frame-wrapper" hidden style="position: absolute; height: 100%;">
|
||
|
|
<iframe id="frame" style="position: absolute; width: 1920px; height: 100%; border: none;" onload="if ($(this).attr('src') != '') { resize(); $('#frame-wrapper').fadeIn(300); }"></iframe>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.0/jquery.min.js"></script>
|
||
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script>
|
||
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/gentelella/1.3.0/js/custom.min.js"></script>
|
||
|
|
<script>
|
||
|
|
var load = function(url) {
|
||
|
|
$("#connect-go-ethereum-geth").fadeOut(300)
|
||
|
|
$("#connect-go-ethereum-mist").fadeOut(300)
|
||
|
|
$("#connect-go-ethereum-mobile").fadeOut(300)
|
||
|
|
$("#about").fadeOut(300)
|
||
|
|
$("#frame-wrapper").fadeOut(300);
|
||
|
|
|
||
|
|
setTimeout(function() {
|
||
|
|
if (url.substring(0, 1) == "#") {
|
||
|
|
$('.body').css({overflowY: 'auto'});
|
||
|
|
$("#frame").attr("src", "");
|
||
|
|
$(url).fadeIn(300);
|
||
|
|
} else {
|
||
|
|
$('.body').css({overflowY: 'hidden'});
|
||
|
|
$("#frame").attr("src", url);
|
||
|
|
}
|
||
|
|
}, 300);
|
||
|
|
}
|
||
|
|
var resize = function() {
|
||
|
|
var sidebar = $($(".navbar")[0]).width();
|
||
|
|
var content = 1920;
|
||
|
|
var limit = document.body.clientWidth - sidebar;
|
||
|
|
var scale = limit / content;
|
||
|
|
|
||
|
|
console.log(document.body.clientHeight);
|
||
|
|
|
||
|
|
$("#frame-wrapper").width(content / scale);
|
||
|
|
$("#frame-wrapper").height(document.body.clientHeight / scale);
|
||
|
|
$("#frame-wrapper").css({
|
||
|
|
transform: 'scale(' + (scale) + ')',
|
||
|
|
transformOrigin: "0 0"
|
||
|
|
});
|
||
|
|
};
|
||
|
|
$(window).resize(resize);
|
||
|
|
|
||
|
|
var item = $(".side-menu").children()[0];
|
||
|
|
$(item).children()[0].click();
|
||
|
|
$(item).addClass("active");
|
||
|
|
</script>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
`
|
||
|
|
|
||
|
|
// dashboardMascot is the png dump of the mascot to display on the dashboard about page.
|
||
|
|
var dashboardMascot = []byte("\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x01s\x00\x00\x02\x00\b\x06\x00\x00\x00p\xe4\x8c`\x00\x00\x00\x06bKGD\x00\xff\x00\xff\x00\xff\xa0\xbd\xa7\x93\x00\x00\x00\tpHYs\x00\x00\v\x13\x00\x00\v\x13\x01\x00\x9a\x9c\x18\x00\x00\x00\atIME\a\xe1\x03\x1d\x0e0&\xf3\xca\t\x11\x00\x00\x00\x1diTXtComment\x00\x00\x00\x00\x00Created with GIMPd.e\a\x00\x00 \x00IDATx\xda\xec\xbdw|\x15U\xfe\xff\xff<3s[\x12BB\x12H!\x90\u0411&H\a\x01i\"V\xb0!b\xc1^>\xbb\xee\xae\xdd\xd5u\xed}-k/X\u058e\xa8\xa0\u049bH\x87\bH\xef\x04BI\x81\xf4[\xa6\x9c\xf3\xfbcnB`\xdd\xef\xcf\xdd\xd5\xddU\xe7\xf9x\\\u023d\u027dw\xee\u0339\xafy\xcd\xfb\xbc\xcf\xfb\r\x1e\x1e\xff\";wn\x17\xb7\xdf~\xabQw_)\xa5+\xa5\x1a)\xa5\u0494R\xc9J\xa9D\xa5T\xf0\xb8\xa7\xe9\x1f|\xf0\x9eQYyXx{\xd0\xc3\xe3\xc7\xc3\xfbBy\xfcK\xbc\xf3\xce[\xe2\xd2K/Wq\x11o>y\xf2G'\xaf[\xb7\xae\xff\u05ad\xdb2\xa5\x94\xa9\xd1h\xb4:---\u06b9s\xe7HJJ\xf2\xb2f\xcd27\x9e}\xf6\x98\"!\xc4\u07ba\xd7x\xf6\xd9g\xb4\xcb.\xbbD\xa6\xa4\xa4\xb1d\xc97\f\x18p\xb2\xb7c=<<1\xf7\xf8O\xf0\x97\xbf<EII\x89x\xf4\xd1\xc7\x14\xc0\x8c\xe9_\x0e\xffv\u035a\xa7\u05ec]\u05f9`\xf5jJK\xcb0M\x13M\xd3\b\x85B4i\x92J\xabV\xf9\xe4\xe5\u54d9\x99Y\x90\x9a\x9a2\xa5_\xbf\xfeS\xfb\xf5\ubfe9\xee5o\xba\xe9V\x9e}\xf6\t\x94R\b\xe1\rI\x0f\x0f\x0f\x8f\x9f\x9c\xf7\xde{\xb7\x81;\u007fs\xe4\xc4+.\xafi\u04e6\x8d\x02\xfe\xe1M\xd75\x95\x9c\x9c\xacZ\xb7n\xadF\x8d\x1a\xa5\u018d\xbbp\xd7=\xf7\xfc\xf1\xf5\xaf\x17.\x18q\xfc\xeb\u007f\xfa\xe9'\xdeN\xf6\xf0\xf0\xf0\xf8\xa9\xc9i\x9e\v\xc0\x97_N\x1bq\u0265\x97\x1c\xceh\u06b4^\xb4\x85\xa6)\xc3\xe7S>\xbf_\x89\xef\x15u]\x86B!\x99\x93\x93\xa3\xfa\xf6\xed\xab.\xb8\xe0\x82\x8a\a\x1e\xb8\xef\x83}\xfbv\xf7k\xf8\x1e\u007f\xf8\xc3\x1f\xc4\u0739\xb3\xbc\x9d\xed\xe1\xe1\xe1\xf1S\xb0r\xe5r\r@)\xd5\xee\xf6\xdbo\u06d2\u07fa\xb5\x02$\xa04]W\x86\xe1S\t\u024dUjV\xaeJ\xcdn\xa9\x12S\u04d5\x10\xe2\x18A\x17B(\xbf\xdfo'5jde\xe74W\xfd\xfa\xf5WW^yE\xe5k\xaf\xbf\xfa\xa0R*\xb1\xee\xbdz\xf7\xee#\xdex\xe35o\xa7{x\xfc@\fo\x17x\xfc\x10\x94R\x9cz\xeaH\x00\xfe\xf6\xb7\xb7\xaf\u0634yK\xfb\xdd;w\u0680\xa1\xe9:\x86\xcfO\x93\xdc\xd6t\x18r\x06\x19m\xbb\xa0\xe9\x06f\xd5\x11\xcavmd\xff\xa65\x1c\u06be\x91pU\x05J)L\xd3\xd4\x1d)\xb1\x1d\u01e9\xae\xae\xe1\u0421\x83\u027bw\xef\xfe\xe3\x96\xcd[\u03999s\xfam\xa3F\x8d\x9e\xber\xe5\n\xb5r\xe5\n>\xfa\xe8\x03q\xe1\x85\x17)\xef\bxxxx\xfc\b\u0318\xf1U\x9d+O\xbe\u66ab\xe7\xb6\xcc\xcbW\x80\x85\x10J7|\xaay\x97^\ua497\xa7\xab{\xd7Ku\xcfw\x8e\xbao\x83\xa3\x9e\xd8\"\xd53[\x1d\xf5\xe0\xd2\xfd\xea\xca\x17>Q\xfd/\xbcZ\xa5\xe5\xe6\xff]X&!1Q\xa6\xa5\xa5\xa9\xf6\xed\u06ebs\xce9[=\xfa\xe8#\x1f\u06b6\x99Y\xf7\u0793&\xbd\xe1\x99\x0e\x0f\x0f\u03d9{\xfc\x18l\u0630A\x03\xe4\xf4\xe9\xd3z\x95\x1d>\xd2\xfdPq1\x80.4\x8d`R2\x9dF\x9eG\xab\xc1\xa7\x11\x8dJ|\xd2B\xf3\t4\f4M#%3\x9b\x93\xce<\x97\x13O=\x97\xc2u+Y\xf1\xc9$VM{\x8fhm\r\xb6\x94H\xc7\x11JJu\xe8\xd0!QYYIY\xd9\xe1\v\v\v\v{\xbf\xfa\xea\xcb\u007f\xbc\xfa\xeak?\x12B\xd8c\u019c\xa3=\xf0\xc0\xfd\xaas\u7b9eK\xf7\xf0\xf0\xc4\xdc\xe3\xdf\b\xb3\u803dq\u00e6v\xa6i6\x89E\xc2\x12\xd0p\x1c2\xf2\xdb\u04a6\xcf`t\xc0pb\x04|\x02\x03\xb0-\vi\x83\xa6\t\x10\x02C\xf7\u0476ooZu\xefM\x87\x81#\x98?\xe9iv\x16,AJI$\x12\x11J)4Mc\u02d6-\x1c<x0\xff\u0421C\xefWTT\x9c\xa7\x94\xfa\x83\x10\xa2\xf0\xb3\xcf>\xe7\xc9'\x9f\x10II\x89\xea\xba\xebn\xf0\x0e\x8a\x87G\x03to\x17x\xfc\x10\xe6\u0319\xeb(\xa5\xf4\x85\v\x17\\\xb5x\xf1\u0493JJJ\x00\x84\xa6\xe9\xe4\x9f4\x90^\xe7\\\x8a\xdf\x1f\xc4'\x1c4\x01 @\x80B\xe1(\x85t\x14\xb6\xed`\xc5\x1c\x84\xd0\xc9\xed|\x02\xed\xfb\x8d\xc4\x17\brp\xebz,3\x86m\xdbH)\xd14\r\u02f2\u063f\u007f?\xd5\xd5\xd5\x1d\xb7n\xdd:\xfc\xfd\xf7\u07dd\xf3\xf4\xd3\xcf\x1c\x99={\x0eYYYb\xfc\xf8q\u031e=\xc7;0\x1e\x1eq4o\x17x\xfc\x13\xe4X\x96\u0569\xa2\xa2<\xae\xd6`\x04\x83\xa4d\u5498\x92\x8a\x81D\x17u+\xd1\x14(\x85T \x158\xb87KB,\x16\xa5\xb6\"L\x93\x9c\xe6\x9cu\xcb\xc3\\\xf9\u0707\xb4\xee\xd1\x1f\x00\xd34\xa9\xad\xad\xc54M\xa4t\xd4\u06b5\xeb\x983gn\xe7G\x1ey\xec\u04d2\x92\x03\xb9\x00\xaf\xbd\xf6\xba*--\xf5V\x17yxxb\xee\xf1\xafP[Se\x16\x15\xed\x8fX\x8e\x13Wk\b$$\xd18\xb39\x9a\x06\x02\x85&@\x8b\vz\xc3\u015c\ueb27B\x01\xb6\u0490B'\\S\x8be\xd9t\x191\x8a\u02df\xf9\x80\xbec/\x03\xc0\xb6mjjj\x88FcB
|
||
|
|
|
||
|
|
// dashboardDockerfile is the Dockerfile required to build an dashboard container
|
||
|
|
// to aggregate various private network services under one easily accessible page.
|
||
|
|
var dashboardDockerfile = `
|
||
|
|
FROM mhart/alpine-node:latest
|
||
|
|
|
||
|
|
RUN \
|
||
|
|
npm install connect serve-static && \
|
||
|
|
\
|
||
|
|
echo 'var connect = require("connect");' > server.js && \
|
||
|
|
echo 'var serveStatic = require("serve-static");' >> server.js && \
|
||
|
|
echo 'connect().use(serveStatic("/dashboard")).listen(80, function(){' >> server.js && \
|
||
|
|
echo ' console.log("Server running on 80...");' >> server.js && \
|
||
|
|
echo '});' >> server.js
|
||
|
|
|
||
|
|
ADD {{.Network}}.json /dashboard/{{.Network}}.json
|
||
|
|
ADD index.html /dashboard/index.html
|
||
|
|
ADD puppeth.png /dashboard/puppeth.png
|
||
|
|
|
||
|
|
EXPOSE 80
|
||
|
|
|
||
|
|
CMD ["node", "/server.js"]
|
||
|
|
`
|
||
|
|
|
||
|
|
// dashboardComposefile is the docker-compose.yml file required to deploy and
|
||
|
|
// maintain an service aggregating dashboard.
|
||
|
|
var dashboardComposefile = `
|
||
|
|
version: '2'
|
||
|
|
services:
|
||
|
|
dashboard:
|
||
|
|
build: .
|
||
|
|
image: {{.Network}}/dashboard{{if not .VHost}}
|
||
|
|
ports:
|
||
|
|
- "{{.Port}}:80"{{else}}
|
||
|
|
environment:
|
||
|
|
- VIRTUAL_HOST={{.VHost}}{{end}}
|
||
|
|
logging:
|
||
|
|
driver: "json-file"
|
||
|
|
options:
|
||
|
|
max-size: "1m"
|
||
|
|
max-file: "10"
|
||
|
|
restart: always
|
||
|
|
`
|
||
|
|
|
||
|
|
// deployDashboard deploys a new dashboard container to a remote machine via SSH,
|
||
|
|
// docker and docker-compose. If an instance with the specified network name
|
||
|
|
// already exists there, it will be overwritten!
|
||
|
|
func deployDashboard(client *sshClient, network string, port int, vhost string, services map[string]string, conf *config, ethstats bool) ([]byte, error) {
|
||
|
|
// Generate the content to upload to the server
|
||
|
|
workdir := fmt.Sprintf("%d", rand.Int63())
|
||
|
|
files := make(map[string][]byte)
|
||
|
|
|
||
|
|
dockerfile := new(bytes.Buffer)
|
||
|
|
template.Must(template.New("").Parse(dashboardDockerfile)).Execute(dockerfile, map[string]interface{}{
|
||
|
|
"Network": network,
|
||
|
|
})
|
||
|
|
files[filepath.Join(workdir, "Dockerfile")] = dockerfile.Bytes()
|
||
|
|
|
||
|
|
composefile := new(bytes.Buffer)
|
||
|
|
template.Must(template.New("").Parse(dashboardComposefile)).Execute(composefile, map[string]interface{}{
|
||
|
|
"Network": network,
|
||
|
|
"Port": port,
|
||
|
|
"VHost": vhost,
|
||
|
|
})
|
||
|
|
files[filepath.Join(workdir, "docker-compose.yaml")] = composefile.Bytes()
|
||
|
|
|
||
|
|
statsLogin := fmt.Sprintf("yournode:%s", conf.ethstats)
|
||
|
|
if !ethstats {
|
||
|
|
statsLogin = ""
|
||
|
|
}
|
||
|
|
indexfile := new(bytes.Buffer)
|
||
|
|
template.Must(template.New("").Parse(dashboardContent)).Execute(indexfile, map[string]interface{}{
|
||
|
|
"Network": network,
|
||
|
|
"NetworkID": conf.genesis.Config.ChainId,
|
||
|
|
"NetworkTitle": strings.Title(network),
|
||
|
|
"EthstatsPage": services["ethstats"],
|
||
|
|
"ExplorerPage": services["explorer"],
|
||
|
|
"WalletPage": services["wallet"],
|
||
|
|
"FaucetPage": services["faucet"],
|
||
|
|
"GethGenesis": network + ".json",
|
||
|
|
"BootnodesFull": conf.bootFull,
|
||
|
|
"BootnodesLight": conf.bootLight,
|
||
|
|
"BootnodesFullFlat": strings.Join(conf.bootFull, ","),
|
||
|
|
"BootnodesLightFlat": strings.Join(conf.bootLight, ","),
|
||
|
|
"Ethstats": statsLogin,
|
||
|
|
})
|
||
|
|
files[filepath.Join(workdir, "index.html")] = indexfile.Bytes()
|
||
|
|
|
||
|
|
genesis, _ := conf.genesis.MarshalJSON()
|
||
|
|
files[filepath.Join(workdir, network+".json")] = genesis
|
||
|
|
|
||
|
|
files[filepath.Join(workdir, "puppeth.png")] = dashboardMascot
|
||
|
|
|
||
|
|
// Upload the deployment files to the remote server (and clean up afterwards)
|
||
|
|
if out, err := client.Upload(files); err != nil {
|
||
|
|
return out, err
|
||
|
|
}
|
||
|
|
defer client.Run("rm -rf " + workdir)
|
||
|
|
|
||
|
|
// Build and deploy the dashboard service
|
||
|
|
return nil, client.Stream(fmt.Sprintf("cd %s && docker-compose -p %s up -d --build", workdir, network))
|
||
|
|
}
|
||
|
|
|
||
|
|
// dashboardInfos is returned from an dashboard status check to allow reporting
|
||
|
|
// various configuration parameters.
|
||
|
|
type dashboardInfos struct {
|
||
|
|
host string
|
||
|
|
port int
|
||
|
|
}
|
||
|
|
|
||
|
|
// String implements the stringer interface.
|
||
|
|
func (info *dashboardInfos) String() string {
|
||
|
|
return fmt.Sprintf("host=%s, port=%d", info.host, info.port)
|
||
|
|
}
|
||
|
|
|
||
|
|
// checkDashboard does a health-check against a dashboard container to verify if
|
||
|
|
// it's running, and if yes, gathering a collection of useful infos about it.
|
||
|
|
func checkDashboard(client *sshClient, network string) (*dashboardInfos, error) {
|
||
|
|
// Inspect a possible ethstats container on the host
|
||
|
|
infos, err := inspectContainer(client, fmt.Sprintf("%s_dashboard_1", network))
|
||
|
|
if err != nil {
|
||
|
|
return nil, err
|
||
|
|
}
|
||
|
|
if !infos.running {
|
||
|
|
return nil, ErrServiceOffline
|
||
|
|
}
|
||
|
|
// Resolve the port from the host, or the reverse proxy
|
||
|
|
port := infos.portmap["80/tcp"]
|
||
|
|
if port == 0 {
|
||
|
|
if proxy, _ := checkNginx(client, network); proxy != nil {
|
||
|
|
port = proxy.port
|
||
|
|
}
|
||
|
|
}
|
||
|
|
if port == 0 {
|
||
|
|
return nil, ErrNotExposed
|
||
|
|
}
|
||
|
|
// Resolve the host from the reverse-proxy and configure the connection string
|
||
|
|
host := infos.envvars["VIRTUAL_HOST"]
|
||
|
|
if host == "" {
|
||
|
|
host = client.server
|
||
|
|
}
|
||
|
|
// Run a sanity check to see if the port is reachable
|
||
|
|
if err = checkPort(host, port); err != nil {
|
||
|
|
log.Warn("Dashboard service seems unreachable", "server", host, "port", port, "err", err)
|
||
|
|
}
|
||
|
|
// Container available, assemble and return the useful infos
|
||
|
|
return &dashboardInfos{
|
||
|
|
host: host,
|
||
|
|
port: port,
|
||
|
|
}, nil
|
||
|
|
}
|