From 9977606e40c82f17dc6118b3ab5219bb3507dbf3 Mon Sep 17 00:00:00 2001 From: Anna Shaleva Date: Mon, 10 Oct 2022 13:59:37 +0300 Subject: [PATCH] cli: support 'loadtx' VM CLI command --- cli/vm/cli.go | 83 ++++++++++++++++++++++++++++++++++++++-------- cli/vm/cli_test.go | 33 ++++++++++++++++++ 2 files changed, 103 insertions(+), 13 deletions(-) diff --git a/cli/vm/cli.go b/cli/vm/cli.go index ad4f3a184..647e3057d 100644 --- a/cli/vm/cli.go +++ b/cli/vm/cli.go @@ -20,6 +20,7 @@ import ( "github.com/kballard/go-shellquote" "github.com/nspcc-dev/neo-go/cli/flags" "github.com/nspcc-dev/neo-go/cli/options" + "github.com/nspcc-dev/neo-go/cli/paramcontext" "github.com/nspcc-dev/neo-go/pkg/compiler" "github.com/nspcc-dev/neo-go/pkg/config" "github.com/nspcc-dev/neo-go/pkg/core" @@ -27,6 +28,7 @@ import ( "github.com/nspcc-dev/neo-go/pkg/core/interop/runtime" "github.com/nspcc-dev/neo-go/pkg/core/storage" "github.com/nspcc-dev/neo-go/pkg/core/storage/dbconfig" + "github.com/nspcc-dev/neo-go/pkg/core/transaction" "github.com/nspcc-dev/neo-go/pkg/crypto/keys" "github.com/nspcc-dev/neo-go/pkg/encoding/address" "github.com/nspcc-dev/neo-go/pkg/encoding/bigint" @@ -166,6 +168,21 @@ both parameters are mandatory, example: > loadgo /path/to/file.go`, Action: handleLoadGo, }, + { + Name: "loadtx", + Usage: "Load transaction into the VM from chain or from parameter context file. " + + "The transaction script will be loaded into VM; the resulting execution context will use the provided transaction as script container including its signers, hash and nonce.", + UsageText: `loadtx [--historic ] `, + Flags: []cli.Flag{historicFlag}, + Description: `loadtx [--historic ] + +Load transaction into the VM from chain or from parameter context file. +The transaction script will be loaded into VM; the resulting execution context will use the provided transaction as script container including its signers, hash and nonce. + + is mandatory parameter, example: +> loadtx /path/to/file`, + Action: handleLoadTx, + }, { Name: "reset", Usage: "Unload compiled script from the VM and reset context to proper (possibly, historic) state", @@ -574,17 +591,17 @@ func handleSlots(c *cli.Context) error { // prepareVM retrieves --historic flag from context (if set) and resets app state // (to the specified historic height if given). -func prepareVM(c *cli.Context) error { +func prepareVM(c *cli.Context, tx *transaction.Transaction) error { if c.IsSet(historicFlagFullName) { height := c.Int(historicFlagFullName) - return resetState(c.App, uint32(height)) + return resetState(c.App, tx, uint32(height)) } - return resetState(c.App) + return resetState(c.App, tx) } func handleLoadNEF(c *cli.Context) error { - err := prepareVM(c) + err := prepareVM(c, nil) if err != nil { return err } @@ -607,7 +624,7 @@ func handleLoadNEF(c *cli.Context) error { } func handleLoadBase64(c *cli.Context) error { - err := prepareVM(c) + err := prepareVM(c, nil) if err != nil { return err } @@ -627,7 +644,7 @@ func handleLoadBase64(c *cli.Context) error { } func handleLoadHex(c *cli.Context) error { - err := prepareVM(c) + err := prepareVM(c, nil) if err != nil { return err } @@ -647,7 +664,7 @@ func handleLoadHex(c *cli.Context) error { } func handleLoadGo(c *cli.Context) error { - err := prepareVM(c) + err := prepareVM(c, nil) if err != nil { return err } @@ -676,8 +693,48 @@ func handleLoadGo(c *cli.Context) error { return nil } +func handleLoadTx(c *cli.Context) error { + args := c.Args() + if len(args) < 1 { + return fmt.Errorf("%w: ", ErrMissingParameter) + } + + var ( + tx *transaction.Transaction + err error + ) + h, err := util.Uint256DecodeStringLE(strings.TrimPrefix(args[0], "0x")) + if err != nil { + pc, err := paramcontext.Read(args[0]) + if err != nil { + return fmt.Errorf("invalid tx hash or path to parameter context: %w", err) + } + var ok bool + tx, ok = pc.Verifiable.(*transaction.Transaction) + if !ok { + return errors.New("failed to retrieve transaction from parameter context: verifiable item is not a transaction") + } + } else { + bc := getChainFromContext(c.App) + tx, _, err = bc.GetTransaction(h) + if err != nil { + return fmt.Errorf("failed to get transaction from chain: %w", err) + } + } + err = prepareVM(c, tx) + if err != nil { + return err + } + v := getVMFromContext(c.App) + + v.LoadWithFlags(tx.Script, callflag.All) + fmt.Fprintf(c.App.Writer, "READY: loaded %d instructions\n", v.Context().LenInstr()) + changePrompt(c.App) + return nil +} + func handleReset(c *cli.Context) error { - err := prepareVM(c) + err := prepareVM(c, nil) if err != nil { return err } @@ -693,7 +750,7 @@ func finalizeInteropContext(app *cli.App) { // resetInteropContext calls finalizer for current interop context and replaces // it with the newly created one. -func resetInteropContext(app *cli.App, height ...uint32) error { +func resetInteropContext(app *cli.App, tx *transaction.Transaction, height ...uint32) error { finalizeInteropContext(app) bc := getChainFromContext(app) var ( @@ -701,12 +758,12 @@ func resetInteropContext(app *cli.App, height ...uint32) error { err error ) if len(height) != 0 { - newIc, err = bc.GetTestHistoricVM(trigger.Application, nil, height[0]+1) + newIc, err = bc.GetTestHistoricVM(trigger.Application, tx, height[0]+1) if err != nil { return fmt.Errorf("failed to create historic VM for height %d: %w", height[0], err) } } else { - newIc, err = bc.GetTestVM(trigger.Application, nil, nil) + newIc, err = bc.GetTestVM(trigger.Application, tx, nil) if err != nil { return fmt.Errorf("failed to create VM: %w", err) } @@ -723,8 +780,8 @@ func resetManifest(app *cli.App) { // resetState resets state of the app (clear interop context and manifest) so that it's ready // to load new program. -func resetState(app *cli.App, height ...uint32) error { - err := resetInteropContext(app, height...) +func resetState(app *cli.App, tx *transaction.Transaction, height ...uint32) error { + err := resetInteropContext(app, tx, height...) if err != nil { return err } diff --git a/cli/vm/cli_test.go b/cli/vm/cli_test.go index 256625e1f..4e90cd1b5 100644 --- a/cli/vm/cli_test.go +++ b/cli/vm/cli_test.go @@ -5,6 +5,7 @@ import ( "encoding/base64" "encoding/hex" "encoding/json" + "errors" "fmt" gio "io" "os" @@ -15,10 +16,12 @@ import ( "time" "github.com/chzyer/readline" + "github.com/nspcc-dev/neo-go/cli/paramcontext" "github.com/nspcc-dev/neo-go/internal/basicchain" "github.com/nspcc-dev/neo-go/internal/random" "github.com/nspcc-dev/neo-go/pkg/compiler" "github.com/nspcc-dev/neo-go/pkg/config" + "github.com/nspcc-dev/neo-go/pkg/config/netmode" "github.com/nspcc-dev/neo-go/pkg/core/interop/interopnames" "github.com/nspcc-dev/neo-go/pkg/core/state" "github.com/nspcc-dev/neo-go/pkg/core/storage" @@ -986,3 +989,33 @@ func TestDumpChanges(t *testing.T) { e.checkChange(t, expected[1]) e.checkChange(t, expected[2]) } + +func TestLoadtx(t *testing.T) { + e := newTestVMClIWithState(t) + + b, err := e.cli.chain.GetBlock(e.cli.chain.GetHeaderHash(2)) // Block #2 contains transaction that puts (1,1) pair to storage contract. + require.NoError(t, err) + require.Equal(t, 1, len(b.Transactions)) + tx := b.Transactions[0] + + tmp := filepath.Join(t.TempDir(), "tx.json") + require.NoError(t, paramcontext.InitAndSave(netmode.UnitTestNet, tx, nil, tmp)) + + e.runProg(t, + "loadtx "+tx.Hash().StringLE(), // hash LE + "run", + "loadtx 0x"+tx.Hash().StringLE(), // hash LE with 0x prefix + "run", + "loadtx '"+tmp+"'", // Tx from parameter context file. + "run", + "loadtx", // missing argument + "exit", + ) + e.checkNextLine(t, "READY: loaded \\d+ instructions") + e.checkStack(t, 1) + e.checkNextLine(t, "READY: loaded \\d+ instructions") + e.checkStack(t, 1) + e.checkNextLine(t, "READY: loaded \\d+ instructions") + e.checkStack(t, 1) + e.checkError(t, errors.New("missing argument: ")) +}