Skip to content

Write Sui v1 learn sections w/ math & access#136

Merged
stevep0z merged 2 commits intomainfrom
feat/sui-learn-pages-v1
Mar 26, 2026
Merged

Write Sui v1 learn sections w/ math & access#136
stevep0z merged 2 commits intomainfrom
feat/sui-learn-pages-v1

Conversation

@stevep0z
Copy link
Copy Markdown
Collaborator

Documentation Pull Request

Summary

Adds a Learn section for OpenZeppelin Contracts for Sui under contracts-sui/1.x/learn/, introducing two in-depth walkthrough guides:

  • Math Walkthrough: covers why explicit arithmetic matters on-chain (with the Cetus exploit as context), rounding as a protocol decision, Option<T> handling patterns, core primitives (mul_div, mul_shr, average), safe bit operations (checked_shl, checked_shr), introspection and logarithms, modular arithmetic, decimal scaling, and a complete pricing module example.
  • Access Walkthrough: covers the wrapping and borrow model, the full lifecycle of two_step_transfer (wrap → initiate → accept/cancel) and delayed_transfer (wrap → schedule → wait → execute/cancel), security notes for shared-object flows and TTO recipient validation, and a combined protocol example using both packages.

Includes a Learn landing index page and wired-up sidebar navigation under the Sui nav tree.

Type of Change

  • New documentation
  • Documentation update/revision
  • Fix typos or grammar
  • Restructure/reorganize content
  • Add examples or tutorials
  • Update API documentation
  • Other: ___________

Related Issues

N/A

Checklist

Additional Notes

Content is sourced from externally authored walkthrough documents. Code examples are experimental and unaudited. A warning callout is present on each page.

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 26, 2026

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit fd90921
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/69c5548f827e9a0008065d9f
😎 Deploy Preview https://deploy-preview-136--openzeppelin-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@stevep0z stevep0z self-assigned this Mar 26, 2026
@stevep0z stevep0z requested a review from ernestognw March 26, 2026 15:34
@stevep0z stevep0z merged commit e957cfb into main Mar 26, 2026
10 checks passed
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.

2 participants