Skip to content

Commit feb2932

Browse files
karalabekaralabe
authored
Merge pull request ethereum#14540 from bas-vk/whisper-api
whisperv5: integrate whisper and implement API
2 parents f321ed2 + ea1d182 commit feb2932

31 files changed

+1664
-1217
lines changed

‎cmd/geth/config.go

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ import (
3333
"github.com/ethereum/go-ethereum/eth"
3434
"github.com/ethereum/go-ethereum/node"
3535
"github.com/ethereum/go-ethereum/params"
36+
whisper "github.com/ethereum/go-ethereum/whisper/whisperv5"
3637
"github.com/naoina/toml"
3738
)
3839

@@ -42,7 +43,7 @@ var (
4243
Name: "dumpconfig",
4344
Usage: "Show configuration values",
4445
ArgsUsage: "",
45-
Flags: append(nodeFlags, rpcFlags...),
46+
Flags: append(append(nodeFlags, rpcFlags...), whisperFlags...),
4647
Category: "MISCELLANEOUS COMMANDS",
4748
Description: `The dumpconfig command shows configuration values.`,
4849
}
@@ -76,6 +77,7 @@ type ethstatsConfig struct {
7677

7778
type gethConfig struct {
7879
Eth eth.Config
80+
Shh whisper.Config
7981
Node node.Config
8082
Ethstats ethstatsConfig
8183
}
@@ -99,8 +101,8 @@ func defaultNodeConfig() node.Config {
99101
cfg := node.DefaultConfig
100102
cfg.Name = clientIdentifier
101103
cfg.Version = params.VersionWithCommit(gitCommit)
102-
cfg.HTTPModules = append(cfg.HTTPModules, "eth")
103-
cfg.WSModules = append(cfg.WSModules, "eth")
104+
cfg.HTTPModules = append(cfg.HTTPModules, "eth", "shh")
105+
cfg.WSModules = append(cfg.WSModules, "eth", "shh")
104106
cfg.IPCPath = "geth.ipc"
105107
return cfg
106108
}
@@ -109,6 +111,7 @@ func makeConfigNode(ctx *cli.Context) (*node.Node, gethConfig) {
109111
// Load defaults.
110112
cfg := gethConfig{
111113
Eth: eth.DefaultConfig,
114+
Shh: whisper.DefaultConfig,
112115
Node: defaultNodeConfig(),
113116
}
114117

@@ -130,19 +133,37 @@ func makeConfigNode(ctx *cli.Context) (*node.Node, gethConfig) {
130133
cfg.Ethstats.URL = ctx.GlobalString(utils.EthStatsURLFlag.Name)
131134
}
132135

136+
utils.SetShhConfig(ctx, stack, &cfg.Shh)
137+
133138
return stack, cfg
134139
}
135140

141+
// enableWhisper returns true in case one of the whisper flags is set.
142+
func enableWhisper(ctx *cli.Context) bool {
143+
for _, flag := range whisperFlags {
144+
if ctx.GlobalIsSet(flag.GetName()) {
145+
return true
146+
}
147+
}
148+
return false
149+
}
150+
136151
func makeFullNode(ctx *cli.Context) *node.Node {
137152
stack, cfg := makeConfigNode(ctx)
138153

139154
utils.RegisterEthService(stack, &cfg.Eth)
140155

141-
// Whisper must be explicitly enabled, but is auto-enabled in --dev mode.
142-
shhEnabled := ctx.GlobalBool(utils.WhisperEnabledFlag.Name)
156+
// Whisper must be explicitly enabled by specifying at least 1 whisper flag or in dev mode
157+
shhEnabled := enableWhisper(ctx)
143158
shhAutoEnabled := !ctx.GlobalIsSet(utils.WhisperEnabledFlag.Name) && ctx.GlobalIsSet(utils.DevModeFlag.Name)
144159
if shhEnabled || shhAutoEnabled {
145-
utils.RegisterShhService(stack)
160+
if ctx.GlobalIsSet(utils.WhisperMaxMessageSizeFlag.Name) {
161+
cfg.Shh.MaxMessageSize = uint32(ctx.Int(utils.WhisperMaxMessageSizeFlag.Name))
162+
}
163+
if ctx.GlobalIsSet(utils.WhisperMinPOWFlag.Name) {
164+
cfg.Shh.MinimumAcceptedPOW = ctx.Float64(utils.WhisperMinPOWFlag.Name)
165+
}
166+
utils.RegisterShhService(stack, &cfg.Shh)
146167
}
147168

148169
// Add the Ethereum Stats daemon if requested.

‎cmd/geth/consolecmd.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var (
3535
Action: utils.MigrateFlags(localConsole),
3636
Name: "console",
3737
Usage: "Start an interactive JavaScript environment",
38-
Flags: append(append(nodeFlags, rpcFlags...), consoleFlags...),
38+
Flags: append(append(append(nodeFlags, rpcFlags...), consoleFlags...), whisperFlags...),
3939
Category: "CONSOLE COMMANDS",
4040
Description: `
4141
The Geth console is an interactive shell for the JavaScript runtime environment

‎cmd/geth/main.go

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,6 @@ var (
9595
utils.NetrestrictFlag,
9696
utils.NodeKeyFileFlag,
9797
utils.NodeKeyHexFlag,
98-
utils.WhisperEnabledFlag,
9998
utils.DevModeFlag,
10099
utils.TestnetFlag,
101100
utils.RinkebyFlag,
@@ -125,6 +124,12 @@ var (
125124
utils.IPCDisabledFlag,
126125
utils.IPCPathFlag,
127126
}
127+
128+
whisperFlags = []cli.Flag{
129+
utils.WhisperEnabledFlag,
130+
utils.WhisperMaxMessageSizeFlag,
131+
utils.WhisperMinPOWFlag,
132+
}
128133
)
129134

130135
func init() {
@@ -161,6 +166,7 @@ func init() {
161166
app.Flags = append(app.Flags, rpcFlags...)
162167
app.Flags = append(app.Flags, consoleFlags...)
163168
app.Flags = append(app.Flags, debug.Flags...)
169+
app.Flags = append(app.Flags, whisperFlags...)
164170

165171
app.Before = func(ctx *cli.Context) error {
166172
runtime.GOMAXPROCS(runtime.NumCPU())

‎cmd/geth/usage.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ var AppHelpFlagGroups = []flagGroup{
187187
utils.NoCompactionFlag,
188188
}, debug.Flags...),
189189
},
190+
{
191+
Name: "WHISPER (EXPERIMENTAL)",
192+
Flags: whisperFlags,
193+
},
190194
{
191195
Name: "DEPRECATED",
192196
Flags: []cli.Flag{
@@ -195,10 +199,7 @@ var AppHelpFlagGroups = []flagGroup{
195199
},
196200
},
197201
{
198-
Name: "EXPERIMENTAL",
199-
Flags: []cli.Flag{
200-
utils.WhisperEnabledFlag,
201-
},
202+
Name: "MISC",
202203
},
203204
}
204205

‎cmd/utils/flags.go

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -440,11 +440,6 @@ var (
440440
Usage: "Restricts network communication to the given IP networks (CIDR masks)",
441441
}
442442

443-
WhisperEnabledFlag = cli.BoolFlag{
444-
Name: "shh",
445-
Usage: "Enable Whisper",
446-
}
447-
448443
// ATM the url is left to the user and deployment to
449444
JSpathFlag = cli.StringFlag{
450445
Name: "jspath",
@@ -463,6 +458,20 @@ var (
463458
Usage: "Suggested gas price is the given percentile of a set of recent transaction gas prices",
464459
Value: eth.DefaultConfig.GPO.Percentile,
465460
}
461+
WhisperEnabledFlag = cli.BoolFlag{
462+
Name: "shh",
463+
Usage: "Enable Whisper",
464+
}
465+
WhisperMaxMessageSizeFlag = cli.IntFlag{
466+
Name: "shh.maxmessagesize",
467+
Usage: "Max message size accepted",
468+
Value: int(whisper.DefaultMaxMessageSize),
469+
}
470+
WhisperMinPOWFlag = cli.Float64Flag{
471+
Name: "shh.pow",
472+
Usage: "Minimum POW accepted",
473+
Value: whisper.DefaultMinimumPoW,
474+
}
466475
)
467476

468477
// MakeDataDir retrieves the currently requested data directory, terminating
@@ -878,6 +887,16 @@ func checkExclusive(ctx *cli.Context, flags ...cli.Flag) {
878887
}
879888
}
880889

890+
// SetShhConfig applies shh-related command line flags to the config.
891+
func SetShhConfig(ctx *cli.Context, stack *node.Node, cfg *whisper.Config) {
892+
if ctx.GlobalIsSet(WhisperMaxMessageSizeFlag.Name) {
893+
cfg.MaxMessageSize = uint32(ctx.GlobalUint(WhisperMaxMessageSizeFlag.Name))
894+
}
895+
if ctx.GlobalIsSet(WhisperMinPOWFlag.Name) {
896+
cfg.MinimumAcceptedPOW = ctx.GlobalFloat64(WhisperMinPOWFlag.Name)
897+
}
898+
}
899+
881900
// SetEthConfig applies eth-related command line flags to the config.
882901
func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *eth.Config) {
883902
// Avoid conflicting network flags
@@ -983,8 +1002,10 @@ func RegisterEthService(stack *node.Node, cfg *eth.Config) {
9831002
}
9841003

9851004
// RegisterShhService configures Whisper and adds it to the given node.
986-
func RegisterShhService(stack *node.Node) {
987-
if err := stack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
1005+
func RegisterShhService(stack *node.Node, cfg *whisper.Config) {
1006+
if err := stack.Register(func(n *node.ServiceContext) (node.Service, error) {
1007+
return whisper.New(cfg), nil
1008+
}); err != nil {
9881009
Fatalf("Failed to register the Whisper service: %v", err)
9891010
}
9901011
}

‎cmd/wnode/main.go

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ var (
8787
argVerbosity = flag.Int("verbosity", int(log.LvlError), "log verbosity level")
8888
argTTL = flag.Uint("ttl", 30, "time-to-live for messages in seconds")
8989
argWorkTime = flag.Uint("work", 5, "work time in seconds")
90-
argMaxSize = flag.Int("maxsize", whisper.DefaultMaxMessageLength, "max size of message")
90+
argMaxSize = flag.Uint("maxsize", uint(whisper.DefaultMaxMessageSize), "max size of message")
9191
argPoW = flag.Float64("pow", whisper.DefaultMinimumPoW, "PoW for normal messages in float format (e.g. 2.7)")
9292
argServerPoW = flag.Float64("mspow", whisper.DefaultMinimumPoW, "PoW requirement for Mail Server request")
9393

@@ -198,18 +198,24 @@ func initialize() {
198198
peers = append(peers, peer)
199199
}
200200

201+
cfg := &whisper.Config{
202+
MaxMessageSize: uint32(*argMaxSize),
203+
MinimumAcceptedPOW: *argPoW,
204+
}
205+
201206
if *mailServerMode {
202207
if len(msPassword) == 0 {
203208
msPassword, err = console.Stdin.PromptPassword("Please enter the Mail Server password: ")
204209
if err != nil {
205210
utils.Fatalf("Failed to read Mail Server password: %s", err)
206211
}
207212
}
208-
shh = whisper.New()
213+
214+
shh = whisper.New(cfg)
209215
shh.RegisterServer(&mailServer)
210216
mailServer.Init(shh, *argDBPath, msPassword, *argServerPoW)
211217
} else {
212-
shh = whisper.New()
218+
shh = whisper.New(cfg)
213219
}
214220

215221
if *argPoW != whisper.DefaultMinimumPoW {
@@ -219,8 +225,8 @@ func initialize() {
219225
}
220226
}
221227

222-
if *argMaxSize != whisper.DefaultMaxMessageLength {
223-
err := shh.SetMaxMessageLength(*argMaxSize)
228+
if uint32(*argMaxSize) != whisper.DefaultMaxMessageSize {
229+
err := shh.SetMaxMessageSize(uint32(*argMaxSize))
224230
if err != nil {
225231
utils.Fatalf("Failed to set max message size: %s", err)
226232
}

‎internal/web3ext/web3ext.go

Lines changed: 36 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -526,10 +526,6 @@ const Shh_JS = `
526526
web3._extend({
527527
property: 'shh',
528528
methods: [
529-
new web3._extend.Method({
530-
name: 'info',
531-
call: 'shh_info'
532-
}),
533529
new web3._extend.Method({
534530
name: 'setMaxMessageLength',
535531
call: 'shh_setMaxMessageLength',
@@ -541,8 +537,8 @@ web3._extend({
541537
params: 1
542538
}),
543539
new web3._extend.Method({
544-
name: 'allowP2PMessagesFromPeer',
545-
call: 'shh_allowP2PMessagesFromPeer',
540+
name: 'markTrustedPeer',
541+
call: 'shh_markTrustedPeer',
546542
params: 1
547543
}),
548544
new web3._extend.Method({
@@ -570,57 +566,67 @@ web3._extend({
570566
params: 1
571567
}),
572568
new web3._extend.Method({
573-
name: 'generateSymmetricKey',
574-
call: 'shh_generateSymmetricKey',
569+
name: 'newSymKey',
570+
call: 'shh_newSymKey',
575571
}),
576572
new web3._extend.Method({
577-
name: 'addSymmetricKeyDirect',
578-
call: 'shh_addSymmetricKeyDirect',
573+
name: 'addSymKey',
574+
call: 'shh_addSymKey',
579575
params: 1
580576
}),
581577
new web3._extend.Method({
582-
name: 'addSymmetricKeyFromPassword',
583-
call: 'shh_addSymmetricKeyFromPassword',
578+
name: 'generateSymKeyFromPassword',
579+
call: 'shh_generateSymKeyFromPassword',
584580
params: 1
585581
}),
586582
new web3._extend.Method({
587-
name: 'hasSymmetricKey',
588-
call: 'shh_hasSymmetricKey',
583+
name: 'hasSymKey',
584+
call: 'shh_hasSymKey',
589585
params: 1
590586
}),
591587
new web3._extend.Method({
592-
name: 'getSymmetricKey',
593-
call: 'shh_getSymmetricKey',
588+
name: 'getSymKey',
589+
call: 'shh_getSymKey',
594590
params: 1
595591
}),
596592
new web3._extend.Method({
597-
name: 'deleteSymmetricKey',
598-
call: 'shh_deleteSymmetricKey',
593+
name: 'deleteSymKey',
594+
call: 'shh_deleteSymKey',
599595
params: 1
600596
}),
601597
new web3._extend.Method({
602598
name: 'subscribe',
603599
call: 'shh_subscribe',
604-
params: 1
600+
params: 2
605601
}),
606602
new web3._extend.Method({
607603
name: 'unsubscribe',
608604
call: 'shh_unsubscribe',
609605
params: 1
610606
}),
611607
new web3._extend.Method({
612-
name: 'getNewSubscriptionMessages',
613-
call: 'shh_getNewSubscriptionMessages',
608+
name: 'post',
609+
call: 'shh_post',
614610
params: 1
615611
}),
616612
new web3._extend.Method({
617-
name: 'getFloatingMessages',
618-
call: 'shh_getFloatingMessages',
613+
name: 'publicKey',
614+
call: 'shh_getPublicKey',
619615
params: 1
620616
}),
621617
new web3._extend.Method({
622-
name: 'post',
623-
call: 'shh_post',
618+
name: 'getFilterMessages',
619+
call: 'shh_getFilterMessages',
620+
params: 1
621+
}),
622+
new web3._extend.Method({
623+
name: 'deleteMessageFilter',
624+
call: 'shh_deleteMessageFilter',
625+
params: 1
626+
}),
627+
new web3._extend.Method({
628+
name: 'newMessageFilter',
629+
call: 'shh_newMessageFilter',
624630
params: 1
625631
})
626632
],
@@ -630,7 +636,11 @@ web3._extend({
630636
name: 'version',
631637
getter: 'shh_version',
632638
outputFormatter: web3._extend.utils.toDecimal
633-
})
639+
}),
640+
new web3._extend.Property({
641+
name: 'info',
642+
getter: 'shh_info'
643+
}),
634644
]
635645
});
636646
`

‎mobile/geth.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,9 @@ func NewNode(datadir string, config *NodeConfig) (stack *Node, _ error) {
169169
}
170170
// Register the Whisper protocol if requested
171171
if config.WhisperEnabled {
172-
if err := rawStack.Register(func(*node.ServiceContext) (node.Service, error) { return whisper.New(), nil }); err != nil {
172+
if err := rawStack.Register(func(*node.ServiceContext) (node.Service, error) {
173+
return whisper.New(&whisper.DefaultConfig), nil
174+
}); err != nil {
173175
return nil, fmt.Errorf("whisper init: %v", err)
174176
}
175177
}

0 commit comments

Comments
 (0)