Skip to content

Conversation

JJScar
Copy link

@JJScar JJScar commented Jul 9, 2025

Fixes #1016

Summary

Adds documentation for the utility modules used in OpenZeppelin's Starknet account components, including:

  • secp256_point.cairo
  • signature.cairo
  • utils.cairo

Details

This contributes to #1016 by extending accounts.adoc with an == Account Utilities section. The content includes usage details, import paths, function summaries, and security notes (e.g., for signature malleability).

Let me know if you'd like the content split into separate .adoc files — for now I followed the single-page structure.

Thanks! 🙌

PR Checklist

  • Tests
  • Documentation
  • Added entry to CHANGELOG.md
  • Tried the feature on a public network

Copy link

codecov bot commented Jul 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.11%. Comparing base (cbfda3c) to head (935b021).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1465      +/-   ##
==========================================
+ Coverage   93.00%   93.11%   +0.10%     
==========================================
  Files          80       82       +2     
  Lines        2230     2251      +21     
==========================================
+ Hits         2074     2096      +22     
+ Misses        156      155       -1     

see 7 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cbfda3c...935b021. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ericnordelo
Copy link
Member

Hey, the content of the docs look right, but it should be moved into the API Reference section of Accounts instead, and follow the same format that the rest of the page is following. You can find that page in the Deploy Preview here. We can add a Utilities section after Presets.

Copy link
Author

@JJScar JJScar left a comment

Choose a reason for hiding this comment

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

Moved location of docs

@JJScar
Copy link
Author

JJScar commented Jul 17, 2025

Gm was wondering if this commit is right? I'll make changes if needed.

Also, I came across this issue via OnlyDust.xyz so if this commit is good, is it possible to "approve" my application and accept my work as "completed"?

@ericnordelo
Copy link
Member

Hey @JJScar, if you go to the deploy preview here (which you can follow from the actions in the PR), you can see that the output format is not compatible with the current one in the API Reference. Also, we don't have OnlyDust rewards for our repo, and we haven't added any issues to the board neither can we approve them sadly.

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.

Document account component utils in docsite

2 participants