-
Notifications
You must be signed in to change notification settings - Fork 633
added audits #8577
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
added audits #8577
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
WalkthroughAdds three new MDX documentation pages under apps/portal (Bridge Link, Build with tokens, Deploy programmatically) and updates the wallet security page to include an "Audits" tab with links to external audit reports. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro Disabled knowledge base sources:
📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (4)
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8577 +/- ##
=======================================
Coverage 54.47% 54.47%
=======================================
Files 922 922
Lines 61361 61361
Branches 4149 4149
=======================================
Hits 33425 33425
Misses 27835 27835
Partials 101 101
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🧹 Nitpick comments (1)
apps/portal/src/app/tokens/deploy-programmatically/page.mdx (1)
17-24: Consider removing trailing empty lines.The OpenApiEndpoint component usage is correct. However, Lines 21-24 contain excessive trailing whitespace that could be cleaned up for better file hygiene.
🔎 Apply this diff to remove trailing lines:
## Deploy ERC-20 Token <OpenApiEndpoint path="/v1/tokens" method="POST" /> - - - -
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
apps/portal/src/app/bridge/link/page.mdx(1 hunks)apps/portal/src/app/tokens/build-tokens/page.mdx(1 hunks)apps/portal/src/app/tokens/deploy-programmatically/page.mdx(1 hunks)apps/portal/src/app/wallets/security/page.mdx(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)
- GitHub Check: E2E Tests (pnpm, vite)
- GitHub Check: Lint Packages
- GitHub Check: E2E Tests (pnpm, esbuild)
- GitHub Check: Build Packages
- GitHub Check: E2E Tests (pnpm, webpack)
- GitHub Check: Unit Tests
- GitHub Check: Size
- GitHub Check: Analyze (javascript)
🔇 Additional comments (5)
apps/portal/src/app/wallets/security/page.mdx (2)
26-28: LGTM!The new "Audits" tab trigger follows the same pattern and styling as the existing tabs.
195-203: The audit link to thirdweb-22 may be invalid.Line 201 references "https://0xmacro.com/library/audits/thirdweb-22", but the 0xMacro audit library appears to only include audits up to thirdweb-17. Verify this link exists or update to the correct audit number. The IPFS link on line 202 may also be subject to gateway availability issues.
apps/portal/src/app/bridge/link/page.mdx (1)
1-2: LGTM!The component imports are correct and necessary for the Steps UI pattern used in this documentation page.
apps/portal/src/app/tokens/deploy-programmatically/page.mdx (2)
1-6: LGTM!The import statement and page introduction are clear and appropriate for API documentation.
8-14: LGTM!The use cases section provides clear examples of when programmatic token deployment is beneficial.
| <Steps> | ||
| <Step title="Generate Links"> | ||
| Generate a link to request a specific amount of tokens from a specific wallet. | ||
| </Step> | ||
| <Step title="Share payment "> | ||
| Host the link on your website | ||
| </Step> | ||
| <Step title="Host Link"> | ||
| Host the link on your website | ||
| </Step> | ||
| <Step title="Host Link"> | ||
| Host the link on your website | ||
| </Step> | ||
| </Steps> No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix duplicate steps and mismatched content.
The Steps component contains duplicate and incomplete content:
- Line 13-15: The "Share payment" step title doesn't match its content ("Host the link on your website").
- Lines 16-21: Steps 3 and 4 both have the identical title "Host Link" and identical content, appearing to be copy-paste duplicates.
This creates confusing documentation that doesn't provide distinct, actionable guidance for each step.
🔎 Suggested structure for the steps:
<Steps>
<Step title="Generate Links">
Generate a link to request a specific amount of tokens from a specific wallet.
</Step>
-<Step title="Share payment ">
-Host the link on your website
+<Step title="Customize the link">
+[Add content about customizing the bridge link parameters]
</Step>
<Step title="Host Link">
Host the link on your website
</Step>
-<Step title="Host Link">
-Host the link on your website
+<Step title="Share with users">
+[Add content about sharing the link with users]
</Step>
</Steps>Would you like me to help draft appropriate content for each step based on typical bridge link workflows?
🤖 Prompt for AI Agents
In apps/portal/src/app/bridge/link/page.mdx around lines 9 to 22, the Steps
block has a mismatched title/content for "Share payment" (title shows “Share
payment” but content says “Host the link on your website”) and two duplicate
"Host Link" steps; replace the four entries with four distinct steps (e.g.,
"Generate Links" — describe creating a payment link with amount and wallet;
"Share Payment" — explain how to distribute the link to payers via
email/QR/embed/social; "Host Link" — describe embedding or hosting the link on
your website and required config); and "Monitor Payments" or "Confirm Receipt" —
describe how to verify and handle incoming payments; remove the duplicate step
and ensure each Step title matches its content and is concise and actionable.
| # Build with tokens | ||
|
|
||
| ### No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the empty heading or add content.
Line 3 contains an empty heading marker (###) with no text. This creates incomplete documentation structure and should either have meaningful content added or be removed entirely.
🔎 Apply this diff to remove the empty heading:
# Build with tokens
-### Do you want me to help draft content for this placeholder section?
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Build with tokens | |
| ### | |
| # Build with tokens | |
🤖 Prompt for AI Agents
In apps/portal/src/app/tokens/build-tokens/page.mdx around lines 1 to 3, there
is an empty third-level heading marker ("###") on line 3; either delete that
line to remove the empty heading or replace it with a meaningful subheading and
accompanying content (e.g., a short description or list explaining the build
tokens section). Ensure markdown structure remains valid (no stray heading
markers) and update any nearby TOC or references if you add a new subsection
title.
size-limit report 📦
|
Merge activity
|
<!--
## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"
If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):
## Notes for the reviewer
Anything important to call out? Be sure to also clarify these in your comments.
## How to test
Unit tests, playground, etc.
-->
<!-- start pr-codex -->
---
## PR-Codex overview
This PR adds documentation for building and deploying tokens programmatically, generating bridge links, and auditing wallets. It enhances the user experience by providing clear instructions and examples for developers.
### Detailed summary
- Added a section titled `Build with tokens` in `page.mdx`.
- Introduced `Deploy Programmatically through API` section with details on ERC-20, ERC-721, and ERC-1155 tokens in `deploy-programmatically/page.mdx`.
- Included a guide on generating bridge links with steps in `link/page.mdx`.
- Added `Wallets Audits` section with links to audit reports in `security/page.mdx`.
> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`
<!-- end pr-codex -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit
* **Documentation**
* Added Bridge Link guide with step-by-step instructions for generating payment links and hosting them on websites
* Added Build with Tokens guide
* Added Deploying Tokens Programmatically guide with API examples for ERC-20, ERC-721, and ERC-1155 tokens
* Added Wallet Security Audits section highlighting audit reports
<sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2622883 to
6e87b92
Compare
PR-Codex overview
This PR introduces new documentation content across several pages, enhancing the information available for building and deploying tokens, creating bridge links, and auditing wallets.
Detailed summary
Build with tokensinpage.mdx.page.mdxfor deploying tokens programmatically, including use cases and anOpenApiEndpoint.Bridge Linksection inpage.mdxwith steps for generating and sharing links.auditstab inpage.mdxwith links to wallet audit reports.Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.