cmd/swarm, swarm, swap, api: configurable payment/disconnect thresholds

api/config.go

@@ -32,6 +32,7 @@ import (
 	"github.com/ethersphere/swarm/network"
 	"github.com/ethersphere/swarm/pss"
 	"github.com/ethersphere/swarm/storage"
+	"github.com/ethersphere/swarm/swap"
 )
 
 const (
@@ -52,8 +53,10 @@ type Config struct {
 	BaseKey       []byte
 
 	// Swap configs
-	SwapBackendURL string
-	SwapEnabled    bool
+	SwapBackendURL          string
+	SwapEnabled             bool
+	SwapPaymentThreshold    uint64
+	SwapDisconnectThreshold uint64
 
 	*network.HiveParams
 	Pss                  *pss.Params
@@ -81,26 +84,28 @@ type Config struct {
 	privateKey           *ecdsa.PrivateKey
 }
 
-//create a default config with all parameters to set to defaults
+//NewConfig creates a default config with all parameters to set to defaults
 func NewConfig() (c *Config) {
 
 	c = &Config{
-		FileStoreParams:      storage.NewFileStoreParams(),
-		HiveParams:           network.NewHiveParams(),
-		Pss:                  pss.NewParams(),
-		ListenAddr:           DefaultHTTPListenAddr,
-		Port:                 DefaultHTTPPort,
-		Path:                 node.DefaultDataDir(),
-		EnsAPIs:              nil,
-		EnsRoot:              ens.TestNetAddress,
-		NetworkID:            network.DefaultNetworkID,
-		SyncEnabled:          true,
-		SyncingSkipCheck:     false,
-		MaxStreamPeerServers: 10000,
-		DeliverySkipCheck:    true,
-		SyncUpdateDelay:      15 * time.Second,
-		SwapEnabled:          false,
-		SwapBackendURL:       "",
+		FileStoreParams:         storage.NewFileStoreParams(),
+		HiveParams:              network.NewHiveParams(),
+		Pss:                     pss.NewParams(),
+		ListenAddr:              DefaultHTTPListenAddr,
+		Port:                    DefaultHTTPPort,
+		Path:                    node.DefaultDataDir(),
+		EnsAPIs:                 nil,
+		EnsRoot:                 ens.TestNetAddress,
+		NetworkID:               network.DefaultNetworkID,
+		SyncEnabled:             true,
+		SyncingSkipCheck:        false,
+		MaxStreamPeerServers:    10000,
+		DeliverySkipCheck:       true,
+		SyncUpdateDelay:         15 * time.Second,
+		SwapEnabled:             false,
+		SwapBackendURL:          "",
+		SwapPaymentThreshold:    swap.DefaultPaymentThreshold,
+		SwapDisconnectThreshold: swap.DefaultDisconnectThreshold,
 	}
 
 	return

cmd/swarm/config.go

@@ -27,10 +27,10 @@ import (
 	"strings"
 	"unicode"
 
+	"github.com/ethereum/go-ethereum/common"
 	cli "gopkg.in/urfave/cli.v1"
 
 	"github.com/ethereum/go-ethereum/cmd/utils"
-	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/log"
 	"github.com/ethereum/go-ethereum/node"
 	"github.com/naoina/toml"
@@ -59,33 +59,35 @@ var (
 
 //constants for environment variables
 const (
-	SwarmEnvChequebookAddr       = "SWARM_CHEQUEBOOK_ADDR"
-	SwarmEnvAccount              = "SWARM_ACCOUNT"
-	SwarmEnvBzzKeyHex            = "SWARM_BZZ_KEY_HEX"
-	SwarmEnvListenAddr           = "SWARM_LISTEN_ADDR"
-	SwarmEnvPort                 = "SWARM_PORT"
-	SwarmEnvNetworkID            = "SWARM_NETWORK_ID"
-	SwarmEnvSwapEnable           = "SWARM_SWAP_ENABLE"
-	SwarmEnvSwapBackendURL       = "SWARM_SWAP_BACKEND_URL"
-	SwarmEnvSyncDisable          = "SWARM_SYNC_DISABLE"
-	SwarmEnvSyncUpdateDelay      = "SWARM_ENV_SYNC_UPDATE_DELAY"
-	SwarmEnvMaxStreamPeerServers = "SWARM_ENV_MAX_STREAM_PEER_SERVERS"
-	SwarmEnvLightNodeEnable      = "SWARM_LIGHT_NODE_ENABLE"
-	SwarmEnvDeliverySkipCheck    = "SWARM_DELIVERY_SKIP_CHECK"
-	SwarmEnvENSAPI               = "SWARM_ENS_API"
-	SwarmEnvENSAddr              = "SWARM_ENS_ADDR"
-	SwarmEnvCORS                 = "SWARM_CORS"
-	SwarmEnvBootnodes            = "SWARM_BOOTNODES"
-	SwarmEnvPSSEnable            = "SWARM_PSS_ENABLE"
-	SwarmEnvStorePath            = "SWARM_STORE_PATH"
-	SwarmEnvStoreCapacity        = "SWARM_STORE_CAPACITY"
-	SwarmEnvStoreCacheCapacity   = "SWARM_STORE_CACHE_CAPACITY"
-	SwarmEnvBootnodeMode         = "SWARM_BOOTNODE_MODE"
-	SwarmEnvNATInterface         = "SWARM_NAT_INTERFACE"
-	SwarmAccessPassword          = "SWARM_ACCESS_PASSWORD"
-	SwarmAutoDefaultPath         = "SWARM_AUTO_DEFAULTPATH"
-	SwarmGlobalstoreAPI          = "SWARM_GLOBALSTORE_API"
-	GethEnvDataDir               = "GETH_DATADIR"
+	SwarmEnvChequebookAddr          = "SWARM_CHEQUEBOOK_ADDR"
+	SwarmEnvAccount                 = "SWARM_ACCOUNT"
+	SwarmEnvBzzKeyHex               = "SWARM_BZZ_KEY_HEX"
+	SwarmEnvListenAddr              = "SWARM_LISTEN_ADDR"
+	SwarmEnvPort                    = "SWARM_PORT"
+	SwarmEnvNetworkID               = "SWARM_NETWORK_ID"
+	SwarmEnvSwapEnable              = "SWARM_SWAP_ENABLE"
+	SwarmEnvSwapBackendURL          = "SWARM_SWAP_BACKEND_URL"
+	SwarmEnvSwapPaymentThreshold    = "SWARM_SWAP_PAYMENT_THRESHOLD"
+	SwarmEnvSwapDisconnectThreshold = "SWARM_SWAP_DISCONNECT_THRESHOLD"
+	SwarmEnvSyncDisable             = "SWARM_SYNC_DISABLE"
+	SwarmEnvSyncUpdateDelay         = "SWARM_ENV_SYNC_UPDATE_DELAY"
+	SwarmEnvMaxStreamPeerServers    = "SWARM_ENV_MAX_STREAM_PEER_SERVERS"
+	SwarmEnvLightNodeEnable         = "SWARM_LIGHT_NODE_ENABLE"
+	SwarmEnvDeliverySkipCheck       = "SWARM_DELIVERY_SKIP_CHECK"
+	SwarmEnvENSAPI                  = "SWARM_ENS_API"
+	SwarmEnvENSAddr                 = "SWARM_ENS_ADDR"
+	SwarmEnvCORS                    = "SWARM_CORS"
+	SwarmEnvBootnodes               = "SWARM_BOOTNODES"
+	SwarmEnvPSSEnable               = "SWARM_PSS_ENABLE"
+	SwarmEnvStorePath               = "SWARM_STORE_PATH"
+	SwarmEnvStoreCapacity           = "SWARM_STORE_CAPACITY"
+	SwarmEnvStoreCacheCapacity      = "SWARM_STORE_CACHE_CAPACITY"
+	SwarmEnvBootnodeMode            = "SWARM_BOOTNODE_MODE"
+	SwarmEnvNATInterface            = "SWARM_NAT_INTERFACE"
+	SwarmAccessPassword             = "SWARM_ACCESS_PASSWORD"
+	SwarmAutoDefaultPath            = "SWARM_AUTO_DEFAULTPATH"
+	SwarmGlobalstoreAPI             = "SWARM_GLOBALSTORE_API"
+	GethEnvDataDir                  = "GETH_DATADIR"
 )
 
 // These settings ensure that TOML keys use the same names as Go struct fields.
@@ -176,11 +178,9 @@ func flagsOverride(currentConfig *bzzapi.Config, ctx *cli.Context) *bzzapi.Confi
 	if keyid := ctx.GlobalString(SwarmAccountFlag.Name); keyid != "" {
 		currentConfig.BzzAccount = keyid
 	}
-
 	if chbookaddr := ctx.GlobalString(ChequebookAddrFlag.Name); chbookaddr != "" {
 		currentConfig.Contract = common.HexToAddress(chbookaddr)
 	}
-
 	if networkid := ctx.GlobalString(SwarmNetworkIdFlag.Name); networkid != "" {
 		id, err := strconv.ParseUint(networkid, 10, 64)
 		if err != nil {
@@ -210,6 +210,18 @@ func flagsOverride(currentConfig *bzzapi.Config, ctx *cli.Context) *bzzapi.Confi
 		currentConfig.SwapEnabled = true
 	}
 
+	if swapBackendURL := ctx.GlobalString(SwarmSwapBackendURLFlag.Name); swapBackendURL != "" {
+		currentConfig.SwapBackendURL = swapBackendURL
+	}
+
+	if paymentThreshold := ctx.GlobalUint64(SwarmSwapPaymentThresholdFlag.Name); paymentThreshold != 0 {
+		currentConfig.SwapPaymentThreshold = paymentThreshold
+	}
+
+	if disconnectThreshold := ctx.GlobalUint64(SwarmSwapDisconnectThresholdFlag.Name); disconnectThreshold != 0 {
+		currentConfig.SwapDisconnectThreshold = disconnectThreshold
+	}
+
 	if ctx.GlobalIsSet(SwarmSyncDisabledFlag.Name) {
 		currentConfig.SyncEnabled = false
 	}
@@ -229,7 +241,6 @@ func flagsOverride(currentConfig *bzzapi.Config, ctx *cli.Context) *bzzapi.Confi
 		currentConfig.DeliverySkipCheck = true
 	}
 
-	currentConfig.SwapBackendURL = ctx.GlobalString(SwarmSwapBackendURLFlag.Name)
 	if currentConfig.SwapEnabled && currentConfig.SwapBackendURL == "" {
 		utils.Fatalf(SwarmErrSwapSetNoBackendURL)
 	}

cmd/swarm/config_test.go

@@ -244,7 +244,10 @@ func TestConfigCmdLineOverrides(t *testing.T) {
 		fmt.Sprintf("--%s", EnsAPIFlag.Name), "",
 		fmt.Sprintf("--%s", utils.DataDirFlag.Name), dir,
 		fmt.Sprintf("--%s", utils.IPCPathFlag.Name), conf.IPCPath,
+		fmt.Sprintf("--%s", SwarmSwapPaymentThresholdFlag.Name), "10",
+		fmt.Sprintf("--%s", SwarmSwapDisconnectThresholdFlag.Name), "15",
 	}
+
 	node.Cmd = runSwarm(t, flags...)
 	node.Cmd.InputLine(testPassphrase)
 	defer func() {
@@ -289,6 +292,14 @@ func TestConfigCmdLineOverrides(t *testing.T) {
 		t.Fatalf("Expected Cors flag to be set to %s, got %s", "*", info.Cors)
 	}
 
+	if info.SwapPaymentThreshold != 10 {
+		t.Fatalf("Expected SwapPaymentThreshold to be %d, but got %d", 10, info.SwapPaymentThreshold)
+	}
+
+	if info.SwapDisconnectThreshold != 15 {
+		t.Fatalf("Expected SwapDisconnectThreshold to be %d, but got %d", 15, info.SwapDisconnectThreshold)
+	}
+
 	node.Shutdown()
 }
 

cmd/swarm/flags.go

@@ -65,6 +65,16 @@ var (
 		Usage:  "URL of the Ethereum API provider to use to settle SWAP payments",
 		EnvVar: SwarmEnvSwapBackendURL,
 	}
+	SwarmSwapPaymentThresholdFlag = cli.Uint64Flag{
+		Name:   "swap-payment-threshold",
+		Usage:  "honey amount indebted to a peer at which you will initiate payment",
+		EnvVar: SwarmEnvSwapPaymentThreshold,
+	}
+	SwarmSwapDisconnectThresholdFlag = cli.Uint64Flag{
+		Name:   "swap-disconnect-threshold",
+		Usage:  "honey amount at debt of a peer at which you will disconnect",
+		EnvVar: SwarmEnvSwapDisconnectThreshold,
+	}
 	SwarmSyncDisabledFlag = cli.BoolTFlag{
 		Name:   "nosync",
 		Usage:  "Disable swarm syncing",

cmd/swarm/main.go

@@ -177,8 +177,11 @@ func init() {
 		CorsStringFlag,
 		EnsAPIFlag,
 		SwarmTomlConfigPathFlag,
+		//swap flags
 		SwarmSwapEnabledFlag,
 		SwarmSwapBackendURLFlag,
+		SwarmSwapDisconnectThresholdFlag,
+		SwarmSwapPaymentThresholdFlag,
 		SwarmSyncDisabledFlag,
 		SwarmSyncUpdateDelay,
 		SwarmMaxStreamPeerServersFlag,

swap/config.go

@@ -34,6 +34,6 @@ const (
 	// The smart-contract allows for setting this variable differently per beneficiary
 	defaultHarddepositTimeoutDuration = 24 * time.Hour
 
-	// While Swap is unstable, it's only allowed to be run under a specific network ID
-	AllowedNetworkID = 5
+	// While Swap is unstable, it is not allowed to run on mainnet
+	DisabledNetworkID = 1
 )

swap/oracle.go → swap/honeyOracle.go

@@ -16,14 +16,15 @@
 
 package swap
 
-// PriceOracle is the interface through which Oracles will deliver prices
-type PriceOracle interface {
+// HoneyOracle is the interface through which Oracles will deliver prices
+type HoneyOracle interface {
 	GetPrice(honey uint64) (uint64, error)
 }
 
-// NewPriceOracle returns the actual oracle to be used for discovering the price
+// NewHoneyPriceOracle returns the actual oracle to be used for discovering the price
 // It will return a default one
-func NewPriceOracle() PriceOracle {
+func NewHoneyPriceOracle() HoneyOracle {
+
 	return &fixedPriceOracle{
 		honeyPrice: defaultHoneyPrice,
 	}

swap/protocol_test.go

@@ -207,7 +207,7 @@ func TestTriggerPaymentThreshold(t *testing.T) {
 	defer cleanup()
 
 	// create a dummy pper
-	cPeer := newDummyPeerWithSpec(Spec)
+	cPeer := newDummyPeer(Spec)
 	creditor := NewPeer(cPeer.Peer, debitorSwap, common.Address{}, common.Address{})
 	// set the creditor as peer into the debitor's swap
 	debitorSwap.peers[creditor.ID()] = creditor
@@ -262,7 +262,7 @@ func TestTriggerDisconnectThreshold(t *testing.T) {
 	defer clean()
 
 	// create a dummy pper
-	cPeer := newDummyPeerWithSpec(Spec)
+	cPeer := newDummyPeer(Spec)
 	debitor := NewPeer(cPeer.Peer, creditorSwap, common.Address{}, common.Address{})
 	// set the debitor as peer into the creditor's swap
 	creditorSwap.peers[debitor.ID()] = debitor

swap/swap.go

@@ -60,9 +60,9 @@ type Swap struct {
 	owner               *Owner               // contract access
 	params              *Params              // economic and operational parameters
 	contract            swap.Contract        // reference to the smart contract
-	oracle              PriceOracle          // the oracle providing the ether price for honey
-	paymentThreshold    int64                // balance difference required for sending cheque
-	disconnectThreshold int64                // balance difference required for dropping peer
+	disconnectThreshold uint64               // amount at which the node will disconnect from the peer
+	thresholdOracle     ThresholdOracle      // oracle which resolves at which amount node will initiate payment
+	honeyPriceOracle    HoneyOracle          // oracle which resolves the price of honey (in Wei)
 }
 
 // Owner encapsulates information related to accessing the contract
@@ -86,7 +86,7 @@ func NewParams() *Params {
 }
 
 // New - swap constructor
-func New(stateStore state.Store, prvkey *ecdsa.PrivateKey, contract common.Address, backend contract.Backend) *Swap {
+func New(stateStore state.Store, prvkey *ecdsa.PrivateKey, contract common.Address, backend contract.Backend, disconnectThreshold uint64, paymentThreshold uint64) *Swap {
 	return &Swap{
 		store:               stateStore,
 		balances:            make(map[enode.ID]int64),
@@ -95,9 +95,9 @@ func New(stateStore state.Store, prvkey *ecdsa.PrivateKey, contract common.Addre
 		backend:             backend,
 		owner:               createOwner(prvkey, contract),
 		params:              NewParams(),
-		paymentThreshold:    DefaultPaymentThreshold,
-		disconnectThreshold: DefaultDisconnectThreshold,
-		oracle:              NewPriceOracle(),
+		disconnectThreshold: disconnectThreshold,
+		thresholdOracle:     NewThresholdOracle(paymentThreshold),
+		honeyPriceOracle:    NewHoneyPriceOracle(),
 	}
 }
 
@@ -158,8 +158,9 @@ func (s *Swap) Add(amount int64, peer *protocols.Peer) (err error) {
 	if !exists {
 		return fmt.Errorf("peer %v does not exist", peer.ID())
 	}
-	if balance >= s.disconnectThreshold {
-		return fmt.Errorf("balance for peer %s is over the disconnect threshold %d, disconnecting", peer.ID().String(), s.disconnectThreshold)
+	disconnectThreshold := s.disconnectThreshold
+	if balance >= int64(disconnectThreshold) {
+		return fmt.Errorf("balance for peer %s is over the disconnect threshold %d, disconnecting", peer.ID().String(), disconnectThreshold)
 	}
 
 	var newBalance int64
@@ -171,8 +172,10 @@ func (s *Swap) Add(amount int64, peer *protocols.Peer) (err error) {
 	// Check if balance with peer crosses the payment threshold
 	// It is the peer with a negative balance who sends a cheque, thus we check
 	// that the balance is *below* the threshold
-	if newBalance <= -s.paymentThreshold {
-		log.Warn("balance for peer went over the payment threshold, sending cheque", "peer", peer.ID().String(), "payment threshold", s.paymentThreshold)
+	paymentThreshold, _ := s.thresholdOracle.GetPaymentThreshold()
+
+	if newBalance <= -int64(paymentThreshold) {
+		log.Warn("balance for peer went over the payment threshold, sending cheque", "peer", peer.ID().String(), "payment threshold", paymentThreshold)
 		swapPeer, ok := s.getPeer(peer.ID())
 		if !ok {
 			return fmt.Errorf("peer %s not found", peer)
@@ -289,7 +292,7 @@ func (s *Swap) processAndVerifyCheque(cheque *Cheque, p *Peer) (uint64, error) {
 	lastCheque := s.loadLastReceivedCheque(p)
 
 	// TODO: there should probably be a lock here?
-	expectedAmount, err := s.oracle.GetPrice(cheque.Honey)
+	expectedAmount, err := s.honeyPriceOracle.GetPrice(cheque.Honey)
 	if err != nil {
 		return 0, err
 	}
@@ -390,7 +393,7 @@ func (s *Swap) createCheque(swapPeer *Peer) (*Cheque, error) {
 	honey := uint64(-peerBalance)
 
 	var amount uint64
-	amount, err = s.oracle.GetPrice(honey)
+	amount, err = s.honeyPriceOracle.GetPrice(honey)
 	if err != nil {
 		return nil, fmt.Errorf("error getting price from oracle: %s", err.Error())
 	}