Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

defi

package module

Go to main page

Versions in this module

v0

v0.4.0

Jul 30, 2026

Changes in this version

+ var ErrDynamicPlaceholderNotZero = errors.New("dynamic calldata placeholder is not zero")

+ var ErrInvalidCalldataPatch = errors.New("invalid calldata patch")

+ var ErrInvalidCheckpointGraph = errors.New("invalid checkpoint graph")

+ var ErrInvalidDynamicCall = errors.New("invalid dynamic call")

+ var ErrPlanKindMismatch = errors.New("execution plan kind is incompatible with accessor")

+ type BalanceCheckpoint struct

+ ID [32]byte

+ Token common.Address

+ type BalancePatch struct

+ BPS uint16

+ CheckpointID [32]byte

+ Offset uint32

+ Source BalanceSource

+ Token common.Address

+ type BalanceSource uint8

+ const BalanceSourceCheckpointDelta

+ const BalanceSourceCurrentBalance

+ type CalldataPatch struct

+ Offset uint32

+ Source amount.Source

+ type CheckpointDeclaration struct

+ Ref amount.CheckpointRef

+ type DynamicCall struct

+ CheckpointsBefore []BalanceCheckpoint

+ Data []byte

+ ExpectsCallback bool

+ Patches []BalancePatch

+ Target common.Address

+ Value *big.Int

type ExecutionPlan

+ func (p *ExecutionPlan) DynamicCalls() ([]DynamicCall, error)

+ func (p *ExecutionPlan) Kind() PlanKind

+ func (p *ExecutionPlan) StaticCalls() ([]Call, error)

type FlowStep

+ func CheckpointBefore(step FlowStep, checkpoints ...amount.CheckpointRef) FlowStep

+ type PlanKind uint8

+ const PlanDynamic

+ const PlanStatic

+ type PlannedCall struct

+ Call Call

+ CheckpointsBefore []CheckpointDeclaration

+ ExpectsCallback bool

+ Patches []CalldataPatch

v0.3.0

Jul 16, 2026

Changes in this version

+ var ErrEmptyFlow = errors.New("empty flow")

+ var ErrExecutionAccountMismatch = errors.New("flow account does not match transaction signer")

+ var ErrExpectedEventNotFound = errors.New("expected execution event not found")

+ var ErrInvalidAccount = errors.New("flow account is zero")

+ var ErrInvalidAmountConstraint = errors.New("invalid amount constraint")

+ var ErrInvalidEventExpectation = errors.New("invalid event expectation")

+ var ErrInvalidExecutionPlan = errors.New("invalid execution plan")

+ var ErrInvalidExecutionReceipt = errors.New("invalid execution receipt")

+ var ErrInvalidMatchResult = errors.New("invalid match result")

+ var ErrMalformedExecutionEvent = errors.New("malformed execution event")

+ var ErrMissingChain = errors.New("flow chain is required")

+ var ErrMissingExecutor = errors.New("flow executor is required")

+ func EventsOf[T DecodedEvent](result *ExecutionResult) []T

+ type Action = contract.Action

+ type AmountConstraint interface

+ Describe func() string

+ Match func(actual *big.Int, ctx MatchContext) (MatchResult, error)

+ func AtLeast(minimum *big.Int) AmountConstraint

+ func AtMost(maximum *big.Int) AmountConstraint

+ func Exact(expected *big.Int) AmountConstraint

+ func Positive() AmountConstraint

+ type BuildEnv struct

+ Account common.Address

+ Chain config.Chain

+ Conn EthereumClient

+ type BuiltStep struct

+ Calls []Call

+ Expectations []EventExpectation

+ ID StepID

+ Name string

+ type Call = contract.Call

+ type CallExecutor = contract.CallExecutor

+ type DecodedEvent interface

+ EventMetadata func() EventMetadata

+ type EthereumClient = contract.EthereumClient

+ type EventExpectation interface

+ Decode func(log *types.Log) (DecodedEvent, error)

+ ExpectationName func() string

+ IsCandidate func(log *types.Log) bool

+ Match func(event DecodedEvent, ctx MatchContext) (MatchResult, error)

+ type EventMetadata struct

+ Emitter common.Address

+ LogIndex uint

+ Name string

+ Protocol string

+ type ExecutionError struct

+ Err error

+ Expectation string

+ LogIndex *uint

+ Stage ExecutionStage

+ StepID StepID

+ func (e *ExecutionError) Error() string

+ func (e *ExecutionError) Unwrap() error

+ type ExecutionMode string

+ const ExecutionAtomicEOA

+ const ExecutionEOA

+ type ExecutionPlan struct

+ Account common.Address

+ Steps []BuiltStep

+ func (p *ExecutionPlan) Calls() []Call

+ type ExecutionResult struct

+ Receipt *types.Receipt

+ Steps []StepResult

+ func ValidateExecution(plan *ExecutionPlan, receipt *types.Receipt) (*ExecutionResult, error)

+ type ExecutionStage string

+ const ExecutionStageDecode

+ const ExecutionStageMatch

+ const ExecutionStageReceipt

+ const ExecutionStageTransaction

+ const ExecutionStageValidation

+ type ExpectationResult struct

+ CandidateCount int

+ Event DecodedEvent

+ Mismatches []FieldMismatch

+ Name string

+ SkipReason SkipReason

+ Status ValidationStatus

+ type FieldMismatch struct

+ Actual string

+ Expected string

+ Field string

+ type Flow struct

+ func NewFlow(account common.Address, opts ...FlowOption) *Flow

+ func (f *Flow) Add(step FlowStep) *Flow

+ func (f *Flow) Build(ctx context.Context, conn EthereumClient) (*ExecutionPlan, error)

+ func (f *Flow) Execute(ctx context.Context, conn EthereumClient, executor CallExecutor) (*types.Receipt, error)

+ type FlowOption func(*Flow)

+ func WithChain(chain config.Chain) FlowOption

+ type FlowStep interface

+ Build func(ctx context.Context, env BuildEnv) (BuiltStep, error)

+ func ActionStep(name string, action Action) FlowStep

+ type MatchContext struct

+ StepID StepID

+ type MatchDecision uint8

+ const MatchAccepted

+ const MatchSkip

+ type MatchResult struct

+ Decision MatchDecision

+ Mismatches []FieldMismatch

+ func MatchAmountConstraints(field string, actual *big.Int, ctx MatchContext, ...) (MatchResult, error)

+ type Runner struct

+ func NewRunner(conn EthereumClient, opts *bind.TransactOpts, chain config.Chain) *Runner

+ func (r *Runner) Execute(ctx context.Context, flow *Flow, mode ExecutionMode) (*types.Receipt, error)

+ func (r *Runner) ExecuteWithResult(ctx context.Context, flow *Flow, mode ExecutionMode) (*ExecutionResult, error)

+ type SkipReason string

+ const SkipExecutionFailed

+ const SkipInvalidReceipt

+ const SkipPriorValidationFailed

+ type StepID string

+ type StepResult struct

+ Expectations []ExpectationResult

+ ID StepID

+ Name string

+ SkipReason SkipReason

+ Status ValidationStatus

+ type ValidationStatus string

+ const ValidationFailed

+ const ValidationSkipped

+ const ValidationUnvalidated

+ const ValidationValidated

v0.2.0

Jul 8, 2026

v0.1.6

May 28, 2025

v0.1.5

May 22, 2025

v0.1.4

May 22, 2025

v0.1.3

May 21, 2025

v0.1.2

May 21, 2025

v0.1.1

May 21, 2025