Add ethersjs testcases (#193)

* Add ethersjs testcases

* Update changelog

Author: ferranbt

.github/workflows/pr.yaml

@@ -14,7 +14,7 @@ jobs:
       - name: Setup go
         uses: actions/setup-go@v1
         with:
-          go-version: '1.15.10'
+          go-version: '1.18.1'
       - name: "Setup"
         run: ./scripts/setup-ci.sh
       - name: Go test

CHANGELOG.md

@@ -1,6 +1,7 @@
 
 # 0.1.2 (Unreleased)
 
+- Add `testcases` for contract signature and transaction signing [[GH-193](https://github.com/umbracle/ethgo/issues/193)]
 - Add `eth_feeHistory` rpc endpoint [[GH-192](https://github.com/umbracle/ethgo/issues/192)]
 - Update `testserver` to `go-ethereum:v1.10.15` [[GH-191](https://github.com/umbracle/ethgo/issues/191)]
 - Do not decode `to` in `Transaction` if not exists [[GH-190](https://github.com/umbracle/ethgo/issues/190)]

abi/type.go

@@ -165,7 +165,9 @@ func (t *Type) Format(includeArgs bool) string {
 				name += " indexed"
 			}
 			if includeArgs {
-				name += " " + i.Name
+				if i.Name != "" {
+					name += " " + i.Name
+				}
 			}
 			rawAux = append(rawAux, name)
 		}
@@ -328,11 +330,17 @@ func readType(l *lexer) (*Type, error) {
 	var tt *Type
 
 	tok := l.nextToken()
+
+	isTuple := false
 	if tok.typ == tupleToken {
 		if l.nextToken().typ != lparenToken {
 			return nil, expectedToken(lparenToken)
 		}
-
+		isTuple = true
+	} else if tok.typ == lparenToken {
+		isTuple = true
+	}
+	if isTuple {
 		var next token
 		elems := []*TupleElem{}
 		for {

abi/type_test.go

@@ -264,6 +264,45 @@ func TestType(t *testing.T) {
 				tuple: []*TupleElem{},
 			},
 		},
+		{
+			// hidden tuple token
+			s: "tuple((int32))",
+			a: &ArgumentStr{
+				Type: "tuple",
+				Components: []*ArgumentStr{
+					{
+						Type: "tuple",
+						Components: []*ArgumentStr{
+							{
+								Type: "int32",
+							},
+						},
+					},
+				},
+			},
+			t: &Type{
+				kind: KindTuple,
+				t:    tupleT,
+				tuple: []*TupleElem{
+					{
+						Elem: &Type{
+							kind: KindTuple,
+							t:    tupleT,
+							tuple: []*TupleElem{
+								{
+									Elem: &Type{
+										kind: KindInt,
+										size: 32,
+										t:    int32T,
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+			r: "tuple(tuple(int32))",
+		},
 		{
 			s:   "int[[",
 			err: true,

encoding.go

@@ -0,0 +1,90 @@
+package ethgo
+
+import (
+	"encoding/hex"
+	"math/big"
+	"strconv"
+	"strings"
+)
+
+type ArgBig big.Int
+
+func (a *ArgBig) UnmarshalText(input []byte) error {
+	buf, err := decodeToHex(input)
+	if err != nil {
+		return err
+	}
+	b := new(big.Int)
+	b.SetBytes(buf)
+	*a = ArgBig(*b)
+	return nil
+}
+
+func (a ArgBig) MarshalText() ([]byte, error) {
+	b := (*big.Int)(&a)
+	return []byte("0x" + b.Text(16)), nil
+}
+
+type ArgUint64 uint64
+
+func (b ArgUint64) MarshalText() ([]byte, error) {
+	buf := make([]byte, 2, 10)
+	copy(buf, `0x`)
+	buf = strconv.AppendUint(buf, uint64(b), 16)
+	return buf, nil
+}
+
+func (u *ArgUint64) UnmarshalText(input []byte) error {
+	str := strings.TrimPrefix(string(input), "0x")
+	if str == "" {
+		str = "0"
+	}
+	num, err := strconv.ParseUint(str, 16, 64)
+	if err != nil {
+		return err
+	}
+	*u = ArgUint64(num)
+	return nil
+}
+
+func (u *ArgUint64) Uint64() uint64 {
+	return uint64(*u)
+}
+
+type ArgBytes []byte
+
+func (b ArgBytes) MarshalText() ([]byte, error) {
+	return encodeToHex(b), nil
+}
+
+func (b *ArgBytes) UnmarshalText(input []byte) error {
+	hh, err := decodeToHex(input)
+	if err != nil {
+		return nil
+	}
+	aux := make([]byte, len(hh))
+	copy(aux[:], hh[:])
+	*b = aux
+	return nil
+}
+
+func (b *ArgBytes) Bytes() []byte {
+	return *b
+}
+
+func decodeToHex(b []byte) ([]byte, error) {
+	str := string(b)
+	str = strings.TrimPrefix(str, "0x")
+	if len(str)%2 != 0 {
+		str = "0" + str
+	}
+	return hex.DecodeString(str)
+}
+
+func encodeToHex(b []byte) []byte {
+	str := hex.EncodeToString(b)
+	if len(str)%2 != 0 {
+		str = "0" + str
+	}
+	return []byte("0x" + str)
+}

go.mod

@@ -1,41 +1,53 @@
 module github.com/umbracle/ethgo
 
-go 1.12
+go 1.18
 
 require (
-	github.com/Azure/go-ansiterm v0.0.0-20170929234023-d6e3b3328b78 // indirect
-	github.com/Microsoft/go-winio v0.4.13 // indirect
-	github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect
 	github.com/boltdb/bolt v1.3.1
 	github.com/btcsuite/btcd v0.21.0-beta
 	github.com/btcsuite/btcutil v1.0.2
+	github.com/gorilla/websocket v1.4.1
+	github.com/jmoiron/sqlx v1.2.0
+	github.com/lib/pq v1.2.0
+	github.com/mitchellh/mapstructure v1.1.2
+	github.com/ory/dockertest v3.3.5+incompatible
+	github.com/stretchr/testify v1.4.0
+	github.com/tyler-smith/go-bip39 v1.1.0
+	github.com/umbracle/fastrlp v0.0.0-20211229195328-c1416904ae17
+	github.com/valyala/fasthttp v1.4.0
+	github.com/valyala/fastjson v1.4.1
+	golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
+	golang.org/x/text v0.3.2
+)
+
+require (
+	github.com/Azure/go-ansiterm v0.0.0-20170929234023-d6e3b3328b78 // indirect
+	github.com/Microsoft/go-winio v0.4.13 // indirect
+	github.com/Nvveen/Gotty v0.0.0-20120604004816-cd527374f1e5 // indirect
 	github.com/cenkalti/backoff v2.2.1+incompatible // indirect
 	github.com/containerd/continuity v0.0.0-20191214063359-1097c8bae83b // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/docker/go-connections v0.4.0 // indirect
 	github.com/docker/go-units v0.4.0 // indirect
 	github.com/go-sql-driver/mysql v1.4.1 // indirect
 	github.com/google/go-cmp v0.3.1 // indirect
-	github.com/gorilla/websocket v1.4.1
+	github.com/google/gofuzz v1.2.0 // indirect
 	github.com/gotestyourself/gotestyourself v2.2.0+incompatible // indirect
-	github.com/jmoiron/sqlx v1.2.0
 	github.com/klauspost/compress v1.4.1 // indirect
 	github.com/klauspost/cpuid v1.2.0 // indirect
+	github.com/konsorten/go-windows-terminal-sequences v1.0.1 // indirect
 	github.com/kr/pretty v0.1.0 // indirect
-	github.com/lib/pq v1.2.0
-	github.com/mitchellh/mapstructure v1.1.2
+	github.com/opencontainers/go-digest v1.0.0-rc1 // indirect
 	github.com/opencontainers/image-spec v1.0.1 // indirect
 	github.com/opencontainers/runc v0.1.1 // indirect
-	github.com/ory/dockertest v3.3.5+incompatible
+	github.com/pkg/errors v0.8.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/sirupsen/logrus v1.4.2 // indirect
-	github.com/stretchr/testify v1.4.0
-	github.com/tyler-smith/go-bip39 v1.1.0
-	github.com/umbracle/fastrlp v0.0.0-20211229195328-c1416904ae17
-	github.com/valyala/fasthttp v1.4.0
-	github.com/valyala/fastjson v1.4.1
-	golang.org/x/crypto v0.0.0-20201221181555-eec23a3978ad
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	golang.org/x/net v0.0.0-20190813141303-74dc4d7220e7 // indirect
-	golang.org/x/text v0.3.2
+	golang.org/x/sys v0.0.0-20191026070338-33540a1f6037 // indirect
 	google.golang.org/appengine v1.6.5 // indirect
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
+	gopkg.in/yaml.v2 v2.2.2 // indirect
 	gotest.tools v2.2.0+incompatible // indirect
 )

testcases/accounts_test.go

@@ -0,0 +1,38 @@
+package testcases
+
+import (
+	"encoding/hex"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/umbracle/ethgo"
+	"github.com/umbracle/ethgo/wallet"
+)
+
+func TestAccounts(t *testing.T) {
+	var walletSpec []struct {
+		Address    string  `json:"address"`
+		Checksum   string  `json:"checksumAddress"`
+		Name       string  `json:"name"`
+		PrivateKey *string `json:"privateKey,omitempty"`
+	}
+	ReadTestCase(t, "accounts", &walletSpec)
+
+	for _, spec := range walletSpec {
+		if spec.PrivateKey != nil {
+			// test that we can decode the private key
+			priv, err := hex.DecodeString(strings.TrimPrefix(*spec.PrivateKey, "0x"))
+			assert.NoError(t, err)
+
+			key, err := wallet.NewWalletFromPrivKey(priv)
+			assert.NoError(t, err)
+
+			assert.Equal(t, key.Address().String(), spec.Checksum)
+		}
+
+		// test that an string address can be checksumed
+		addr := ethgo.HexToAddress(spec.Address)
+		assert.Equal(t, addr.String(), spec.Checksum)
+	}
+}

testcases/contract_test.go

@@ -0,0 +1,74 @@
+package testcases
+
+import (
+	"encoding/hex"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/umbracle/ethgo"
+	"github.com/umbracle/ethgo/abi"
+	"github.com/umbracle/ethgo/testutil"
+)
+
+func TestContract_Signatures(t *testing.T) {
+	var signatures []struct {
+		Name      string `json:"name"`
+		Signature string `json:"signature"`
+		SigHash   string `json:"sigHash"`
+		Abi       string `json:"abi"`
+	}
+	ReadTestCase(t, "contract-signatures", &signatures)
+
+	for _, c := range signatures {
+		t.Run(c.Name, func(t *testing.T) {
+			m, err := abi.NewMethod(c.Signature)
+			assert.NoError(t, err)
+
+			sigHash := "0x" + hex.EncodeToString(m.ID())
+			assert.Equal(t, sigHash, c.SigHash)
+		})
+	}
+}
+
+func TestContract_Interface(t *testing.T) {
+	t.Skip()
+
+	server := testutil.NewTestServer(t, nil)
+	defer server.Close()
+
+	var calls []struct {
+		Name      string         `json:"name"`
+		Interface string         `json:"interface"`
+		Bytecode  ethgo.ArgBytes `json:"bytecode"`
+		Result    ethgo.ArgBytes `json:"result"`
+		Values    string         `json:"values"`
+	}
+	ReadTestCase(t, "contract-interface", &calls)
+
+	for _, c := range calls {
+		t.Run(c.Name, func(t *testing.T) {
+			a, err := abi.NewABI(c.Interface)
+			assert.NoError(t, err)
+
+			method := a.GetMethod("test")
+
+			receipt, err := server.SendTxn(&ethgo.Transaction{
+				Input: c.Bytecode.Bytes(),
+			})
+			assert.NoError(t, err)
+
+			outputRaw, err := server.Call(&ethgo.CallMsg{
+				To:   &receipt.ContractAddress,
+				Data: method.ID(),
+			})
+			assert.NoError(t, err)
+
+			output, err := hex.DecodeString(outputRaw[2:])
+			assert.NoError(t, err)
+
+			_, err = method.Decode(output)
+			assert.NoError(t, err)
+		})
+	}
+
+}