gaspersic/go-ethereum
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

swarm: add CLI --ens-endpoint flag (#14386)

Browse Source 
Implement a CLI flag that can be repeated to allow multiple ENS
resolvers for different TLDs.
This commit is contained in:
Janos Guljas
2017-12-01 10:32:14 +01:00
parent 5aa3eac22d
commit 057af8c5c8
5 changed files with 459 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
cmd/swarm/main.go
View File

@ -17,11 +17,9 @@
package main
import (
"context"
"crypto/ecdsa"
"fmt"
"io/ioutil"
"math/big"
"os"
"os/signal"
"runtime"
@ -29,14 +27,13 @@ import (
"strconv"
"strings"
"syscall"
"time"
"unicode"
"github.com/ethereum/go-ethereum/accounts"
"github.com/ethereum/go-ethereum/accounts/keystore"
"github.com/ethereum/go-ethereum/cmd/utils"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/console"
"github.com/ethereum/go-ethereum/contracts/ens"
"github.com/ethereum/go-ethereum/crypto"
"github.com/ethereum/go-ethereum/ethclient"
"github.com/ethereum/go-ethereum/internal/debug"
@ -45,7 +42,6 @@ import (
"github.com/ethereum/go-ethereum/p2p"
"github.com/ethereum/go-ethereum/p2p/discover"
"github.com/ethereum/go-ethereum/params"
"github.com/ethereum/go-ethereum/rpc"
"github.com/ethereum/go-ethereum/swarm"
bzzapi "github.com/ethereum/go-ethereum/swarm/api"
"gopkg.in/urfave/cli.v1"
@ -101,6 +97,10 @@ var (
Name: "sync",
Usage: "Swarm Syncing enabled (default true)",
}
EnsEndpointsFlag = cli.StringSliceFlag{
Name: "ens-endpoint",
Usage: "ENS API endpoint for a TLD and with contract address, can be repeated, format [tld:][contract-addr@]url",
}
EnsAPIFlag = cli.StringFlag{
Name: "ens-api",
Usage: "URL of the Ethereum API provider to use for ENS record lookups",
@ -323,6 +323,7 @@ DEPRECATED: use 'swarm db clean'.
utils.PasswordFileFlag,
// bzzd-specific flags
CorsStringFlag,
EnsEndpointsFlag,
EnsAPIFlag,
EnsAddrFlag,
SwarmConfigPathFlag,
@ -416,38 +417,6 @@ func bzzd(ctx *cli.Context) error {
return nil
}
// detectEnsAddr determines the ENS contract address by getting both the
// version and genesis hash using the client and matching them to either
// mainnet or testnet addresses
func detectEnsAddr(client *rpc.Client) (common.Address, error) {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
var version string
if err := client.CallContext(ctx, &version, "net_version"); err != nil {
return common.Address{}, err
}
block, err := ethclient.NewClient(client).BlockByNumber(ctx, big.NewInt(0))
if err != nil {
return common.Address{}, err
}
switch {
case version == "1" && block.Hash() == params.MainnetGenesisHash:
log.Info("using Mainnet ENS contract address", "addr", ens.MainNetAddress)
return ens.MainNetAddress, nil
case version == "3" && block.Hash() == params.TestnetGenesisHash:
log.Info("using Testnet ENS contract address", "addr", ens.TestNetAddress)
return ens.TestNetAddress, nil
default:
return common.Address{}, fmt.Errorf("unknown version and genesis hash: %s %s", version, block.Hash())
}
}
func registerBzzService(ctx *cli.Context, stack *node.Node) {
prvkey := getAccount(ctx, stack)
@ -476,6 +445,7 @@ func registerBzzService(ctx *cli.Context, stack *node.Node) {
utils.Fatalf("SWAP is enabled but --swap-api is not set")
}
ensEndpoints := ctx.GlobalStringSlice(EnsEndpointsFlag.Name)
ensapi := ctx.GlobalString(EnsAPIFlag.Name)
ensAddr := ctx.GlobalString(EnsAddrFlag.Name)
@ -491,34 +461,59 @@ func registerBzzService(ctx *cli.Context, stack *node.Node) {
}
}
var ensClient *ethclient.Client
ensClientConfigs := []swarm.ENSClientConfig{}
if ensapi != "" {
log.Info("connecting to ENS API", "url", ensapi)
client, err := rpc.Dial(ensapi)
if err != nil {
return nil, fmt.Errorf("error connecting to ENS API %s: %s", ensapi, err)
}
ensClient = ethclient.NewClient(client)
if ensAddr != "" {
bzzconfig.EnsRoot = common.HexToAddress(ensAddr)
} else {
ensAddr, err := detectEnsAddr(client)
if err == nil {
bzzconfig.EnsRoot = ensAddr
} else {
log.Warn(fmt.Sprintf("could not determine ENS contract address, using default %s", bzzconfig.EnsRoot), "err", err)
ensClientConfigs = append(ensClientConfigs, swarm.ENSClientConfig{
Endpoint: ensapi,
ContractAddress: ensAddr,
})
}
if ensEndpoints != nil {
for _, s := range ensEndpoints {
if s != "" {
ensClientConfigs = append(ensClientConfigs, parseFlagEnsEndpoint(s))
}
}
}
if len(ensClientConfigs) == 0 {
log.Warn("No ENS, please specify non-empty --ens-api or --ens-endpoint to use domain name resolution")
}
return swarm.NewSwarm(ctx, swapClient, ensClient, bzzconfig, swapEnabled, syncEnabled, cors)
return swarm.NewSwarm(ctx, swapClient, ensClientConfigs, bzzconfig, swapEnabled, syncEnabled, cors)
}
if err := stack.Register(boot); err != nil {
utils.Fatalf("Failed to register the Swarm service: %v", err)
}
}
func parseFlagEnsEndpoint(s string) swarm.ENSClientConfig {
isAllLetterString := func(s string) bool {
for _, r := range s {
if !unicode.IsLetter(r) {
return false
}
}
return true
}
endpoint := s
var addr, tld string
if i := strings.Index(endpoint, ":"); i > 0 {
if isAllLetterString(endpoint[:i]) && len(endpoint) > i+2 && endpoint[i+1:i+3] != "//" {
tld = endpoint[:i]
endpoint = endpoint[i+1:]
}
}
if i := strings.Index(endpoint, "@"); i > 0 {
addr = endpoint[:i]
endpoint = endpoint[i+1:]
}
return swarm.ENSClientConfig{
Endpoint: endpoint,
ContractAddress: addr,
TLD: tld,
}
}
func getAccount(ctx *cli.Context, stack *node.Node) *ecdsa.PrivateKey {
keyid := ctx.GlobalString(SwarmAccountFlag.Name)

141
cmd/swarm/main_test.go Normal file
View File

@ -0,0 +1,141 @@
// 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 (
"testing"
"github.com/ethereum/go-ethereum/swarm"
)
func TestParseFlagEnsEndpoint(t *testing.T) {
for _, x := range []struct {
description string
value string
config swarm.ENSClientConfig
}{
{
description: "IPC endpoint",
value: "/data/testnet/geth.ipc",
config: swarm.ENSClientConfig{
Endpoint: "/data/testnet/geth.ipc",
},
},
{
description: "HTTP endpoint",
value: "http://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "http://127.0.0.1:1234",
},
},
{
description: "WS endpoint",
value: "ws://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "ws://127.0.0.1:1234",
},
},
{
description: "IPC Endpoint and TLD",
value: "test:/data/testnet/geth.ipc",
config: swarm.ENSClientConfig{
Endpoint: "/data/testnet/geth.ipc",
TLD: "test",
},
},
{
description: "HTTP endpoint and TLD",
value: "test:http://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "http://127.0.0.1:1234",
TLD: "test",
},
},
{
description: "WS endpoint and TLD",
value: "test:ws://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "ws://127.0.0.1:1234",
TLD: "test",
},
},
{
description: "IPC Endpoint and contract address",
value: "314159265dD8dbb310642f98f50C066173C1259b@/data/testnet/geth.ipc",
config: swarm.ENSClientConfig{
Endpoint: "/data/testnet/geth.ipc",
ContractAddress: "314159265dD8dbb310642f98f50C066173C1259b",
},
},
{
description: "HTTP endpoint and contract address",
value: "314159265dD8dbb310642f98f50C066173C1259b@http://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "http://127.0.0.1:1234",
ContractAddress: "314159265dD8dbb310642f98f50C066173C1259b",
},
},
{
description: "WS endpoint and contract address",
value: "314159265dD8dbb310642f98f50C066173C1259b@ws://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "ws://127.0.0.1:1234",
ContractAddress: "314159265dD8dbb310642f98f50C066173C1259b",
},
},
{
description: "IPC Endpoint, TLD and contract address",
value: "test:314159265dD8dbb310642f98f50C066173C1259b@/data/testnet/geth.ipc",
config: swarm.ENSClientConfig{
Endpoint: "/data/testnet/geth.ipc",
ContractAddress: "314159265dD8dbb310642f98f50C066173C1259b",
TLD: "test",
},
},
{
description: "HTTP endpoint, TLD and contract address",
value: "eth:314159265dD8dbb310642f98f50C066173C1259b@http://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "http://127.0.0.1:1234",
ContractAddress: "314159265dD8dbb310642f98f50C066173C1259b",
TLD: "eth",
},
},
{
description: "WS endpoint, TLD and contract address",
value: "eth:314159265dD8dbb310642f98f50C066173C1259b@ws://127.0.0.1:1234",
config: swarm.ENSClientConfig{
Endpoint: "ws://127.0.0.1:1234",
ContractAddress: "314159265dD8dbb310642f98f50C066173C1259b",
TLD: "eth",
},
},
} {
t.Run(x.description, func(t *testing.T) {
config := parseFlagEnsEndpoint(x.value)
if config.Endpoint != x.config.Endpoint {
t.Errorf("expected Endpoint %q, got %q", x.config.Endpoint, config.Endpoint)
}
if config.ContractAddress != x.config.ContractAddress {
t.Errorf("expected ContractAddress %q, got %q", x.config.ContractAddress, config.ContractAddress)
}
if config.TLD != x.config.TLD {
t.Errorf("expected TLD %q, got %q", x.config.TLD, config.TLD)
}
})
}
}