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.

Sign up for GitHub

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

*: add invocations to applicationlog #3569

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
+235 −24
Open

*: add invocations to applicationlog #3569

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d8a0d13
Store invocations in application log
ixje Jun 28, 2024
04c71f5
rename params to arguments
ixje Sep 2, 2024
dfd5c9b
make invocation saving configurable, safely handle args
ixje Oct 31, 2024
cd7caf5
re-use serialized arguments for storing
ixje Oct 31, 2024
e7063a2
feedback
ixje Nov 20, 2024
ae3b481
process feedback
ixje Jan 2, 2025
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
2 changes: 2 additions & 0 deletions pkg/config/ledger_config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ type Ledger struct {
// SkipBlockVerification allows to disable verification of received
// blocks (including cryptographic checks).
SkipBlockVerification bool `yaml:"SkipBlockVerification"`
// SaveInvocations enables contract smart contract invocation data saving.
ixje marked this conversation as resolved.
Show resolved Hide resolved
SaveInvocations bool `yaml:"SaveInvocations"`
Copy link
Member

Choose a reason for hiding this comment

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

Please, adjust docs/node-configuration.md. Write some details on how this feature works and recommendations on situations when it should be enabled/disabled.

}

// Blockchain is a set of settings for core.Blockchain to use, it includes protocol
Expand Down
2 changes: 2 additions & 0 deletions pkg/core/dao/dao_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,8 @@ func TestStoreAsTransaction(t *testing.T) {
Arguments: stackitem.NewArray([]stackitem.Item{
stackitem.NewBool(false),
}),
ArgumentsCount: 1,
IsValid: true,
}},
},
}
Expand Down
22 changes: 17 additions & 5 deletions pkg/core/interop/contract/call.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,23 @@ func Call(ic *interop.Context) error {
}
hasReturn := md.ReturnType != smartcontract.VoidType

ic.InvocationCalls = append(ic.InvocationCalls, state.ContractInvocation{
Hash: u,
Method: method,
Arguments: stackitem.NewArray(args),
})
if ic.Chain.GetConfig().Ledger.SaveInvocations {
Copy link
Member

Choose a reason for hiding this comment

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

GetConfig() for every call is too costly, we need some new field in ic inited on NewContext() (just like Network and Hardforks are initialized currently).

arr := stackitem.NewArray(args)
Copy link
Member

Choose a reason for hiding this comment

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

If you're serializing this is a useless variable.

arrCount := len(args)
valid := true
if _, err = ic.DAO.GetItemCtx().Serialize(arr, false); err != nil {
arr = stackitem.NewArray([]stackitem.Item{})
valid = false
}

ic.InvocationCalls = append(ic.InvocationCalls, state.ContractInvocation{
ixje marked this conversation as resolved.
Show resolved Hide resolved
Hash: u,
Method: method,
Arguments: arr,
ArgumentsCount: uint32(arrCount),
IsValid: valid,
})
}
return callInternal(ic, cs, method, fs, hasReturn, args, true)
}

Expand Down
30 changes: 21 additions & 9 deletions pkg/core/state/notification_event.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@ type NotificationEvent struct {
}

type ContractInvocation struct {
Copy link
Member

Choose a reason for hiding this comment

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

Move it to a separate go file. notification_event.go is for NotificationEvent structure.

Hash util.Uint160 `json:"contract_hash"`
Method string `json:"method"`
Arguments *stackitem.Array `json:"arguments"`
Hash util.Uint160 `json:"contract_hash"`
Method string `json:"method"`
Arguments *stackitem.Array `json:"arguments"`
ArgumentsCount uint32 `json:"arguments_count"`
Copy link
Member

Choose a reason for hiding this comment

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

Why this one? In the optimistic case you have Arguments with some proper number of elements. In pessimistic, does it make any difference?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The idea was that in case of Isvalid = false, then at least we have some information on the argument count.

as said in #3569 (comment)

I don't think we should throw away the complete invocation record because of a parameter violation. If it's recorded on chain then it was apparently still a valid invocation, regardless if we want to store all of the invocation details

I don't recall a hard necessity for this in my original use-case for this PR, but I think it's cheap to do and harder to add later (assuming the C# follows).

IsValid bool `json:"is_valid"`
Copy link
Member

Choose a reason for hiding this comment

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

Notice we never use snake_case in JSON structures, this should be something different. Also, from the Go perspective it's very convenient to have the default boolean (false) to follow regular use case. Like we use truncated for various find* results. Maybe truncated is applicable here too.

}

func (ci *ContractInvocation) DecodeBinary(r *io.BinReader) {
Expand All @@ -39,6 +41,8 @@ func (ci *ContractInvocation) DecodeBinary(r *io.BinReader) {
return
}
ci.Arguments = stackitem.NewArray(arr)
ci.ArgumentsCount = r.ReadU32LE()
ci.IsValid = r.ReadBool()
}

func (ci *ContractInvocation) EncodeBinaryWithContext(w *io.BinWriter, sc *stackitem.SerializationContext) {
Expand All @@ -50,6 +54,8 @@ func (ci *ContractInvocation) EncodeBinaryWithContext(w *io.BinWriter, sc *stack
return
}
w.WriteBytes(b)
w.WriteU32LE(ci.ArgumentsCount)
w.WriteBool(ci.IsValid)
}

// MarshalJSON implements the json.Marshaler interface.
Expand All @@ -59,9 +65,11 @@ func (ci ContractInvocation) MarshalJSON() ([]byte, error) {
item = []byte(fmt.Sprintf(`"error: %v"`, err))
}
return json.Marshal(ContractInvocationAux{
Hash: ci.Hash,
Method: ci.Method,
Arguments: item,
Hash: ci.Hash,
Method: ci.Method,
Arguments: item,
ArgumentsCount: ci.ArgumentsCount,
IsValid: ci.IsValid,
})
}

Expand All @@ -81,6 +89,8 @@ func (ci *ContractInvocation) UnmarshalJSON(data []byte) error {
ci.Arguments = params.(*stackitem.Array)
ci.Method = aux.Method
ci.Hash = aux.Hash
ci.ArgumentsCount = aux.ArgumentsCount
ci.IsValid = aux.IsValid
return nil
}

Expand Down Expand Up @@ -286,9 +296,11 @@ type Execution struct {
}

type ContractInvocationAux struct {
Copy link
Member

Choose a reason for hiding this comment

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

Exported structure needs a comment.

Copy link
Member

Choose a reason for hiding this comment

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

And BTW, all auxiliary structures should be unexported.

Hash util.Uint160 `json:"contract_hash"`
Method string `json:"method"`
Arguments json.RawMessage `json:"arguments"`
Hash util.Uint160 `json:"contract_hash"`
Method string `json:"method"`
Arguments json.RawMessage `json:"arguments"`
ArgumentsCount uint32 `json:"arguments_count"`
IsValid bool `json:"is_valid"`
}

// executionAux represents an auxiliary struct for Execution JSON marshalling.
Expand Down