Feat multiple backends (#410)

* feat(wallet, channel): Change backend to map of backends feat(Asset, Adjudicator): Add AssetID struct to identify assets with LedgerID and BackendID feat(persistence, wire): Use map[int]Address to identify clients Signed-off-by: Sophia Koehler <[email protected]> * fix(multi): Add AssetIDKey struct to fix the map lookups for funders and adjudicators. fix(randomizer): Lookup backend opts to correctly initialize address maps. fix(test): Generalize tests to be used in other backends. Signed-off-by: Sophia Koehler <[email protected]> * fix(all): Use map[int]ID instead of id for each backend. Signed-off-by: Sophia Koehler <[email protected]> * fix(all): Add map of IDs Signed-off-by: Sophia Koehler <[email protected]> * fix(channel/backend): Revert change in verify. fix(wallet/wallet, wallet/account): Revert changed definition. feat(client): Add wallet map to client for each backend. Signed-off-by: Sophia Koehler <[email protected]> * fix(Adjudicator): Change to singular channel ID in events. Signed-off-by: Sophia Koehler <[email protected]> * fix(client/test): Generalize role test. Signed-off-by: Sophia Koehler <[email protected]> * feat(channel): Add backend field check. feat(client/test, wire): Add backendID arguments. Signed-off-by: Sophia Koehler <[email protected]> * fix(subchannel_dispute): Generalize event watcher. Signed-off-by: Sophia Koehler <[email protected]> * feat: Asset Address function to handle encoding in backends. Signed-off-by: Sophia Koehler <[email protected]> * feat(apps/payment, backend/sim, channel/test, client/test, log, wallet, ): Specify backend for randomizers feat(channel/multi): Change AssetID to interface feat(channel/persistence, client/test): Generalize test for backends Signed-off-by: Sophia Koehler <[email protected]> * fix(asset.go, allocation.go): Adjust Address() to return byte[] instead of string. fix(params.go): Change IDKey to encode map entries sorted by keys. fix(backend.go): Use BackendID in argument to sign depending on backend. fix(address.go): Sort Addresses by keys before adding them to Keys. Signed-off-by: Sophia Koehler <[email protected]> * chore: Remove unnecessary logs Signed-off-by: Sophia Koehler <[email protected]> * fix: Remove repeated assetIDs in LedgerID array Signed-off-by: Sophia Koehler <[email protected]> * chore: update go.sum, gofmt some files Signed-off-by: Sophia Koehler <[email protected]> * fix(wallet/backend.go): Return just one error instead of concatenation of errors chore(All): Run gofmt and sort imports Signed-off-by: Sophia Koehler <[email protected]> * fix(golangci.yml): Exclude generated file from linter chore: Refactor for linter Signed-off-by: Sophia Koehler <[email protected]> * fix(ci): Use go1.18 for the any type in proto fix(golangci): Fix structure Signed-off-by: Sophia Koehler <[email protected]> * fix(ci): Use glinter 1.45 which supports go1.18 Signed-off-by: Sophia Koehler <[email protected]> * chore(all): Add nolint flags for conversions Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): remove unnecessary flags Signed-off-by: Sophia Koehler <[email protected]> * chore(all): Rename and add comments to exported functions Signed-off-by: Sophia Koehler <[email protected]> * chore: Rename variables Signed-off-by: Sophia Koehler <[email protected]> * fix(params, address): Fix index allocation Signed-off-by: Sophia Koehler <[email protected]> * refactor(/apps/payment, /sim/wallet, /channel, /client, /wallet, /wire): Name test backend ID in tests refactor(/multi, /client/test): Rename AssetID to MultiLedgerID Signed-off-by: Sophia Koehler <[email protected]> * refactor: Name TestBackendID, rename multiLedgerID to LedgerBackendID Signed-off-by: Sophia Koehler <[email protected]> * refactor: Fix comment on exported function Signed-off-by: Sophia Koehler <[email protected]> * chore(all): Update license dates Signed-off-by: Sophia Koehler <[email protected]> * chore(backendtest): Rename to fix import issues Signed-off-by: Sophia Koehler <[email protected]> * chore: Update license date fix: revert increased timeouts Signed-off-by: Sophia Koehler <[email protected]> --------- Signed-off-by: Sophia Koehler <[email protected]>
hyperledger-labs · Jan 29, 2025 · b53c36b · b53c36b
1 parent 381fe48
commit b53c36b
Show file tree

Hide file tree

Showing 152 changed files with 3,610 additions and 1,961 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -7,7 +7,7 @@ on:
   release:
 
 env:
-  go-version: 1.17
+  go-version: 1.18
 
 jobs:
   check-copyright:
@@ -39,7 +39,7 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
-          version: v1.43
+          version: v1.45
 
       - name: Lint proto files
         uses: plexsystems/[email protected]

diff --git a/.golangci.yml b/.golangci.yml
@@ -54,7 +54,8 @@ linters-settings:
       # Default values:
       - ^print.*$
       - 'fmt\.Print.*'
-
+    exclude-rules:
+      - path: ".*\\.pb\\.go$" # Exclude protobuf generated files.
 issues:
   # Re-enable default excludes.
   include:

diff --git a/apps/payment/app_internal_test.go b/apps/payment/app_internal_test.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -27,7 +27,7 @@ import (
 
 func TestApp_Def(t *testing.T) {
 	rng := pkgtest.Prng(t)
-	def := test.NewRandomAppID(rng)
+	def := test.NewRandomAppID(rng, channel.TestBackendID)
 	app := &App{def}
 	assert.True(t, app.Def().Equal(app.Def()))
 }

diff --git a/apps/payment/randomizer.go b/apps/payment/randomizer.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@ package payment
 import (
 	"math/rand"
 
+	"perun.network/go-perun/wallet"
+
 	"perun.network/go-perun/channel"
 	"perun.network/go-perun/channel/test"
 )
@@ -27,8 +29,8 @@ type Randomizer struct{}
 var _ test.AppRandomizer = (*Randomizer)(nil)
 
 // NewRandomApp always returns a payment app with a different address.
-func (*Randomizer) NewRandomApp(rng *rand.Rand) channel.App {
-	return &App{test.NewRandomAppID(rng)}
+func (*Randomizer) NewRandomApp(rng *rand.Rand, bID wallet.BackendID) channel.App {
+	return &App{test.NewRandomAppID(rng, bID)}
 }
 
 // NewRandomData returns NoData because a PaymentApp does not have data.

diff --git a/apps/payment/randomizer_internal_test.go b/apps/payment/randomizer_internal_test.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ func TestRandomizer(t *testing.T) {
 	rng := pkgtest.Prng(t)
 
 	r := new(Randomizer)
-	app := r.NewRandomApp(rng)
+	app := r.NewRandomApp(rng, channel.TestBackendID)
 	channel.RegisterApp(app)
 	regApp, err := channel.Resolve(app.Def())
 	assert.NoError(t, err)

diff --git a/apps/payment/resolver_internal_test.go b/apps/payment/resolver_internal_test.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -32,7 +32,7 @@ func TestResolver(t *testing.T) {
 	rng := pkgtest.Prng(t)
 	assert, require := assert.New(t), require.New(t)
 
-	def := ctest.NewRandomAppID(rng)
+	def := ctest.NewRandomAppID(rng, channel.TestBackendID)
 	channel.RegisterAppResolver(def.Equal, &Resolver{})
 
 	app, err := channel.Resolve(def)

diff --git a/backend/sim/channel/app.go b/backend/sim/channel/app.go
@@ -1,4 +1,4 @@
-// Copyright 2022 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -48,5 +48,5 @@ func (id AppID) Key() channel.AppIDKey {
 // NewRandomAppID generates a new random app identifier.
 func NewRandomAppID(rng *rand.Rand) AppID {
 	addr := wallet.NewRandomAddress(rng)
-	return AppID{addr}
+	return AppID{Address: addr}
 }
diff --git a/backend/sim/channel/asset.go b/backend/sim/channel/asset.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -65,3 +65,9 @@ func (a Asset) Equal(b channel.Asset) bool {
 	}
 	return a.ID == simAsset.ID
 }
+
+// Address returns the address of the asset.
+func (a Asset) Address() []byte {
+	data, _ := a.MarshalBinary()
+	return data
+}
diff --git a/backend/sim/channel/backend.go b/backend/sim/channel/backend.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -33,23 +33,22 @@ type backend struct{}
 var _ channel.Backend = new(backend)
 
 // CalcID calculates a channel's ID by hashing all fields of its parameters.
-func (*backend) CalcID(p *channel.Params) (id channel.ID) {
+func (*backend) CalcID(p *channel.Params) (id channel.ID, err error) {
 	w := sha256.New()
 
 	// Write Parts
-	for _, addr := range p.Parts {
-		if err := perunio.Encode(w, addr); err != nil {
-			log.Panic("Could not write to sha256 hasher")
-		}
+	if err := perunio.Encode(w, wallet.AddressMapArray{Addr: p.Parts}); err != nil {
+		log.Panic("Could not write to sha256 hasher")
 	}
 
-	err := perunio.Encode(w, p.Nonce, p.ChallengeDuration, channel.OptAppEnc{App: p.App}, p.LedgerChannel, p.VirtualChannel)
+	err = perunio.Encode(w, p.Nonce, p.ChallengeDuration, channel.OptAppEnc{App: p.App}, p.LedgerChannel, p.VirtualChannel)
 	if err != nil {
-		log.Panic("Could not write to sha256 hasher")
+		return
 	}
 
 	if copy(id[:], w.Sum(nil)) != channel.IDLen {
-		log.Panic("Could not copy id")
+		err = errors.New("Could not copy id")
+		return
 	}
 	return
 }
@@ -83,7 +82,7 @@ func (b *backend) NewAsset() channel.Asset {
 
 // NewAppID returns an object of type AppID, which can be used for
 // unmarshalling an app identifier from its binary representation.
-func (b *backend) NewAppID() channel.AppID {
+func (b *backend) NewAppID() (channel.AppID, error) {
 	addr := &simwallet.Address{}
-	return AppID{addr}
+	return AppID{addr}, nil
 }
diff --git a/backend/sim/channel/channel_internal_test.go b/backend/sim/channel/channel_internal_test.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -17,6 +17,8 @@ package channel
 import (
 	"testing"
 
+	"perun.network/go-perun/channel"
+
 	chtest "perun.network/go-perun/channel/test"
 	"perun.network/go-perun/wallet"
 	wtest "perun.network/go-perun/wallet/test"
@@ -36,11 +38,13 @@ func newChannelSetup(t *testing.T) *chtest.Setup {
 	params2, state2 := chtest.NewRandomParamsAndState(rng, chtest.WithIsFinal(!state.IsFinal), chtest.WithNumLocked(int(rng.Int31n(4)+1)))
 
 	return &chtest.Setup{
-		Params:        params,
-		Params2:       params2,
-		State:         state,
-		State2:        state2,
-		Account:       wtest.NewRandomAccount(rng),
-		RandomAddress: func() wallet.Address { return wtest.NewRandomAddress(rng) },
+		Params:  params,
+		Params2: params2,
+		State:   state,
+		State2:  state2,
+		Account: wtest.NewRandomAccount(rng, channel.TestBackendID),
+		RandomAddress: func() map[wallet.BackendID]wallet.Address {
+			return wtest.NewRandomAddresses(rng, channel.TestBackendID)
+		},
 	}
 }
diff --git a/backend/sim/channel/init.go b/backend/sim/channel/init.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -22,9 +22,9 @@ import (
 )
 
 func init() {
-	channel.SetBackend(new(backend))
-	test.SetRandomizer(new(randomizer))
+	channel.SetBackend(new(backend), channel.TestBackendID)
+	test.SetRandomizer(new(randomizer), channel.TestBackendID)
 	test.SetNewRandomAppID(func(r *rand.Rand) channel.AppID {
 		return NewRandomAppID(r)
-	})
+	}, channel.TestBackendID)
 }
diff --git a/backend/sim/wallet/account.go b/backend/sim/wallet/account.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -57,7 +57,7 @@ func NewRandomAccount(rng io.Reader) *Account {
 
 // Address returns the address of this account.
 func (a *Account) Address() wallet.Address {
-	return wallet.Address((*Address)(&a.privKey.PublicKey))
+	return (*Address)(&a.privKey.PublicKey)
 }
 
 // SignData is used to sign data with this account. If the account is locked,

diff --git a/backend/sim/wallet/address.go b/backend/sim/wallet/address.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -20,13 +20,20 @@ import (
 	"io"
 	"math/big"
 
+	"perun.network/go-perun/channel"
+
 	"perun.network/go-perun/log"
 	"perun.network/go-perun/wallet"
 )
 
 // Address represents a simulated address.
 type Address ecdsa.PublicKey
 
+// BackendID returns the backend id of the address.
+func (a Address) BackendID() wallet.BackendID {
+	return channel.TestBackendID
+}
+
 const (
 	// elemLen is the length of the binary representation of a single element
 	// of the address in bytes.
@@ -54,6 +61,21 @@ func NewRandomAddress(rng io.Reader) *Address {
 	}
 }
 
+// NewRandomAddresses creates a new address using the randomness
+// provided by rng.
+func NewRandomAddresses(rng io.Reader) map[int]wallet.Address {
+	privateKey, err := ecdsa.GenerateKey(curve, rng)
+	if err != nil {
+		log.Panicf("Creation of account failed with error", err)
+	}
+
+	return map[int]wallet.Address{channel.TestBackendID: &Address{
+		Curve: privateKey.Curve,
+		X:     privateKey.X,
+		Y:     privateKey.Y,
+	}}
+}
+
 // Bytes converts this address to bytes.
 func (a *Address) Bytes() []byte {
 	data := a.byteArray()
@@ -90,9 +112,11 @@ func (a *Address) Equal(addr wallet.Address) bool {
 }
 
 // Cmp checks the ordering of two addresses according to following definition:
-//   -1 if (a.X <  addr.X) || ((a.X == addr.X) && (a.Y < addr.Y))
-//    0 if (a.X == addr.X) && (a.Y == addr.Y)
-//   +1 if (a.X >  addr.X) || ((a.X == addr.X) && (a.Y > addr.Y))
+//
+//	-1 if (a.X <  addr.X) || ((a.X == addr.X) && (a.Y < addr.Y))
+//	 0 if (a.X == addr.X) && (a.Y == addr.Y)
+//	+1 if (a.X >  addr.X) || ((a.X == addr.X) && (a.Y > addr.Y))
+//
 // So the X coordinate is weighted higher.
 // Pancis if the passed address is of the wrong type.
 func (a *Address) Cmp(addr wallet.Address) int {

diff --git a/backend/sim/wallet/init.go b/backend/sim/wallet/init.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -15,11 +15,12 @@
 package wallet
 
 import (
+	"perun.network/go-perun/channel"
 	"perun.network/go-perun/wallet"
 	"perun.network/go-perun/wallet/test"
 )
 
 func init() {
-	wallet.SetBackend(new(Backend))
-	test.SetRandomizer(newRandomizer())
+	wallet.SetBackend(new(Backend), channel.TestBackendID)
+	test.SetRandomizer(newRandomizer(), channel.TestBackendID)
 }
diff --git a/backend/sim/wallet/wallet.go b/backend/sim/wallet/wallet.go
@@ -1,4 +1,4 @@
-// Copyright 2020 - See NOTICE file for copyright holders.
+// Copyright 2025 - See NOTICE file for copyright holders.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -64,7 +64,6 @@ type Wallet struct {
 func (w *Wallet) Unlock(a wallet.Address) (wallet.Account, error) {
 	w.accMutex.RLock()
 	defer w.accMutex.RUnlock()
-
 	acc, ok := w.accs[wallet.Key(a)]
 	if !ok {
 		return nil, errors.Errorf("unlock unknown address: %v", a)
@@ -90,7 +89,6 @@ func (w *Wallet) LockAll() {
 func (w *Wallet) IncrementUsage(a wallet.Address) {
 	w.accMutex.RLock()
 	defer w.accMutex.RUnlock()
-
 	acc, ok := w.accs[wallet.Key(a)]
 	if !ok {
 		panic("invalid address")
@@ -106,7 +104,6 @@ func (w *Wallet) IncrementUsage(a wallet.Address) {
 func (w *Wallet) DecrementUsage(a wallet.Address) {
 	w.accMutex.Lock()
 	defer w.accMutex.Unlock()
-
 	acc, ok := w.accs[wallet.Key(a)]
 	if !ok {
 		panic("invalid address")
@@ -129,7 +126,6 @@ func (w *Wallet) DecrementUsage(a wallet.Address) {
 func (w *Wallet) UsageCount(a wallet.Address) int {
 	w.accMutex.RLock()
 	defer w.accMutex.RUnlock()
-
 	acc, ok := w.accs[wallet.Key(a)]
 	if !ok {
 		panic("invalid address")
@@ -153,15 +149,13 @@ func (w *Wallet) NewRandomAccount(rng *rand.Rand) wallet.Account {
 // account was already registered beforehand, an error is returned. Does not
 // lock or unlock the account.
 func (w *Wallet) AddAccount(acc *Account) error {
-	key := wallet.Key(acc.Address())
-
 	w.accMutex.Lock()
 	defer w.accMutex.Unlock()
 
-	if _, ok := w.accs[key]; ok {
+	if _, ok := w.accs[wallet.Key(acc.Address())]; ok {
 		return errors.New("duplicate insertion")
 	}
-	w.accs[key] = acc
+	w.accs[wallet.Key(acc.Address())] = acc
 
 	return nil
 }
@@ -171,7 +165,6 @@ func (w *Wallet) AddAccount(acc *Account) error {
 func (w *Wallet) HasAccount(acc *Account) bool {
 	w.accMutex.RLock()
 	defer w.accMutex.RUnlock()
-
 	_, ok := w.accs[wallet.Key(acc.Address())]
 	return ok
 }