debug

package
v0.28.16 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 7, 2022 License: AGPL-3.0 Imports: 15 Imported by: 2

README

Remote Debugger

Remote debugger provides utils needed to run transactions and scripts against live network data. It uses GRPC endpoints on an execution nodes to fetch registers and block info when running a transaction. This is mostly provided for debugging purpose and should not be used for production level operations. If you use the caching method you can run the transaction once and use the cached values to run transaction in debugging mode.

sample code

package debug_test

import (
	"fmt"
	"os"
	"testing"

	"github.com/rs/zerolog"
	"github.com/stretchr/testify/require"

	"github.com/onflow/flow-go/model/flow"
	"github.com/onflow/flow-go/utils/debug"
)

func TestDebugger_RunTransaction(t *testing.T) {

	grpcAddress := "localhost:3600"
	chain := flow.Emulator.Chain()
	debugger := debug.NewRemoteDebugger(grpcAddress, chain, zerolog.New(os.Stdout).With().Logger())

	const scriptTemplate = `
	import FlowServiceAccount from 0x%s
	transaction() {
		prepare(signer: AuthAccount) {
			log(signer.balance)
		}
	  }
	`

	script := []byte(fmt.Sprintf(scriptTemplate, chain.ServiceAddress()))
	txBody := flow.NewTransactionBody().
		SetGasLimit(9999).
		SetScript([]byte(script)).
		SetPayer(chain.ServiceAddress()).
		SetProposalKey(chain.ServiceAddress(), 0, 0)
	txBody.Authorizers = []flow.Address{chain.ServiceAddress()}

	// Run at the latest blockID
	txErr, err := debugger.RunTransaction(txBody)
	require.NoError(t, txErr)
	require.NoError(t, err)

	// Run with blockID (use the file cache)
	blockId, err := flow.HexStringToIdentifier("3a8281395e2c1aaa3b8643d148594b19e2acb477611a8e0cab8a55c46c40b563")
	require.NoError(t, err)
	txErr, err = debugger.RunTransactionAtBlockID(txBody, blockId, "")
	require.NoError(t, txErr)
	require.NoError(t, err)

	testCacheFile := "test.cache"
	defer os.Remove(testCacheFile)
	// the first run would cache the results
	txErr, err = debugger.RunTransactionAtBlockID(txBody, blockId, testCacheFile)
	require.NoError(t, txErr)
	require.NoError(t, err)

	// second one should only use the cache
	// make blockId invalid so if it endsup looking up by id it should fail
	blockId = flow.Identifier{}
	txErr, err = debugger.RunTransactionAtBlockID(txBody, blockId, testCacheFile)
	require.NoError(t, txErr)
	require.NoError(t, err)
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetHeapAllocsBytes added in v0.27.0 

func GetHeapAllocsBytes() uint64

GetHeapAllocsBytes returns the value of /gc/heap/allocs:bytes.

Types

type RemoteDebugger added in v0.23.1 

type RemoteDebugger struct {
	// contains filtered or unexported fields
}

func NewRemoteDebugger added in v0.23.1 

func NewRemoteDebugger(grpcAddress string,
	chain flow.Chain,
	logger zerolog.Logger) *RemoteDebugger

Warning : make sure you use the proper flow-go version, same version as the network you are collecting registers from, otherwise the execution might differ from the way runs on the network

func (*RemoteDebugger) RunScript added in v0.23.1 

func (d *RemoteDebugger) RunScript(code []byte, arguments [][]byte) (value cadence.Value, scriptError, processError error)

func (*RemoteDebugger) RunScriptAtBlockID added in v0.23.1 

func (d *RemoteDebugger) RunScriptAtBlockID(code []byte, arguments [][]byte, blockID flow.Identifier) (value cadence.Value, scriptError, processError error)

func (*RemoteDebugger) RunTransaction added in v0.23.1 

func (d *RemoteDebugger) RunTransaction(txBody *flow.TransactionBody) (txErr, processError error)

RunTransaction runs the transaction given the latest sealed block data

func (*RemoteDebugger) RunTransactionAtBlockID added in v0.23.1 

func (d *RemoteDebugger) RunTransactionAtBlockID(txBody *flow.TransactionBody, blockID flow.Identifier, regCachePath string) (txErr, processError error)

RunTransaction runs the transaction and tries to collect the registers at the given blockID note that it would be very likely that block is far in the past and you can't find the trie to read the registers from if regCachePath is empty, the register values won't be cached

type RemoteView added in v0.23.1 

type RemoteView struct {
	Parent      *RemoteView
	Delta       map[string]flow.RegisterValue
	Cache       registerCache
	BlockID     []byte
	BlockHeader *flow.Header
	// contains filtered or unexported fields
}

RemoteView provides a view connected to a live execution node to read the registers writen values are kept inside a map

TODO implement register touches

func NewRemoteView added in v0.23.1 

func NewRemoteView(grpcAddress string, opts ...RemoteViewOption) *RemoteView

func (*RemoteView) AllRegisters added in v0.23.1 

func (v *RemoteView) AllRegisters() []flow.RegisterID

returns all the registers that has been touched

func (*RemoteView) Delete added in v0.23.1 

func (v *RemoteView) Delete(owner, key string) error

func (*RemoteView) Done added in v0.23.1 

func (v *RemoteView) Done()

func (*RemoteView) DropDelta added in v0.23.1 

func (v *RemoteView) DropDelta()

func (*RemoteView) Get added in v0.23.1 

func (v *RemoteView) Get(owner, key string) (flow.RegisterValue, error)

func (*RemoteView) MergeView added in v0.23.1 

func (v *RemoteView) MergeView(o state.View) error

func (*RemoteView) NewChild added in v0.23.1 

func (v *RemoteView) NewChild() state.View

func (*RemoteView) RegisterUpdates added in v0.23.1 

func (v *RemoteView) RegisterUpdates() ([]flow.RegisterID, []flow.RegisterValue)

func (*RemoteView) Set added in v0.23.1 

func (v *RemoteView) Set(owner, key string, value flow.RegisterValue) error

func (*RemoteView) Touch added in v0.23.1 

func (v *RemoteView) Touch(owner, key string) error

type RemoteViewOption added in v0.23.1 

type RemoteViewOption func(view *RemoteView) *RemoteView

A RemoteViewOption sets a configuration parameter for the remote view

func WithBlockID added in v0.23.1 

func WithBlockID(blockID flow.Identifier) RemoteViewOption

WithBlockID sets the blockID for the remote view, if not used remote view will use the latest sealed block

func WithCache added in v0.23.1 

func WithCache(cache registerCache) RemoteViewOption

WithFileCache sets the output path to store register values so can be fetched from a file cache it loads the values from the cache upon object construction

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.