aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/puppeth/module_wallet.go
blob: ebaa5b6ae1a5e084e0898e13054c3d6fc2f2fb9c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
// 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"
    "strconv"
    "strings"

    "github.com/ethereum/go-ethereum/log"
)

// walletDockerfile is the Dockerfile required to run a web wallet.
var walletDockerfile = `
FROM puppeth/wallet:latest

ADD genesis.json /genesis.json

RUN \
  echo 'node server.js &'                     > wallet.sh && \
    echo 'geth --cache 512 init /genesis.json' >> wallet.sh && \
    echo $'exec geth --networkid {{.NetworkID}} --port {{.NodePort}} --bootnodes {{.Bootnodes}} --ethstats \'{{.Ethstats}}\' --cache=512 --rpc --rpcaddr=0.0.0.0 --rpccorsdomain "*" --rpcvhosts "*"' >> wallet.sh

RUN \
    sed -i 's/PuppethNetworkID/{{.NetworkID}}/g' dist/js/etherwallet-master.js && \
    sed -i 's/PuppethNetwork/{{.Network}}/g'     dist/js/etherwallet-master.js && \
    sed -i 's/PuppethDenom/{{.Denom}}/g'         dist/js/etherwallet-master.js && \
    sed -i 's/PuppethHost/{{.Host}}/g'           dist/js/etherwallet-master.js && \
    sed -i 's/PuppethRPCPort/{{.RPCPort}}/g'     dist/js/etherwallet-master.js

ENTRYPOINT ["/bin/sh", "wallet.sh"]
`

// walletComposefile is the docker-compose.yml file required to deploy and
// maintain a web wallet.
var walletComposefile = `
version: '2'
services:
  wallet:
    build: .
    image: {{.Network}}/wallet
    container_name: {{.Network}}_wallet_1
    ports:
      - "{{.NodePort}}:{{.NodePort}}"
      - "{{.NodePort}}:{{.NodePort}}/udp"
      - "{{.RPCPort}}:8545"{{if not .VHost}}
      - "{{.WebPort}}:80"{{end}}
    volumes:
      - {{.Datadir}}:/root/.ethereum
    environment:
      - NODE_PORT={{.NodePort}}/tcp
      - STATS={{.Ethstats}}{{if .VHost}}
      - VIRTUAL_HOST={{.VHost}}
      - VIRTUAL_PORT=80{{end}}
    logging:
      driver: "json-file"
      options:
        max-size: "1m"
        max-file: "10"
    restart: always
`

// deployWallet deploys a new web wallet 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 deployWallet(client *sshClient, network string, bootnodes []string, config *walletInfos, nocache 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(walletDockerfile)).Execute(dockerfile, map[string]interface{}{
        "Network":   strings.ToTitle(network),
        "Denom":     strings.ToUpper(network),
        "NetworkID": config.network,
        "NodePort":  config.nodePort,
        "RPCPort":   config.rpcPort,
        "Bootnodes": strings.Join(bootnodes, ","),
        "Ethstats":  config.ethstats,
        "Host":      client.address,
    })
    files[filepath.Join(workdir, "Dockerfile")] = dockerfile.Bytes()

    composefile := new(bytes.Buffer)
    template.Must(template.New("").Parse(walletComposefile)).Execute(composefile, map[string]interface{}{
        "Datadir":  config.datadir,
        "Network":  network,
        "NodePort": config.nodePort,
        "RPCPort":  config.rpcPort,
        "VHost":    config.webHost,
        "WebPort":  config.webPort,
        "Ethstats": config.ethstats[:strings.Index(config.ethstats, ":")],
    })
    files[filepath.Join(workdir, "docker-compose.yaml")] = composefile.Bytes()

    files[filepath.Join(workdir, "genesis.json")] = config.genesis

    // 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 boot or seal node service
    if nocache {
        return nil, client.Stream(fmt.Sprintf("cd %s && docker-compose -p %s build --pull --no-cache && docker-compose -p %s up -d --force-recreate --timeout 60", workdir, network, network))
    }
    return nil, client.Stream(fmt.Sprintf("cd %s && docker-compose -p %s up -d --build --force-recreate --timeout 60", workdir, network))
}

// walletInfos is returned from a web wallet status check to allow reporting
// various configuration parameters.
type walletInfos struct {
    genesis  []byte
    network  int64
    datadir  string
    ethstats string
    nodePort int
    rpcPort  int
    webHost  string
    webPort  int
}

// Report converts the typed struct into a plain string->string map, containing
// most - but not all - fields for reporting to the user.
func (info *walletInfos) Report() map[string]string {
    report := map[string]string{
        "Data directory":         info.datadir,
        "Ethstats username":      info.ethstats,
        "Node listener port ":    strconv.Itoa(info.nodePort),
        "RPC listener port ":     strconv.Itoa(info.rpcPort),
        "Website address ":       info.webHost,
        "Website listener port ": strconv.Itoa(info.webPort),
    }
    return report
}

// checkWallet does a health-check against web wallet server to verify whether
// it's running, and if yes, whether it's responsive.
func checkWallet(client *sshClient, network string) (*walletInfos, error) {
    // Inspect a possible web wallet container on the host
    infos, err := inspectContainer(client, fmt.Sprintf("%s_wallet_1", network))
    if err != nil {
        return nil, err
    }
    if !infos.running {
        return nil, ErrServiceOffline
    }
    // Resolve the port from the host, or the reverse proxy
    webPort := infos.portmap["80/tcp"]
    if webPort == 0 {
        if proxy, _ := checkNginx(client, network); proxy != nil {
            webPort = proxy.port
        }
    }
    if webPort == 0 {
        return nil, ErrNotExposed
    }
    // Resolve the host from the reverse-proxy and the config values
    host := infos.envvars["VIRTUAL_HOST"]
    if host == "" {
        host = client.server
    }
    // Run a sanity check to see if the devp2p and RPC ports are reachable
    nodePort := infos.portmap[infos.envvars["NODE_PORT"]]
    if err = checkPort(client.server, nodePort); err != nil {
        log.Warn(fmt.Sprintf("Wallet devp2p port seems unreachable"), "server", client.server, "port", nodePort, "err", err)
    }
    rpcPort := infos.portmap["8545/tcp"]
    if err = checkPort(client.server, rpcPort); err != nil {
        log.Warn(fmt.Sprintf("Wallet RPC port seems unreachable"), "server", client.server, "port", rpcPort, "err", err)
    }
    // Assemble and return the useful infos
    stats := &walletInfos{
        datadir:  infos.volumes["/root/.ethereum"],
        nodePort: nodePort,
        rpcPort:  rpcPort,
        webHost:  host,
        webPort:  webPort,
        ethstats: infos.envvars["STATS"],
    }
    return stats, nil
}