Skip to content

Commit

Permalink
process feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
ixje committed Jan 2, 2025
1 parent e7063a2 commit ae3b481
Show file tree
Hide file tree
Showing 10 changed files with 186 additions and 109 deletions.
2 changes: 2 additions & 0 deletions docs/node-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ node-related settings described in the table below.
| SaveStorageBatch | `bool` | `false` | Enables storage batch saving before every persist. It is similar to StorageDump plugin for C# node. |
| SkipBlockVerification | `bool` | `false` | Allows to disable verification of received/processed blocks (including cryptographic checks). |
| StateRoot | [State Root Configuration](#State-Root-Configuration) | | State root module configuration. See the [State Root Configuration](#State-Root-Configuration) section for details. |
| SaveInvocations | `bool` | `false` | Determines if additional smart contract invocation details are stored. If enabled, the `getapplicationlog` RPC method will return a new field with invocation details for the transaction. See the [RPC](rpc.md#applicationlog-invocations) documentation for more information. |

### P2P Configuration

Expand Down Expand Up @@ -471,6 +472,7 @@ affect this:
- `GarbageCollectionPeriod` must be the same
- `KeepOnlyLatestState` must be the same
- `RemoveUntraceableBlocks` must be the same
- `SaveInvocations` must be the same

BotlDB is also known to be incompatible between machines with different
endianness. Nothing is known for LevelDB wrt this, so it's not recommended
Expand Down
46 changes: 46 additions & 0 deletions docs/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,52 @@ to various blockchain events (with simple event filtering) and receive them on
the client as JSON-RPC notifications. More details on that are written in the
[notifications specification](notifications.md).

#### Applicationlog invocations

The `SaveInvocations` node configuration setting stores smart contract invocation
details into the application logs under the `invocations` key. This feature is
specifically useful to capture information in the absence of `System.Runtime.Notify`
calls for the given smart contract method. Other use-cases are described in
[this issue](https://github.com/neo-project/neo/issues/3386).

Example:
```json
"invocations": [
{
"hash": "0xd2a4cff31913016155e38e474a2c06d08be276cf",
"method": "transfer",
"arguments": {
"type": "Array",
"value": [
{
"type": "ByteString",
"value": "krOcd6pg8ptXwXPO2Rfxf9Mhpus="
},
{
"type": "ByteString",
"value": "AZelPVEEY0csq+FRLl/HJ9cW+Qs="
},
{
"type": "Integer",
"value": "1000000000000"
},
{
"type": "Any"
}
]
},
"argumentscount": 4,
"truncated": false
}
]
```

For security reasons the `arguments` field data may result in `null`. In such case the
`Truncated` field will be set to `true`.

Note that invocation records for faulted transactions are kept and are present in the
applicationlog. This behaviour differs from notifications which are omitted for faulted transactions.

## Reference

* [JSON-RPC 2.0 Specification](http://www.jsonrpc.org/specification)
Expand Down
2 changes: 1 addition & 1 deletion pkg/config/ledger_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ 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.
// SaveInvocations enables smart contract invocation data saving.
SaveInvocations bool `yaml:"SaveInvocations"`
}

Expand Down
5 changes: 5 additions & 0 deletions pkg/core/blockchain.go
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ func (bc *Blockchain) init() error {
KeepOnlyLatestState: bc.config.Ledger.KeepOnlyLatestState,
Magic: uint32(bc.config.Magic),
Value: version,
SaveInvocations: bc.config.SaveInvocations,
}
bc.dao.PutVersion(ver)
bc.dao.Version = ver
Expand Down Expand Up @@ -454,6 +455,10 @@ func (bc *Blockchain) init() error {
return fmt.Errorf("protocol configuration Magic mismatch (old=%v, new=%v)",
ver.Magic, bc.config.Magic)
}
if ver.SaveInvocations != bc.config.SaveInvocations {
return fmt.Errorf("SaveInvocations setting mismatch (old=%v, new=%v)",
ver.SaveInvocations, bc.config.SaveInvocations)
}
bc.dao.Version = ver
bc.persistent.Version = ver

Expand Down
6 changes: 6 additions & 0 deletions pkg/core/dao/dao.go
Original file line number Diff line number Diff line change
Expand Up @@ -448,13 +448,15 @@ type Version struct {
KeepOnlyLatestState bool
Magic uint32
Value string
SaveInvocations bool
}

const (
stateRootInHeaderBit = 1 << iota
p2pSigExtensionsBit
p2pStateExchangeExtensionsBit
keepOnlyLatestStateBit
saveInvocationsBit
)

// FromBytes decodes v from a byte-slice.
Expand Down Expand Up @@ -482,6 +484,7 @@ func (v *Version) FromBytes(data []byte) error {
v.P2PSigExtensions = data[i+2]&p2pSigExtensionsBit != 0
v.P2PStateExchangeExtensions = data[i+2]&p2pStateExchangeExtensionsBit != 0
v.KeepOnlyLatestState = data[i+2]&keepOnlyLatestStateBit != 0
v.SaveInvocations = data[i+2]&saveInvocationsBit != 0

m := i + 3
if len(data) == m+4 {
Expand All @@ -505,6 +508,9 @@ func (v *Version) Bytes() []byte {
if v.KeepOnlyLatestState {
mask |= keepOnlyLatestStateBit
}
if v.SaveInvocations {
mask |= saveInvocationsBit
}
res := append([]byte(v.Value), '\x00', byte(v.StoragePrefix), mask)
res = binary.LittleEndian.AppendUint32(res, v.Magic)
return res
Expand Down
22 changes: 8 additions & 14 deletions pkg/core/dao/dao_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,10 @@ func TestStoreAsTransaction(t *testing.T) {
tx.Signers = append(tx.Signers, transaction.Signer{})
tx.Scripts = append(tx.Scripts, transaction.Witness{})
hash := tx.Hash()
si := stackitem.NewArray([]stackitem.Item{stackitem.NewBool(false)})
argBytes, err := dao.GetItemCtx().Serialize(si, false)
require.NoError(t, err)
ci := state.NewContractInvocation(util.Uint160{}, "fakeMethodCall", argBytes, 1, false)
aer := &state.AppExecResult{
Container: hash,
Execution: state.Execution{
Expand All @@ -184,24 +188,14 @@ func TestStoreAsTransaction(t *testing.T) {
{
ScriptHash: util.Uint160{},
Name: "fakeTransferEvent",
Item: stackitem.NewArray([]stackitem.Item{
stackitem.NewBool(false),
}),
Item: si,
},
},
Stack: []stackitem.Item{},
Invocations: []state.ContractInvocation{{
Hash: util.Uint160{},
Method: "fakeMethodCall",
Arguments: stackitem.NewArray([]stackitem.Item{
stackitem.NewBool(false),
}),
ArgumentsCount: 1,
Truncated: false,
}},
Stack: []stackitem.Item{},
Invocations: []state.ContractInvocation{*ci},
},
}
err := dao.StoreAsTransaction(tx, 0, aer)
err = dao.StoreAsTransaction(tx, 0, aer)
require.NoError(t, err)
err = dao.HasTransaction(hash, nil, 0, 0)
require.ErrorIs(t, err, ErrAlreadyExists)
Expand Down
4 changes: 2 additions & 2 deletions pkg/core/interop/context.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func NewContext(trigger trigger.Type, bc Ledger, d *dao.Simple, baseExecFee, bas
loadTokenFunc func(ic *Context, id int32) error,
block *block.Block, tx *transaction.Transaction, log *zap.Logger) *Context {
dao := d.GetPrivate()
cfg := bc.GetConfig().ProtocolConfiguration
cfg := bc.GetConfig()
return &Context{
Chain: bc,
Network: uint32(cfg.Magic),
Expand All @@ -96,7 +96,7 @@ func NewContext(trigger trigger.Type, bc Ledger, d *dao.Simple, baseExecFee, bas
baseExecFee: baseExecFee,
baseStorageFee: baseStorageFee,
loadToken: loadTokenFunc,
SaveInvocations: bc.GetConfig().SaveInvocations,
SaveInvocations: cfg.SaveInvocations,
}
}

Expand Down
10 changes: 2 additions & 8 deletions pkg/core/interop/contract/call.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,8 @@ func Call(ic *interop.Context) error {
if argBytes, err = ic.DAO.GetItemCtx().Serialize(stackitem.NewArray(args), false); err != nil {
truncated = true
}

ic.InvocationCalls = append(ic.InvocationCalls, state.ContractInvocation{
Hash: u,
Method: method,
ArgumentsBytes: argBytes,
ArgumentsCount: uint32(arrCount),
Truncated: truncated,
})
ci := state.NewContractInvocation(u, method, argBytes, uint32(arrCount), truncated)
ic.InvocationCalls = append(ic.InvocationCalls, *ci)
}
return callInternal(ic, cs, method, fs, hasReturn, args, true)
}
Expand Down
109 changes: 109 additions & 0 deletions pkg/core/state/contract_invocation.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
package state

import (
"encoding/json"
"fmt"

"github.com/nspcc-dev/neo-go/pkg/io"
"github.com/nspcc-dev/neo-go/pkg/util"
"github.com/nspcc-dev/neo-go/pkg/vm/stackitem"
)

// NewContractInvocation return a new ContractInvocation.
func NewContractInvocation(hash util.Uint160, method string, argBytes []byte, argCnt uint32, truncated bool) *ContractInvocation {
return &ContractInvocation{
Hash: hash,
Method: method,
argumentsBytes: argBytes,
ArgumentsCount: argCnt,
Truncated: truncated,
}
}

// ContractInvocation contains method call information.
// The Arguments field will be nil if serialization of the arguments exceeds the predefined limit
// of [stackitem.MaxSerialized] (for security reasons). In that case Truncated will be set to true.
type ContractInvocation struct {
Hash util.Uint160 `json:"contract"`
Method string `json:"method"`
// Arguments are the arguments as passed to the `args` parameter of System.Contract.Call
// for use in the RPC Server and RPC Client.
Arguments *stackitem.Array `json:"arguments"`
// argumentsBytes is the serialized arguments used at the interop level.
argumentsBytes []byte
ArgumentsCount uint32 `json:"argumentscount"`
Truncated bool `json:"truncated"`
}

// DecodeBinary implements the Serializable interface.
func (ci *ContractInvocation) DecodeBinary(r *io.BinReader) {
ci.Hash.DecodeBinary(r)
ci.Method = r.ReadString()
ci.argumentsBytes = r.ReadVarBytes()
ci.ArgumentsCount = r.ReadU32LE()
ci.Truncated = r.ReadBool()
}

// EncodeBinary implements the Serializable interface.
func (ci *ContractInvocation) EncodeBinary(w *io.BinWriter) {
ci.EncodeBinaryWithContext(w, stackitem.NewSerializationContext())
}

// EncodeBinaryWithContext is the same as EncodeBinary, but allows to efficiently reuse
// stack item serialization context.
func (ci *ContractInvocation) EncodeBinaryWithContext(w *io.BinWriter, sc *stackitem.SerializationContext) {
ci.Hash.EncodeBinary(w)
w.WriteString(ci.Method)
w.WriteVarBytes(ci.argumentsBytes)
w.WriteU32LE(ci.ArgumentsCount)
w.WriteBool(ci.Truncated)
}

// MarshalJSON implements the json.Marshaler interface.
func (ci ContractInvocation) MarshalJSON() ([]byte, error) {
si, err := stackitem.Deserialize(ci.argumentsBytes)
if err != nil {
return nil, err
}
item, err := stackitem.ToJSONWithTypes(si.(*stackitem.Array))
if err != nil {
item = []byte(fmt.Sprintf(`"error: %v"`, err))
}
return json.Marshal(contractInvocationAux{
Hash: ci.Hash,
Method: ci.Method,
Arguments: item,
ArgumentsCount: ci.ArgumentsCount,
Truncated: ci.Truncated,
})
}

// UnmarshalJSON implements the json.Unmarshaler interface.
func (ci *ContractInvocation) UnmarshalJSON(data []byte) error {
aux := new(contractInvocationAux)
if err := json.Unmarshal(data, aux); err != nil {
return err
}
params, err := stackitem.FromJSONWithTypes(aux.Arguments)
if err != nil {
return err
}
if t := params.Type(); t != stackitem.ArrayT {
return fmt.Errorf("failed to convert invocation state of type %s to array", t.String())
}
ci.Arguments = params.(*stackitem.Array)
ci.Method = aux.Method
ci.Hash = aux.Hash
ci.ArgumentsCount = aux.ArgumentsCount
ci.Truncated = aux.Truncated
return nil
}

// contractInvocationAux is an auxiliary struct for ContractInvocation JSON marshalling.
type contractInvocationAux struct {
Hash util.Uint160 `json:"hash"`
Method string `json:"method"`
Arguments json.RawMessage `json:"arguments"`
ArgumentsCount uint32 `json:"argumentscount"`
Truncated bool `json:"truncated"`
}
Loading

0 comments on commit ae3b481

Please sign in to comment.