Egoistic Funding Test (#52)

* feat(multiledger): Add egoistic argument in setupClient to test correctness of egoisticPart and EgoisticChains. Signed-off-by: Sophia Koehler <[email protected]> * feat(multiledger): Add new test case for egoistic funding. Signed-off-by: Sophia Koehler <[email protected]> * feat(fund): Add fundAll function that funds all funders and returns a list of times, each funder took to finish. feat(TestEgoisticParticipantFunding): Add Test that sets one participant as egoistic, funds and checks if egoistic funder funds last. Signed-off-by: Sophia Koehler <[email protected]> refactor(multiledger): Add comment, rename function. Signed-off-by: Sophia Koehler <[email protected]> refactor(multiledger): Add var for participants length. Signed-off-by: Sophia Koehler <[email protected]> * revert: Remove multiledger test. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Add t.Helper() Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Rearrange arguments in fundAll. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Add comment for FundAll. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Add const for waiting time. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Change to loop. Signed-off-by: Sophia Koehler <[email protected]> Revert "refactor(fund): change to loop." This reverts commit a567031. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): change to loop. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): remove loop, add 2 second wait. Signed-off-by: Sophia Koehler <[email protected]> refactor(funder): rearrange imports. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Add waitgroup. Signed-off-by: Sophia Koehler <[email protected]> refactor(funder_test) refactor(fund): Add concurrent testing. Signed-off-by: Sophia Koehler <[email protected]> refactor(fund): Add comments, delete unnecessary function. Signed-off-by: Sophia Koehler <[email protected]> * chore: Update dates of copyright license Signed-off-by: Sophia Koehler <[email protected]> --------- Signed-off-by: Sophia Koehler <[email protected]> Co-authored-by: Ilja von Hoessle <[email protected]>
hyperledger-labs · Apr 9, 2024 · 3c47eab · 3c47eab
1 parent 06cea29
commit 3c47eab
Show file tree

Hide file tree

Showing 4 changed files with 121 additions and 4 deletions.
diff --git a/channel/funder_test.go b/channel/funder_test.go
@@ -1,4 +1,4 @@
-// Copyright 2019 - See NOTICE file for copyright holders.
+// Copyright 2024 - 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.
@@ -16,6 +16,8 @@ package channel_test
 
 import (
 	"context"
+	"fmt"
+	"math"
 	"math/big"
 	"math/rand"
 	"testing"
@@ -194,6 +196,53 @@ func testFunderCrossOverFunding(t *testing.T, n int) {
 	assert.NoError(t, compareOnChainAlloc(ctx, params, agreement, alloc.Assets, &funders[0].ContractBackend))
 }
 
+func TestEgoisticParticipantFunding(t *testing.T) {
+	// Peers will randomly fund for each other.
+	for i := 0; i < 30; i++ {
+		name := fmt.Sprintf("Egoistic Funding %v", i)
+		t.Run(name, func(t *testing.T) { testEgoisticParticipantFunding(t) })
+	}
+}
+
+func testEgoisticParticipantFunding(t *testing.T) {
+	t.Helper()
+	t.Parallel()
+	n := 2
+	rng := pkgtest.Prng(t, n)
+	EgoisticTxTimeout := 20 * time.Second
+	ctx, cancel := context.WithTimeout(context.Background(), EgoisticTxTimeout*time.Duration(n))
+	defer cancel()
+	_, funders, params, alloc := newNFunders(ctx, t, rng, n)
+	egoisticIndex := rng.Intn(2)
+	balances := [][]*big.Int{
+		{big.NewInt(1), big.NewInt(0)},
+		{big.NewInt(0), big.NewInt(2)},
+	}
+	allocation := channel.Allocation{Assets: alloc.Assets, Balances: balances, Locked: alloc.Locked}
+	egoisticParts := make([]bool, n)
+	funders[egoisticIndex].SetEgoisticPart(channel.Index(egoisticIndex), n)
+	egoisticParts[egoisticIndex] = true
+	t.Logf("Egoistic Participants: %v", egoisticParts)
+	agreement := allocation.Balances
+	require.Equal(t, agreement.Sum(), allocation.Balances.Sum())
+
+	fundingRequests := make([]*channel.FundingReq, n)
+	for i := range funders {
+		req := channel.NewFundingReq(params, &channel.State{Allocation: allocation}, channel.Index(i), agreement)
+		fundingRequests[i] = req
+	}
+	finishTimes, err := test.FundAll(ctx, t, funders, fundingRequests, egoisticIndex)
+	require.True(t, len(finishTimes) == n, "Length of indexes must be n")
+	require.NoError(t, err)
+
+	t.Logf("finishTimes: %v", finishTimes)
+	// Check if finish time of egoistic funder is larger than finish time of non-egoistic funder.
+	correct := finishTimes[egoisticIndex].Time > finishTimes[int(math.Abs(float64(1-egoisticIndex)))].Time
+	// Use require.True to compare the finish times
+	require.True(t, correct, "Non-egoistic funders finish earlier than egoistic funders")
+	assert.NoError(t, compareOnChainAlloc(ctx, params, agreement, allocation.Assets, &funders[0].ContractBackend))
+}
+
 func TestFunder_ZeroBalance(t *testing.T) {
 	t.Run("1 Participant", func(t *testing.T) { testFunderZeroBalance(t, 1) })
 	t.Run("2 Participant", func(t *testing.T) { testFunderZeroBalance(t, 2) })

diff --git a/channel/test/fund.go b/channel/test/fund.go
@@ -0,0 +1,68 @@
+// Copyright 2024 - 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.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package test
+
+import (
+	"context"
+	"sync"
+	"testing"
+	"time"
+
+	"github.com/perun-network/perun-eth-backend/channel"
+	"github.com/stretchr/testify/require"
+	pchannel "perun.network/go-perun/channel"
+)
+
+// waitTime is the time to wait before funding a channel when the funder is not egoistic.
+const waitTime = 2 * time.Second
+
+// FunderFinishTime is the returned type of FundAll which includes the process time of each funder.
+type FunderFinishTime struct {
+	Index int
+	Time  time.Duration
+}
+
+// FundAll calls fund for all funders simultaneously.
+func FundAll(ctx context.Context, t *testing.T, funders []*channel.Funder, reqs []*pchannel.FundingReq, egoisticIndex int) ([]FunderFinishTime, error) {
+	t.Helper()
+	finishTimes := make([]FunderFinishTime, len(funders))
+	var mutex sync.Mutex
+
+	var wg sync.WaitGroup
+	wg.Add(len(funders))
+
+	for i := range funders {
+		i := i
+		go func() {
+			defer wg.Done()
+			if i != egoisticIndex {
+				time.Sleep(waitTime)
+			}
+			startTime := time.Now()
+			err := funders[i].Fund(ctx, *reqs[i])
+			require.NoError(t, err)
+			finishTime := time.Now()
+			mutex.Lock()
+			finishTimes[i] = FunderFinishTime{
+				Index: i,
+				Time:  finishTime.Sub(startTime),
+			}
+			mutex.Unlock()
+		}()
+	}
+
+	wg.Wait()
+	return finishTimes, nil
+}
diff --git a/go.mod b/go.mod
@@ -9,7 +9,7 @@ require (
 	github.com/sirupsen/logrus v1.8.1
 	github.com/stretchr/testify v1.7.0
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
-	perun.network/go-perun v0.11.1-0.20240312125059-3811fdb76baf
+	perun.network/go-perun v0.11.1-0.20240326094100-011cfdf0ea51
 	polycry.pt/poly-go v0.0.0-20220301085937-fb9d71b45a37
 )
 

diff --git a/go.sum b/go.sum
@@ -645,8 +645,8 @@ honnef.co/go/tools v0.0.0-20190418001031-e561f6794a2a/go.mod h1:rf3lG4BRIbNafJWh
 honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg=
 honnef.co/go/tools v0.1.3/go.mod h1:NgwopIslSNH47DimFoV78dnkksY2EFtX0ajyb3K/las=
-perun.network/go-perun v0.11.1-0.20240312125059-3811fdb76baf h1:eTmgN9p2Uo48c+8Jiya67wnRakZEBoXlG3fWOSXlPw0=
-perun.network/go-perun v0.11.1-0.20240312125059-3811fdb76baf/go.mod h1:VfCebjZTnFrQRcjbkK1s1l+H71MKW7jodpFQBdP7tRQ=
+perun.network/go-perun v0.11.1-0.20240326094100-011cfdf0ea51 h1:fIM4nKc6OKkBX/gJrCTMMFmxeoFTE1DAerndDW/njVc=
+perun.network/go-perun v0.11.1-0.20240326094100-011cfdf0ea51/go.mod h1:VfCebjZTnFrQRcjbkK1s1l+H71MKW7jodpFQBdP7tRQ=
 polycry.pt/poly-go v0.0.0-20220301085937-fb9d71b45a37 h1:iA5GzEa/hHfVlQpimEjPV09NATwHXxSjWNB0VVodtew=
 polycry.pt/poly-go v0.0.0-20220301085937-fb9d71b45a37/go.mod h1:XUBrNtqgEhN3EEOP/5gh7IBd3xVHKidCjXDZfl9+kMU=
 rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8=