plugeth/plugins/test-plugin/hooks.go

package main

import (
	"time"
	"math/big"
	"sync"
	
	"github.com/openrelayxyz/plugeth-utils/core"
	"github.com/openrelayxyz/plugeth-utils/restricted"
	
)

var apis []core.API

type engineService struct {
	backend core.Backend
	stack core.Node
}

// cmd/geth/

func GetAPIs(stack core.Node, backend core.Backend) []core.API {
	// GetAPIs is covered by virtue of the plugeth_captureShutdown method functioning.
	apis = []core.API{
		{
			Namespace: "plugeth",
			Version:   "1.0",
			Service:   &engineService{backend, stack},
			Public:    true,
		},
		{
			Namespace: "plugeth",
			Version:   "1.0",
			Service:   &LiveTracerResult{},
			Public:    true,
		},
	}
	return apis
}

func InitializeNode(stack core.Node, b restricted.Backend) {
	go func() {
			m := map[string]struct{}{
				"InitializeNode":struct{}{},
			}
			hookChan <- m
	}()
}

// func OnShutdown(){
	// this injection is covered by another test in this package. See documentation for details. 
// }

// cmd/utils/

func SetDefaultDataDir(arg string) string {
	m := map[string]struct{}{
		"SetDefaultDataDir":struct{}{},
	}
	hookChan <- m
	return "test"
}

func SetBootstrapNodes() []string {
	m := map[string]struct{}{
		"SetBootstrapNodes":struct{}{},
	}
	hookChan <- m
	return nil
}

func SetNetworkId() *uint64 {
	m := map[string]struct{}{
		"SetNetworkId":struct{}{},
	}
	hookChan <- m
	return nil
}

func SetETHDiscoveryURLs(arg bool) []string {
	m := map[string]struct{}{
		"SetETHDiscoveryURLs":struct{}{},
	}
	hookChan <- m
	return nil
}

func SetSnapDiscoveryURLs() []string {
	m := map[string]struct{}{
		"SetSnapDiscoveryURLs":struct{}{},
	}
	hookChan <- m
	return nil
}

// core/


func PreProcessBlock(hash core.Hash, number uint64, encoded []byte) {
	m := map[string]struct{}{
		"PreProcessBlock":struct{}{},
	}
	hookChan <- m
}

func PreProcessTransaction(txBytes []byte, txHash, blockHash core.Hash, i int) {
	m := map[string]struct{}{
		"PreProcessTransaction":struct{}{},
	}
	hookChan <- m
}

func BlockProcessingError(tx core.Hash, block core.Hash, err error) { 
	// this injection is covered by a stand alone test: plugeth_injection_test.go in the core/ package. 
}

func PostProcessTransaction(tx core.Hash, block core.Hash, i int, receipt []byte) {
	m := map[string]struct{}{
		"PostProcessTransaction":struct{}{},
	}
	hookChan <- m
}

func PostProcessBlock(block core.Hash) {
	m := map[string]struct{}{
		"PostProcessBlock":struct{}{},
	}
	hookChan <- m
}

func NewHead(block []byte, hash core.Hash, logs [][]byte, td *big.Int) {
	m := map[string]struct{}{
		"NewHead":struct{}{},
	}
	hookChan <- m
}

func NewSideBlock(block []byte, hash core.Hash, logs [][]byte) { // beyond the scope of the test at this time
	// this injection is covered by a stand alone test: plugeth_injection_test.go in the core/ package.
}

func Reorg(commonBlock core.Hash, oldChain, newChain []core.Hash) { // beyond the scope of the test at this time
	// this injection is covered by a stand alone test: plugeth_injection_test.go in the core/ package.
}

func SetTrieFlushIntervalClone(duration time.Duration) time.Duration {
	m := map[string]struct{}{
		"SetTrieFlushIntervalClone":struct{}{},
	}
	hookChan <- m
	return duration
}

// core/forkid/

var onceZero sync.Once

func ForkIDs(byBlock, byTime []uint64) ([]uint64, []uint64) {
	go func() {
		onceZero.Do(func() {
			m := map[string]struct{}{
				"ForkIDs":struct{}{},
			}
			hookChan <- m
		})
	}()

	return byBlock, byTime
}

// core/rawdb/

func ModifyAncients(index uint64, freezerUpdate map[string]struct{}) {
	// this injection is covered by a stand alone test: plugeth_injection_test.go in the core/rawdb package. 
}

func AppendAncient(number uint64, hash, header, body, receipts, td []byte) {
	// this injection is covered by a stand alone test: plugeth_injection_test.go in the core/rawdb package.
}

// core/state/

func StateUpdate(blockRoot core.Hash, parentRoot core.Hash, coreDestructs map[core.Hash]struct{}, coreAccounts map[core.Hash][]byte, coreStorage map[core.Hash]map[core.Hash][]byte, coreCode map[core.Hash][]byte) {
	m := map[string]struct{}{
		"StateUpdate":struct{}{},
	}
	hookChan <- m
}

// core/vm/

func OpCodeSelect() []int {
	m := map[string]struct{}{
		"OpCodeSelect":struct{}{},
	}
	hookChan <- m
	return nil
}

// eth/ethconfig

func pseudoCreateEngine() {
	if createEngineCalled {
		m := map[string]struct{}{
			"CreateEngine":struct{}{},
		}
		hookChan <- m
	}
}

// rpc/


func GetRPCCalls(method string, id string, params string) {
	m := map[string]struct{}{
		"GetRPCCalls":struct{}{},
	}
	hookChan <- m
}

var onceOne sync.Once

func RPCSubscriptionTest() {
	go func() {
		onceOne.Do(func() {
			m := map[string]struct{}{
			"RPCSubscriptionTest":struct{}{},
			}
			hookChan <- m
		})
	}()
}

// trie/

// func PreTrieCommit(node core.Hash) {
	// this injection is covered by another test in this package. See documentation for details.
// }

// func PostTrieCommit(node core.Hash) {
	// this injection is covered by another test in this package. See documentation for details.
// }

// params/ 

// Is1559 is written in params/ the injections are in: consensus/misc/ (2), and core/ (2) and miner/ (1)
func Is1559(*big.Int) bool { 
	m := map[string]struct{}{
		"Is1559":struct{}{},
	}
	hookChan <- m
	return true
}

// the following two hooks are both testing the PluginEIPCheck() hook 

func Is160(num *big.Int) bool {
	m := map[string]struct{}{
		"Is160":struct{}{},
	}
	hookChan <- m
	return true
}

func IsShanghai(num *big.Int) bool { 
	m := map[string]struct{}{
		"IsShanghai":struct{}{},
	}
	hookChan <- m
	return true
}

var plugins map[string]struct{} = map[string]struct{}{
	"InitializeNode":struct{}{},
	"CreateEngine":struct{}{},
	"OnShutdown": struct{}{},
	"SetTrieFlushIntervalClone":struct{}{},
	"StateUpdate": struct{}{},
	"PreProcessBlock": struct{}{},
	"PreProcessTransaction": struct{}{},
	"PostProcessTransaction": struct{}{},
	"PostProcessBlock": struct{}{},
	"NewHead": struct{}{},
	"StandardCaptureStart": struct{}{},
	"StandardCaptureState": struct{}{},
	"StandardCaptureFault": struct{}{},
	"StandardCaptureEnter": struct{}{},
	"StandardCaptureExit": struct{}{},
	"StandardCaptureEnd": struct{}{},
	"StandardTracerResult": struct{}{},
	"GetRPCCalls": struct{}{},
	"RPCSubscriptionTest": struct{}{},
	"LivePreProcessBlock": struct{}{},
	"LivePreProcessTransaction": struct{}{},
	"LivePostProcessTransaction": struct{}{},
	"LivePostProcessBlock": struct{}{},
	"LiveCaptureStart": struct{}{},
	"LiveCaptureState": struct{}{},
	"LiveCaptureEnd": struct{}{},
	"PreTrieCommit": struct{}{},
	"PostTrieCommit": struct{}{},
	// "LiveCaptureFault": struct{}{},
	// "LiveCaptureEnter": struct{}{},
	// "LiveCaptureExit": struct{}{},
	// "LiveTracerResult": struct{}{},
	"SetDefaultDataDir":struct{}{},
	"SetBootstrapNodes":struct{}{},
	"SetNetworkId":struct{}{},
	"SetETHDiscoveryURLs": struct{}{},
	"SetSnapDiscoveryURLs": struct{}{},
	"ForkIDs": struct{}{},
	"OpCodeSelect":struct{}{},
	"Is1559":struct{}{},
	"Is160":struct{}{},
	"IsShanghai":struct{}{},
}