util

Documentation

Overview

Package util contains eth type utils

Index

• func CopyTX(unsignedTx *types.Transaction, options ...CopyOption) (*types.Transaction, error)
• func TxToCall(transaction Transaction) (*ethereum.CallMsg, error)
• type Chunk
  • func (c *Chunk) MaxBlock() *big.Int
  • func (c *Chunk) MinBlock() *big.Int
• type ChunkIterator
  • func NewChunkIterator(startBlock, endBlock *big.Int, chunkSize int, ascending bool) ChunkIterator
• type CopyOption
  • func WithGasFeeCap(gasFeeCap *big.Int) CopyOption
  • func WithGasPrice(gasPrice *big.Int) CopyOption
  • func WithGasTipCap(gasTipCap *big.Int) CopyOption
  • func WithNonce(nonce uint64) CopyOption
  • func WithTxType(txType uint8) CopyOption
• type Transaction

Examples

• Chunk

Functions

func CopyTX

func CopyTX(unsignedTx *types.Transaction, options ...CopyOption) (*types.Transaction, error)

CopyTX copies a transaction and sets the nonce to the given value. Note: when copying from a dynamic tx to a legacy tx, the chain id cannot be copied over since it's embedded in the signature rather than the rlp envelope. Resigning will fix this. nolint: cyclop

func TxToCall

func TxToCall(transaction Transaction) (*ethereum.CallMsg, error)

TxToCall converts a transaction to a call.

Types

type Chunk

type Chunk struct {
	// StartBlock for this chunk. It is less then end block in ascending txes and greater in descending.
	StartBlock *big.Int
	// EndBlock for this chunk
	EndBlock *big.Int
	// contains filtered or unexported fields
}

Chunk represents an individual chunk of startBlock-startBlock. TODO: this needs to be moved to scribe.

Example

ExampleChunk demonstrates ascending and descending chunking.

// a ascending chunk iterator
chunkIterator := util.NewChunkIterator(big.NewInt(1), big.NewInt(10), 1, true)
var minMaxChunk, startEndChunks string
for {
	nextChunk := chunkIterator.NextChunk()
	if nextChunk == nil {
		break
	}

	minMaxChunk += fmt.Sprintf("[%d-%d],", nextChunk.MinBlock(), nextChunk.MaxBlock())
	startEndChunks += fmt.Sprintf("[%d-%d],", nextChunk.StartBlock, nextChunk.EndBlock)
}
fmt.Println(strings.TrimSuffix(minMaxChunk, ","))
fmt.Println(strings.TrimSuffix(startEndChunks, ","))

// a descending chunk iterator
chunkIterator = util.NewChunkIterator(big.NewInt(1), big.NewInt(10), 1, false)
minMaxChunk = ""
startEndChunks = ""

for {
	nextChunk := chunkIterator.NextChunk()
	if nextChunk == nil {
		break
	}

	minMaxChunk += fmt.Sprintf("[%d-%d],", nextChunk.MinBlock(), nextChunk.MaxBlock())
	startEndChunks += fmt.Sprintf("[%d-%d],", nextChunk.StartBlock, nextChunk.EndBlock)
}
fmt.Println(strings.TrimSuffix(minMaxChunk, ","))
fmt.Println(strings.TrimSuffix(startEndChunks, ","))

Output:

[1-2],[3-4],[5-6],[7-8],[9-10]
[1-2],[3-4],[5-6],[7-8],[9-10]
[9-10],[7-8],[5-6],[3-4],[1-2]
[10-9],[8-7],[6-5],[4-3],[2-1]

func (*Chunk) MaxBlock

func (c *Chunk) MaxBlock() *big.Int

MaxBlock returns the minimum of start block and end block. This is useful because start/end change based on the ordering of the chunk.

func (*Chunk) MinBlock

func (c *Chunk) MinBlock() *big.Int

MinBlock returns the minimum of start block and end block. This is useful because start/end change based on the ordering of the chunk.

type ChunkIterator

type ChunkIterator interface {
	// NextChunk gets the next chunk. If the iterator has completed null will be returned.
	NextChunk() *Chunk
}

ChunkIterator is an instantiation of a stateful iterator that groups startBlock-endBlock blocks into length chunkSize.

func NewChunkIterator

func NewChunkIterator(startBlock, endBlock *big.Int, chunkSize int, ascending bool) ChunkIterator

NewChunkIterator creates an iterator for a range of elements (startBlock-endBlock) split into groups the length of chunkSize the final chunk has any remaining elements. An iterator is used here as opposed to a slice to save memory while iterating over *very large* chunks.This follows the stateful iterator pattern: https://ewencp.org/blog/golang-iterators/index.html

type CopyOption

type CopyOption func(*copyOptions)

CopyOption is a function that sets a copy option Certain options are not supported for certain transaction types on purpose please exercise caution before adding new options.

func WithGasFeeCap

func WithGasFeeCap(gasFeeCap *big.Int) CopyOption

WithGasFeeCap sets the gas fee cap for the copy.

func WithGasPrice

func WithGasPrice(gasPrice *big.Int) CopyOption

WithGasPrice sets the gas price for the copy.

func WithGasTipCap

func WithGasTipCap(gasTipCap *big.Int) CopyOption

WithGasTipCap sets the gas tip cap for the copy.

func WithNonce

func WithNonce(nonce uint64) CopyOption

WithNonce sets the nonce for the copy.

func WithTxType

func WithTxType(txType uint8) CopyOption

WithTxType sets the tx type for the copy. should be one of one of types.LegacyTxType, types.AccessListTxType, types.DynamicFeeTxType Warning: txtype conversions are not well supported and should be avoided if possible.

type Transaction

type Transaction interface {
	// ChainId returns the chain id.
	ChainId() *big.Int
	// To returns the to address.
	To() *common.Address
	// GasPrice returns the gas price.
	GasPrice() *big.Int
	// GasFeeCap returns the gas fee cap.
	GasFeeCap() *big.Int
	// GasTipCap returns the gas tip cap.
	GasTipCap() *big.Int
	// Gas returns the gas limit.
	Gas() uint64
	// Value returns the value of the tx.
	Value() *big.Int
	// Data returns the data of the tx.
	Data() []byte
	// AsMessage converts the transaction to a message.
	AsMessage(s types.Signer, baseFee *big.Int) (types.Message, error)
}

Transaction is an interface for everything needed to convert a transaction to a call.