🔀 Merge branch '452-release-0-6-0-fenrir' into 'dev'

0.6.0 Fenrir Changelog

Closes #452

See merge request perun/go-perun!387

Author: sebastianst

CHANGELOG.md

@@ -6,9 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] Fenrir - 2020-12-18 [:warning:]
+Support for on-chain progression of app channels.
+
+### Added
+- On-chain progression: The channel watcher is now interactive and informs the client when a channel has been registered on-chain. If the channel has a defined app logic with a valid state transition logic, clients can individually progress the app state on-chain according to the defined state transition logic by calling `ProgressBy` on the channel object.
+- Settle with sub-channel disputes: Ledger channels can now be settled with funds locked in disputed sub-channels if the corresponding sub-channels have been registered and the disputes have been resolved on-chain.
+
 ### Changed
-- `ContractBackend.NewTransactor` to set the correct context and also removed
-  the `value` parameter.
+- The channel watcher logic changed. The channel watcher now takes as input an event handler which gets notified about on-chain channel events. Before, the watcher automatically settled a channel in case of a dispute. Now, the watcher will automatically detect if an old state has been registered, refute with the most recent one, and notify the user. If the channel has a defined application logic, the user can further progress the channel on-chain. It is within the responsibility of the framework user to finally settle the channel and withdraw the funds.
+- The channel settling logic changed. Before, a call to `Settle` on a channel object automatically registered the channel, concluded it, and withdrew the funds. Now, to accomodate on-chain progression functionality, the user must call `Register` independetly before being able to settle the channel. Afterwards, for app channels, the user has the opportunity to  progress the channel state on-chain by calling `ProgressBy`. Finally, the user can settle the channel by calling `Settle`.
+- `ContractBackend.NewTransactor` now sets the context on `TransactOpts`. Furthermore, parameter `value` has been removed.
+
+### Fixed
+- Persistence: Sub-channels are now persisted and restored properly.
 
 ## [0.5.2] European Ecstasy - 2020-11-05 [:warning:]
 ERC20 and Funding Agreement support and many test fixes.
@@ -187,7 +198,8 @@ Initial release.
 
 [:warning:]: #:warning:
 
-[Unreleased]: https://github.com/perun-network/go-perun/compare/v0.5.2...HEAD
+[Unreleased]: https://github.com/perun-network/go-perun/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/perun-network/go-perun/compare/v0.5.2...v0.6.0
 [0.5.2]: https://github.com/perun-network/go-perun/compare/v0.5.0...v0.5.2
 [0.5.0]: https://github.com/perun-network/go-perun/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/perun-network/go-perun/compare/v0.3.0...v0.4.0

backend/ethereum/channel/funder_test.go

@@ -24,6 +24,7 @@ import (
 	"github.com/ethereum/go-ethereum/accounts"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -330,7 +331,7 @@ func newNFunders(
 	simBackend.FundAddress(ctx, deployAccount.Address)
 	tokenAcc := &ksWallet.NewRandomAccount(rng).(*keystore.Account).Account
 	simBackend.FundAddress(ctx, tokenAcc.Address)
-	cb := ethchannel.NewContractBackend(simBackend, keystore.NewTransactor(*ksWallet))
+	cb := ethchannel.NewContractBackend(simBackend, keystore.NewTransactor(*ksWallet, types.NewEIP155Signer(big.NewInt(1337))))
 
 	// Deploy ETHAssetholder
 	assetAddr1, err := ethchannel.DeployETHAssetholder(ctx, cb, deployAccount.Address, *deployAccount)

backend/ethereum/channel/test/setup.go

@@ -16,12 +16,14 @@ package test
 
 import (
 	"context"
+	"math/big"
 	"math/rand"
 	"testing"
 	"time"
 
 	"github.com/ethereum/go-ethereum/accounts"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/stretchr/testify/require"
 
 	ethchannel "perun.network/go-perun/backend/ethereum/channel"
@@ -63,7 +65,7 @@ func NewSimSetup(rng *rand.Rand) *SimSetup {
 	defer cancel()
 	simBackend.FundAddress(ctx, txAccount.Account.Address)
 
-	contractBackend := ethchannel.NewContractBackend(simBackend, keystore.NewTransactor(*ksWallet))
+	contractBackend := ethchannel.NewContractBackend(simBackend, keystore.NewTransactor(*ksWallet, types.NewEIP155Signer(big.NewInt(1337))))
 
 	return &SimSetup{
 		SimBackend: simBackend,
@@ -102,7 +104,7 @@ func NewSetup(t *testing.T, rng *rand.Rand, n int) *Setup {
 		s.Parts[i] = s.Accs[i].Address()
 		s.SimBackend.FundAddress(ctx, s.Accs[i].Account.Address)
 		s.Recvs[i] = ksWallet.NewRandomAccount(rng).Address().(*ethwallet.Address)
-		cb := ethchannel.NewContractBackend(s.SimBackend, keystore.NewTransactor(*ksWallet))
+		cb := ethchannel.NewContractBackend(s.SimBackend, keystore.NewTransactor(*ksWallet, types.NewEIP155Signer(big.NewInt(1337))))
 		accounts := map[ethchannel.Asset]accounts.Account{asset: s.Accs[i].Account}
 		depositors := map[ethchannel.Asset]ethchannel.Depositor{asset: new(ethchannel.ETHDepositor)}
 		s.Funders[i] = ethchannel.NewFunder(cb, accounts, depositors)

backend/ethereum/channel/test/transactor.go

@@ -31,36 +31,26 @@ import (
 
 // TransactorSetup holds the setup for running generic tests on a transactor implementation.
 type TransactorSetup struct {
+	Signer     types.Signer
+	ChainID    int64
 	Tr         channel.Transactor
 	ValidAcc   accounts.Account // wallet should contain key corresponding to this account.
 	MissingAcc accounts.Account // wallet should not contain key corresponding to this account.
 }
 
-// GenericLegacyTransactorTest tests that a transactor works with Frontier and
-// Homestead signers.
-func GenericLegacyTransactorTest(t *testing.T, rng *rand.Rand, s TransactorSetup) {
-	// Both can only deal with chainID == 0.
-	GenericSignerTest(t, rng, s, &types.FrontierSigner{}, 0)
-	GenericSignerTest(t, rng, s, &types.HomesteadSigner{}, 0)
-}
-
-// GenericEIP155TransactorTest tests that a transactor works with EIP155 signers.
-func GenericEIP155TransactorTest(t *testing.T, rng *rand.Rand, s TransactorSetup) {
-	id := rng.Int63() // Any id will work.
-	GenericSignerTest(t, rng, s, types.NewEIP155Signer(big.NewInt(id)), id)
-}
-
 // GenericSignerTest tests that a transactor produces the correct signatures
 // for the passed signer.
-func GenericSignerTest(t *testing.T, rng *rand.Rand, setup TransactorSetup, signer types.Signer, chainID int64) {
+func GenericSignerTest(t *testing.T, rng *rand.Rand, setup TransactorSetup) {
+	signer := setup.Signer
+	chainID := setup.ChainID
 	data := make([]byte, rng.Int31n(100)+1)
 	rng.Read(data)
 
 	t.Run("happy", func(t *testing.T) {
 		transactOpts, err := setup.Tr.NewTransactor(setup.ValidAcc)
 		require.NoError(t, err)
 		rawTx := types.NewTransaction(uint64(1), common.Address{}, big.NewInt(1), uint64(1), big.NewInt(1), data)
-		signedTx, err := transactOpts.Signer(signer, setup.ValidAcc.Address, rawTx)
+		signedTx, err := transactOpts.Signer(setup.ValidAcc.Address, rawTx)
 		assert.NoError(t, err)
 		require.NotNil(t, signedTx)
 
@@ -83,7 +73,7 @@ func GenericSignerTest(t *testing.T, rng *rand.Rand, setup TransactorSetup, sign
 		require.NoError(t, err)
 
 		rawTx := types.NewTransaction(uint64(1), common.Address{}, big.NewInt(1), uint64(1), big.NewInt(1), data)
-		_, err = transactOpts.Signer(signer, setup.MissingAcc.Address, rawTx)
+		_, err = transactOpts.Signer(setup.MissingAcc.Address, rawTx)
 		assert.Error(t, err)
 	})
 }

backend/ethereum/wallet/hd/transactor.go

@@ -25,6 +25,7 @@ import (
 // Transactor can be used to make TransactOpts for accounts stored in a HD wallet.
 type Transactor struct {
 	Wallet accounts.Wallet
+	Signer types.Signer
 }
 
 type hashSigner interface {
@@ -39,7 +40,7 @@ func (t *Transactor) NewTransactor(account accounts.Account) (*bind.TransactOpts
 	}
 	return &bind.TransactOpts{
 		From: account.Address,
-		Signer: func(signer types.Signer, address common.Address, tx *types.Transaction) (*types.Transaction, error) {
+		Signer: func(address common.Address, tx *types.Transaction) (*types.Transaction, error) {
 			if address != account.Address {
 				return nil, errors.New("not authorized to sign this account")
 			}
@@ -55,17 +56,17 @@ func (t *Transactor) NewTransactor(account accounts.Account) (*bind.TransactOpts
 				return t.Wallet.SignTx(account, tx, tx.ChainId())
 			}
 
-			signature, err := hs.SignHash(account, signer.Hash(tx).Bytes())
+			signature, err := hs.SignHash(account, t.Signer.Hash(tx).Bytes())
 			if err != nil {
 				return nil, err
 			}
-			return tx.WithSignature(signer, signature)
+			return tx.WithSignature(t.Signer, signature)
 		},
 	}, nil
 }
 
 // NewTransactor returns a backend that can make TransactOpts for accounts
 // contained in the given ethereum wallet.
-func NewTransactor(w accounts.Wallet) *Transactor {
-	return &Transactor{Wallet: w}
+func NewTransactor(w accounts.Wallet, signer types.Signer) *Transactor {
+	return &Transactor{Wallet: w, Signer: signer}
 }

backend/ethereum/wallet/hd/transactor_test.go

@@ -23,7 +23,6 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/types"
 	hdwallet "github.com/miguelmota/go-ethereum-hdwallet"
-	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"perun.network/go-perun/backend/ethereum/channel/test"
@@ -38,24 +37,58 @@ const missingAddr = "0x1"
 // noSignHash is used to hide the SignHash function of the embedded wallet.
 type noSignHash struct {
 	*hdwallet.Wallet
-	SignTxCalled bool
 }
 
 func TestTransactor(t *testing.T) {
 	rng := pkgtest.Prng(t)
-	// The normal transactor should be able to deal with all signers.
-	s := newTransactorSetup(t, rng, false)
-	test.GenericLegacyTransactorTest(t, rng, s)
-	test.GenericEIP155TransactorTest(t, rng, s)
+	chainID := rng.Int63()
 
-	// The noSignHasher should only work with Frontier and Homestead.
-	s = newTransactorSetup(t, rng, true)
-	test.GenericLegacyTransactorTest(t, rng, s)
-	assert.True(t, s.Tr.(*hd.Transactor).Wallet.(*noSignHash).SignTxCalled)
+	tests := []struct {
+		title        string
+		signer       types.Signer
+		chainID      int64
+		hideSignHash bool
+	}{
+		{
+			title:   "FrontierSigner",
+			signer:  &types.FrontierSigner{},
+			chainID: 0,
+		},
+		{
+			title:   "HomesteadSigner",
+			signer:  &types.HomesteadSigner{},
+			chainID: 0,
+		},
+		{
+			title:        "FrontierSigner (hideSignHash)",
+			signer:       &types.FrontierSigner{},
+			chainID:      0,
+			hideSignHash: true,
+		},
+		{
+			title:        "HomesteadSigner (hideSignHash)",
+			signer:       &types.HomesteadSigner{},
+			chainID:      0,
+			hideSignHash: true,
+		},
+		{
+			title:   "EIP155Signer",
+			signer:  types.NewEIP155Signer(big.NewInt(chainID)),
+			chainID: chainID,
+		},
+	}
+
+	for _, _t := range tests {
+		_t := _t
+		t.Run(_t.title, func(t *testing.T) {
+			s := newTransactorSetup(t, rng, _t.hideSignHash, _t.signer, _t.chainID)
+			test.GenericSignerTest(t, rng, s)
+		})
+	}
 }
 
 // nolint:interfacer // rand.Rand is preferred over io.Reader here.
-func newTransactorSetup(t *testing.T, prng *rand.Rand, hideSignHash bool) test.TransactorSetup {
+func newTransactorSetup(t *testing.T, prng *rand.Rand, hideSignHash bool, signer types.Signer, chainID int64) test.TransactorSetup {
 	walletSeed := make([]byte, 20)
 	prng.Read(walletSeed)
 	mnemonic, err := hdwallet.NewMnemonicFromEntropy(walletSeed)
@@ -67,7 +100,7 @@ func newTransactorSetup(t *testing.T, prng *rand.Rand, hideSignHash bool) test.T
 
 	var wrappedWallet accounts.Wallet = rawHDWallet
 	if hideSignHash {
-		wrappedWallet = &noSignHash{rawHDWallet, false}
+		wrappedWallet = &noSignHash{rawHDWallet}
 	}
 	hdWallet, err := hd.NewWallet(wrappedWallet, hd.DefaultRootDerivationPath.String(), 0)
 	require.NoError(t, err)
@@ -78,7 +111,9 @@ func newTransactorSetup(t *testing.T, prng *rand.Rand, hideSignHash bool) test.T
 	require.NotNil(t, validAcc)
 
 	return test.TransactorSetup{
-		Tr:         hd.NewTransactor(hdWallet.Wallet()),
+		Signer:     signer,
+		ChainID:    chainID,
+		Tr:         hd.NewTransactor(hdWallet.Wallet(), signer),
 		ValidAcc:   accounts.Account{Address: wallet.AsEthAddr(validAcc.Address())},
 		MissingAcc: accounts.Account{Address: common.HexToAddress(missingAddr)},
 	}
@@ -87,9 +122,3 @@ func newTransactorSetup(t *testing.T, prng *rand.Rand, hideSignHash bool) test.T
 // SignHash hides the public SignHash.
 func (*noSignHash) SignHash() {
 }
-
-// SignTx calls SignTx of the embedded wallet and sets SignTxCalled to true.
-func (n *noSignHash) SignTx(account accounts.Account, tx *types.Transaction, chainID *big.Int) (*types.Transaction, error) {
-	n.SignTxCalled = true
-	return n.Wallet.SignTx(account, tx, chainID)
-}

backend/ethereum/wallet/keystore/transactor.go

@@ -18,12 +18,15 @@ import (
 	"github.com/ethereum/go-ethereum/accounts"
 	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/ethereum/go-ethereum/accounts/keystore"
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/pkg/errors"
 )
 
 // Transactor can be used to make TransactOpts for accounts stored in a keystore.
 type Transactor struct {
-	Ks *keystore.KeyStore
+	Ks     *keystore.KeyStore
+	Signer types.Signer
 }
 
 // NewTransactor returns a TransactOpts for the given account. It errors if the account is
@@ -32,11 +35,23 @@ func (t *Transactor) NewTransactor(account accounts.Account) (*bind.TransactOpts
 	if !t.Ks.HasAddress(account.Address) {
 		return nil, errors.New("the wallet does not contain the keys for the given account")
 	}
-	tr, err := bind.NewKeyStoreTransactor(t.Ks, account)
-	return tr, errors.WithStack(err)
+	return &bind.TransactOpts{
+		From: account.Address,
+		Signer: func(address common.Address, tx *types.Transaction) (*types.Transaction, error) {
+			keystore, signer := t.Ks, t.Signer
+			if address != account.Address {
+				return nil, bind.ErrNotAuthorized
+			}
+			signature, err := keystore.SignHash(account, signer.Hash(tx).Bytes())
+			if err != nil {
+				return nil, err
+			}
+			return tx.WithSignature(signer, signature)
+		},
+	}, nil
 }
 
 // NewTransactor returns a backend that can make TransactOpts for accounts contained in the given keystore.
-func NewTransactor(w Wallet) *Transactor {
-	return &Transactor{Ks: w.Ks}
+func NewTransactor(w Wallet, s types.Signer) *Transactor {
+	return &Transactor{Ks: w.Ks, Signer: s}
 }

backend/ethereum/wallet/keystore/transactor_test.go

@@ -15,14 +15,16 @@
 package keystore_test
 
 import (
+	"math/big"
 	"math/rand"
 	"testing"
 
 	"github.com/ethereum/go-ethereum/accounts"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/stretchr/testify/require"
 
-	ethchanneltest "perun.network/go-perun/backend/ethereum/channel/test"
+	"perun.network/go-perun/backend/ethereum/channel/test"
 	"perun.network/go-perun/backend/ethereum/wallet"
 	"perun.network/go-perun/backend/ethereum/wallet/keystore"
 	_ "perun.network/go-perun/backend/ethereum/wallet/test"
@@ -34,18 +36,48 @@ import (
 const randomAddr = "0x1"
 
 func TestTxOptsBackend(t *testing.T) {
-	prng := pkgtest.Prng(t)
-	s := newTransactorSetup(t, prng)
-	ethchanneltest.GenericEIP155TransactorTest(t, prng, s)
-	ethchanneltest.GenericLegacyTransactorTest(t, prng, s)
+	rng := pkgtest.Prng(t)
+	chainID := rng.Int63()
+
+	tests := []struct {
+		title   string
+		signer  types.Signer
+		chainID int64
+	}{
+		{
+			title:   "FrontierSigner",
+			signer:  &types.FrontierSigner{},
+			chainID: 0,
+		},
+		{
+			title:   "HomesteadSigner",
+			signer:  &types.HomesteadSigner{},
+			chainID: 0,
+		},
+		{
+			title:   "EIP155Signer",
+			signer:  types.NewEIP155Signer(big.NewInt(chainID)),
+			chainID: chainID,
+		},
+	}
+
+	for _, _t := range tests {
+		_t := _t
+		t.Run(_t.title, func(t *testing.T) {
+			s := newTransactorSetup(t, rng, _t.signer, _t.chainID)
+			test.GenericSignerTest(t, rng, s)
+		})
+	}
 }
 
-func newTransactorSetup(t require.TestingT, prng *rand.Rand) ethchanneltest.TransactorSetup {
+func newTransactorSetup(t require.TestingT, prng *rand.Rand, signer types.Signer, chainID int64) test.TransactorSetup {
 	ksWallet, ok := wallettest.RandomWallet().(*keystore.Wallet)
 	require.Truef(t, ok, "random wallet in wallettest should be a keystore wallet")
 	acc := wallettest.NewRandomAccount(prng)
-	return ethchanneltest.TransactorSetup{
-		Tr:         keystore.NewTransactor(*ksWallet),
+	return test.TransactorSetup{
+		Signer:     signer,
+		ChainID:    chainID,
+		Tr:         keystore.NewTransactor(*ksWallet, signer),
 		ValidAcc:   accounts.Account{Address: wallet.AsEthAddr(acc.Address())},
 		MissingAcc: accounts.Account{Address: common.HexToAddress(randomAddr)},
 	}