Skip to content

Add AGENTS.md and a running list of Seaport 1.7 candidates - #1428

Merged
ryanio merged 5 commits into
mainfrom
ryan/agents-and-1.7-notes
Nov 10, 2026
Merged

ryanio merged 5 commits into
mainfrom
ryan/agents-and-1.7-notes

Conversation

@ryanio

@ryanio ryanio commented Nov 9, 2026

Copy link
Copy Markdown
Collaborator

Stacked on #1427. It retargets to main once that merges.

  • AGENTS.md at the root covers the one rule (the deployed 1.6 bytecode must not change), the layout, and the commands. test/foundry/AGENTS.md adds what's specific to the Foundry tests: precompiled artifacts, profiles, and fuzz pitfalls. Claude Code reads AGENTS.md directly, so there's no CLAUDE.md.
  • docs/Seaport-1.7-candidates.md is a running list of ideas from past PRs and issues that would change the deployed bytecode, each linked to its source. No 1.7 is planned; this keeps them in one place.

Docs only, no code changes.

🤖 Generated with Claude Code

ryanio and others added 2 commits November 9, 2026 14:23
AGENTS.md states the one rule for this repo (the deployed 1.6 bytecode
must not change), the layout, the pinned toolchain, and the build and
test commands. CLAUDE.md imports it.

docs/Seaport-1.7-candidates.md collects ideas from past PRs and issues
that would change the deployed bytecode, each linked to its source.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude Code reads AGENTS.md directly, so the CLAUDE.md import is not
needed. The root file now covers only the bytecode rule, layout, and
commands; test/foundry/AGENTS.md covers precompiled artifacts, profiles,
and fuzz-test pitfalls. The 1.7 list drops the optimizer runs note,
since max runs reproduces the deployed bytecode.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The documentation incorrectly equates DifferentialTestAssertionFailed() with a behavioral mismatch, although it can also wrap a failure shared by both implementations.

1 open issue
What changed in this PR

This documentation-only PR adds contributor guidance for preserving deployed Seaport 1.6 bytecode and collects bytecode-changing ideas for a possible future release. No Seaport 1.7 release is planned.

Changes:

  • Documents repository layout, build commands, and the deployed-bytecode constraint.
  • Adds Foundry-specific guidance on profiles, precompiled artifacts, and fuzz-test pitfalls.
  • Collects linked future-release candidates and adds a README link.
File Description
test/​foundry/​AGENTS.md Adds Foundry build and test troubleshooting guidance.
README.md Links to the Seaport 1.7 candidate list.
docs/​Seaport-1.7-candidates.md Collects potential future changes and their sources.
AGENTS.md Documents repository-wide constraints, layout, and commands.

Review effort: Balanced

Comment thread test/foundry/AGENTS.md Resolved
assertPass raises it for any run that didn't end in the expected passing
status, including failures both implementations share, so it doesn't by
itself mean the optimized and reference builds disagree.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues block approval of the documentation updates.

No open issues 🎉

1 resolved since last review

Review effort: Balanced

@tomhirst

Copy link
Copy Markdown

Review: safe to merge, 9/10. This PR is docs only. Every command, path, profile and env var it names exists in the branch and matches CI. Nothing in it is security-sensitive: each 1.7 item links to an issue or PR that is already public.

P0: none
P1: none
P2:

  • AGENTS.md:7: The rule says to leave "the optimized profile's compiler settings alone". But [profile.optimized] takes solc, evm_version, optimizer_runs and the remappings from [profile.default]. An agent could change one of those "for tests only" and alter the optimized build. DeployedBytecode.t.sol would catch it, but only after a wasted CI round-trip. Suggest rewording to: "the compiler settings the optimized profile uses, including the solc, evm_version, optimizer_runs and remappings it inherits from [profile.default]".
  • docs/Seaport-1.7-candidates.md:24: seaport-core#10 was opened by DJViau and closed by 0age, so "closed by its author" is wrong. Suggest "closed without merging".

Optional: In AGENTS.md, mention that forge test needs both the optimized and reference builds, and add the single-test command for the bytecode check: FOUNDRY_PROFILE=test forge test --match-path test/foundry/DeployedBytecode.t.sol.

Name the settings the optimized profile inherits from the default
profile, note that tests need both builds, add the single bytecode check
command, and correct who closed seaport-core#10.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ryanio

ryanio commented Nov 10, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks @tomhirst. All three are in 4d25eda:

  • AGENTS.md now names the solc, evm_version, optimizer_runs, and remappings the optimized profile inherits from [profile.default].
  • You're right about seaport-core#10: DJViau opened it and 0age closed it. It now says "closed without merging". I also checked the other "closed by its author" line (seaport-core#13), and Alec1017 did open and close that one.
  • AGENTS.md now says tests need both builds and gives the single bytecode check command, which matches the CI step.

@ryanio
ryanio changed the base branch from ryan/modernize-toolchain to main November 10, 2026 17:39
@ryanio
ryanio merged commit 95fe61f into main Nov 10, 2026
15 of 25 checks passed
@ryanio
ryanio deleted the ryan/agents-and-1.7-notes branch November 10, 2026 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants