Skip to content
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

upgrade to docusaurus v3 #826

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

smblee
Copy link

@smblee smblee commented Dec 4, 2024

No description provided.

Copy link

vercel bot commented Dec 4, 2024

@smblee is attempting to deploy a commit to the Uniswap Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Dec 4, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 11, 2024 6:41pm

Copy link

socket-security bot commented Dec 4, 2024

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert Package NoteSourceCI
Possible typosquat attack npm/v8-compile-cache@2.4.0 🚫
Filesystem access npm/cosmiconfig@8.3.6 ⚠︎
Filesystem access npm/config-chain@1.1.13 ⚠︎
Dynamic require npm/jest-util@29.7.0 ⚠︎
Dynamic require npm/webpackbar@6.0.1 ⚠︎
Filesystem access npm/jiti@1.21.6 ⚠︎
Filesystem access npm/jiti@1.21.6 ⚠︎
Filesystem access npm/@pnpm/npm-conf@2.3.1 ⚠︎
Shell access npm/launch-editor@2.9.1 ⚠︎
Filesystem access npm/launch-editor@2.9.1 ⚠︎
Shell access npm/update-browserslist-db@1.1.1 ⚠︎
Filesystem access npm/update-browserslist-db@1.1.1 ⚠︎
Dynamic require npm/@babel/core@7.26.0 ⚠︎
Filesystem access npm/@docusaurus/babel@3.6.3 ⚠︎
Filesystem access npm/@docusaurus/utils-validation@3.6.3 ⚠︎

View full report↗︎

Next steps

What is a typosquat?

Package name is similar to other popular packages and may not be the package you want.

Use care when consuming similarly named packages and ensure that you did not intend to consume a different package. Malicious packages often publish using similar names as existing popular packages.

What is filesystem access?

Accesses the file system, and could potentially read sensitive data.

If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

What is dynamic require?

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Packages should avoid dynamic imports when possible. Audit the use of dynamic require to ensure it is not executing malicious or vulnerable code.

What is shell access?

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

  • @SocketSecurity ignore npm/v8-compile-cache@2.4.0
  • @SocketSecurity ignore npm/cosmiconfig@8.3.6
  • @SocketSecurity ignore npm/config-chain@1.1.13
  • @SocketSecurity ignore npm/jest-util@29.7.0
  • @SocketSecurity ignore npm/webpackbar@6.0.1
  • @SocketSecurity ignore npm/jiti@1.21.6
  • @SocketSecurity ignore npm/@pnpm/npm-conf@2.3.1
  • @SocketSecurity ignore npm/launch-editor@2.9.1
  • @SocketSecurity ignore npm/update-browserslist-db@1.1.1
  • @SocketSecurity ignore npm/@babel/core@7.26.0
  • @SocketSecurity ignore npm/@docusaurus/babel@3.6.3
  • @SocketSecurity ignore npm/@docusaurus/utils-validation@3.6.3

@@ -118,7 +118,7 @@ function getSqrtPriceAtTick(int24 tick) internal pure returns (uint160 sqrtPrice

### getTickAtSqrtPrice

Calculates the greatest tick value such that getSqrtPriceAtTick(tick) <= sqrtPriceX96
Calculates the greatest tick value such that getSqrtPriceAtTick(tick) \<= sqrtPriceX96
Copy link
Collaborator

Choose a reason for hiding this comment

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

flagging for myself -- the markdown files in v4/reference/* are generated with forge doc and copied to this repo's directory structure in uniswap/docs/scripts/v4-forge-doc.sh

I'll update the script and use sed to make sure we're escaping docusaurus v3 special characters


this shouldnt block our upgrade to docusaurus v3 tho

Copy link
Author

Choose a reason for hiding this comment

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

Could i get a ✅

Copy link

Report too large to display inline

View full report↗︎

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