Skip to content

Conversation

@salemalem
Copy link

Related Issue

  • None; housekeeping/documentation improvement

Description of Changes

  • README
    • Expanded overview to clarify what the periphery includes and current development status
    • Enhanced “Local Deployment and Usage” with:
      • Install/build commands (forge install, forge build)
      • Example remappings hints
      • Quickstart guidance for PositionManager, V4Router, and V4Quoter
      • Example forge script invocations
    • Kept structure minimal (no new top-level sections), updated license blurb to match repository license (MIT)
  • Scripts comment improvements (documentation-only, no logic/ABI changes)
    • Added a consistent block header to each script with Purpose, Usage, and Notes/Params
    • Added contract-level NatSpec and function-level NatSpec for clarity
    • Cleaned formatting to avoid backticks and misaligned lines
    • Files updated:
      • script/01_PoolManager.s.sol
      • script/02_PoolModifyLiquidityTest.s.sol
      • script/03_PoolSwapTest.s.sol
      • script/DeployHook.s.sol
      • script/DeployPosm.s.sol
      • script/DeployStateView.s.sol
      • script/DeployV4Quoter.s.sol

Rationale

  • Improve developer onboarding and reduce friction when running scripts
  • Make script roles, parameters, and usage explicit
  • Align README with actual repo configuration and common workflows

Impact

  • No runtime or functional changes
  • No ABI changes
  • Tests and builds remain unchanged

How to Verify

  • Build succeeds: forge build
  • Scripts compile and are self-descriptive:
    • forge script script/01_PoolManager.s.sol:DeployPoolManager --rpc-url $RPC --private-key $PK --broadcast
    • forge script script/DeployV4Quoter.s.sol:DeployV4Quoter --rpc-url $RPC --private-key $PK --broadcast --sig "run(address)" <POOL_MANAGER>
    • Similar usage for other scripts per header comments
  • README renders with the enhanced guidance and correct license note

Release Notes

  • Documentation-only update: expanded README and standardized comments across deployment scripts for clearer usage and maintenance

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.

1 participant