Switch to the big-int library we use in go-state-types (#519)

* fix: switch to the big-int library we use in go-state-types

Previously, we dropped the sign. Unfortunately, the only ways to do this
were to:

1. Replace the StoragePower type (what I did here).
2. Hack marshaling/unmarshaling for anything containing this type (which
I really didn't want to do).

It has some warts, but it works well in practice and works around some
issues regarding nil encoding/decoding.

fixes #517
replaces #518

* Test that we can round-trip powers

Including negative powers...

* format

* Import big instead of copying

We can split it into a new package/repo later if desired.

* go fmt

Author: Stebalien

certs/cbor_gen.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/filecoin-project/go-bitfield"
 	"github.com/filecoin-project/go-f3/gpbft"
+	"github.com/filecoin-project/go-state-types/big"
 )
 
 // PowerTableDelta represents a single power table change between GPBFT instances. If the resulting
@@ -17,7 +18,7 @@ type PowerTableDelta struct {
 	// Participant with changed power
 	ParticipantID gpbft.ActorID
 	// Change in power from base (signed).
-	PowerDelta *gpbft.StoragePower
+	PowerDelta gpbft.StoragePower
 	// New signing key if relevant (else empty)
 	SigningKey gpbft.PubKey
 }
@@ -212,7 +213,7 @@ func MakePowerTableDiff(oldPowerTable, newPowerTable gpbft.PowerEntries) PowerTa
 		delta := PowerTableDelta{ParticipantID: newEntry.ID}
 		if oldEntry, ok := oldPowerMap[newEntry.ID]; ok {
 			delete(oldPowerMap, newEntry.ID)
-			delta.PowerDelta = new(gpbft.StoragePower).Sub(newEntry.Power, oldEntry.Power)
+			delta.PowerDelta = big.Sub(newEntry.Power, oldEntry.Power)
 			if !bytes.Equal(newEntry.PubKey, oldEntry.PubKey) {
 				delta.SigningKey = newEntry.PubKey
 			}
@@ -228,7 +229,7 @@ func MakePowerTableDiff(oldPowerTable, newPowerTable gpbft.PowerEntries) PowerTa
 	for _, e := range oldPowerMap {
 		diff = append(diff, PowerTableDelta{
 			ParticipantID: e.ID,
-			PowerDelta:    new(gpbft.StoragePower).Neg(e.Power),
+			PowerDelta:    e.Power.Neg(),
 		})
 	}
 	slices.SortFunc(diff, func(a, b PowerTableDelta) int {
@@ -268,7 +269,7 @@ func ApplyPowerTableDiffs(prevPowerTable gpbft.PowerEntries, diffs ...PowerTable
 					return nil, fmt.Errorf("diff %d delta for participant %d includes an unchanged key", j, pe.ID)
 				}
 				if d.PowerDelta.Sign() != 0 {
-					pe.Power = new(gpbft.StoragePower).Add(d.PowerDelta, pe.Power)
+					pe.Power = big.Add(d.PowerDelta, pe.Power)
 				}
 				if len(d.SigningKey) > 0 {
 					// If we end up with no power, we shouldn't have replaced the key.

certs/certs.go

@@ -1,6 +1,7 @@
 package certs_test
 
 import (
+	"bytes"
 	"fmt"
 	"math/rand"
 	"slices"
@@ -11,6 +12,7 @@ import (
 	"github.com/filecoin-project/go-f3/gpbft"
 	"github.com/filecoin-project/go-f3/sim"
 	"github.com/filecoin-project/go-f3/sim/signing"
+	"github.com/filecoin-project/go-state-types/big"
 	"github.com/stretchr/testify/require"
 )
 
@@ -47,13 +49,16 @@ func TestPowerTableDiff(t *testing.T) {
 
 			expDeltaRemove[i] = certs.PowerTableDelta{
 				ParticipantID: e.ID,
-				PowerDelta:    new(gpbft.StoragePower).Neg(e.Power),
+				PowerDelta:    e.Power.Neg(),
 			}
 
 		}
 		require.Equal(t, expDeltaRemove, certs.MakePowerTableDiff(powerTable, nil))
 		require.Equal(t, expDeltaAdd, certs.MakePowerTableDiff(nil, powerTable))
 
+		testRoundTrip(t, expDeltaRemove)
+		testRoundTrip(t, expDeltaAdd)
+
 		addAll, err := certs.ApplyPowerTableDiffs(nil, expDeltaAdd)
 		require.NoError(t, err)
 		require.Equal(t, powerTable, addAll)
@@ -102,7 +107,7 @@ func TestPowerTableDiff(t *testing.T) {
 		}})
 		require.NoError(t, err)
 		require.Equal(t,
-			new(gpbft.StoragePower).Sub(newPowerTable[0].Power, powerTable[0].Power),
+			big.Sub(newPowerTable[0].Power, powerTable[0].Power),
 			gpbft.NewStoragePower(1),
 		)
 
@@ -114,7 +119,7 @@ func TestPowerTableDiff(t *testing.T) {
 		}})
 		require.NoError(t, err)
 		require.Equal(t,
-			new(gpbft.StoragePower).Sub(newPowerTable[0].Power, powerTable[0].Power),
+			big.Sub(newPowerTable[0].Power, powerTable[0].Power),
 			gpbft.NewStoragePower(1),
 		)
 		require.Equal(t, newPowerTable[0].PubKey, powerTable[1].PubKey)
@@ -149,7 +154,7 @@ func TestPowerTableDiff(t *testing.T) {
 		// Remove all power and change key.
 		_, err = certs.ApplyPowerTableDiffs(powerTable, certs.PowerTableDiff{{
 			ParticipantID: powerTable[0].ID,
-			PowerDelta:    new(gpbft.StoragePower).Neg(powerTable[0].Power),
+			PowerDelta:    powerTable[0].Power.Neg(),
 			SigningKey:    powerTable[1].PubKey,
 		}})
 		require.ErrorContains(t, err, "removes all power for participant 1 while specifying a new key")
@@ -180,13 +185,23 @@ func TestPowerTableDiff(t *testing.T) {
 		// Remove more power than we have.
 		_, err = certs.ApplyPowerTableDiffs(powerTable, certs.PowerTableDiff{{
 			ParticipantID: powerTable[0].ID,
-			PowerDelta:    new(gpbft.StoragePower).Sub(gpbft.NewStoragePower(-1), powerTable[0].Power),
+			PowerDelta:    big.Sub(gpbft.NewStoragePower(-1), powerTable[0].Power),
 		}})
 		require.ErrorContains(t, err, "resulted in negative power")
 	}
 
 }
 
+func testRoundTrip(t *testing.T, diff certs.PowerTableDiff) {
+	var b bytes.Buffer
+	require.NoError(t, diff.MarshalCBOR(&b))
+
+	var out certs.PowerTableDiff
+	require.NoError(t, out.UnmarshalCBOR(&b))
+
+	require.EqualValues(t, diff, out)
+}
+
 func TestFinalityCertificates(t *testing.T) {
 	backend := signing.NewFakeBackend()
 
@@ -319,7 +334,7 @@ func TestBadFinalityCertificates(t *testing.T) {
 		require.NoError(t, err)
 		powerTableCpy := slices.Clone(powerTable)
 		// increase so we definitely have enough power
-		powerTableCpy[firstSigner].Power = new(gpbft.StoragePower).Add(powerTableCpy[firstSigner].Power, gpbft.NewStoragePower(1))
+		powerTableCpy[firstSigner].Power = big.Add(powerTableCpy[firstSigner].Power, gpbft.NewStoragePower(1))
 		nextInstance, chain, _, err := certs.ValidateFinalityCertificates(backend, networkName, powerTableCpy, 1, nil, *certificate)
 		require.ErrorContains(t, err, "incorrect power diff")
 		require.EqualValues(t, 1, nextInstance)

certs/certs_test.go

@@ -3,7 +3,6 @@ package main
 import (
 	"context"
 	"fmt"
-	"math/big"
 	"os"
 
 	"github.com/filecoin-project/go-f3"
@@ -90,7 +89,7 @@ var runCmd = cli.Command{
 			initialPowerTable = append(initialPowerTable, gpbft.PowerEntry{
 				ID:     gpbft.ActorID(i),
 				PubKey: pubkey,
-				Power:  big.NewInt(1000),
+				Power:  gpbft.NewStoragePower(1000),
 			})
 		}
 

cmd/f3/run.go

@@ -8,6 +8,7 @@ require (
 	github.com/drand/kyber-bls12381 v0.3.1
 	github.com/filecoin-project/go-bitfield v0.2.4
 	github.com/filecoin-project/go-clock v0.1.0
+	github.com/filecoin-project/go-state-types v0.14.0
 	github.com/ipfs/go-cid v0.4.1
 	github.com/ipfs/go-datastore v0.6.0
 	github.com/ipfs/go-ds-leveldb v0.5.0

go.mod

@@ -59,6 +59,8 @@ github.com/filecoin-project/go-bitfield v0.2.4 h1:uZ7MeE+XfM5lqrHJZ93OnhQKc/rveW
 github.com/filecoin-project/go-bitfield v0.2.4/go.mod h1:CNl9WG8hgR5mttCnUErjcQjGvuiZjRqK9rHVBsQF4oM=
 github.com/filecoin-project/go-clock v0.1.0 h1:SFbYIM75M8NnFm1yMHhN9Ahy3W5bEZV9gd6MPfXbKVU=
 github.com/filecoin-project/go-clock v0.1.0/go.mod h1:4uB/O4PvOjlx1VCMdZ9MyDZXRm//gkj1ELEbxfI1AZs=
+github.com/filecoin-project/go-state-types v0.14.0 h1:JFw8r/LA0/Hvu865Yn2Gz3R5e2woItKeHTgbT4VsXoU=
+github.com/filecoin-project/go-state-types v0.14.0/go.mod h1:cDbxwjbmVtV+uNi5D/cFtxKlsRqibnQNlz7xQA1EqYg=
 github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
 github.com/flynn/noise v1.1.0 h1:KjPQoQCEFdZDiP03phOvGi11+SVVhBG2wOWAorLsstg=
 github.com/flynn/noise v1.1.0/go.mod h1:xbMo+0i6+IGbYdJhF31t2eR1BIU0CYc12+BNAKwUTag=

go.sum

@@ -1,9 +1,9 @@
 package gpbft
 
 import (
-	"math/big"
 	"testing"
 
+	"github.com/filecoin-project/go-state-types/big"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )