Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Solsig indexed #75

Merged
merged 3 commits into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions pkg/abi/abi.go
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,13 @@ func (e *Entry) SolidityDef() (string, []string, error) {
// SolidityDefCtx returns a Solidity-like descriptor of the entry, including its type
func (e *Entry) SolidityDefCtx(ctx context.Context) (string, []string, error) {
// Everything apart from event and error is a type of function
isFunction := e.Type != Error && e.Type != Event
var fieldType SolFieldType
switch e.Type {
case Error, Event:
fieldType = EventOrErrorField
default:
fieldType = FunctionInput
}

allChildStructs := []string{}
buff := new(strings.Builder)
Expand All @@ -713,7 +719,7 @@ func (e *Entry) SolidityDefCtx(ctx context.Context) (string, []string, error) {
if i > 0 {
buff.WriteString(", ")
}
s, childStructs, err := p.SolidityDefCtx(ctx, isFunction)
s, childStructs, err := p.SolidityDefCtx(ctx, fieldType)
if err != nil {
return "", nil, err
}
Expand All @@ -722,7 +728,7 @@ func (e *Entry) SolidityDefCtx(ctx context.Context) (string, []string, error) {
}
buff.WriteRune(')')

if isFunction {
if fieldType == FunctionInput {
buff.WriteString(" external")
if e.StateMutability != "" &&
// The state mutability nonpayable is reflected in Solidity by not specifying a state mutability modifier at all.
Expand All @@ -736,7 +742,7 @@ func (e *Entry) SolidityDefCtx(ctx context.Context) (string, []string, error) {
if i > 0 {
buff.WriteString(", ")
}
s, childStructs, err := p.SolidityDefCtx(ctx, isFunction)
s, childStructs, err := p.SolidityDefCtx(ctx, fieldType)
if err != nil {
return "", nil, err
}
Expand Down Expand Up @@ -782,13 +788,13 @@ func (p *Parameter) SignatureStringCtx(ctx context.Context) (string, error) {
return tc.String(), nil
}

func (p *Parameter) SolidityDefCtx(ctx context.Context, inFunction bool) (string, []string, error) {
func (p *Parameter) SolidityDefCtx(ctx context.Context, fieldType SolFieldType) (string, []string, error) {
// Ensure the type component tree has been parsed
tc, err := p.TypeComponentTreeCtx(ctx)
if err != nil {
return "", nil, err
}
solDef, childStructs := tc.SolidityParamDef(inFunction)
solDef, childStructs := tc.SolidityParamDef(fieldType)
return solDef, childStructs, nil
}

Expand Down
7 changes: 6 additions & 1 deletion pkg/abi/abi_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,11 @@ const sampleABI5 = `[
"internalType": "struct AribtraryWidgets.Widget[]",
"name": "widgets",
"type": "tuple[]"
},
{
"name": "account",
"type": "address",
"indexed": true
}
],
"name": "Invoiced",
Expand Down Expand Up @@ -1015,7 +1020,7 @@ func TestComplexStructSolidityDef(t *testing.T) {

solDef, childStructs, err = abi.Events()["Invoiced"].SolidityDef()
assert.NoError(t, err)
assert.Equal(t, "event Invoiced(Customer customer, Widget[] widgets)", solDef)
assert.Equal(t, "event Invoiced(Customer customer, Widget[] widgets, address indexed account)", solDef)
assert.Equal(t, []string{
"struct Customer { address owner; bytes32 locator; }",
"struct Widget { string description; uint256 price; string[] attributes; }",
Expand Down
25 changes: 19 additions & 6 deletions pkg/abi/typecomponents.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ type TypeComponent interface {
DecodeABIData(d []byte, offset int) (*ComponentValue, error)
DecodeABIDataCtx(ctx context.Context, d []byte, offest int) (*ComponentValue, error)

SolidityParamDef(inFunction bool) (solDef string, structDefs []string) // gives a string that can be used to define this param in solidity
SolidityParamDef(fieldType SolFieldType) (solDef string, structDefs []string) // gives a string that can be used to define this param in solidity
SolidityTypeDef() (isRef bool, typeDef string, childStructs []string)
SolidityStructDef() (structName string, structs []string)
}
Expand Down Expand Up @@ -187,6 +187,14 @@ const (
BaseTypeString BaseTypeName = "string"
)

type SolFieldType int

const (
FunctionInput SolFieldType = iota // input to a function, or a constructor
EventOrErrorField // a field of an event or an error
StructField // a field of a struct
)

// tupleTypeString appears in the same place in the ABI as elementary type strings, but it is not an elementary type.
// We treat it separately.
const tupleTypeString = "tuple"
Expand Down Expand Up @@ -371,13 +379,18 @@ func (tc *typeComponent) String() string {
}
}

func (tc *typeComponent) SolidityParamDef(inFunction bool) (string, []string) {
func (tc *typeComponent) SolidityParamDef(fieldType SolFieldType) (string, []string) {
isRef, paramDef, childStructs := tc.SolidityTypeDef()
if isRef && inFunction {
paramDef = fmt.Sprintf("%s memory", paramDef)
if isRef && fieldType == FunctionInput {
paramDef += " memory"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why the change from sprintF to +=?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just felt more readable

}
if tc.parameter != nil && tc.parameter.Name != "" {
paramDef = fmt.Sprintf("%s %s", paramDef, tc.parameter.Name)
if tc.parameter != nil {
if fieldType == EventOrErrorField && tc.parameter.Indexed {
paramDef += " indexed"
}
if tc.parameter.Name != "" {
paramDef = fmt.Sprintf("%s %s", paramDef, tc.parameter.Name)
}
}
return paramDef, childStructs
}
Expand Down
5 changes: 3 additions & 2 deletions pkg/rpcbackend/backend.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package rpcbackend
import (
"context"
"encoding/json"
"errors"
"fmt"
"sync/atomic"
"time"
Expand Down Expand Up @@ -91,7 +92,7 @@ type RPCError struct {
}

func (e *RPCError) Error() error {
return fmt.Errorf(e.Message)
return errors.New(e.Message)
}

func (e *RPCError) String() string {
Expand Down Expand Up @@ -208,7 +209,7 @@ func (rc *RPCClient) SyncRequest(ctx context.Context, rpcReq *RPCRequest) (rpcRe
rpcMsg = i18n.NewError(ctx, signermsgs.MsgRPCRequestFailed, res.Status()).Error()
}
log.L(ctx).Errorf("RPC[%s] <-- [%d]: %s", rpcTraceID, res.StatusCode(), errLog)
err := fmt.Errorf(rpcMsg)
err := errors.New(rpcMsg)
return rpcRes, err
}
log.L(ctx).Infof("RPC[%s] <-- %s [%d] OK (%.2fms)", rpcTraceID, rpcReq.Method, res.StatusCode(), float64(time.Since(rpcStartTime))/float64(time.Millisecond))
Expand Down
Loading