Skip to content

fix: correct duplicate parameter in signature verification table#617

Open
Kropiunig wants to merge 1 commit intocowprotocol:mainfrom
Kropiunig:fix/signature-verification-table
Open

fix: correct duplicate parameter in signature verification table#617
Kropiunig wants to merge 1 commit intocowprotocol:mainfrom
Kropiunig:fix/signature-verification-table

Conversation

@Kropiunig
Copy link
Copy Markdown

@Kropiunig Kropiunig commented Apr 21, 2026

Summary

  • Fixed duplicate encodeData entry in the signature verification parameter table
  • Replaced the second encodeData row with the missing payload parameter and added its description linking to the PayloadStruct section

Fixes #430

Summary by CodeRabbit

  • Documentation
    • Clarified documentation for the payload parameter, specifying it contains ABI-encoded Merkle proof and conditional order data.

Replace duplicate encodeData entry with the missing payload parameter
and add its description referencing the PayloadStruct section.

Fixes cowprotocol#430
@Kropiunig Kropiunig requested a review from a team as a code owner April 21, 2026 08:38
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 21, 2026

@Kropiunig is attempting to deploy a commit to the cow Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 21, 2026

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: afd0bea4-2a57-45b6-a1d8-d9a8f1fde41e

📥 Commits

Reviewing files that changed from the base of the PR and between 99b2eb7 and 3afbe7c.

📒 Files selected for processing (1)
  • docs/cow-protocol/reference/contracts/periphery/composable_cow.md

📝 Walkthrough

Walkthrough

The documentation table for isValidSafeSignature parameters in the Composable Cow contract reference was corrected. A duplicated encodeData row was removed and replaced with a proper payload parameter description documenting the ABI-encoded PayloadStruct data.

Changes

Cohort / File(s) Summary
Documentation Fix
docs/cow-protocol/reference/contracts/periphery/composable_cow.md
Removed duplicate encodeData parameter row and added payload parameter description documenting ABI-encoded PayloadStruct containing Merkle proof, conditional order parameters, and off-chain input.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Hop hop, a doc so fine,
The table's fixed, now it will shine!
No more duplicates in sight,
The payload's here, all proper and right! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change—removing a duplicate parameter entry and correcting the documentation table.
Description check ✅ Passed The description covers the key changes made and references the linked issue, though it lacks detailed context and a structured changelog section.
Linked Issues check ✅ Passed The PR successfully addresses the requirements from issue #430: it removes the duplicate encodeData entry and documents the missing payload parameter.
Out of Scope Changes check ✅ Passed All changes are directly scoped to fixing the documentation issue described in issue #430; no extraneous modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Kropiunig
Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Apr 21, 2026
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.

bug: Documentation issue in Signature verification of Composable Cow

1 participant