swap: chequebook persistence #1797

Eknir · 2019-09-23T13:59:27Z

Rework from #1790 , now with a shorter git-history
closes #1796
Closes the first bullet point of #1739

Implements chequebook persistence by saving to the swap datastore any chequebook it connects to.
Upon boot-up the node will see if there is already a chequebook used for the current Ethereum NetworkID. If this is the case, this one will be used, otherwise a new one will be deployed or the passed-in value will be used. If a value is passed-in and a chequebook is used previously, the node does not boot up and will display an error message.
Saves the Ethereum Network ID the first time a node boots up with swap-enabled. Subsequently, don't allow a different Ethereum network ID to be used anymore.
Small refactor around the deploy logic in swap

This PR is a feature which is important to help users in rebooting their swap-enabled swarm. Without the feature, users would have to manually collect from the logs the address of their previously deployed chequebook and provide this the next time via command line/config/env.

Test scenario's by hand:

Node boots up and deploys chequebook:
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://rinkeby.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt
Node boots up and uses previously deployed chequebook (from test scenario 1):
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://rinkeby.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt
Node boots up and uses previously deployed chequebook (from scenario 1 and 2), with chequebookAddress passed-in
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://rinkeby.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt --swap-chequebook <address_from_before>
Node does not boot up, with chequebookAddress passed-in. Reason: other chequebook used before
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://rinkeby.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt --swap-chequebook <different_address>
Remove data file swap.db
Node boots up, with chequebook address passed-in
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://rinkeby.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt --swap-chequebook <address_from_before>
Remove file swap.db
Node does not boot up, with chequebookAddress passed-in. Reason: contract validation failed
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://rinkeby.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt --swap-chequebook <different_address>
Node does not boot up when attempting to connect with a different than Ethereum Network ID
/home/rinke/go/src/github.com/ethersphere/swarm/build/bin/swarm --swap --swap-backend-url https://ropsen.infura.io/v3/<infure_key> --bzznetworkid=5 --password ~/.ethereum/swarm/standardPassword.txt --swap-chequebook <different_address>

…oad from state at boot-up

… disk

mortelli

first pass through the code for me. i've left some comments, but i would like to request a more in-depth explanation for this network ID business, if possible :)

i think i am missing some of the high level logic that i need to understand in order to review the code better.

what's the idea behind using and storing network IDs, specifically?

thanks

contracts/swap/swap.go

swap/swap.go

swap/swap_test.go

swap/swap.go

Eknir · 2019-09-23T14:57:31Z

first pass through the code for me. i've left some comments, but i would like to request a more in-depth explanation for this network ID business, if possible :)

i think i am missing some of the high level logic that i need to understand in order to review the code better.

what's the idea behind using and storing network IDs, specifically?

thanks

@mortelli , thanks for the code review. The networkID is needed in the statestore, because otherwise if a node saves a chequebook when connecting to (say) Rinkeby, the node will attempt to load this same chequebook when the node connects to (say) Mainnet. The contract is obviously not deployed on mainnet, so we have to add the networkID as a key in the database. If not, the node will error on ValidateCode (swap/swap.go:489:bindToContractAt)

1_used_chequebook will yield the used chequebook address on mainnet,
3_used_chequebook will yield the used chequebook on Ropsten, etc.

Based on review from @ralph-pichler, I added the same logic to the key for balances used cheques and sent cheques, such that these keys are also not reused on different Ethereum networks

…ndURL

holisticode

A couple of minor things to look at please.

I am a bit nervous with this adding of a network ID again, but I can't pinpoint it and can't name any real problem for now

swap/swap.go

swap/swap_test.go

swap/swap.go

swap/swap_test.go

…ackend

…de it impossible to connect with one statestore to multiple Ethereum network IDs

ralph-pichler

I don't think your networkID logic works because you're using different userBefore keys.

My idea was:

there is one usedBeforeNetworkId key
on start check if it exists
- if it exists compare it against the current one and abort if it doesn't match
- if it doesn't exist save it as usedBeforeNetworkId and continue

The rest of the PR looks good to me.

swap/swap.go

holisticode

Good work tackling this bit of complex matter.

There are a couple of issues though. The most important ones:

Moving it to StartChequebook now gives the problem of other go routines messing up the prompt. I don't think we should overlook that. The reason is that you do all this initialization from Swarm.Start(). As I have commented elsewhere, this should actually be the correct way to initialize services, but we don't use it like this. I would suggest to move everything back into New to avoid these issues.
It seems to me that it is not possible anymore to provide an initial amount via config flag, can you check?

I like the idea of removing the InitialDepositAmount altogether from the Params, as it really only is used once and it doesn't need to be stored really. However make sure that the param can be set in any case.

holisticode · 2019-09-25T20:16:57Z

contracts/swap/swap.go

+// It assumes that there is an existing contract instance at the given address, or an error is returned
+// This function is needed to communicate with remote Swap contracts (e.g. sending a cheque)
+func InstanceAt(address common.Address, backend Backend) (Contract, error) {
+	simple, err := contract.NewSimpleSwap(address, backend)


Mind you he just moved what was existing, so it was like this before.

But I am ok changing these things too (this is why careful with moving things around without changing them, it becomes unclear IF something changed and by who)

holisticode · 2019-09-25T20:18:09Z

swap/swap.go

@@ -143,28 +145,60 @@ func New(logpath string, dbPath string, prvkey *ecdsa.PrivateKey, backendURL str
 	// initialize the balances store
 	stateStore, err := state.NewDBStore(filepath.Join(dbPath, "swap.db"))
 	if err != nil {
-		return nil, fmt.Errorf("swap init error: %s", err)
+		return nil, fmt.Errorf("swap init error: error initializing statestore: %v", err)


Remember, only log//add an error if it has not been logged before (so useful to go and check), and/or if it actually adds to the available error message.

holisticode · 2019-09-25T20:20:21Z

swap/swap.go

+	if err != nil {
+		return nil, fmt.Errorf("swap init error: error retrieving networkID from backendURL: %v", err)
+	}
+	var usedBeforeAtNetwork uint64


I agree, these names are strange - what was used before?

I suggest something like firstConnectedBlockchain or something (Network is not descriptive enough and could be misleading, even if the call on the blockchain is called NetworkID() )

swap/swap.go

holisticode · 2019-09-25T20:30:21Z

swap/swap.go

+	}
+	// read from database
+	if err == nil {
+		usedBefore = true


Is this safe enough? What if the state store went away?

That would be of course a user error. And in that case all balances and cheques would be gone anyway, which means that the node starts afresh.

I am just asking you to think of what this could mean for the complete initialization process here. I guess there is no problem whatsoever, please confirm.

If the user corrupts it's state store many things can go wrong. Let's say it would only delete the entry about the networkID. In this case, the user might connect on a different network, where he will (among other potential errors) not be able to cash the cheques which should be cashable according to the statestore.

holisticode · 2019-09-25T20:42:32Z

swap/swap.go

@@ -491,8 +532,8 @@ func (s *Swap) deployLoop(opts *bind.TransactOpts, owner common.Address, default
 			time.Sleep(deployDelay)
 		}

-		if s.contract, tx, err = contract.Deploy(opts, s.backend, owner, defaultHarddepositTimeoutDuration); err != nil {
-			auditLog.Warn("can't send chequebook deploy tx", "try", try, "error", err)
+		if addr, tx, _, err = contract.Deploy(opts, s.backend, owner, defaultHarddepositTimeoutDuration); err != nil {


yes, this is production code, not test code, let's not ignore, and if it needs to be ignored, explain why

holisticode · 2019-09-25T20:44:19Z

swap/swap_test.go

 	opts := bind.NewKeyedTransactor(swap.owner.privateKey)
 	opts.Value = big.NewInt(int64(swap.params.InitialDepositAmount))
 	opts.Context = ctx

-	swap.contract, _, err = cswap.Deploy(opts, swap.backend, swap.owner.address, defaultHarddepositTimeoutDuration)
+	address, _, _, err := cswap.Deploy(opts, swap.backend, swap.owner.address, defaultHarddepositTimeoutDuration)


Why is this change?

holisticode · 2019-09-25T20:45:24Z

swarm_test.go

@@ -109,19 +108,6 @@ func TestNewSwarm(t *testing.T) {
 				}
 			},
 		},
-		{


Me too.

In fact on first glance (I only did a quick check) it seems as it is not possible to pass the initial amount via config variable anymore, and this tests would probably catch it!

swap/swap.go

…k initial networkID in checkNetworkID

holisticode

Great job!

ralph-pichler

Nodes don't start anymore on empty datadirs, this needs to be fixed before merge.

As for the issue with StartChequebook I don't like it but if @holisticode and @mortelli think it's ok I'll accept that.

swap/swap.go

ralph-pichler

LGTM

ralph-pichler · 2019-09-26T20:03:29Z

One final request: Please change the title from persistance to persistence

Eknir added 7 commits September 23, 2019 15:50

swap, contracts/swap: save used chequebook to state and attempt to l…

7f45609

…oad from state at boot-up

swap: fix broken test

6692bae

swap: add networkID as a parameter to save/load used chequebooks from…

a6354de

… disk

implemented NetworkID for swapTestBackend

cf0ba7e

swap: added tests covering the connecting to an existing chequebook

56daf95

swap: made testChequeContract2 not the same as testChequeContract

6e391f0

swap: saved networkID on SWAP object

0c260c3

Eknir mentioned this pull request Sep 23, 2019

Incentives chequebook persistance #1790

Closed

Eknir added the incentives label Sep 23, 2019

Eknir self-assigned this Sep 23, 2019

Eknir added the ready for review label Sep 23, 2019

mortelli reviewed Sep 23, 2019

View reviewed changes

swap: add networkID prefix to balances, received cheque and sent cheque

632de27

Eknir added 2 commits September 23, 2019 17:07

swap:renaming and comments

662233f

removed testNewSwarm:withSwap testcase because of dependency on backe…

949c5dc

…ndURL

Eknir changed the title ~~Incentive chequebook persistance1~~ Incentive chequebook persistance Sep 23, 2019

swap: removed networkID from balances prefix

5d293c6

holisticode suggested changes Sep 23, 2019

View reviewed changes

Eknir added 4 commits September 24, 2019 10:45

swap: more elaborate startChequebook tests, testNetworkID under testB…

ac2160e

…ackend

swap: renamed networkID to backendNetworkID. Removed debug prints

c148730

swap: removed redundant whitespace

419a06f

swap: fix misspell

5f00a9c

ralph-pichler mentioned this pull request Sep 24, 2019

swap: use the SimpleSwapFactory for deployment and verification #1803

Merged

holisticode mentioned this pull request Sep 25, 2019

Query user for initial deposit amount #1807

Closed

Eknir added 2 commits September 25, 2019 12:25

swap: removed Ethereum networkID identifiers from statestore keys, ma…

7408362

…de it impossible to connect with one statestore to multiple Ethereum network IDs

swap: error messages and comments

a07c5c1

Eknir requested a review from ralph-pichler September 25, 2019 10:33

Eknir changed the title ~~Incentive chequebook persistance~~ swap: chequebook persistance Sep 25, 2019

ralph-pichler suggested changes Sep 25, 2019

View reviewed changes

swap/swap.go Outdated Show resolved Hide resolved

swap/swap.go Outdated Show resolved Hide resolved

swap/swap.go Outdated Show resolved Hide resolved

swap: prompt to startChequebook

b7f98ac

holisticode suggested changes Sep 25, 2019

View reviewed changes

Eknir added 12 commits September 26, 2019 12:15

swap: initialize chequebook in swap.New

26d9467

swap: make tests pass again

f9e1837

swap: update comments, logs, variable names

e2e8edc

swap: usedBefore fix

e414145

swap: updated expected error in tests

170878d

swap: remove auditlog from protocol_test.go

bbf2f9b

swap: updated comment at swap.New

a5fd51a

swap: made comment to match godoc specification

bf2cad0

swap: updated comment for SWAP deployment

2e53e83

swap: removed backendNetworkID from swap

675c797

swap: remove networkID from simulatedBackend

2441747

swap: update statestore keys

5d7484d

Eknir mentioned this pull request Sep 26, 2019

testNewSwarm with swap-enabled #1820

Closed

Eknir added 2 commits September 26, 2019 16:01

swap: more changes from feedback

047422c

swap: assign variables in if-statement in swap-new and save chequeboo…

98771d6

…k initial networkID in checkNetworkID

holisticode approved these changes Sep 26, 2019

View reviewed changes

ralph-pichler suggested changes Sep 26, 2019

View reviewed changes

swap/swap.go Outdated Show resolved Hide resolved

swap/swap.go Outdated Show resolved Hide resolved

swap/swap.go Outdated Show resolved Hide resolved

Eknir added 5 commits September 26, 2019 19:05

swap: fix reading network ID on initial boot

42aaca0

swap: use chainID instead of networkID

286cf36

swap: put receivers back

27e2220

swap: made test pass again

aca25a2

swap: change log message

8b1400d

holisticode mentioned this pull request Sep 26, 2019

Automate manual testing for chequebook initialization #1824

Open

ralph-pichler approved these changes Sep 26, 2019

View reviewed changes

holisticode changed the title ~~swap: chequebook persistance~~ swap: chequebook persistence Sep 26, 2019

holisticode merged commit 0362436 into master Sep 26, 2019

mortelli deleted the incentive-chequebook_persistance1 branch November 14, 2019 18:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

swap: chequebook persistence #1797

swap: chequebook persistence #1797

Eknir commented Sep 23, 2019 •

edited

Loading

mortelli left a comment

Eknir commented Sep 23, 2019 •

edited

Loading

holisticode left a comment

ralph-pichler left a comment

holisticode left a comment

holisticode Sep 25, 2019

holisticode Sep 25, 2019

holisticode Sep 25, 2019

holisticode Sep 25, 2019

Eknir Sep 26, 2019

holisticode Sep 25, 2019

holisticode Sep 25, 2019

holisticode Sep 25, 2019

holisticode left a comment

ralph-pichler left a comment

ralph-pichler left a comment

ralph-pichler commented Sep 26, 2019

@@ @@ -109,19 +108,6 @@ func TestNewSwarm(t *testing.T) { @@
               				}
               			},
               		},
-              		{

swap: chequebook persistence #1797

swap: chequebook persistence #1797

Conversation

Eknir commented Sep 23, 2019 • edited Loading

mortelli left a comment

Choose a reason for hiding this comment

Eknir commented Sep 23, 2019 • edited Loading

holisticode left a comment

Choose a reason for hiding this comment

ralph-pichler left a comment

Choose a reason for hiding this comment

holisticode left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holisticode left a comment

Choose a reason for hiding this comment

ralph-pichler left a comment

Choose a reason for hiding this comment

ralph-pichler left a comment

Choose a reason for hiding this comment

ralph-pichler commented Sep 26, 2019

Eknir commented Sep 23, 2019 •

edited

Loading

Eknir commented Sep 23, 2019 •

edited

Loading