lib: Drop old metadata examples, fix linter

centrifuge · Sep 10, 2024 · 9dfb473 · 9dfb473
1 parent 2e0b9c6
commit 9dfb473
Show file tree

Hide file tree

Showing 22 changed files with 11 additions and 615 deletions.
diff --git a/registry/decoder.go b/registry/decoder.go
@@ -3,11 +3,11 @@ package registry
 import (
 	"bytes"
 	"fmt"
-	"github.com/centrifuge/go-substrate-rpc-client/v4/types/extrinsic"
-	"github.com/ethereum/go-ethereum/common/hexutil"
 
 	"github.com/centrifuge/go-substrate-rpc-client/v4/scale"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/types"
+	"github.com/centrifuge/go-substrate-rpc-client/v4/types/extrinsic"
+	"github.com/ethereum/go-ethereum/common/hexutil"
 )
 
 // FieldDecoder is the interface implemented by all the different types that are available.

diff --git a/registry/factory.go b/registry/factory.go
@@ -690,7 +690,8 @@ func (f *factory) getStoredFieldDecoder(fieldLookupIndex int64) (FieldDecoder, b
 }
 
 const (
-	// ExpectedExtrinsicParamsCount is the count of generic params that we expect for a generic Extrinsic type from the metadata.
+	// ExpectedExtrinsicParamsCount is the count of generic params that we expect for a
+	// generic Extrinsic type from the metadata.
 	//
 	// The parameters are expected to be in the following order:
 	// 1. Address

diff --git a/registry/retriever/extrinsic_retriever.go b/registry/retriever/extrinsic_retriever.go
@@ -1,13 +1,14 @@
 package retriever
 
 import (
+	"time"
+
 	"github.com/centrifuge/go-substrate-rpc-client/v4/registry"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/registry/exec"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/rpc/chain"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/rpc/state"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/types"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/types/block"
-	"time"
 )
 
 //nolint:lll

diff --git a/types/block/block.go b/types/block/block.go
@@ -2,6 +2,7 @@ package block
 
 import (
 	"errors"
+
 	"github.com/centrifuge/go-substrate-rpc-client/v4/registry"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/types"
 )

diff --git a/types/call_test.go b/types/call_test.go
@@ -15,19 +15,6 @@ func TestCall(t *testing.T) {
 	assert.Equal(t, "0x0601000000", enc)
 }
 
-func TestNewCallV4(t *testing.T) {
-	addr, err := NewAddressFromHexAccountID("0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48")
-	assert.NoError(t, err)
-
-	c, err := NewCall(ExamplaryMetadataV4, "balances.transfer", addr, NewUCompactFromUInt(1000))
-	assert.NoError(t, err)
-
-	enc, err := codec.EncodeToHex(c)
-	assert.NoError(t, err)
-
-	assert.Equal(t, "0x0300ff8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48a10f", enc)
-}
-
 func TestNewCallV7(t *testing.T) {
 	c, err := NewCall(&exampleMetadataV7, "Module2.my function", U8(3))
 	assert.NoError(t, err)

diff --git a/types/event_record_test.go b/types/event_record_test.go
@@ -17,7 +17,6 @@
 package types_test
 
 import (
-	"fmt"
 	"testing"
 
 	. "github.com/centrifuge/go-substrate-rpc-client/v4/types"
@@ -89,91 +88,6 @@ func TestEventSystemExtrinsicSuccess_Decode(t *testing.T) {
 	assert.Equal(t, exampleEventApp, decoded)
 }
 
-func TestEventRecordsRaw_Decode_FailsNumFields(t *testing.T) {
-	e := EventRecordsRaw(MustHexDecodeString("0x0400020000000302d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48266d00000000000000000000000000000010a5d4e8000000000000000000000000")) //nolint:lll
-
-	events := struct {
-		Balances_Transfer []struct{ Abc uint8 } //nolint:stylecheck,golint
-	}{}
-	err := e.DecodeEventRecords(ExamplaryMetadataV8, &events)
-	assert.EqualError(t, err, "expected event #0 with EventID [3 2], field Balances_Transfer to have at least 2 fields (for Phase and Topics), but has 1 fields") //nolint:lll
-}
-
-func TestEventRecordsRaw_Decode_FailsFirstNotPhase(t *testing.T) {
-	e := EventRecordsRaw(MustHexDecodeString("0x0400020000000302d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48266d00000000000000000000000000000010a5d4e8000000000000000000000000")) //nolint:lll
-
-	events := struct {
-		Balances_Transfer []struct { //nolint:stylecheck,golint
-			P     uint8
-			Other uint32
-			T     []Hash
-		}
-	}{}
-	err := e.DecodeEventRecords(ExamplaryMetadataV8, &events)
-	assert.EqualError(t, err, "expected the first field of event #0 with EventID [3 2], field Balances_Transfer to be of type types.Phase, but got uint8") //nolint:lll
-}
-
-func TestEventRecordsRaw_Decode_FailsLastNotHash(t *testing.T) {
-	e := EventRecordsRaw(MustHexDecodeString("0x0400020000000302d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48266d00000000000000000000000000000010a5d4e8000000000000000000000000")) //nolint:lll
-
-	events := struct {
-		Balances_Transfer []struct { //nolint:stylecheck,golint
-			P     Phase
-			Other uint32
-			T     Phase
-		}
-	}{}
-	err := e.DecodeEventRecords(ExamplaryMetadataV8, &events)
-	assert.EqualError(t, err, "expected the last field of event #0 with EventID [3 2], field Balances_Transfer to be of type []types.Hash for Topics, but got types.Phase") //nolint:lll
-}
-
-func ExampleEventRecordsRaw_Decode() {
-	e := EventRecordsRaw(MustHexDecodeString(
-		"0x10" +
-			"0000000000" +
-			"0000" +
-			"2ce909" + // Weight
-			"01" + // Operational
-			"01" + // PaysFee
-			"00" +
-			"0001000000" +
-			"0000" +
-			"2ce909" + // Weight
-			"01" + // operational
-			"01" + // PaysFee
-			"00" +
-			"0001000000" + // ApplyExtrinsic(1)
-			"0302" + // Balances_Transfer
-			"d43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d" + // From
-			"8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48" + // To
-			"391b0000000000000000000000000000" + // Value
-			"00" + // Topics
-
-			"0002000000" +
-			"0000" +
-			"2ce909" + // Weight
-			"00" + // Normal
-			"01" + // PaysFee
-			"00",
-	))
-
-	events := EventRecords{}
-	err := e.DecodeEventRecords(ExamplaryMetadataV8, &events)
-	if err != nil {
-		panic(err)
-	}
-
-	fmt.Printf("Got %v System_ExtrinsicSuccess events\n", len(events.System_ExtrinsicSuccess))
-	fmt.Printf("Got %v Balances_Transfer events\n", len(events.Balances_Transfer))
-	t := events.Balances_Transfer[0]
-	fmt.Printf("Transfer: %v tokens from %#x to\n%#x", t.Value, t.From, t.To)
-
-	// Output: Got 3 System_ExtrinsicSuccess events
-	// Got 1 Balances_Transfer events
-	// Transfer: 6969 tokens from 0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d to
-	// 0x8eaf04151687736326c9fea17e25fc5287613693c912909cb226aa4794f26a48
-}
-
 func TestDispatchError(t *testing.T) {
 	AssertRoundTripFuzz[DispatchError](t, 1000, dispatchErrorFuzzOpts...)
 	AssertDecodeNilData[DispatchError](t)

diff --git a/types/extrinsic/extrinsic.go b/types/extrinsic/extrinsic.go
@@ -4,12 +4,13 @@ import (
 	"bytes"
 	"encoding/json"
 	"fmt"
+	"math/big"
+
 	libErr "github.com/centrifuge/go-substrate-rpc-client/v4/error"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/scale"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/signature"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/types"
 	"github.com/centrifuge/go-substrate-rpc-client/v4/types/codec"
-	"math/big"
 )
 
 const (
@@ -78,6 +79,7 @@ func (e Extrinsic) Type() uint8 {
 // Sign adds a signature to the extrinsic.
 func (e *Extrinsic) Sign(signer signature.KeyringPair, meta *types.Metadata, opts ...SigningOption) error {
 	if e.Type() != Version4 {
+		//nolint:lll
 		return ErrInvalidVersion.WithMsg("unsupported extrinsic version: %v (isSigned: %v, type: %v)", e.Version, e.IsSigned(), e.Type())
 	}
 

diff --git a/types/metadataV10_example.go b/types/metadataV10_example.go
diff --git a/types/metadataV11_example.go b/types/metadataV11_example.go
diff --git a/types/metadataV11_example_string.go b/types/metadataV11_example_string.go
diff --git a/types/metadataV11_test.go b/types/metadataV11_test.go
@@ -20,7 +20,6 @@ import (
 	"testing"
 
 	. "github.com/centrifuge/go-substrate-rpc-client/v4/types"
-	. "github.com/centrifuge/go-substrate-rpc-client/v4/types/codec"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -30,32 +29,6 @@ var exampleMetadataV11 = Metadata{
 	AsMetadataV11: MetadataV11{MetadataV10: exampleRuntimeMetadataV10},
 }
 
-func TestNewMetadataV11_Decode(t *testing.T) {
-	tests := []struct {
-		name, hexData string
-	}{
-		{
-			"SubstrateV11", ExamplaryMetadataV11SubstrateString,
-		},
-
-		{
-			"PolkadotV11", ExamplaryMetadataV11PolkadotString,
-		},
-	}
-
-	for _, s := range tests {
-		t.Run(s.name, func(t *testing.T) {
-			metadata := NewMetadataV11()
-			err := Decode(MustHexDecodeString(s.hexData), metadata)
-			assert.NoError(t, err)
-			data, err := Encode(metadata)
-			assert.NoError(t, err)
-			assert.Equal(t, s.hexData, HexEncodeToString(data))
-		})
-
-	}
-}
-
 func TestMetadataV11_ExistsModuleMetadata(t *testing.T) {
 	assert.True(t, exampleMetadataV11.ExistsModuleMetadata("EmptyModule"))
 	assert.False(t, exampleMetadataV11.ExistsModuleMetadata("NotExistModule"))

diff --git a/types/metadataV12_example.go b/types/metadataV12_example.go
diff --git a/types/metadataV12_test.go b/types/metadataV12_test.go
@@ -20,7 +20,6 @@ import (
 	"testing"
 
 	. "github.com/centrifuge/go-substrate-rpc-client/v4/types"
-	. "github.com/centrifuge/go-substrate-rpc-client/v4/types/codec"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -79,29 +78,6 @@ var exampleModuleMetadataV122 = ModuleMetadataV12{
 	Index: 2,
 }
 
-func TestNewMetadataV12_Decode(t *testing.T) {
-	tests := []struct {
-		name, hexData string
-	}{
-		{
-			"PolkadotV12", ExamplaryMetadataV12PolkadotString,
-		},
-	}
-
-	for _, s := range tests {
-		t.Run(s.name, func(t *testing.T) {
-			metadata := NewMetadataV12()
-			err := Decode(MustHexDecodeString(s.hexData), metadata)
-			assert.EqualValues(t, metadata.Version, 12)
-			assert.NoError(t, err)
-			data, err := Encode(metadata)
-			assert.NoError(t, err)
-			assert.Equal(t, s.hexData, HexEncodeToString(data))
-		})
-
-	}
-}
-
 func TestMetadataV12_ExistsModuleMetadata(t *testing.T) {
 	assert.True(t, exampleMetadataV12.ExistsModuleMetadata("EmptyModule"))
 	assert.False(t, exampleMetadataV12.ExistsModuleMetadata("NotExistModule"))

diff --git a/types/metadataV13_example.go b/types/metadataV13_example.go
diff --git a/types/metadataV13_example_string.go b/types/metadataV13_example_string.go
diff --git a/types/metadataV13_test.go b/types/metadataV13_test.go
@@ -20,7 +20,6 @@ import (
 	"testing"
 
 	. "github.com/centrifuge/go-substrate-rpc-client/v4/types"
-	. "github.com/centrifuge/go-substrate-rpc-client/v4/types/codec"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -157,13 +156,3 @@ func TestMetadataV13_TestFindCallIndexWithUnknownFunction(t *testing.T) {
 	_, err := exampleMetadataV13.FindCallIndex("Module2_13.unknownFunction")
 	assert.Error(t, err)
 }
-
-func TestNewMetadataV13_Decode(t *testing.T) {
-	metadata := NewMetadataV13()
-	err := Decode(MustHexDecodeString(ExamplaryMetadataV13SubstrateString), metadata)
-	assert.EqualValues(t, metadata.Version, 13)
-	assert.NoError(t, err)
-	data, err := Encode(metadata)
-	assert.NoError(t, err)
-	assert.Equal(t, ExamplaryMetadataV13SubstrateString, HexEncodeToString(data))
-}
diff --git a/types/metadataV14_example.go b/types/metadataV14_example.go
diff --git a/types/metadataV4_example.go b/types/metadataV4_example.go
diff --git a/types/metadataV4_test.go b/types/metadataV4_test.go
@@ -20,7 +20,6 @@ import (
 	"testing"
 
 	. "github.com/centrifuge/go-substrate-rpc-client/v4/types"
-	. "github.com/centrifuge/go-substrate-rpc-client/v4/types/codec"
 	. "github.com/centrifuge/go-substrate-rpc-client/v4/types/test_utils"
 	"github.com/stretchr/testify/assert"
 )
@@ -126,15 +125,6 @@ var exampleDoubleMapTypeV4 = DoubleMapTypeV4{
 
 var exampleFunctionArgumentMetadata = FunctionArgumentMetadata{Name: "myFunctionName", Type: "myType"}
 
-func TestMetadataV4_Decode(t *testing.T) {
-	metadata := NewMetadataV4()
-
-	err := Decode(MustHexDecodeString(ExamplaryMetadataV4String), metadata)
-	assert.NoError(t, err)
-
-	assert.Equal(t, *ExamplaryMetadataV4, *metadata)
-}
-
 func TestMetadataV4_EncodeDecode(t *testing.T) {
 	AssertRoundtrip(t, exampleMetadataV4)
 }

diff --git a/types/metadataV8_example.go b/types/metadataV8_example.go
diff --git a/types/metadataV9_example.go b/types/metadataV9_example.go