You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The README explains what go-anvil is but doesn't show common end-to-end patterns. New users have to piece together calls from godoc.
Proposal
Add a "Recipes" section after the Quick Start with 4-6 short, copy-pasteable snippets. Pull these from the godoc Example functions in #70 so they stay in sync (or vice versa — link from README to godoc Examples).
Each recipe: 8-12 lines, no error handling boilerplate (use must style or just _, _ = ... for brevity, with a comment noting the user should handle errors in real code).
Acceptance criteria
Recipes section in README.
Cross-link between README and pkg.go.dev godoc Examples.
Recipes don't drift from real code — either they're copied from the Example functions, or there's a CI check that they compile (e.g. go run a sample file).
Problem
The README explains what go-anvil is but doesn't show common end-to-end patterns. New users have to piece together calls from godoc.
Proposal
Add a "Recipes" section after the Quick Start with 4-6 short, copy-pasteable snippets. Pull these from the godoc Example functions in #70 so they stay in sync (or vice versa — link from README to godoc Examples).
Suggested recipes:
NewFundedAccount(depends on [v0.2.0] Wallet helpers: FundAccounts and NewFundedAccount #56).AdvanceTime(depends on [v0.2.0] Time-travel ergonomics: AdvanceBlocks and AdvanceTime #57).WithFork+WithForkBlockNumber.Impersonate+SetBalance.DebugTraceTransaction(depends on [v0.2.0] Add debug_traceTransaction and debug_traceCall wrappers #58).Each recipe: 8-12 lines, no error handling boilerplate (use
muststyle or just_, _ = ...for brevity, with a comment noting the user should handle errors in real code).Acceptance criteria
go runa sample file).