[pkg/io,wire/perun] Move pkg/io to wire/perunio

- pkg/io implements the a custom encoding/decoding logic for sending messages on the wire. - Hence, moving it to a more appropriate path wire/perun. - Note: persistence/keyvalue also uses the wire/perun encoding for storing the channels to the keyvalue store. Signed-off-by: Manoranjith <[email protected]>
perun-network · Dec 8, 2021 · 4392ab6 · 4392ab6
1 parent 39553f9
commit 4392ab6
Show file tree

Hide file tree

Showing 61 changed files with 135 additions and 134 deletions.
diff --git a/backend/ethereum/channel/backend.go b/backend/ethereum/channel/backend.go
@@ -29,8 +29,8 @@ import (
 	"perun.network/go-perun/backend/ethereum/bindings/adjudicator"
 	ethwallet "perun.network/go-perun/backend/ethereum/wallet"
 	"perun.network/go-perun/channel"
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 const (

diff --git a/backend/ethereum/channel_test.go b/backend/ethereum/channel_test.go
@@ -20,7 +20,7 @@ import (
 	pkgtest "polycry.pt/poly-go/test"
 
 	ethwallettest "perun.network/go-perun/backend/ethereum/wallet/test"
-	"perun.network/go-perun/pkg/io/test"
+	"perun.network/go-perun/wire/perunio/test"
 )
 
 func Test_Asset_GenericMarshaler(t *testing.T) {

diff --git a/backend/ethereum/wallet/address_internal_test.go b/backend/ethereum/wallet/address_internal_test.go
@@ -20,7 +20,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/stretchr/testify/require"
 
-	"perun.network/go-perun/pkg/io/test"
+	"perun.network/go-perun/wire/perunio/test"
 	pkgtest "polycry.pt/poly-go/test"
 )
 

diff --git a/backend/ethereum/wallet/backend.go b/backend/ethereum/wallet/backend.go
@@ -20,8 +20,8 @@ import (
 	"github.com/ethereum/go-ethereum/crypto"
 	"github.com/pkg/errors"
 
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 // Backend implements the utility interface defined in the wallet package.

diff --git a/backend/ethereum/wallet/hd/wallet_test.go b/backend/ethereum/wallet/hd/wallet_test.go
@@ -28,8 +28,8 @@ import (
 	ethwallet "perun.network/go-perun/backend/ethereum/wallet"
 	"perun.network/go-perun/backend/ethereum/wallet/hd"
 	ethwallettest "perun.network/go-perun/backend/ethereum/wallet/test"
-	"perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet/test"
+	"perun.network/go-perun/wire/perunio"
 	pkgtest "polycry.pt/poly-go/test"
 )
 
@@ -123,7 +123,7 @@ func newSetup(t require.TestingT, prng *rand.Rand) (*test.Setup, accounts.Wallet
 
 	addressNotInWallet := ethwallettest.NewRandomAddress(prng)
 	var buff bytes.Buffer
-	err = io.Encode(&buff, &addressNotInWallet)
+	err = perunio.Encode(&buff, &addressNotInWallet)
 	if err != nil {
 		panic(err)
 	}

diff --git a/backend/ethereum/wallet/keystore/wallet_test.go b/backend/ethereum/wallet/keystore/wallet_test.go
@@ -26,8 +26,8 @@ import (
 
 	ethwallet "perun.network/go-perun/backend/ethereum/wallet"
 	ethwallettest "perun.network/go-perun/backend/ethereum/wallet/test"
-	"perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet/test"
+	"perun.network/go-perun/wire/perunio"
 	pkgtest "polycry.pt/poly-go/test"
 )
 
@@ -75,12 +75,12 @@ func TestBackend(t *testing.T) {
 
 	buff := bytes.NewReader(s.AddressEncoded)
 	addr := backend.NewAddress()
-	err := io.Decode(buff, addr)
+	err := perunio.Decode(buff, addr)
 	assert.NoError(t, err, "NewAddress from Bytes should work")
 
 	buff = bytes.NewReader([]byte(invalidAddr))
 	addr = backend.NewAddress()
-	err = io.Decode(buff, addr)
+	err = perunio.Decode(buff, addr)
 	assert.Error(t, err, "Conversion from wrong address should fail")
 }
 
@@ -89,7 +89,7 @@ func newSetup(t require.TestingT, prng *rand.Rand) *test.Setup {
 
 	addressNotInWallet := ethwallettest.NewRandomAddress(prng)
 	var buff bytes.Buffer
-	err := io.Encode(&buff, &addressNotInWallet)
+	err := perunio.Encode(&buff, &addressNotInWallet)
 	if err != nil {
 		panic(err)
 	}

diff --git a/backend/ethereum/wallet/simple/wallet_test.go b/backend/ethereum/wallet/simple/wallet_test.go
@@ -29,8 +29,8 @@ import (
 	ethwallet "perun.network/go-perun/backend/ethereum/wallet"
 	"perun.network/go-perun/backend/ethereum/wallet/simple"
 	ethwallettest "perun.network/go-perun/backend/ethereum/wallet/test"
-	"perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet/test"
+	"perun.network/go-perun/wire/perunio"
 	pkgtest "polycry.pt/poly-go/test"
 )
 
@@ -104,7 +104,7 @@ func newSetup(t require.TestingT, prng *rand.Rand) (*test.Setup, *simple.Wallet)
 
 	addressNotInWallet := ethwallettest.NewRandomAddress(prng)
 	var buff bytes.Buffer
-	err = io.Encode(&buff, &addressNotInWallet)
+	err = perunio.Encode(&buff, &addressNotInWallet)
 	if err != nil {
 		panic(err)
 	}

diff --git a/backend/sim/channel/asset.go b/backend/sim/channel/asset.go
@@ -20,7 +20,7 @@ import (
 	"math/rand"
 
 	"perun.network/go-perun/channel"
-	perunio "perun.network/go-perun/pkg/io"
+	"perun.network/go-perun/wire/perunio"
 )
 
 // AssetBinaryLen is the length of binary representation of asset, in bytes.

diff --git a/backend/sim/channel/asset_test.go b/backend/sim/channel/asset_test.go
@@ -17,7 +17,7 @@ import (
 	"testing"
 
 	"perun.network/go-perun/backend/sim/channel"
-	"perun.network/go-perun/pkg/io/test"
+	"perun.network/go-perun/wire/perunio/test"
 	pkgtest "polycry.pt/poly-go/test"
 )
 

diff --git a/backend/sim/channel/backend.go b/backend/sim/channel/backend.go
@@ -22,8 +22,8 @@ import (
 
 	"perun.network/go-perun/channel"
 	"perun.network/go-perun/log"
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 // backend implements the utility interface defined in the channel package.

diff --git a/backend/sim/wallet/address_internal_test.go b/backend/sim/wallet/address_internal_test.go
@@ -21,7 +21,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	pkgtest "polycry.pt/poly-go/test"
 
-	"perun.network/go-perun/pkg/io/test"
+	"perun.network/go-perun/wire/perunio/test"
 )
 
 func TestGenericMarshaler(t *testing.T) {

diff --git a/backend/sim/wallet/backend.go b/backend/sim/wallet/backend.go
@@ -23,8 +23,8 @@ import (
 	"github.com/pkg/errors"
 
 	"perun.network/go-perun/log"
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 var curve = elliptic.P256()

diff --git a/backend/sim/wallet/wallet_internal_test.go b/backend/sim/wallet/wallet_internal_test.go
@@ -22,8 +22,8 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet/test"
+	"perun.network/go-perun/wire/perunio"
 	pkgtest "polycry.pt/poly-go/test"
 )
 
@@ -102,7 +102,7 @@ func newWalletSetup(rng *rand.Rand) *test.Setup {
 
 	addressNotInWallet := NewRandomAccount(rng).Address()
 	var buff bytes.Buffer
-	err = io.Encode(&buff, addressNotInWallet)
+	err = perunio.Encode(&buff, addressNotInWallet)
 	if err != nil {
 		panic(err)
 	}

diff --git a/channel/actionmachine.go b/channel/actionmachine.go
@@ -20,8 +20,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 // An ActionMachine is the channel pushdown automaton around an ActionApp.

diff --git a/channel/allocation.go b/channel/allocation.go
@@ -20,7 +20,7 @@ import (
 	"log"
 	"math/big"
 
-	perunio "perun.network/go-perun/pkg/io"
+	"perun.network/go-perun/wire/perunio"
 	perunbig "polycry.pt/poly-go/math/big"
 
 	"github.com/ethereum/go-ethereum/accounts/abi"

diff --git a/channel/allocation_test.go b/channel/allocation_test.go
@@ -24,8 +24,8 @@ import (
 
 	"perun.network/go-perun/channel"
 	"perun.network/go-perun/channel/test"
-	perunio "perun.network/go-perun/pkg/io"
-	iotest "perun.network/go-perun/pkg/io/test"
+	"perun.network/go-perun/wire/perunio"
+	iotest "perun.network/go-perun/wire/perunio/test"
 	pkgbig "polycry.pt/poly-go/math/big"
 	pkgtest "polycry.pt/poly-go/test"
 )

diff --git a/channel/app.go b/channel/app.go
@@ -20,8 +20,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 type (

diff --git a/channel/machine.go b/channel/machine.go
@@ -21,8 +21,8 @@ import (
 	"github.com/pkg/errors"
 
 	"perun.network/go-perun/log"
-	"perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 	"polycry.pt/poly-go/math/big"
 )
 
@@ -31,13 +31,13 @@ type Index uint16
 
 // Encode encodes the object onto an io.Writer.
 func (i Index) Encode(w stdio.Writer) error {
-	return io.Encode(w, uint16(i))
+	return perunio.Encode(w, uint16(i))
 }
 
 // Decode decodes an object from an io.Reader.
 func (i *Index) Decode(r stdio.Reader) error {
 	var _i uint16
-	err := io.Decode(r, &_i)
+	err := perunio.Decode(r, &_i)
 	*i = Index(_i)
 	return err
 }
@@ -65,8 +65,8 @@ type (
 )
 
 var (
-	_ Source        = (*machine)(nil)
-	_ io.Serializer = (*Phase)(nil)
+	_ Source             = (*machine)(nil)
+	_ perunio.Serializer = (*Phase)(nil)
 )
 
 // Phases known to the channel machine.
@@ -106,12 +106,12 @@ func (p Phase) String() string {
 
 // Encode serializes a Phase.
 func (p Phase) Encode(w stdio.Writer) error {
-	return io.Encode(w, uint8(p))
+	return perunio.Encode(w, uint8(p))
 }
 
 // Decode deserializes a Phase.
 func (p *Phase) Decode(r stdio.Reader) error {
-	return io.Decode(r, (*uint8)(p))
+	return perunio.Decode(r, (*uint8)(p))
 }
 
 func (t PhaseTransition) String() string {

diff --git a/channel/mock_app_internal_test.go b/channel/mock_app_internal_test.go
@@ -19,8 +19,8 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	iotest "perun.network/go-perun/pkg/io/test"
 	wallettest "perun.network/go-perun/wallet/test"
+	iotest "perun.network/go-perun/wire/perunio/test"
 	pkgtest "polycry.pt/poly-go/test"
 )
 

diff --git a/channel/params.go b/channel/params.go
@@ -22,8 +22,8 @@ import (
 	"github.com/pkg/errors"
 
 	"perun.network/go-perun/log"
-	"perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
+	"perun.network/go-perun/wire/perunio"
 )
 
 // IDLen the length of a channelID.
@@ -52,7 +52,7 @@ func NonceFromBytes(b []byte) Nonce {
 // Zero is the default channelID.
 var Zero = ID{}
 
-var _ io.Serializer = (*Params)(nil)
+var _ perunio.Serializer = (*Params)(nil)
 
 // Params are a channel's immutable parameters. A channel's id is the hash of
 // (some of) its parameter, as determined by the backend. All fields should be
@@ -150,12 +150,12 @@ func (p *Params) Clone() *Params {
 	clonedParts := make([]wallet.Address, len(p.Parts))
 	for i, v := range p.Parts {
 		var buff bytes.Buffer
-		if err := io.Encode(&buff, v); err != nil {
+		if err := perunio.Encode(&buff, v); err != nil {
 			log.WithError(err).Panic("Could not encode part")
 		}
 
 		addr := wallet.NewAddress()
-		if err := io.Decode(&buff, addr); err != nil {
+		if err := perunio.Decode(&buff, addr); err != nil {
 			log.WithError(err).Panic("Could not clone params' addresses")
 		}
 		clonedParts[i] = addr
@@ -174,7 +174,7 @@ func (p *Params) Clone() *Params {
 
 // Encode uses the pkg/io module to serialize a params instance.
 func (p *Params) Encode(w stdio.Writer) error {
-	return io.Encode(w,
+	return perunio.Encode(w,
 		p.ChallengeDuration,
 		wallet.AddressesWithLen(p.Parts),
 		OptAppEnc{p.App},
@@ -195,7 +195,7 @@ func (p *Params) Decode(r stdio.Reader) error {
 		virtual           bool
 	)
 
-	err := io.Decode(r,
+	err := perunio.Decode(r,
 		&challengeDuration,
 		&parts,
 		OptAppDec{App: &app},

diff --git a/channel/params_test.go b/channel/params_test.go
@@ -19,8 +19,8 @@ import (
 
 	"perun.network/go-perun/channel"
 	"perun.network/go-perun/channel/test"
-	"perun.network/go-perun/pkg/io"
-	iotest "perun.network/go-perun/pkg/io/test"
+	"perun.network/go-perun/wire/perunio"
+	iotest "perun.network/go-perun/wire/perunio/test"
 	pkgtest "polycry.pt/poly-go/test"
 )
 
@@ -32,7 +32,7 @@ func TestParams_Clone(t *testing.T) {
 
 func TestParams_Serializer(t *testing.T) {
 	rng := pkgtest.Prng(t)
-	params := make([]io.Serializer, 10)
+	params := make([]perunio.Serializer, 10)
 	for i := range params {
 		var p *channel.Params
 		if i&1 == 0 {

diff --git a/channel/persistence/keyvalue/persistedstate.go b/channel/persistence/keyvalue/persistedstate.go
@@ -18,7 +18,7 @@ import (
 	"io"
 
 	"perun.network/go-perun/channel"
-	perunio "perun.network/go-perun/pkg/io"
+	"perun.network/go-perun/wire/perunio"
 )
 
 var (

diff --git a/channel/persistence/keyvalue/persister.go b/channel/persistence/keyvalue/persister.go
@@ -26,8 +26,8 @@ import (
 	"github.com/pkg/errors"
 
 	"perun.network/go-perun/channel"
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wire"
+	"perun.network/go-perun/wire/perunio"
 	"polycry.pt/poly-go/sortedkv"
 )
 

diff --git a/channel/persistence/keyvalue/restorer.go b/channel/persistence/keyvalue/restorer.go
@@ -24,9 +24,9 @@ import (
 
 	"perun.network/go-perun/channel"
 	"perun.network/go-perun/channel/persistence"
-	perunio "perun.network/go-perun/pkg/io"
 	"perun.network/go-perun/wallet"
 	"perun.network/go-perun/wire"
+	"perun.network/go-perun/wire/perunio"
 	"polycry.pt/poly-go/sortedkv"
 )
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,7 +18,7 @@ import ( @@
     	"io"
     	"perun.network/go-perun/channel"
-    	perunio "perun.network/go-perun/pkg/io"
+    	"perun.network/go-perun/wire/perunio"
     )
     var (
@@ Expand Down @@