aboutsummaryrefslogblamecommitdiffstats
path: root/cmd/p2psim/main.go
blob: 0c8ed038d5b6b69eb3017850d3336725815f0df7 (plain) (tree)
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430















                                                                       





























































































































































































































































































































































































































                                                                                                         
// 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/>.

// p2psim provides a command-line client for a simulation HTTP API.
//
// Here is an example of creating a 2 node network with the first node
// connected to the second:
//
//     $ p2psim node create
//     Created node01
//
//     $ p2psim node start node01
//     Started node01
//
//     $ p2psim node create
//     Created node02
//
//     $ p2psim node start node02
//     Started node02
//
//     $ p2psim node connect node01 node02
//     Connected node01 to node02
//
package main

import (
    "context"
    "encoding/json"
    "fmt"
    "io"
    "os"
    "strings"
    "text/tabwriter"

    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/p2p"
    "github.com/ethereum/go-ethereum/p2p/discover"
    "github.com/ethereum/go-ethereum/p2p/simulations"
    "github.com/ethereum/go-ethereum/p2p/simulations/adapters"
    "github.com/ethereum/go-ethereum/rpc"
    "gopkg.in/urfave/cli.v1"
)

var client *simulations.Client

func main() {
    app := cli.NewApp()
    app.Usage = "devp2p simulation command-line client"
    app.Flags = []cli.Flag{
        cli.StringFlag{
            Name:   "api",
            Value:  "http://localhost:8888",
            Usage:  "simulation API URL",
            EnvVar: "P2PSIM_API_URL",
        },
    }
    app.Before = func(ctx *cli.Context) error {
        client = simulations.NewClient(ctx.GlobalString("api"))
        return nil
    }
    app.Commands = []cli.Command{
        {
            Name:   "show",
            Usage:  "show network information",
            Action: showNetwork,
        },
        {
            Name:   "events",
            Usage:  "stream network events",
            Action: streamNetwork,
            Flags: []cli.Flag{
                cli.BoolFlag{
                    Name:  "current",
                    Usage: "get existing nodes and conns first",
                },
                cli.StringFlag{
                    Name:  "filter",
                    Value: "",
                    Usage: "message filter",
                },
            },
        },
        {
            Name:   "snapshot",
            Usage:  "create a network snapshot to stdout",
            Action: createSnapshot,
        },
        {
            Name:   "load",
            Usage:  "load a network snapshot from stdin",
            Action: loadSnapshot,
        },
        {
            Name:   "node",
            Usage:  "manage simulation nodes",
            Action: listNodes,
            Subcommands: []cli.Command{
                {
                    Name:   "list",
                    Usage:  "list nodes",
                    Action: listNodes,
                },
                {
                    Name:   "create",
                    Usage:  "create a node",
                    Action: createNode,
                    Flags: []cli.Flag{
                        cli.StringFlag{
                            Name:  "name",
                            Value: "",
                            Usage: "node name",
                        },
                        cli.StringFlag{
                            Name:  "services",
                            Value: "",
                            Usage: "node services (comma separated)",
                        },
                        cli.StringFlag{
                            Name:  "key",
                            Value: "",
                            Usage: "node private key (hex encoded)",
                        },
                    },
                },
                {
                    Name:      "show",
                    ArgsUsage: "<node>",
                    Usage:     "show node information",
                    Action:    showNode,
                },
                {
                    Name:      "start",
                    ArgsUsage: "<node>",
                    Usage:     "start a node",
                    Action:    startNode,
                },
                {
                    Name:      "stop",
                    ArgsUsage: "<node>",
                    Usage:     "stop a node",
                    Action:    stopNode,
                },
                {
                    Name:      "connect",
                    ArgsUsage: "<node> <peer>",
                    Usage:     "connect a node to a peer node",
                    Action:    connectNode,
                },
                {
                    Name:      "disconnect",
                    ArgsUsage: "<node> <peer>",
                    Usage:     "disconnect a node from a peer node",
                    Action:    disconnectNode,
                },
                {
                    Name:      "rpc",
                    ArgsUsage: "<node> <method> [<args>]",
                    Usage:     "call a node RPC method",
                    Action:    rpcNode,
                    Flags: []cli.Flag{
                        cli.BoolFlag{
                            Name:  "subscribe",
                            Usage: "method is a subscription",
                        },
                    },
                },
            },
        },
    }
    app.Run(os.Args)
}

func showNetwork(ctx *cli.Context) error {
    if len(ctx.Args()) != 0 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    network, err := client.GetNetwork()
    if err != nil {
        return err
    }
    w := tabwriter.NewWriter(ctx.App.Writer, 1, 2, 2, ' ', 0)
    defer w.Flush()
    fmt.Fprintf(w, "NODES\t%d\n", len(network.Nodes))
    fmt.Fprintf(w, "CONNS\t%d\n", len(network.Conns))
    return nil
}

func streamNetwork(ctx *cli.Context) error {
    if len(ctx.Args()) != 0 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    events := make(chan *simulations.Event)
    sub, err := client.SubscribeNetwork(events, simulations.SubscribeOpts{
        Current: ctx.Bool("current"),
        Filter:  ctx.String("filter"),
    })
    if err != nil {
        return err
    }
    defer sub.Unsubscribe()
    enc := json.NewEncoder(ctx.App.Writer)
    for {
        select {
        case event := <-events:
            if err := enc.Encode(event); err != nil {
                return err
            }
        case err := <-sub.Err():
            return err
        }
    }
}

func createSnapshot(ctx *cli.Context) error {
    if len(ctx.Args()) != 0 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    snap, err := client.CreateSnapshot()
    if err != nil {
        return err
    }
    return json.NewEncoder(os.Stdout).Encode(snap)
}

func loadSnapshot(ctx *cli.Context) error {
    if len(ctx.Args()) != 0 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    snap := &simulations.Snapshot{}
    if err := json.NewDecoder(os.Stdin).Decode(snap); err != nil {
        return err
    }
    return client.LoadSnapshot(snap)
}

func listNodes(ctx *cli.Context) error {
    if len(ctx.Args()) != 0 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodes, err := client.GetNodes()
    if err != nil {
        return err
    }
    w := tabwriter.NewWriter(ctx.App.Writer, 1, 2, 2, ' ', 0)
    defer w.Flush()
    fmt.Fprintf(w, "NAME\tPROTOCOLS\tID\n")
    for _, node := range nodes {
        fmt.Fprintf(w, "%s\t%s\t%s\n", node.Name, strings.Join(protocolList(node), ","), node.ID)
    }
    return nil
}

func protocolList(node *p2p.NodeInfo) []string {
    protos := make([]string, 0, len(node.Protocols))
    for name := range node.Protocols {
        protos = append(protos, name)
    }
    return protos
}

func createNode(ctx *cli.Context) error {
    if len(ctx.Args()) != 0 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    config := &adapters.NodeConfig{
        Name: ctx.String("name"),
    }
    if key := ctx.String("key"); key != "" {
        privKey, err := crypto.HexToECDSA(key)
        if err != nil {
            return err
        }
        config.ID = discover.PubkeyID(&privKey.PublicKey)
        config.PrivateKey = privKey
    }
    if services := ctx.String("services"); services != "" {
        config.Services = strings.Split(services, ",")
    }
    node, err := client.CreateNode(config)
    if err != nil {
        return err
    }
    fmt.Fprintln(ctx.App.Writer, "Created", node.Name)
    return nil
}

func showNode(ctx *cli.Context) error {
    args := ctx.Args()
    if len(args) != 1 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodeName := args[0]
    node, err := client.GetNode(nodeName)
    if err != nil {
        return err
    }
    w := tabwriter.NewWriter(ctx.App.Writer, 1, 2, 2, ' ', 0)
    defer w.Flush()
    fmt.Fprintf(w, "NAME\t%s\n", node.Name)
    fmt.Fprintf(w, "PROTOCOLS\t%s\n", strings.Join(protocolList(node), ","))
    fmt.Fprintf(w, "ID\t%s\n", node.ID)
    fmt.Fprintf(w, "ENODE\t%s\n", node.Enode)
    for name, proto := range node.Protocols {
        fmt.Fprintln(w)
        fmt.Fprintf(w, "--- PROTOCOL INFO: %s\n", name)
        fmt.Fprintf(w, "%v\n", proto)
        fmt.Fprintf(w, "---\n")
    }
    return nil
}

func startNode(ctx *cli.Context) error {
    args := ctx.Args()
    if len(args) != 1 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodeName := args[0]
    if err := client.StartNode(nodeName); err != nil {
        return err
    }
    fmt.Fprintln(ctx.App.Writer, "Started", nodeName)
    return nil
}

func stopNode(ctx *cli.Context) error {
    args := ctx.Args()
    if len(args) != 1 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodeName := args[0]
    if err := client.StopNode(nodeName); err != nil {
        return err
    }
    fmt.Fprintln(ctx.App.Writer, "Stopped", nodeName)
    return nil
}

func connectNode(ctx *cli.Context) error {
    args := ctx.Args()
    if len(args) != 2 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodeName := args[0]
    peerName := args[1]
    if err := client.ConnectNode(nodeName, peerName); err != nil {
        return err
    }
    fmt.Fprintln(ctx.App.Writer, "Connected", nodeName, "to", peerName)
    return nil
}

func disconnectNode(ctx *cli.Context) error {
    args := ctx.Args()
    if len(args) != 2 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodeName := args[0]
    peerName := args[1]
    if err := client.DisconnectNode(nodeName, peerName); err != nil {
        return err
    }
    fmt.Fprintln(ctx.App.Writer, "Disconnected", nodeName, "from", peerName)
    return nil
}

func rpcNode(ctx *cli.Context) error {
    args := ctx.Args()
    if len(args) < 2 {
        return cli.ShowCommandHelp(ctx, ctx.Command.Name)
    }
    nodeName := args[0]
    method := args[1]
    rpcClient, err := client.RPCClient(context.Background(), nodeName)
    if err != nil {
        return err
    }
    if ctx.Bool("subscribe") {
        return rpcSubscribe(rpcClient, ctx.App.Writer, method, args[3:]...)
    }
    var result interface{}
    params := make([]interface{}, len(args[3:]))
    for i, v := range args[3:] {
        params[i] = v
    }
    if err := rpcClient.Call(&result, method, params...); err != nil {
        return err
    }
    return json.NewEncoder(ctx.App.Writer).Encode(result)
}

func rpcSubscribe(client *rpc.Client, out io.Writer, method string, args ...string) error {
    parts := strings.SplitN(method, "_", 2)
    namespace := parts[0]
    method = parts[1]
    ch := make(chan interface{})
    subArgs := make([]interface{}, len(args)+1)
    subArgs[0] = method
    for i, v := range args {
        subArgs[i+1] = v
    }
    sub, err := client.Subscribe(context.Background(), namespace, ch, subArgs...)
    if err != nil {
        return err
    }
    defer sub.Unsubscribe()
    enc := json.NewEncoder(out)
    for {
        select {
        case v := <-ch:
            if err := enc.Encode(v); err != nil {
                return err
            }
        case err := <-sub.Err():
            return err
        }
    }
}