diff --git a/README.md b/README.md index 00ec55a202..fd21430448 100644 --- a/README.md +++ b/README.md @@ -63,9 +63,3 @@ yarn serve ```shell git submodule update --remote arbitrum-sdk ``` - -### Format content -Sometimes, your pull request may need to be re-formatted to pass the checks. To be safe, make sure you run the following command (from the `website` directory) before you push your commit: -```shell -yarn && yarn format -``` diff --git a/arbitrum-docs/for-devs/third-party-docs/Particle/particle.mdx b/arbitrum-docs/for-devs/third-party-docs/Particle/particle.mdx index fec9f30c88..f5a8afd58b 100644 --- a/arbitrum-docs/for-devs/third-party-docs/Particle/particle.mdx +++ b/arbitrum-docs/for-devs/third-party-docs/Particle/particle.mdx @@ -6,7 +6,7 @@ sme: TABASCOatw sidebar_label: 'Particle Network' --- -import ImageZoomComponent from '@site/src/components/ImageZoom'; +import ImageZoom from '@site/src/components/ImageZoom'; :::info Community member contribution diff --git a/arbitrum-docs/how-arbitrum-works/timeboost/gentle-introduction.mdx b/arbitrum-docs/how-arbitrum-works/timeboost/gentle-introduction.mdx index 549334354c..516f968b00 100644 --- a/arbitrum-docs/how-arbitrum-works/timeboost/gentle-introduction.mdx +++ b/arbitrum-docs/how-arbitrum-works/timeboost/gentle-introduction.mdx @@ -8,6 +8,8 @@ user_story: As a current or prospective Arbitrum user, I want to understand how content_type: gentle-introduction --- +import { FlowChart } from '@site/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction'; +import ImageWithCaption from '@site/src/components/ImageCaptions/'; import ImageZoom from '@site/src/components/ImageZoom'; This introduction will walk you through Arbitrum Timeboost: a novel transaction ordering policy for Arbitrum chains that allows chain owners to capture the Maximal Extractable Value (MEV) on their chain and reduce spam, all while preserving fast block times and protecting users from harmful types of MEV, such as sandwich attacks and front-running. @@ -17,7 +19,7 @@ Timeboost is the culmination of over a year of research and development by the t ### In a nutshell - The current "First-Come, First-Serve (FCFS)" ordering policy has many benefits, including a great UX and protection from harmful types of MEV. However, nearly all MEV on the chain is extracted by searchers who invest wastefully in hardware and spamming to win latency races (which negatively strains the network and leads to congestion). Timeboost is a new transaction ordering policy that preserves many of the great benefits of FCFS while unlocking a path for chain owners to capture some of the available MEV on their network and introducing an auction to reduce latency, racing, and, ultimately, spam. -- Timeboost introduces a few new components to an Arbitrum chain's infrastructure: a sealed-bid second-price auction and a new "express lane" at an Arbitrum chain's sequencer. Valid transactions submitted to the express lane will be sequenced immediately with no delay, while all other transactions submitted to the chain's sequencer will experience a nominal delay (default: 200ms). The auction winner is granted the sole right to control the express lane for pre-defined, temporary intervals. The default block time for Arbitrum chains will continue to be industry-leading at 250ms, even with Timeboost enabled. What will change with Timeboost is that some transactions not in the express lane will be delayed to the next block. +- Timeboost introduces a few new components to an Arbitrum chain’s infrastructure: a sealed-bid second-price auction and a new "express lane" at an Arbitrum chain’s sequencer. Valid transactions submitted to the express lane will be sequenced immediately with no delay, while all other transactions submitted to the chain’s sequencer will experience a nominal delay (default: 200ms). The auction winner is granted the sole right to control the express lane for pre-defined, temporary intervals. The default block time for Arbitrum chains will continue to be industry-leading at 250ms, even with Timeboost enabled. What will change with Timeboost is that some transactions not in the express lane will be delayed to the next block. - Timeboost is an optional feature for Arbitrum chains aimed at two types of groups of entities: (1) chain owners and their ecosystems and (2) sophisticated on-chain actors and searchers. Chain owners can use Timeboost to capture additional revenue from the MEV their chain generates already, and sophisticated on-chain actors and searchers will spend their resources on buying rights for the express lane (instead of spending those resources on winning latency races, which otherwise leads to spam and congestion on the network). - Timeboost will work with both centralized and [decentralized sequencer setups](https://medium.com/@espressosys/espresso-systems-and-offchain-labs-publish-decentralized-timeboost-specification-b29ff20c5db8). The specification for a centralized sequencer is public ([here](https://github.com/OffchainLabs/timeboost-design)) and the [proposal before the Arbitrum DAO](https://forum.arbitrum.foundation/t/constitutional-aip-proposal-to-adopt-timeboost-a-new-transaction-ordering-policy/25167/1) allows us to deliver Timeboost to market sooner, rather than waiting until the design with a decentralized sequencer set up and its implementation are complete. @@ -43,53 +45,51 @@ Timeboost retains most FCFS benefits while addressing FCFS limitations. #### Timeboost may help reduce spam and congestion on a network -- By introducing the ability to "purchase a time advantage" through the Timeboost auction, it is expected that rational, profit-seeking actors will spend on auctions _instead of_ investing in hardware or infrastructure to win latency races. This diversion of resources by these actors is expected to reduce FCFS MEV-driven spam on the network. +- By introducing the ability to “purchase a time advantage” through the Timeboost auction, it is expected that rational, profit-seeking actors will spend on auctions _instead of_ investing in hardware or infrastructure to win latency races. This diversion of resources by these actors is expected to reduce FCFS MEV-driven spam on the network. ## What is Timeboost, and how does it work? Timeboost is a _transaction ordering policy_. It's a set of rules that the sequencer of an Arbitrum chain is trusted to follow when ordering transactions submitted by users. In the near future, multiple sequencers will be able to enforce those rules with decentralized Timeboost. -For Arbitrum chains, the sequencer's sole job is to take arriving, valid transactions from users, place them into an order dictated by the transaction ordering policy, and then publish the final sequence to a real-time feed and in compressed batches to the chain's data availability layer. The current transaction ordering policy is FCFS, and Timeboost is a modified FCFS ordering policy. +For Arbitrum chains, the sequencer’s sole job is to take arriving, valid transactions from users, place them into an order dictated by the transaction ordering policy, and then publish the final sequence to a real-time feed and in compressed batches to the chain’s data availability layer. The current transaction ordering policy is FCFS, and Timeboost is a modified FCFS ordering policy. Timeboost is implemented using three separate components that work together: -- **A special "express lane"** which allows valid transactions to be sequenced as soon as the sequencer receives them for a given round. +- **A special “express lane”** which allows valid transactions to be sequenced as soon as the sequencer receives them for a given round. - **An off-chain auction** to determine the controller of the express lane for a given round. This auction is managed by an autonomous auctioneer. - **An auction contract** deployed on the target chain to serve as the canonical source of truth for the auction results and handling of auction proceeds. -To start, the default duration of a round is 60 seconds. Transactions not in the express lane will be subject to a default 200-millisecond artificial delay to their arrival timestamp before their transaction is sequenced, which means that some non-express lane transactions may get delayed to the next block. It's important to note that the default Arbitrum block time will remain at 250 milliseconds (which can be adjusted to 100 milliseconds if desired). Let's dive into how each of these components works. +To start, the default duration of a round is 60 seconds. Transactions not in the express lane will be subject to a default 200-millisecond artificial delay to their arrival timestamp before their transaction is sequenced, which means that some non-express lane transactions may get delayed to the next block. It’s important to note that the default Arbitrum block time will remain at 250 milliseconds (which can be adjusted to 100 milliseconds if desired). Let’s dive into how each of these components works. ### The express lane -The express lane is implemented using a special endpoint on the sequencer, formally titled `timeboost_sendExpressLaneTransaction`. This endpoint is special because transactions submitted to it will be sequenced immediately by the sequencer, hence the name, express lane. The sequencer will only accept valid transaction payloads to this endpoint if they are correctly signed by the current round's express lane controller. Other transactions can still be submitted to the sequencer as normal, but these will be considered non-express lane transactions and will, therefore, have their arrival timestamp delayed by 200 milliseconds. It is important to note that transactions from both the express and non-express lanes are eventually sequenced into a single, ordered stream of transactions for node operators to produce an assertion and later post the data to a data availability layer. The express lane controller does _not_: +The express lane is implemented using a special endpoint on the sequencer, formally titled `timeboost_sendExpressLaneTransaction`. This endpoint is special because transactions submitted to it will be sequenced immediately by the sequencer, hence the name, express lane. The sequencer will only accept valid transaction payloads to this endpoint if they are correctly signed by the current round’s express lane controller. Other transactions can still be submitted to the sequencer as normal, but these will be considered non-express lane transactions and will, therefore, have their arrival timestamp delayed by 200 milliseconds. It is important to note that transactions from both the express and non-express lanes are eventually sequenced into a single, ordered stream of transactions for node operators to produce an assertion and later post the data to a data availability layer. The express lane controller does _not_: - Have the right to re-order transactions. -- Have a guarantee that their transactions will always be first at the "top-of-the-block." +- Have a guarantee that their transactions will always be first at the “top-of-the-block.” - Guarantee a profit at all. The value of the express lane will be the sum of how much MEV the express lane controller predicts they can extract during the upcoming round (i.e., MEV opportunity estimates made before the auction closes) _plus_ the amount of MEV extracted by the express lane controller while they are in control (that they otherwise did not predict). Understanding how the value of the express lane is determined can be useful for chain owners when adjusting to the artificial delay and the time before the auction closes. ### The Timeboost auction - - Control of the express lane in each round (default: 60 seconds) is determined by a per-round auction, which is a sealed-bid, second-price auction. This auction is held to determine the express lane controller for the next round. In other words, the express lane controller was determined at any point in time in the previous auction round. Bids for the auction can be made with any ERC20 token, in any amount, and be collected by any address - at the full discretion of the chain owner. -The auction for a round has a closing time that is `auctionClosingSeconds` (default: 15) seconds before the beginning of the round. This means that, in the default parameters, parties have 45 seconds to submit bids before the auction will no longer accept bids. In the 15 seconds between when bids are no longer accepted and when the new round begins, the autonomous auctioneer will verify all bids, determine the winner, and make a call to the on-chain auction contract to formally resolve the auction. +; + +The auction for a round has a closing time that is `auctionClosingSeconds` (default: 15) seconds before the beginning of the round. This means that, in the default parameters, parties have 45 seconds to submit bids before the auction will no longer accept bids. In the 15 seconds between when bids are no longer accepted and when the new round begins, the autonomous auctioneer will verify all bids, determine the winner, and make a call to the on-chain auction contract to formally resolve the auction. ### Auction contract Before placing a bid in the auction, a party must deposit funds into the Auction Contract. Deposits can be made, or funds can be added to an existing deposit at any time. These deposits are fully withdrawable, with some nominal delay (2 rounds or 2 minutes by default), so as not to impact the outcome of an existing round. There is no minimum deposit amount, but there is a starting minimum bid of 0.001 ETH (default amount and token) called the "minimum reserve price". The chain owner sets the minimum reserve price, which can be updated at any time up to 30 seconds (default) before the start of the next round to ensure the auction participants will always know the reserve price at least 30 seconds before they must submit their bids. A reserve price can also be set by the chain owner (or by an address designated by the chain owner) as a way to raise the minimum bid, as the Auction Contract enforces that the reserve price is never less than the minimum reserve price. -Once the autonomous auctioneer determines an auction winner, the auction contract will deduct the second-highest bid amount from the account of the highest bidder and transfer those funds to a `beneficiary` account designated by the chain owner by default. The `expressLaneControllerAddress` specified in the highest bid will become the express lane controller for the round. +Once the autonomous auctioneer determines an auction winner, the auction contract will deduct the second-highest bid amount from the account of the highest bidder and transfer those funds to a `beneficiary` account designated by the chain owner by default. The `expressLaneControllerAddress` specified in the highest bid will become the express lane controller for the round. ### Default parameters @@ -97,7 +97,7 @@ Below are a few of the default Timeboost parameters mentioned earlier. All these | Parameter name | Description | Recommended default value | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | -| `roundDurationSeconds` | Duration of time that the sequencer will honor the express lane privileges for transactions signed by the current round's express lane controller. | 60 seconds | +| `roundDurationSeconds` | Duration of time that the sequencer will honor the express lane privileges for transactions signed by the current round’s express lane controller. | 60 seconds | | `auctionClosingSeconds` | Time before the start of the next round. The autonomous auctioneer will not accept bids during this time interval. | 15 seconds | | `beneficiary` | Address where proceeds from the Timeboost auction are sent to when `flushBeneficiaryBalance()` gets called on the auction contract. | An address controlled by the chain's owner | | `_biddingToken` | Address of the token used to make bids in the Timeboost auction. It can be any ERC20 token (assuming the token address chosen does not have fee-on-transfer, rebasing, transfer hooks, or otherwise non-standard ERC20 logic). | WETH | @@ -107,9 +107,9 @@ Below are a few of the default Timeboost parameters mentioned earlier. All these ## Who is Timeboost for, and how do I use it? -Timeboost is an optional addition to an Arbitrum chain's infrastructure, meaning that enabling Timeboost is at the discretion of the chain owner and that an Arbitrum chain can fully function normally without Timeboost. +Timeboost is an optional addition to an Arbitrum chain’s infrastructure, meaning that enabling Timeboost is at the discretion of the chain owner and that an Arbitrum chain can fully function normally without Timeboost. -When enabled, Timeboost is meant to serve different groups of parties with varying degrees of impact and benefits. Let's go through them below: +When enabled, Timeboost is meant to serve different groups of parties with varying degrees of impact and benefits. Let’s go through them below: #### For regular users: @@ -121,17 +121,17 @@ Timeboost represents a unique way to accrue value to their token and generate re #### For searchers/arbitrageurs: -Timeboost adds a unique twist to your existing or prospective MEV strategies that may become more profitable than before. For instance, purchasing the time advantage offered by Timeboost's auction may end up costing _less_ than the costs to invest in hardware and win latency races. Another example is the potential new business model of reselling express lane rights to other parties in time slots or on a granular, per-transaction basis. +Timeboost adds a unique twist to your existing or prospective MEV strategies that may become more profitable than before. For instance, purchasing the time advantage offered by Timeboost’s auction may end up costing _less_ than the costs to invest in hardware and win latency races. Another example is the potential new business model of reselling express lane rights to other parties in time slots or on a granular, per-transaction basis. ### Special note on Timeboost for chain owners As with many new features and upgrades to Arbitrum Nitro, Timeboost is an optional feature that chain owners may choose to deploy and customize however they see fit. Deploying and enabling/disabling Timeboost on a live Arbitrum chain will not halt or impact the chain but will instead influence the chain's transaction ordering policy. An Arbitrum chain will, by default, fall back to FCFS if Timeboost is deployed but disabled or if there is no express lane controller for a given round. -It is recommended that Arbitrum teams holistically assess the applicability and use cases of Timeboost for their chain before deploying and enabling Timeboost. This is because some Arbitrum chains may not have that much MEV (e.g., arbitrage) to begin with. Furthermore, we recommend that Arbitrum chains start with the default parameters recommended by Offchain Labs and closely monitor the results and impacts on your chain's ecosystem over time before considering adjusting any of the parameters. +It is recommended that Arbitrum teams holistically assess the applicability and use cases of Timeboost for their chain before deploying and enabling Timeboost. This is because some Arbitrum chains may not have that much MEV (e.g., arbitrage) to begin with. Furthermore, we recommend that Arbitrum chains start with the default parameters recommended by Offchain Labs and closely monitor the results and impacts on your chain’s ecosystem over time before considering adjusting any of the parameters. ### Wen mainnet? -Timeboost's auction contract has completed a third-party audit and is rapidly approaching production readiness. Specifically for Arbitrum One and Arbitrum Nova, a [temperature check vote on Snapshot](https://snapshot.box/#/s:arbitrumfoundation.eth/proposal/0xffe9bb38228fdaf3d121140856fd2d51c2ca7f8e0d1021c07e791cebb541129a) has already passed and the AIP will move towards an on-chain Tally vote next hopefully before the end of Q1 2025. +Timeboost’s auction contract has completed a third-party audit and is rapidly approaching production readiness. Specifically for Arbitrum One and Arbitrum Nova, a [temperature check vote on Snapshot](https://snapshot.box/#/s:arbitrumfoundation.eth/proposal/0xffe9bb38228fdaf3d121140856fd2d51c2ca7f8e0d1021c07e791cebb541129a) has already passed and the AIP will move towards an on-chain Tally vote next hopefully before the end of Q1 2025. In the meantime, please read the following resources to learn more about Timeboost: diff --git a/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/fast-withdrawals.mdx b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/fast-withdrawals.mdx new file mode 100644 index 0000000000..3e0414932c --- /dev/null +++ b/arbitrum-docs/launch-orbit-chain/02-configure-your-chain/common-configurations/fast-withdrawals.mdx @@ -0,0 +1,202 @@ +--- +title: 'Enable fast withdrawals on your Orbit chain' +sidebar_label: 'Enable fast withdrawals' +description: 'Learn to deploy Fast Withdrawals' +author: coopermidroni, tucksondev +sme: tucksondev +user_story: As a current or prospective Orbit chain owner, I need to understand how to integrate with the Fast Withdrawal feature. +content_type: get-started +--- + +Optimistic Rollups must sustain a multi-day challenge period to allow time for fraud proofs. This delays finality for users and dApps, resulting in multi-day withdrawal times and cross-chain communication delays. + +Fast withdrawals is a new configuration allowing Orbit chains to achieve fast finality. When an Orbit chain operates on Fast Withdrawals, its transactions will be processed by a committee of validators. Transactions reaching a unanimous vote across the committee will be immediately confirmed. + +This will allow: + +- Setting up a withdrawal frequency of any time period (up to 15 minutes) +- Users' withdrawals confirmation on the parent chain at frequencies up to ~15 minutes +- Cross-chain dApps to read the finalized state at the same rate as the fast withdrawal frequency + +## Recommended configuration + +While any Orbit chain can adopt Fast Withdrawals, we only _recommend_ that fast withdrawals be adopted by AnyTrust chains with a minimum validator and DAC member requirement. We explain both these recommendations below: + +### Fast withdrawals for AnyTrust chains + +As AnyTrust chains are an optimum (an optimistic rollup using a separate data availability layer), AnyTrust chains are already placing a trust assumption on their Data Availability Committee (DAC) to provide the data needed for fraud proofs and recreating the chain. + +The optimal setup for an AnyTrust chain is to have all DAC members _also_ run validators as part of the fast withdrawals committee. This will leverage the existing trust assumption placed on the DAC operators such that **enabling fast withdrawals does not add any new trusted parties.** + +It is possible for an Orbit Rollup to adopt fast withdrawals. However, it would technically no longer be a Rollup as the minimum trust assumption will shift to the trust placed in the Fast Confirmations committee. + +### Minimum validator and DAC nodes + +We recommend that any Fast Withdrawals-enabled chain have at least three DAC members and three validators acting in the fast withdrawals committee. Given that fast withdrawals will enable confirmation of new Rollup state much faster than the usual 6.4-day challenge period (15 minutes for L2s and 15 seconds for L3s), it becomes even more important to have additional parties involved in validation to further reduce trust assumptions. This requirement can be be met with three total operators, who each run a single DAS node and a single validator. + +## Technical lower bound for fast withdrawals + +Once fast withdrawals is enabled, the committee will confirm transactions at the configured frequency. However, a higher network load can cause the fast withdrawals committee to experience slight delays from the configured rate. + +- For low-to-medium activity chains (< 1 Mgas/s), 15 seconds is considered to be the sustained lower bound for Fast Withdrawals. +- For chains with higher throughput (>1 Mgas/s), the practical lower bound for fast withdrawals is between 1-2 minutes. + +Chain owners and operators should be aware that the fast withdrawals committee may take longer to confirm new assertions under conditions with greater network load. This behavior is to be expected and does not interfere with the security or trust model of the fast withdrawals committee. + +## Practical lower bounds concerning parent chain finality + +While a fast withdrawals-enabled chain can be configured to finality in as little as 15 seconds, there are externalities on the parent chain and from cross-chain messaging layers that must be considered. + +For an Ethereum-based Layer-2, we recommend that the fast withdrawal frequency remain above 12.8 minutes, which is the time for Ethereum to achieve finality. For non-Ethereum L1s, we similarly recommend staying above the accepted finality threshold specific to that L1. + +For an Arbitrum One-based Layer-3, there are three tiers of finality to consider: + +1. Soft finality from the sequencer's confirmation of transaction inclusion (~250ms) +2. Safe finality from batch inclusion after Arbitrum One's assertion is included in an Ethereum block. +3. Hard finality after the Ethereum block containing Arbitrum One's batch is finalized on Ethereum (~15 minutes) + +Layer-3 Orbit chains can make their own determination about what level of finality to accept. We consider it safe to rely on soft finality, which would practically enable an Orbit chain to configure fast withdrawals down to 15 seconds. + +## Adoption instructions (example script) + +To enable the fast withdrawals feature, there are three actions to take: + +1. Make sure the chain is using nitro-contracts v2.1.0 or above +2. Activate the fast withdrawals feature +3. Upgrade the node software to nitro v3.1.2 or above + +### Upgrading to nitro-contracts v2.1.0 + +As mentioned above, the fast withdrawals feature is available for chains that are using nitro-contracts v2.1.0 or above, especially the `RollupAdminLogic` and the `RollupUserLogic` contracts. You can check what nitro-contracts version your chain is using by running the [orbit versioner script](https://github.com/OffchainLabs/orbit-actions/blob/main/README.md#check-version-and-upgrade-path). + +If your chain is not running with nitro-contracts v2.1.0 or above, you’ll need to perform an upgrade to enable this version. The [orbit versioner script](https://github.com/OffchainLabs/orbit-actions/blob/main/README.md#check-version-and-upgrade-path) will provide the upgrade paths needed to reach v2.1.0, but basically: + +- If the chain is running nitro-contracts v1.1.x, you need to [upgrade first to v1.2.1](https://github.com/OffchainLabs/orbit-actions/blob/main/scripts/foundry/contract-upgrades/1.2.1/README.md). +- If the chain is running nitro-contracts v1.2.1, you need to [upgrade to v2.1.0](https://github.com/OffchainLabs/orbit-actions/blob/main/scripts/foundry/contract-upgrades/2.1.0/README.md). + +Upgrading to the new nitro-contracts version also requires updating the node software. For v2.1.0, validator nodes and the batch poster node should run [nitro v3.1.2](https://github.com/OffchainLabs/nitro/releases/tag/v3.1.2) or above. + +Suppose you’re upgrading your nitro-contracts from v1.2.1 to v2.1.0 and using the standard WASM module root (without customizations). In that case, there are [action contracts available in the supported chains](https://github.com/OffchainLabs/orbit-actions/blob/main/scripts/foundry/contract-upgrades/2.1.0/README.md#deployed-instances). If you’re using a customized nitro software, with a different WASM module root, you can still deploy the action contract referencing your modified WASM module root (pre and post upgrade). + +### Activating fast withdrawals + +Once the chain runs nitro-contracts v2.1.0 or above, the new fast withdrawal parameters will be available in the `RollupAdminLogic` and the `RollupUserLogic` contracts. + +Both the Orbit SDK and the Orbit actions repository provide configurable scripts to activate and configure fast withdrawals on an AnyTrust chain. You can use either of those to activate the feature. Both scripts perform the same actions. + + + +**Orbit SDK script** + +The Orbit SDK provides an [example script](https://github.com/OffchainLabs/arbitrum-orbit-sdk/tree/main/examples/setup-fast-withdrawal) to set up a fast withdrawal committee by performing the following operations: + +1. Create a new n/n Safe wallet with the specified validators as signers +2. Add the specified validators to the Rollup validators allowlist +3. Set the new Safe wallet as the `anytrustFastConfirmer` in the Rollup contract +4. Set the new `minimumAssertionPeriod` if needed +5. Show how to configure the batch poster and validator nodes + +To configure the script, you need to specify the following environment variables: + +| Variable Name | Description | +| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CHAIN_OWNER_PRIVATE_KEY` | Private key of the account with executor privileges in the UpgradeExecutor admin contract for the chain. It will be the deployer of the multi-sig Safe wallet. | +| `PARENT_CHAIN_ID` | ChainId of the parent chain. | +| `ROLLUP_ADDRESS` | Address of the Rollup contract. | +| `FC_VALIDATORS` | Array of fast-withdrawal validators. They will be added as signers to the multisig Safe wallet and to the Rollup's validator allowlist. It is recommended that these are DAC members of the AnyTrust chain. | +| `MINIMUM_ASSERTION_PERIOD` | Optional parameter that defaults to 75 blocks (~15 minutes). Minimum number of blocks that have to pass in between assertions (measured in L1 blocks). | + +Finally, follow these steps to execute the script (from the `examples/setup-fast-withdrawal` folder): + +1. Install dependencies + +```shell +yarn install +``` + +2. Create a .env file and add the env vars + +```shell +cp .env.example .env +``` + +3. Run the script + +```shell +yarn run dev +``` + +**Orbit actions script** + +The Orbit actions repository also provides an [action script](https://github.com/OffchainLabs/orbit-actions/blob/main/scripts/foundry/fast-confirm/README.md) to activate fast withdrawals by performing the following operations: + +1. Make sure the "Validate fast confirmation" has not been enabled yet +2. Create a Safe contract for the fast confirmation committee +3. Set the Safe contract as the fast confirmer on the Rollup +4. Set the Safe contract as a validator on the Rollup +5. Set `setMinimumAssertionPeriod` to 1 block to allow more frequent assertion + +To configure the action script, you need to specify the following environment variables: + +| Variable Name | Description | +| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `UPGRADE_ACTION_ADDRESS` | Address of the upgrade action to execute. A standard version is deployed in all [supported chains](https://github.com/OffchainLabs/orbit-actions/blob/main/scripts/foundry/fast-confirm/README.md#deployed-instances). If you need to deploy your own action, execute the first step of [this process](https://github.com/OffchainLabs/orbit-actions/blob/main/scripts/foundry/fast-confirm/README.md#how-to-use-it). | +| `PARENT_UPGRADE_EXECUTOR_ADDRESS` | Private key of the account with executor privileges in the UpgradeExecutor admin contract on the parent chain. It will be the deployer of the multi-sig Safe wallet. | +| `PARENT_CHAIN_RPC` | RPC endpoint of the parent chain. | +| `ROLLUP` | Address of the Rollup contract. | +| `FAST_CONFIRM_COMMITTEE` | Comma-separated list of fast-withdrawal validators. They must be allowlisted validators in the Rollup contract. They will be added as signers to the multisig Safe wallet. It is recommended that these are DAC members of the AnyTrust chain. | + +Finally, follow these steps to execute the script (from the `scripts/foundry/fast-confirm` folder): + +1. Install dependencies + +```shell +yarn install +``` + +2. Create a .env file and add the env vars + +```shell +cp .env.example .env +``` + +3. Execute the action. The upgrade can be executed using  `cast`  CLI command ([cast is a part of the Foundry tools](https://book.getfoundry.sh/cast/)), using the owner account (the one with executor rights on parent chain `UpgradeExecutor`) to send the transaction: + +```shell +(export $(cat .env | xargs) && cast send $PARENT_UPGRADE_EXECUTOR_ADDRESS "execute(address, bytes)" $UPGRADE_ACTION_ADDRESS $(cast calldata "perform(address, address[])" $ROLLUP \[$FAST_CONFIRM_COMMITTEE\]) --rpc-url $PARENT_CHAIN_RPC --account EXECUTOR) +# use --account XXX / --private-key XXX / --interactive / --ledger to set the account to send the transaction from +``` + +**NOTE:** If you have a multisig as executor, you can use the following command to create the payload for calling into the `PARENT_UPGRADE_EXECUTOR`: + +```shell +(export $(cat .env | xargs) && cast calldata "execute(address, bytes)" $UPGRADE_ACTION_ADDRESS $(cast calldata "perform(address, address[])" $ROLLUP \[$FAST_CONFIRM_COMMITTEE\])) +``` + +### Configure fast withdrawal on nitro v3.1.2 or above + +To be able to use Fast Withdrawal on your chain, the batch poster and the validators of the chain need to be running [nitro v3.1.2](https://github.com/OffchainLabs/nitro/releases/tag/v3.1.2) or above. + +The following parameters need to be configured in those nodes. + +**Batch poster** + +| Option | Description | +| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--node.batch-poster.max-delay=0h15m0s` | Since batches need to be posted so validators can create and confirm assertions, the maximum delay should be set to an amount close to the `minimumAssertionPeriod` defined in the Rollup contract. Modify `0h15m0s` to the configured value. | + +**Validators** + +| Option | Description | +| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--node.staker.enable-fast-confirmation=true` | Enables fast withdrawals in the validator node | +| `--node.staker.make-assertion-interval=0h15m0s` | Since assertions need to be created for them to be confirmed, the minimum interval to create these assertions should be set to an amount close to the `minimumAssertionPeriod` defined in the Rollup contract. Modify `0h15m0s` to the configured value. | + +:::note + +Immediately after configuring fast withdrawals - your chain may not be operating fully at speed yet. This is because the validators have to work through the backlog of assertions which were not yet confirmed. You will see a series of NodeCreated and NodeConfirmed events. Once the backlog has been processed, your chain should operate fully at speed. + +::: diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000000..3c0cfbb0b6 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "arbitrum-docs", + "lockfileVersion": 3, + "requires": true, + "packages": {} +} diff --git a/stylus-by-example b/stylus-by-example index a4ea27d6d6..fc496b15f8 160000 --- a/stylus-by-example +++ b/stylus-by-example @@ -1 +1 @@ -Subproject commit a4ea27d6d6268d506e22e3c505d088763d03239f +Subproject commit fc496b15f89b5e4f3cb0a3a53f2889f6164b8aaf diff --git a/website/archive/bold/assets/9Pr_Image_1.png b/website/archive/bold/assets/9Pr_Image_1.png deleted file mode 100644 index 2d4e114bc9..0000000000 Binary files a/website/archive/bold/assets/9Pr_Image_1.png and /dev/null differ diff --git a/website/archive/bold/assets/BnF_Image_3.png b/website/archive/bold/assets/BnF_Image_3.png deleted file mode 100644 index 06eb4a6975..0000000000 Binary files a/website/archive/bold/assets/BnF_Image_3.png and /dev/null differ diff --git a/website/archive/bold/assets/CRA_Image_4.png b/website/archive/bold/assets/CRA_Image_4.png deleted file mode 100644 index 3f85ca7f7a..0000000000 Binary files a/website/archive/bold/assets/CRA_Image_4.png and /dev/null differ diff --git a/website/archive/bold/assets/csI_Image_2.png b/website/archive/bold/assets/csI_Image_2.png deleted file mode 100644 index 1ec2695c33..0000000000 Binary files a/website/archive/bold/assets/csI_Image_2.png and /dev/null differ diff --git a/website/archive/build-decentralized-apps/metamask-connect-to-arb-sepolia-2025-01-12.gif b/website/archive/build-decentralized-apps/metamask-connect-to-arb-sepolia-2025-01-12.gif deleted file mode 100644 index b472952783..0000000000 Binary files a/website/archive/build-decentralized-apps/metamask-connect-to-arb-sepolia-2025-01-12.gif and /dev/null differ diff --git a/website/archive/build-decentralized-apps/metamask-quickstart-localhost.png b/website/archive/build-decentralized-apps/metamask-quickstart-localhost.png deleted file mode 100644 index 1fdaef7111..0000000000 Binary files a/website/archive/build-decentralized-apps/metamask-quickstart-localhost.png and /dev/null differ diff --git a/website/archive/build-decentralized-apps/quickstart-localhost-metamask.png b/website/archive/build-decentralized-apps/quickstart-localhost-metamask.png deleted file mode 100644 index 1fdaef7111..0000000000 Binary files a/website/archive/build-decentralized-apps/quickstart-localhost-metamask.png and /dev/null differ diff --git a/website/archive/build-decentralized-apps/remix-metamask-deploy-to-anvil-2025-01-13.gif b/website/archive/build-decentralized-apps/remix-metamask-deploy-to-anvil-2025-01-13.gif deleted file mode 100644 index 4deeb31b70..0000000000 Binary files a/website/archive/build-decentralized-apps/remix-metamask-deploy-to-anvil-2025-01-13.gif and /dev/null differ diff --git a/website/archive/how-arbitrum-works/assertionTree.png b/website/archive/how-arbitrum-works/assertionTree.png deleted file mode 100644 index cbed9fdf50..0000000000 Binary files a/website/archive/how-arbitrum-works/assertionTree.png and /dev/null differ diff --git a/website/archive/how-arbitrum-works/seq-then-exec.png b/website/archive/how-arbitrum-works/seq-then-exec.png deleted file mode 100644 index 4e043c12ae..0000000000 Binary files a/website/archive/how-arbitrum-works/seq-then-exec.png and /dev/null differ diff --git a/website/archive/orbit/assets/orbit_bridge.png b/website/archive/orbit/assets/orbit_bridge.png deleted file mode 100644 index 133de0d5f1..0000000000 Binary files a/website/archive/orbit/assets/orbit_bridge.png and /dev/null differ diff --git a/website/archive/stylus/assets/cargo-stylus.png b/website/archive/stylus/assets/cargo-stylus.png deleted file mode 100644 index f96d856731..0000000000 Binary files a/website/archive/stylus/assets/cargo-stylus.png and /dev/null differ diff --git a/website/archive/stylus/assets/stylus-wallet.png b/website/archive/stylus/assets/stylus-wallet.png deleted file mode 100644 index 319a3b2bc3..0000000000 Binary files a/website/archive/stylus/assets/stylus-wallet.png and /dev/null differ diff --git a/website/package.json b/website/package.json index aa61f75710..5d0ba6b766 100644 --- a/website/package.json +++ b/website/package.json @@ -28,13 +28,17 @@ "dependencies": { "@arbitrum/sdk": "^3.0.0", "@cmfcmf/docusaurus-search-local": "^0.11.0", + "@mdx-js/react": "^3.0.0", "@docusaurus/core": "^3.6.3", "@docusaurus/preset-classic": "^3.6.3", "@docusaurus/theme-live-codeblock": "^3.6.3", "@docusaurus/theme-mermaid": "^3.6.3", - "@radix-ui/react-dialog": "^1.1.6", - "@react-spring/web": "^9.7.5", - "@types/styled-components": "^5.1.34", + "@radix-ui/react-dialog": "^1.0.5", + "@react-spring/web": "^9.7.3", + "@types/mdx": "^2.0.11", + "@types/prismjs": "^1.26.5", + "@types/react": "^18.2.55", + "@types/react-syntax-highlighter": "^15.5.13", "classnames": "^2.5.1", "clsx": "^1.2.1", "docusaurus-lunr-search": "^3.3.2", @@ -45,22 +49,26 @@ "posthog-docusaurus": "^2.0.0", "posthog-js": "^1.219.6", "prism-react-renderer": "^1.3.5", + "prismjs": "^1.29.0", "react": "^18.2.0", "react-dom": "^18.2.0", + "react-syntax-highlighter": "^15.6.1", "sass": "^1.66.1", - "styled-components": "^6.1.15", "tippy.js": "^6.3.7", "trim": "0.0.3" }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.3.2", "@offchainlabs/prettier-config": "0.2.1", + "@stitches/react": "^1.2.8", "@tsconfig/docusaurus": "^2.0.3", "@types/node": "^22.10.10", + "@types/react": "^19.0.10", "docusaurus-plugin-typedoc": "^1.0.1", "husky": "^9.1.7", "markdown-link-extractor": "^3.1.0", "prettier": "^2.8.3", + "styled-components": "^6.1.15", "ts-node": "^10.9.1", "typedoc": "^0.25.13", "typedoc-plugin-frontmatter": "^1.0.0", diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/ButtonComponent.jsx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/ButtonComponent.jsx new file mode 100644 index 0000000000..891c43c553 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/ButtonComponent.jsx @@ -0,0 +1,48 @@ +import * as React from 'react'; + +const ButtonComponent = ({ x, y, width, height }) => { + const [isHovered, setIsHovered] = React.useState(false); + + return ( + setIsHovered(true)} + onMouseLeave={() => setIsHovered(false)} + > + Interactive Button + + + + ); +}; + +export default ButtonComponent; diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/Modal.tsx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/Modal.tsx new file mode 100644 index 0000000000..c48a11b2a7 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/Modal.tsx @@ -0,0 +1,157 @@ +import React, { useState, useEffect } from 'react'; +import { useTransition, animated } from '@react-spring/web'; +import * as Dialog from '@radix-ui/react-dialog'; +import step1Content from './modal-centralized-auction-step-1.mdx'; +import step2Content from './modal-centralized-auction-step-2.mdx'; +import step3Content from './modal-centralized-auction-step-3.mdx'; +import step4Content from './modal-centralized-auction-step-4.mdx'; +import step5Content from './modal-centralized-auction-step-5.mdx'; +import { createPortal } from 'react-dom'; +import { NumberComponent } from './NumberComponent'; +import { MDXProvider } from '@mdx-js/react'; +import type { MDXComponents } from '@mdx-js/react/lib'; +import { PrismLight as SyntaxHighlighter } from 'react-syntax-highlighter'; +import { oneDark, oneLight } from 'react-syntax-highlighter/dist/cjs/styles/prism'; +import javascript from 'react-syntax-highlighter/dist/cjs/languages/prism/javascript'; +import solidity from 'react-syntax-highlighter/dist/cjs/languages/prism/solidity'; +import { useColorMode } from '@docusaurus/theme-common'; + +// Define the CodeBlock interface +interface CodeBlock { + language: string; + code: string; +} + +SyntaxHighlighter.registerLanguage('javascript', javascript); +SyntaxHighlighter.registerLanguage('solidity', solidity); + +const components = { + h1: ({ children }) =>

{children}

, + p: ({ children }) =>

{children}

, + ol: ({ children }) =>
    {children}
, + li: ({ children }) =>
  • {children}
    • , + pre: ({ children }) => children, + code: ({ children, className }) => { + const language = className?.replace('language-', '') || 'text'; + return ( + + {children} + + ); + }, +}; + +export function Modal({ number }: { number: number }) { + const [isOpen, setIsOpen] = useState(false); + const { isDarkTheme } = useColorMode(); + const stepContent = { + 1: step1Content, + 2: step2Content, + 3: step3Content, + 4: step4Content, + 5: step5Content, + }; + const StepContent = stepContent[number]; + + const transitions = useTransition(isOpen, { + from: { opacity: 0, transform: 'scale(0.95)' }, + enter: { opacity: 1, transform: 'scale(1)' }, + leave: { opacity: 0, transform: 'scale(0.95)' }, + config: { tension: 300, friction: 20 }, + }); + + const overlayTransitions = useTransition(isOpen, { + from: { opacity: 0 }, + enter: { opacity: 1 }, + leave: { opacity: 0 }, + config: { duration: 200 }, + }); + + const renderCodeBlock = (block: CodeBlock, index: number) => ( +
    + + {block.code.trim()} + +
    + ); + + return ( + <> + setIsOpen(true)} + style={{ + cursor: 'pointer', + pointerEvents: 'all', + }} + > + + + {typeof document !== 'undefined' && + createPortal( + + + {overlayTransitions( + (styles, item) => + item && , + )} + {transitions( + (styles, item) => + item && ( +
    + +
    + setIsOpen(false)} + > + + +
    + + + +     +
    + ), + )} +     +     , + document.body, + )} + + ); +} + +const CloseIcon = () => ( + + + +); diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/NumberComponent.jsx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/NumberComponent.jsx new file mode 100644 index 0000000000..bd3526a67e --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/NumberComponent.jsx @@ -0,0 +1,67 @@ +import * as React from 'react'; +import { useSpring, animated } from '@react-spring/web'; +import { useColorMode } from '@docusaurus/theme-common'; +import '@site/src/css/custom.css'; +import ButtonComponent from './ButtonComponent'; +import { CIRCLE_RADIUS, numberPaths, coordinates } from './constants'; +import { NumberComponentProps } from './types'; + +export const NumberComponent = ({ number }) => { + const { isDarkTheme } = useColorMode(); + + const animationProps = + number === 1 || number === 5 + ? { opacity: 1 } + : useSpring({ + from: { opacity: 0, fill: '#ff7f2a' }, + to: [ + { opacity: 1, fill: '#ff7f2a' }, + { opacity: 1, fill: '#3578e5' }, + { opacity: 0, fill: '#3578e5' } + ], + config: { tension: 20000, friction: 10 }, + loop: true, + reset: true, + immediate: false, + }); + + const coords = coordinates[number]; + const pathData = numberPaths[number]; + + if (!coords || !pathData) { + return null; + } + + const offsetX = coords.circle.x - coords.path.x + (coords.offset?.x || 0); + const offsetY = coords.circle.y - coords.path.y + (coords.offset?.y || 0); + + const circleClassName = isDarkTheme ? 'cls-5' : 'cls-5-light'; + const pathClassName = isDarkTheme ? 'cls-10' : 'cls-10-light'; + + return ( + + {(number === 2 || number === 3 || number === 4) && ( + + )} + + + + ); +}; diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/constants.ts b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/constants.ts new file mode 100644 index 0000000000..e8d3d2532f --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/constants.ts @@ -0,0 +1,17 @@ +export const CIRCLE_RADIUS = 20.95; + +export const numberPaths = { + 1: 'M412.16 410.7v-3.06c2.5 0 3.66-.47 4.05-2.65h3.99v14.72h-4.35v-9.01h-3.68Z', + 2: 'M583.04 633.46c.8-1.14 1.46-1.64 3.86-2.91 2.09-1.12 2.61-1.64 2.61-2.61 0-.84-.54-1.36-1.38-1.36-1.06 0-1.57.67-1.64 2.11h-4.42c0-3.25 2.35-5.21 6.25-5.21 3.36 0 5.62 1.68 5.62 4.18 0 2.11-.99 3.55-3.34 4.78l-.78.41c-2.05 1.08-2.67 1.55-2.84 2.48.73-.06 1.42-.11 2.2-.11h5.17v3.3h-12.52c0-2.46.37-3.86 1.21-5.06Z', + 3: 'M586.28 781.21c1.06 0 1.72-.62 1.72-1.53 0-1.03-.67-1.59-2.15-1.59h-.6v-3.21h.47c1.49 0 2.05-.52 2.05-1.57 0-.82-.67-1.42-1.62-1.42-1.12 0-1.75.78-1.77 2.05h-4.29c.09-3.19 2.31-5.11 6.14-5.11s5.88 1.57 5.88 4.07c0 1.7-.91 2.93-2.76 3.34v.11c2 .39 3.02 1.64 3.02 3.51 0 2.71-2.28 4.42-6.23 4.42-3.51 0-6.23-1.42-6.23-5.3h4.35c.06 1.42.78 2.24 2 2.24Z', + 4: 'M1048.97 602.13v-3.3l5.49-8.55h5.54v8.66h2.13v3.19H1060V605h-4.24v-2.87h-6.79Zm3.53-3.19h3.45c0-1.7 0-3.38.22-5.52l-.19-.06-3.47 5.58Z', + 5: 'M1003.53 257.43c1.01 0 1.7-.97 1.7-2.18s-.67-2.05-1.75-2.05c-.82 0-1.36.52-1.7 1.31l-4.27-.3.86-8.73h10.43v3.3h-4.42c-.78 0-1.75-.02-2.52-.11-.09.8-.15 1.96-.45 2.76h.17c.69-.78 1.77-1.16 3.12-1.16 2.93 0 5.08 2.11 5.08 4.96 0 3.21-2.46 5.34-6.23 5.34s-6.18-1.92-6.31-4.8h4.52c.06 1.01.73 1.66 1.75 1.66Z', +}; + +export const coordinates = { + 1: { circle: { x: 416.59, y: 412.69 }, path: { x: 412.16, y: 410.7 }, offset: { x: -4, y: -2 } }, + 2: { circle: { x: 588.13, y: 631.51 }, path: { x: 583.04, y: 633.46 }, offset: { x: -4, y: 1 } }, + 3: { circle: { x: 586.23, y: 776.88 }, path: { x: 586.28, y: 781.21 }, offset: { x: 1, y: 4 } }, + 4: { circle: { x: 1055.6, y: 597.98 }, path: { x: 1048.97, y: 602.13 }, offset: { x: -6, y: 3 } }, + 5: { circle: { x: 1003.53, y: 257.43 }, path: { x: 1003.53, y: 257.43 }, offset: { x: 1, y: 4 } }, +}; diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/index.jsx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/index.jsx new file mode 100644 index 0000000000..7cab7f1ff9 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/index.jsx @@ -0,0 +1,2332 @@ +import * as React from 'react'; +import { Modal } from './Modal'; +import { NumberComponent } from './NumberComponent'; + +export default function CentralizedAuction() { + return ; +} + +export const FlowChart = (props) => ( + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +); diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-1.mdx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-1.mdx new file mode 100644 index 0000000000..e8a37c55b8 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-1.mdx @@ -0,0 +1,11 @@ +# Step 1: Deposit funds into the auction contract + +Users must first deposit ERC-20 tokens into the auction contract to participate in bidding. + +1. Call `submitDeposit()` on the IExpressLaneAuction contract +2. The contract emits a DepositSubmitted event with the bidder's address and amount +3. Funds are now available for bidding in future auction rounds + +```solidity +function submitDeposit(uint256 amount) external; +``` diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-2.mdx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-2.mdx new file mode 100644 index 0000000000..1474ba741d --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-2.mdx @@ -0,0 +1,18 @@ +# Step 2: `timeboost_submitBid()` + +Users submit bids through the auctioneer's RPC API for the upcoming round. + +1. Create a bid with chain ID, round number, and bid amount +2. Sign the bid data with your private key +3. Submit the bid via timeboost_submitBid RPC method + +```javascript +{ + chain_id: "uint64", + address: "0x...", + round: "uint64", + amount: "uint256", + signature: "0x..." +} +``` +[Read comprehensive explanation](https://docs.arbitrum.io/run-arbitrum-node/how-to-use-timeboost#step-2-submit-bids) diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-3.mdx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-3.mdx new file mode 100644 index 0000000000..cfc88c628f --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-3.mdx @@ -0,0 +1,16 @@ +# Step 3: Auctioneer Response + +The auctioneer validates the bid and responds with success or failure. + +1. Auctioneer verifies chain ID, round number, and signature +2. Checks if sender is a depositor with sufficient balance +3. Returns status OK or an error code if validation fails + +```javascript +{ + status: "OK" | "ERROR", + error?: "MALFORMED_DATA" | "NOT_DEPOSITOR" | "WRONG_CHAIN_ID" | "WRONG_SIGNATURE" | "BAD_ROUND_NUMBER" | "INSUFFICIENT_BALANCE" +} +``` + +[Read comprehensive explanation](https://docs.arbitrum.io/run-arbitrum-node/how-to-use-timeboost#step-3-find-out-the-winner-of-the-auction) diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-4.mdx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-4.mdx new file mode 100644 index 0000000000..45bfb52966 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-4.mdx @@ -0,0 +1,11 @@ +# Step 4: `auctioneer_submitBidAuctionTransaction` + +The auctioneer submits the winning bids to resolve the auction. + +1. Auctioneer collects and sorts all valid bids for the round +2. Identifies the two highest bids +3. Calls resolveAuction() with the winning bids + +```solidity +function resolveAuction(Bid calldata bid1, Bid calldata bid2) external; +``` diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-5.mdx b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-5.mdx new file mode 100644 index 0000000000..2415d986c8 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/modal-centralized-auction-step-5.mdx @@ -0,0 +1,17 @@ +# Step 5: Sequencer prioritizes the auction contract calls + +The sequencer ensures timely processing of auction-related transactions. + +1. Auction resolution transactions get priority processing +2. Winner is declared as express lane controller for the round +3. Second-highest bid amount is deducted from winner's balance +4. AuctionResolved event is emitted with the results + +```solidity +event AuctionResolved( + uint256 winningBidAmount, + uint256 loserBidAmount, + address indexed winningBidder, + uint256 indexed winnerRound +); +``` diff --git a/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/types.ts b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/types.ts new file mode 100644 index 0000000000..f0b8f3d581 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/Timeboost/CentralizedAuction/types.ts @@ -0,0 +1,25 @@ +export interface Coordinates { + circle: { + x: number; + y: number; + }; + path: { + x: number; + y: number; + }; + offset: { + x: number; + y: number; + }; +} + +export interface NumberComponentProps { + number: 1 | 2 | 3 | 4 | 5; +} + +export interface ButtonComponentProps { + x: number; + y: number; + width: number; + height: number; +} diff --git a/website/src/components/InteractiveDiagrams/index.js b/website/src/components/InteractiveDiagrams/index.js new file mode 100644 index 0000000000..137107b7b0 --- /dev/null +++ b/website/src/components/InteractiveDiagrams/index.js @@ -0,0 +1,15 @@ +import React from 'react'; +import CentralizedAuction from './Timeboost/CentralizedAuction'; + +interface InteractiveDiagramsProps { + type: string; +} + +export default function InteractiveDiagrams({ type }: InteractiveDiagramsProps): JSX.Element { + switch (type) { + case 'timeboost-auction': + return ; + default: + return
    Unknown diagram type: {type}
    ; + } +} diff --git a/website/src/css/custom.css b/website/src/css/custom.css new file mode 100644 index 0000000000..6795efc279 --- /dev/null +++ b/website/src/css/custom.css @@ -0,0 +1,79 @@ +/* Centralized Auction Diagram styles */ +.cls-5 { + fill: #e30663; +} + +.cls-5-light { + fill: #ff4081; +} + +.cls-10 { + fill: #fff; +} + +.cls-10-light { + fill: #000; +} + +/* ImageZoom Component styles */ +.image-zoom__modal { + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + background: transparent; + display: flex; + align-items: center; + justify-content: center; + z-index: 1000; +} + +.image-zoom__container { + position: relative; + max-width: 90vw; + max-height: 90vh; + display: flex; + align-items: center; + justify-content: center; +} + +.image-zoom__image { + max-width: 90vw; + max-height: 90vh; + object-fit: contain; +} + +.image-zoom__close { + position: absolute; + top: 50%; + left: 50%; + transform: translate(-50%, -50%); + background: transparent; + border: none; + color: white; + font-size: 24px; + cursor: pointer; + padding: 8px; + z-index: 1001; +} + +.image-zoom__close:hover { + opacity: 0.8; +} + +.image-zoom__loading { + color: white; + font-size: 18px; + padding: 20px; +} + +/* Image width presets */ +.img-20px { width: 20px; } +.img-50px { width: 50px; } +.img-100px { width: 100px; } +.img-200px { width: 200px; } +.img-400px { width: 400px; } +.img-500px { width: 500px; } +.img-600px { width: 600px; } +.img-900px { width: 900px; } diff --git a/website/src/css/custom.scss b/website/src/css/custom.scss index 202d680a33..35cd8c2023 100644 --- a/website/src/css/custom.scss +++ b/website/src/css/custom.scss @@ -11,3 +11,60 @@ @use './partials/_sidebar.scss'; @use './partials/_footer.scss'; @use './partials/_navbar.scss'; +@use './partials/_modal.scss'; + +@keyframes blink { + 0% { + opacity: 1; + } + 50% { + opacity: 0.4; + } + 100% { + opacity: 1; + } +} + +/* Number component styles */ +.number-component { + cursor: pointer; + + &__circle { + transition: fill 0.3s ease; + + &:hover { + fill: #ff9f5a; + } + } + + &__text { + pointer-events: none; + } +} + +@keyframes pulse { + 0% { + transform: scale(1); + opacity: 1; + } + 50% { + transform: scale(1.1); + opacity: 0.7; + } + 100% { + transform: scale(1); + opacity: 1; + } +} + +.pulse { + animation: pulse 2s infinite ease-in-out; +} + +/* Interactive diagram specific styles */ +.interactive-diagram { + width: 100%; + max-width: 1200px; + margin: 0 auto; + position: relative; +} diff --git a/website/src/css/partials/_content-body.scss b/website/src/css/partials/_content-body.scss index 277a588b91..14c3315802 100644 --- a/website/src/css/partials/_content-body.scss +++ b/website/src/css/partials/_content-body.scss @@ -98,6 +98,96 @@ article { width: 900px; } + img { + transition: transform 0.3s ease-in-out; + + &[role='button'] { + cursor: zoom-in; + &:hover { + transform: scale(1.02); + } + } + } + + .image-zoom { + &__modal { + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + background: rgba(0, 0, 0, 0.9); + display: flex; + align-items: center; + justify-content: center; + z-index: 99999; + animation: fadeIn 0.2s ease-in-out; + } + + &__container { + position: relative; + display: flex; + align-items: center; + justify-content: center; + width: 100vw; + height: 100vh; + box-sizing: border-box; + } + + &__image { + max-width: 90%; + max-height: 90vh; + object-fit: contain; + cursor: zoom-out; + animation: zoomIn 0.3s ease-in-out forwards; + will-change: transform; + } + + &__close { + position: fixed; + top: 20px; + right: 20px; + background: none; + border: none; + color: white; + font-size: 24px; + cursor: pointer; + padding: 8px; + z-index: 100000; + opacity: 0.8; + transition: opacity 0.2s ease; + + &:hover { + opacity: 1; + } + } + + &__loading { + color: white; + font-size: 16px; + } + } + + @keyframes fadeIn { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + + @keyframes zoomIn { + from { + opacity: 0; + transform: scale(0.5); + } + to { + opacity: 1; + transform: scale(1.2); + } + } + .theme-admonition { margin-bottom: 2em; @@ -148,31 +238,6 @@ article { border-radius: 3px; background-color: rgba(150, 150, 150, 0.2); } - - .img-20px { - width: 20px; - } - .img-50px { - width: 50px; - } - .img-100px { - width: 100px; - } - .img-200px { - width: 200px; - } - .img-400px { - width: 400px; - } - .img-500px { - width: 500px; - } - .img-600px { - width: 600px; - } - .img-900px { - width: 900px; - } } } diff --git a/website/src/css/partials/_modal.scss b/website/src/css/partials/_modal.scss new file mode 100644 index 0000000000..23d5a6a5df --- /dev/null +++ b/website/src/css/partials/_modal.scss @@ -0,0 +1,79 @@ +.modal { + &__overlay { + width: 100vw; + height: 100vh; + background-color: rgba(0, 0, 0, 0.75); + position: fixed; + inset: 0; + z-index: 9999; + } + + &__content { + position: relative; + width: 100%; + max-width: 800px; + min-height: 200px; + max-height: calc(100vh - 40px); + background-color: var(--ifm-background-surface-color); + border-radius: 4px; + padding: 24px; + display: flex; + flex-direction: column; + color: var(--ifm-font-color-base); + box-shadow: 0 4px 6px -1px rgb(0 0 0 / 0.1), 0 2px 4px -2px rgb(0 0 0 / 0.1); + overflow: hidden; + will-change: transform, opacity; + + @media (max-width: 768px) { + padding: 16px; + } + } + + &__header { + display: flex; + justify-content: flex-end; + margin-bottom: 16px; + flex-shrink: 0; + } + + &__close-button { + background-color: transparent; + border: none; + position: absolute; + top: 16px; + right: 16px; + cursor: pointer; + color: var(--ifm-color-emphasis-600); + + &:hover { + color: var(--ifm-color-emphasis-900); + } + } + + &__title { + font-size: 20px; + margin-bottom: 16px; + padding-right: 24px; + flex-shrink: 0; + color: var(--ifm-heading-color); + + @media (max-width: 768px) { + font-size: 18px; + margin-bottom: 12px; + } + } + + &__container { + position: fixed; + top: 0; + left: 0; + right: 0; + bottom: 0; + display: flex; + align-items: center; + justify-content: center; + padding: 20px; + z-index: 10000; + pointer-events: none; + } +} diff --git a/website/src/css/partials/_number-component.scss b/website/src/css/partials/_number-component.scss new file mode 100644 index 0000000000..5320e4fd8f --- /dev/null +++ b/website/src/css/partials/_number-component.scss @@ -0,0 +1,45 @@ +:export { + cls5: cls-5; + cls5Light: cls-5-light; + cls10: cls-10; + cls10Light: cls-10-light; + blinking: blinking; +} + +.cls-5 { + r: 20.95px; + transition: opacity 0.3s ease; + fill: #ff7f2a; +} + +.cls-5-light { + r: 20.95px; + transition: opacity 0.3s ease; + fill: #ff7f2a; +} + +.cls-10 { + fill: #fff; + transition: fill 0.3s ease; +} + +.cls-10-light { + fill: #000; + transition: fill 0.3s ease; +} + +@keyframes blink { + 0% { + opacity: 1; + } + 50% { + opacity: 0.4; + } + 100% { + opacity: 1; + } +} + +.blinking { + animation: blink 2s ease-in-out infinite; +} diff --git a/website/src/scripts/contentStructure.txt b/website/src/scripts/contentStructure.txt deleted file mode 100644 index e144a45a60..0000000000 --- a/website/src/scripts/contentStructure.txt +++ /dev/null @@ -1,254 +0,0 @@ -|------ buildDecentralizedAppsSidebar -|--------------------- Welcome -|------------------------------------ A gentle introduction -|------------------------------------ Get started -|------------------------------------ Chain info -|--------------------- Build decentralized apps -|------------------------------------ Quickstart (Solidity) -|------------------------------------ Estimate gas -|------------------------------------ Chains and testnets -|------------------------------------ Cross-chain messaging -|------------------------------------ Arbitrum vs Ethereum -|--------------------------------------------------- Comparison overview -|--------------------------------------------------- Block gas limit, numbers and time -|--------------------------------------------------- RPC methods -|--------------------------------------------------- Solidity support -|------------------------------------ Oracles -|------------------------------------ Precompiles -|--------------------------------------------------- Overview -|--------------------------------------------------- Reference -|------------------------------------ NodeInterface -|--------------------------------------------------- Overview -|--------------------------------------------------- Reference -|------------------------------------ Token bridging -|--------------------------------------------------- Overview -|--------------------------------------------------- ETH bridging -|--------------------------------------------------- ERC-20 token bridging -|--------------------------------------------------- Bridge tokens programmatically -|------------------------------------------------------------------ Get started -|------------------------------------------------------------------ Use the standard gateway -|------------------------------------------------------------------ Use the generic-custom gateway -|------------------------------------------------------------------ Use the custom gateway -|------------------------------------ Reference -|--------------------------------------------------- RPC endpoints and providers -|--------------------------------------------------- Smart contract addresses -|--------------------------------------------------- Chain parameters -|--------------------------------------------------- Development frameworks -|--------------------------------------------------- Web3 libraries and tools -|--------------------------------------------------- Monitoring tools and block explorers -|--------------------------------------------------- Debugging tools -|--------------------------------------------------- Mainnet risks -|------------------------------------ Troubleshooting -|------------------------------------ Arbitrum SDK -|--------------------------------------------------- Introduction -|--------------------------------------------------- Migrating from v3 to v4 -|--------------------------------------------------- Reference -|------------------------------------------------------------------ Index -|------------------------------------------------------------------ AssetBridger -|--------------------------------------------------------------------------------- AssetBridger -|--------------------------------------------------------------------------------- Erc20Bridger -|--------------------------------------------------------------------------------- EthBridger -|--------------------------------------------------------------------------------- L1l3Bridger -|------------------------------------------------------------------ DataEntities -|--------------------------------------------------------------------------------- Address -|--------------------------------------------------------------------------------- Constants -|--------------------------------------------------------------------------------- Errors -|--------------------------------------------------------------------------------- Event -|--------------------------------------------------------------------------------- Message -|--------------------------------------------------------------------------------- Networks -|--------------------------------------------------------------------------------- RetryableData -|--------------------------------------------------------------------------------- Rpc -|--------------------------------------------------------------------------------- SignerOrProvider -|--------------------------------------------------------------------------------- TransactionRequest -|------------------------------------------------------------------ Inbox -|--------------------------------------------------------------------------------- Inbox -|------------------------------------------------------------------ Message -|--------------------------------------------------------------------------------- ChildToParentMessage -|--------------------------------------------------------------------------------- ChildToParentMessageClassic -|--------------------------------------------------------------------------------- ChildToParentMessageNitro -|--------------------------------------------------------------------------------- ChildTransaction -|--------------------------------------------------------------------------------- ParentToChildMessage -|--------------------------------------------------------------------------------- ParentToChildMessageCreator -|--------------------------------------------------------------------------------- ParentToChildMessageGasEstimator -|--------------------------------------------------------------------------------- ParentTransaction -|------------------------------------------------------------------ Utils -|--------------------------------------------------------------------------------- ArbProvider -|--------------------------------------------------------------------------------- Byte_serialize_params -|--------------------------------------------------------------------------------- EventFetcher -|--------------------------------------------------------------------------------- Lib -|--------------------------------------------------------------------------------- Multicall -|--------------------------------------------------------------------------------- Types -|------------------------------------ Tutorials -|------------------------------------ Tutorials (https://github.com/OffchainLabs/arbitrum-tutorials) -|--------------------- Run an Orbit chain -|------------------------------------ A gentle introduction -|------------------------------------ Quickstart -|------------------------------------ Orbit licensing -|------------------------------------ Guidance for Orbit chain operators -|--------------------------------------------------- Manage gas state growth -|--------------------------------------------------- Manage gas speed limit -|------------------------------------ Production Orbit chain setup -|--------------------------------------------------- Introduction -|--------------------------------------------------- Rollup Orbit Deployment -|--------------------------------------------------- AnyTrust Orbit Deployment -|--------------------------------------------------- Custom Gas Token Orbit Deployment -|--------------------------------------------------- Node Config Generation -|--------------------------------------------------- Token bridge deployment -|--------------------------------------------------- Orbit Chain Configuration -|------------------------------------ Customize your chain -|--------------------------------------------------- Customize your chain's deployment -|--------------------------------------------------- Additional configuration parameters -|--------------------------------------------------- Use a custom gas token -|--------------------------------------------------- Customize your chain's precompiles -|--------------------------------------------------- Customize your chain's behavior -|--------------------------------------------------- Configure delayed inbox finality -|--------------------------------------------------- Manage the fee collectors -|--------------------------------------------------- Customize ArbOS version -|--------------------------------------------------- Implement Circle bridged USDC -|--------------------------------------------------- Enable fast withdrawals -|--------------------------------------------------- AEP fee router -|------------------------------------------------------------------ AEP fee router overview -|------------------------------------------------------------------ Set up AEP fee router -|------------------------------------------------------------------ Calculate AEP license fees -|------------------------------------ ArbOS -|--------------------------------------------------- ArbOS software releases -|--------------------------------------------------- Upgrade ArbOS -|------------------------------------ Data Availability Committees -|--------------------------------------------------- Get started -|--------------------------------------------------- Deploy a Data Availability Server (DAS) -|--------------------------------------------------- Deploy a mirror Data Availability Server -|--------------------------------------------------- Configure a Data Availability Committee (DAC) -|------------------------------------ Add new validators to Orbit chain -|------------------------------------ Monitoring tools and considerations -|------------------------------------ Run a full Orbit node -|------------------------------------ Add your chain to the bridge -|------------------------------------ Orbit chain ownership -|------------------------------------ Custom gas token SDK -|------------------------------------ BoLD for Orbit chains -|------------------------------------ Public preview -|------------------------------------ Third-party infrastructure providers -|------------------------------------ FAQ -|--------------------- Write Stylus Contracts -|------------------------------------ A gentle introduction -|------------------------------------ Quickstart -|------------------------------------ Rust SDK -|--------------------------------------------------- Overview -|--------------------------------------------------- Hello World -|--------------------------------------------------- Primitive Data Types -|--------------------------------------------------- Variables -|--------------------------------------------------- Constants -|--------------------------------------------------- Function -|--------------------------------------------------- Errors -|--------------------------------------------------- Events -|--------------------------------------------------- Inheritance -|--------------------------------------------------- Vm Affordances -|--------------------------------------------------- Sending Ether -|--------------------------------------------------- Function Selector -|--------------------------------------------------- Abi Encode -|--------------------------------------------------- Abi Decode -|--------------------------------------------------- Hashing -|--------------------------------------------------- Bytes In Bytes Out -|--------------------------------------------------- Advanced features -|--------------------------------------------------- Recommended Rust Crates -|------------------------------------ Rust CLI -|--------------------------------------------------- Overview -|--------------------------------------------------- Debug transactions -|--------------------------------------------------- Verify contracts -|--------------------------------------------------- Cache contracts -|--------------------------------------------------- Verify on Arbiscan -|--------------------------------------------------- Optimize WASM binaries -|------------------------------------ Run a local dev node -|------------------------------------ Concepts -|--------------------------------------------------- Architecture overview -|--------------------------------------------------- Gas metering -|------------------------------------ Examples -|--------------------------------------------------- Erc20 -|--------------------------------------------------- Erc721 -|--------------------------------------------------- Multi Call -|--------------------------------------------------- Vending Machine -|--------------------------------------------------- Awesome Stylus -|--------------------------------------------------- Awesome Stylus (https://github.com/OffchainLabs/awesome-stylus) -|------------------------------------ Reference -|--------------------------------------------------- Chain Info -|--------------------------------------------------- Gas & Ink Pricing -|--------------------------------------------------- Stylus by Example -|--------------------------------------------------- Stylus by Example (https://stylus-by-example.org/) -|--------------------------------------------------- Cargo Stylus CLI GitHub -|--------------------------------------------------- Cargo Stylus CLI GitHub (https://github.com/OffchainLabs/cargo-stylus) -|--------------------------------------------------- Rust SDK Crate -|--------------------------------------------------- Rust SDK Crate (https://docs.rs/stylus-sdk/latest/stylus_sdk/index.html) -|--------------------------------------------------- Source Code Repository -|--------------------------------------------------- Source Code Repository (https://github.com/OffchainLabs/stylus) -|------------------------------------ Using other languages -|------------------------------------ Troubleshooting -|--------------------- Run an Arbitrum node -|------------------------------------ Overview -|------------------------------------ Quickstart -|------------------------------------ Run a full node -|------------------------------------ Run a local full chain simulation -|------------------------------------ Run a local dev node -|------------------------------------ L1 Ethereum RPC providers -|------------------------------------ Use Timeboost -|------------------------------------ Run a full Orbit node -|------------------------------------ Data Availability Committees -|------------------------------------ ArbOS software releases -|--------------------------------------------------- Overview -|--------------------------------------------------- ArbOS 32 Bianca -|--------------------------------------------------- ArbOS 20 Atlas -|--------------------------------------------------- ArbOS 11 -|------------------------------------ More node types -|--------------------------------------------------- Run an archive node -|--------------------------------------------------- Run a validator -|--------------------------------------------------- Run a Classic node -|------------------------------------ Sequencer -|--------------------------------------------------- Run a feed relay -|--------------------------------------------------- Read the sequencer feed -|--------------------------------------------------- Run a Sequencer Coordination Manager (SQM) -|------------------------------------ Build Nitro locally -|------------------------------------ Migrate to Nitro from Classic -|------------------------------------ Database snapshots -|------------------------------------ Troubleshooting -|------------------------------------ FAQ -|--------------------- Arbitrum bridge -|------------------------------------ Quickstart -|------------------------------------ USDC on Arbitrum One -|------------------------------------ Troubleshooting -|--------------------- How Arbitrum works -|------------------------------------ A gentle introduction -|------------------------------------ Sequencing, Followed by Deterministic Execution -|------------------------------------ The Sequencer and Censorship Resistance -|------------------------------------ Geth at the Core -|------------------------------------ Separating Execution from Proving -|------------------------------------ Optimistic Rollup -|------------------------------------ Challenges: Interactive Fraud Proofs -|------------------------------------ AnyTrust protocol -|------------------------------------ Gas and fees -|------------------------------------ L1 to L2 messaging -|------------------------------------ L2 to L1 messaging -|------------------------------------ Nitro whitepaper -|------------------------------------ Nitro whitepaper (https://github.com/OffchainLabs/nitro/blob/master/docs/Nitro-whitepaper.pdf) -|------------------------------------ The BoLD dispute protocol -|--------------------------------------------------- A gentle introduction -|--------------------------------------------------- Deploy a validator on testnet -|--------------------------------------------------- Deploy a validator on testnet (https://github.com/offchainlabs/bold-validator-starter-kit) -|--------------------------------------------------- BoLD Whitepaper -|--------------------------------------------------- BoLD Whitepaper (https://arxiv.org/abs/2404.10491) -|--------------------------------------------------- Technical deep dive -|--------------------------------------------------- Economics of disputes -|--------------------------------------------------- Specification on Github -|--------------------------------------------------- Specification on Github (https://github.com/OffchainLabs/bold) -|--------------------------------------------------- Audit Report by Trail of Bits -|--------------------------------------------------- Audit Report by Trail of Bits (https://github.com/trailofbits/publications/blob/master/reviews/2024-04-offchainbold-securityreview.pdf) -|--------------------------------------------------- Audit Report by Code4rena -|--------------------------------------------------- Audit Report by Code4rena (https://code4rena.com/reports/2024-05-arbitrum-foundation) -|------------------------------------ Timeboost -|--------------------------------------------------- Public preview -|--------------------- FAQ -|--------------------- Glossary -|--------------------- Third-party docs -|------------------------------------ Oracles -|--------------------- Audit reports -|--------------------- DAO docs -|--------------------- DAO docs (https://docs.arbitrum.foundation/gentle-intro-dao-governance) -|--------------------- Prysm docs -|--------------------- Prysm docs (https://docs.prylabs.network/docs/install/install-with-script) diff --git a/website/src/scripts/contentStructureGenerator.js b/website/src/scripts/contentStructureGenerator.js deleted file mode 100644 index be04ab7de0..0000000000 --- a/website/src/scripts/contentStructureGenerator.js +++ /dev/null @@ -1,140 +0,0 @@ -// @ts-check - -/** - * Content Structure Generator - * - * This script generates a hierarchical tree visualization of the Arbitrum documentation's - * sidebar structure, making it easier to understand and analyze the documentation organization. - * - * Usage: - * 1. Run the script directly: - * node website/src/scripts/contentStructureGenerator.js - * - * Output: - * - Creates 'contentStructure.txt' in the same directory as this script - * - The output file shows the complete documentation hierarchy with: - * - Proper indentation showing relationships between items - * - Labels for all documentation pages - * - URLs for external links - * - Special handling for HTML elements and external content - * - * Configuration: - * The script accepts the following options (passed to generateSidebarTree): - * - indentBase: Base number of dashes for indentation (default: 6) - * - indentLevel: Additional dashes per nested level (default: 15) - * - skipEmpty: Whether to skip items without labels (default: true) - * - handleMissing: How to handle invalid/missing items (default: true) - * - * Example output format: - * |------ Section - * |--------------------- Category - * |------------------------------------ Page Title - * |------------------------------------ External Link (https://example.com) - */ - -const sidebars = require('../../sidebars.js'); -const fs = require('fs'); -const path = require('path'); - -function generateSidebarTree(sidebar, options = {}) { - const { - indentBase = 6, // Base number of dashes - indentLevel = 15, // Additional dashes per level - skipEmpty = true, // Skip items without labels - handleMissing = true, // Handle missing/undefined items gracefully - } = options; - - function getIndent(level) { - return '|' + '-'.repeat(indentBase + level * indentLevel); - } - - function processItem(item, level = 0) { - // Handle null, undefined, or invalid items - if (!item || typeof item !== 'object') { - return handleMissing ? '' : `${getIndent(level)} [Invalid Item]\n`; - } - - let output = ''; - - // Handle the current item - if (item.label) { - output += `${getIndent(level)} ${item.label}\n`; - } else if (!skipEmpty) { - output += `${getIndent(level)} [Unnamed Item]\n`; - } - - // Handle items array - if (item.items) { - // If items is a reference to an external sidebar (like sdkDocsSidebar) - if (!Array.isArray(item.items)) { - try { - // Try to process the external sidebar if it's an array - if (Array.isArray(item.items.default) || Array.isArray(item.items)) { - const itemsArray = item.items.default || item.items; - itemsArray.forEach((childItem) => { - output += processItem(childItem, level + 1); - }); - } else { - output += `${getIndent(level + 1)} [External Content]\n`; - } - } catch (error) { - output += `${getIndent(level + 1)} [External Content]\n`; - } - } else { - // Process each child item - item.items.forEach((childItem) => { - output += processItem(childItem, level + 1); - }); - } - } - - // Handle HTML type items - if (item.type === 'html' && item.value) { - // Extract label from HTML value using regex - const labelMatch = item.value.match(/>(.*?) { - output += `${getIndent(0)} ${sectionName}\n`; - if (Array.isArray(items)) { - items.forEach((item) => { - output += processItem(item, 1); - }); - } - }); - } - - return output; -} - -// Generate the tree using the actual sidebars configuration -const treeOutput = generateSidebarTree(sidebars, { - indentBase: 6, - indentLevel: 15, - skipEmpty: true, - handleMissing: true, -}); - -// Write output to file -const outputPath = path.join(__dirname, 'contentStructure.txt'); -fs.writeFileSync(outputPath, treeOutput, 'utf8'); -console.log(`Content structure has been written to: ${outputPath}`); - -// Export the function for use in other files -module.exports = { - generateSidebarTree, -}; diff --git a/website/src/theme/MDXComponents/index.js b/website/src/theme/MDXComponents/index.js index 1463e72a3d..d8cfca425f 100644 --- a/website/src/theme/MDXComponents/index.js +++ b/website/src/theme/MDXComponents/index.js @@ -4,5 +4,11 @@ import ImageZoom from '@site/src/components/ImageZoom'; export default { ...MDXComponents, - ImageZoom, + img: (props) => { + // Don't wrap images that are explicitly marked to not zoom + if (props.className?.includes('no-zoom')) { + return ; + } + return ; + }, }; diff --git a/website/tsconfig.json b/website/tsconfig.json index 2a5abb1e87..bb5f98521e 100644 --- a/website/tsconfig.json +++ b/website/tsconfig.json @@ -7,6 +7,9 @@ "module": "nodenext", "moduleResolution": "nodenext", "downlevelIteration": true, - "types": ["node"] + "types": ["node", "@types/react"], + "resolveJsonModule": true, + "jsx": "react", + "lib": ["DOM", "DOM.Iterable", "ESNext"] } } diff --git a/website/yarn.lock b/website/yarn.lock index db0e360677..ba0fc9716b 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -2035,6 +2035,13 @@ dependencies: regenerator-runtime "^0.14.0" +"@babel/runtime@^7.3.1": + version "7.26.7" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.26.7.tgz#f4e7fe527cd710f8dc0618610b61b4b060c3c341" + integrity sha512-AOPI3D+a8dXnja+iwsUqGRjr1BbZIe771sXdapOtYI531gSqpi92vXivKcq2asu/DFpdl1ceFAKZyRzK2PCVcQ== + dependencies: + regenerator-runtime "^0.14.0" + "@babel/template@^7.22.15", "@babel/template@^7.24.0": version "7.24.0" resolved "https://registry.yarnpkg.com/@babel/template/-/template-7.24.0.tgz#c6a524aa93a4a05d66aaf31654258fae69d87d50" @@ -3613,7 +3620,7 @@ resolved "https://registry.yarnpkg.com/@radix-ui/react-context/-/react-context-1.1.1.tgz#82074aa83a472353bb22e86f11bcbd1c61c4c71a" integrity sha512-UASk9zi+crv9WteK/NU4PLvOoL3OuE6BWVKNF6hPRBtYBDXQ2u5iu3O59zUlJiTVvkyuycnqrztsHVJwcK9K+Q== -"@radix-ui/react-dialog@^1.1.6": +"@radix-ui/react-dialog@^1.0.5": version "1.1.6" resolved "https://registry.yarnpkg.com/@radix-ui/react-dialog/-/react-dialog-1.1.6.tgz#65b4465e99ad900f28a98eed9a94bb21ec644bf7" integrity sha512-/IVhJV5AceX620DUJ4uYVMymzsipdKBzo3edo+omeskCKGm9FRHM0ebIdbPnlQVJqyuHbuBltQUOG2mOTq2IYw== @@ -3754,7 +3761,7 @@ resolved "https://registry.yarnpkg.com/@react-spring/types/-/types-9.7.5.tgz#e5dd180f3ed985b44fd2cd2f32aa9203752ef3e8" integrity sha512-HVj7LrZ4ReHWBimBvu2SKND3cDVUPWKLqRTmWe/fNY6o1owGOX0cAHbdPDTMelgBlVbrTKrre6lFkhqGZErK/g== -"@react-spring/web@^9.7.5": +"@react-spring/web@^9.7.3": version "9.7.5" resolved "https://registry.yarnpkg.com/@react-spring/web/-/web-9.7.5.tgz#7d7782560b3a6fb9066b52824690da738605de80" integrity sha512-lmvqGwpe+CSttsWNZVr+Dg62adtKhauGwLyGE/RRyZ8AAMLgb9x3NDMA5RMElXo+IMyTkPp7nxTB8ZQlmhb6JQ== @@ -3805,6 +3812,11 @@ micromark-util-character "^1.1.0" micromark-util-symbol "^1.0.1" +"@stitches/react@^1.2.8": + version "1.2.8" + resolved "https://registry.yarnpkg.com/@stitches/react/-/react-1.2.8.tgz#954f8008be8d9c65c4e58efa0937f32388ce3a38" + integrity sha512-9g9dWI4gsSVe8bNLlb+lMkBYsnIKCZTmvqvDG+Avnn69XfmHZKiaMrx7cgTaddq7aTPPmXiTsbFcUy0xgI4+wA== + "@svgr/babel-plugin-add-jsx-attribute@8.0.0": version "8.0.0" resolved "https://registry.yarnpkg.com/@svgr/babel-plugin-add-jsx-attribute/-/babel-plugin-add-jsx-attribute-8.0.0.tgz#4001f5d5dd87fa13303e36ee106e3ff3a7eb8b22" @@ -4301,14 +4313,6 @@ resolved "https://registry.yarnpkg.com/@types/history/-/history-4.7.11.tgz#56588b17ae8f50c53983a524fc3cc47437969d64" integrity sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA== -"@types/hoist-non-react-statics@*": - version "3.3.6" - resolved "https://registry.yarnpkg.com/@types/hoist-non-react-statics/-/hoist-non-react-statics-3.3.6.tgz#6bba74383cdab98e8db4e20ce5b4a6b98caed010" - integrity sha512-lPByRJUer/iN/xa4qpyL0qmL11DqNW81iU/IG1S3uvRUq4oKagz8VCxZjiWkumgt66YT3vOdDgZ0o32sGKtCEw== - dependencies: - "@types/react" "*" - hoist-non-react-statics "^3.3.0" - "@types/html-minifier-terser@^6.0.0": version "6.1.0" resolved "https://registry.yarnpkg.com/@types/html-minifier-terser/-/html-minifier-terser-6.1.0.tgz#4fc33a00c1d0c16987b1a20cf92d20614c55ac35" @@ -4369,7 +4373,7 @@ dependencies: "@types/unist" "*" -"@types/mdx@^2.0.0": +"@types/mdx@^2.0.0", "@types/mdx@^2.0.11": version "2.0.13" resolved "https://registry.yarnpkg.com/@types/mdx/-/mdx-2.0.13.tgz#68f6877043d377092890ff5b298152b0a21671bd" integrity sha512-+OWZQfAYyio6YkJb3HLxDrvnx6SWWDbC0zVPfBRzUk0/nqoDyf6dNxQi3eArPe8rJ473nobTMQ/8Zk+LxJ+Yuw== @@ -4425,6 +4429,11 @@ resolved "https://registry.yarnpkg.com/@types/prismjs/-/prismjs-1.26.3.tgz#47fe8e784c2dee24fe636cab82e090d3da9b7dec" integrity sha512-A0D0aTXvjlqJ5ZILMz3rNfDBOx9hHxLZYv2by47Sm/pqW35zzjusrZTryatjN/Rf8Us2gZrJD+KeHbUSTux1Cw== +"@types/prismjs@^1.26.5": + version "1.26.5" + resolved "https://registry.yarnpkg.com/@types/prismjs/-/prismjs-1.26.5.tgz#72499abbb4c4ec9982446509d2f14fb8483869d6" + integrity sha512-AUZTa7hQ2KY5L7AmtSiqxlhWxb4ina0yd8hNbl4TWuqnv/pFP0nDMb3YrfSBf4hJVGLh2YEIBfKaBW/9UEl6IQ== + "@types/prop-types@*": version "15.7.12" resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.12.tgz#12bb1e2be27293c1406acb6af1c3f3a1481d98c6" @@ -4466,6 +4475,13 @@ "@types/history" "^4.7.11" "@types/react" "*" +"@types/react-syntax-highlighter@^15.5.13": + version "15.5.13" + resolved "https://registry.yarnpkg.com/@types/react-syntax-highlighter/-/react-syntax-highlighter-15.5.13.tgz#c5baf62a3219b3bf28d39cfea55d0a49a263d1f2" + integrity sha512-uLGJ87j6Sz8UaBAooU0T6lWJ0dBmjZgN1PZTrj05TNql2/XpC6+4HhMT5syIdFUUt+FASfCeLLv4kBygNU+8qA== + dependencies: + "@types/react" "*" + "@types/react@*": version "18.3.1" resolved "https://registry.yarnpkg.com/@types/react/-/react-18.3.1.tgz#fed43985caa834a2084d002e4771e15dfcbdbe8e" @@ -4474,6 +4490,14 @@ "@types/prop-types" "*" csstype "^3.0.2" +"@types/react@^18.2.55": + version "18.3.18" + resolved "https://registry.yarnpkg.com/@types/react/-/react-18.3.18.tgz#9b382c4cd32e13e463f97df07c2ee3bbcd26904b" + integrity sha512-t4yC+vtgnkYjNSKlFx1jkAhH8LgTo2N/7Qvi83kdEaUtMDiwpbLAktKDaAMlRcJ5eSxZkH74eEGt1ky31d7kfQ== + dependencies: + "@types/prop-types" "*" + csstype "^3.0.2" + "@types/responselike@^1.0.0": version "1.0.3" resolved "https://registry.yarnpkg.com/@types/responselike/-/responselike-1.0.3.tgz#cc29706f0a397cfe6df89debfe4bf5cea159db50" @@ -4524,15 +4548,6 @@ dependencies: "@types/node" "*" -"@types/styled-components@^5.1.34": - version "5.1.34" - resolved "https://registry.yarnpkg.com/@types/styled-components/-/styled-components-5.1.34.tgz#4107df8ef8a7eaba4fa6b05f78f93fba4daf0300" - integrity sha512-mmiVvwpYklFIv9E8qfxuPyIt/OuyIrn6gMOAMOFUO3WJfSrSE+sGUoa4PiZj77Ut7bKZpaa6o1fBKS/4TOEvnA== - dependencies: - "@types/hoist-non-react-statics" "*" - "@types/react" "*" - csstype "^3.0.2" - "@types/stylis@4.2.5": version "4.2.5" resolved "https://registry.yarnpkg.com/@types/stylis/-/stylis-4.2.5.tgz#1daa6456f40959d06157698a653a9ab0a70281df" @@ -5458,16 +5473,31 @@ character-entities-html4@^2.0.0: resolved "https://registry.yarnpkg.com/character-entities-html4/-/character-entities-html4-2.1.0.tgz#1f1adb940c971a4b22ba39ddca6b618dc6e56b2b" integrity sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA== +character-entities-legacy@^1.0.0: + version "1.1.4" + resolved "https://registry.yarnpkg.com/character-entities-legacy/-/character-entities-legacy-1.1.4.tgz#94bc1845dce70a5bb9d2ecc748725661293d8fc1" + integrity sha512-3Xnr+7ZFS1uxeiUDvV02wQ+QDbc55o97tIV5zHScSPJpcLm/r0DFPcoY3tYRp+VZukxuMeKgXYmsXQHO05zQeA== + character-entities-legacy@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz#76bc83a90738901d7bc223a9e93759fdd560125b" integrity sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ== +character-entities@^1.0.0: + version "1.2.4" + resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-1.2.4.tgz#e12c3939b7eaf4e5b15e7ad4c5e28e1d48c5b16b" + integrity sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw== + character-entities@^2.0.0: version "2.0.2" resolved "https://registry.yarnpkg.com/character-entities/-/character-entities-2.0.2.tgz#2d09c2e72cd9523076ccb21157dff66ad43fcc22" integrity sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ== +character-reference-invalid@^1.0.0: + version "1.1.4" + resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-1.1.4.tgz#083329cda0eae272ab3dbbf37e9a382c13af1560" + integrity sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg== + character-reference-invalid@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/character-reference-invalid/-/character-reference-invalid-2.0.1.tgz#85c66b041e43b47210faf401278abf808ac45cb9" @@ -7106,6 +7136,13 @@ fastq@^1.6.0: dependencies: reusify "^1.0.4" +fault@^1.0.0: + version "1.0.4" + resolved "https://registry.yarnpkg.com/fault/-/fault-1.0.4.tgz#eafcfc0a6d214fc94601e170df29954a4f842f13" + integrity sha512-CJ0HCB5tL5fYTEA7ToAq5+kTwd++Borf1/bifxd9iT70QcXr4MRrO3Llf8Ifs70q+SJcGHFtnIE/Nw6giCtECA== + dependencies: + format "^0.2.0" + fault@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/fault/-/fault-2.0.1.tgz#d47ca9f37ca26e4bd38374a7c500b5a384755b6c" @@ -7786,6 +7823,16 @@ he@^1.2.0: resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f" integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw== +highlight.js@^10.4.1, highlight.js@~10.7.0: + version "10.7.3" + resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-10.7.3.tgz#697272e3991356e40c3cac566a74eef681756531" + integrity sha512-tzcUFauisWKNHaRkN4Wjl/ZA07gENAjFl3J/c480dprkGTg5EQstgaNFqBfUqCq54kZRIEcreTsAgF/m2quD7A== + +highlightjs-vue@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/highlightjs-vue/-/highlightjs-vue-1.0.0.tgz#fdfe97fbea6354e70ee44e3a955875e114db086d" + integrity sha512-PDEfEF102G23vHmPhLyPboFCD+BkMGu+GuJe2d9/eH4FsCwvgBpnc9n0pGE+ffKdph38s6foEZiEjdgHdzp+IA== + history@^4.9.0: version "4.10.1" resolved "https://registry.yarnpkg.com/history/-/history-4.10.1.tgz#33371a65e3a83b267434e2b3f3b1b4c58aad4cf3" @@ -7815,7 +7862,7 @@ hogan.js@^3.0.2: mkdirp "0.3.0" nopt "1.0.10" -hoist-non-react-statics@^3.1.0, hoist-non-react-statics@^3.3.0: +hoist-non-react-statics@^3.1.0: version "3.3.2" resolved "https://registry.yarnpkg.com/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz#ece0acaf71d62c2969c2ec59feff42a4b1a85b45" integrity sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw== @@ -8147,11 +8194,24 @@ ipaddr.js@^2.0.1: resolved "https://registry.yarnpkg.com/ipaddr.js/-/ipaddr.js-2.2.0.tgz#d33fa7bac284f4de7af949638c9d68157c6b92e8" integrity sha512-Ag3wB2o37wslZS19hZqorUnrnzSkpOVy+IiiDEiTqNubEYpYuHWIf6K4psgN2ZWKExS4xhVCrRVfb/wfW8fWJA== +is-alphabetical@^1.0.0: + version "1.0.4" + resolved "https://registry.yarnpkg.com/is-alphabetical/-/is-alphabetical-1.0.4.tgz#9e7d6b94916be22153745d184c298cbf986a686d" + integrity sha512-DwzsA04LQ10FHTZuL0/grVDk4rFoVH1pjAToYwBrHSxcrBIGQuXrQMtD5U1b0U2XVgKZCTLLP8u2Qxqhy3l2Vg== + is-alphabetical@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/is-alphabetical/-/is-alphabetical-2.0.1.tgz#01072053ea7c1036df3c7d19a6daaec7f19e789b" integrity sha512-FWyyY60MeTNyeSRpkM2Iry0G9hpr7/9kD40mD/cGQEuilcZYS4okz8SN2Q6rLCJ8gbCt6fN+rC+6tMGS99LaxQ== +is-alphanumerical@^1.0.0: + version "1.0.4" + resolved "https://registry.yarnpkg.com/is-alphanumerical/-/is-alphanumerical-1.0.4.tgz#7eb9a2431f855f6b1ef1a78e326df515696c4dbf" + integrity sha512-UzoZUr+XfVz3t3v4KyGEniVL9BDRoQtY7tOyrRybkVNjDFWyo1yhXNGrrBTQxp3ib9BLAWs7k2YKBQsFRkZG9A== + dependencies: + is-alphabetical "^1.0.0" + is-decimal "^1.0.0" + is-alphanumerical@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/is-alphanumerical/-/is-alphanumerical-2.0.1.tgz#7c03fbe96e3e931113e57f964b0a368cc2dfd875" @@ -8191,6 +8251,11 @@ is-core-module@^2.13.0: dependencies: hasown "^2.0.0" +is-decimal@^1.0.0: + version "1.0.4" + resolved "https://registry.yarnpkg.com/is-decimal/-/is-decimal-1.0.4.tgz#65a3a5958a1c5b63a706e1b333d7cd9f630d3fa5" + integrity sha512-RGdriMmQQvZ2aqaQq3awNA6dCGtKpiDFcOzrTWrDAT2MiWrKQVPmxLGHl7Y2nNu6led0kEyoX0enY0qXYsv9zw== + is-decimal@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/is-decimal/-/is-decimal-2.0.1.tgz#9469d2dc190d0214fd87d78b78caecc0cc14eef7" @@ -8223,6 +8288,11 @@ is-glob@^4.0.1, is-glob@^4.0.3, is-glob@~4.0.1: dependencies: is-extglob "^2.1.1" +is-hexadecimal@^1.0.0: + version "1.0.4" + resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-1.0.4.tgz#cc35c97588da4bd49a8eedd6bc4082d44dcb23a7" + integrity sha512-gyPJuv83bHMpocVYoqof5VDiZveEoGoFL8m3BXNb2VW8Xs+rz9kqO8LOQ5DH6EsuvilT1ApazU0pyl+ytbPtlw== + is-hexadecimal@^2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/is-hexadecimal/-/is-hexadecimal-2.0.1.tgz#86b5bf668fca307498d319dfc03289d781a90027" @@ -8675,6 +8745,14 @@ lowercase-keys@^3.0.0: resolved "https://registry.yarnpkg.com/lowercase-keys/-/lowercase-keys-3.0.0.tgz#c5e7d442e37ead247ae9db117a9d0a467c89d4f2" integrity sha512-ozCC6gdQ+glXOQsveKD0YsDy8DSQFjDTz4zyzEHNV5+JP5D62LmfDZ6o1cycFx9ouG940M5dE8C8CTewdj2YWQ== +lowlight@^1.17.0: + version "1.20.0" + resolved "https://registry.yarnpkg.com/lowlight/-/lowlight-1.20.0.tgz#ddb197d33462ad0d93bf19d17b6c301aa3941888" + integrity sha512-8Ktj+prEb1RoCPkEOrPMYUN/nCggB7qAWe3a7OpMjWQkh3l2RD5wKRQ+o8Q8YuI9RG/xs95waaI/E6ym/7NsTw== + dependencies: + fault "^1.0.0" + highlight.js "~10.7.0" + lru-cache@^10.2.0: version "10.2.2" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.2.2.tgz#48206bc114c1252940c41b25b41af5b545aca878" @@ -9892,6 +9970,18 @@ parent-module@^1.0.0: dependencies: callsites "^3.0.0" +parse-entities@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/parse-entities/-/parse-entities-2.0.0.tgz#53c6eb5b9314a1f4ec99fa0fdf7ce01ecda0cbe8" + integrity sha512-kkywGpCcRYhqQIchaWqZ875wzpS/bMKhz5HnN3p7wveJTkTtyAB/AlnS0f8DFSqYW1T82t6yEAkEcB+A1I3MbQ== + dependencies: + character-entities "^1.0.0" + character-entities-legacy "^1.0.0" + character-reference-invalid "^1.0.0" + is-alphanumerical "^1.0.0" + is-decimal "^1.0.0" + is-hexadecimal "^1.0.0" + parse-entities@^4.0.0: version "4.0.1" resolved "https://registry.yarnpkg.com/parse-entities/-/parse-entities-4.0.1.tgz#4e2a01111fb1c986549b944af39eeda258fc9e4e" @@ -10715,11 +10805,16 @@ prism-react-renderer@^2.0.6, prism-react-renderer@^2.3.0: "@types/prismjs" "^1.26.0" clsx "^2.0.0" -prismjs@^1.29.0: +prismjs@^1.27.0, prismjs@^1.29.0: version "1.29.0" resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.29.0.tgz#f113555a8fa9b57c35e637bba27509dcf802dd12" integrity sha512-Kx/1w86q/epKcmte75LNrEoT+lX8pBpavuAbvJWRXar7Hz8jrtF+e3vY751p0R8H9HdArwaCTNDDzHg/ScJK1Q== +prismjs@~1.27.0: + version "1.27.0" + resolved "https://registry.yarnpkg.com/prismjs/-/prismjs-1.27.0.tgz#bb6ee3138a0b438a3653dd4d6ce0cc6510a45057" + integrity sha512-t13BGPUlFDR7wRB5kQDG4jjl7XeuH6jbJGt11JHPL96qwsEHNX2+68tFXqc1/k+/jALsbSWJKUOT/hcYAZ5LkA== + process-nextick-args@~2.0.0: version "2.0.1" resolved "https://registry.yarnpkg.com/process-nextick-args/-/process-nextick-args-2.0.1.tgz#7820d9b16120cc55ca9ae7792680ae7dba6d7fe2" @@ -11011,6 +11106,18 @@ react-style-singleton@^2.2.2, react-style-singleton@^2.2.3: get-nonce "^1.0.0" tslib "^2.0.0" +react-syntax-highlighter@^15.6.1: + version "15.6.1" + resolved "https://registry.yarnpkg.com/react-syntax-highlighter/-/react-syntax-highlighter-15.6.1.tgz#fa567cb0a9f96be7bbccf2c13a3c4b5657d9543e" + integrity sha512-OqJ2/vL7lEeV5zTJyG7kmARppUjiB9h9udl4qHQjjgEos66z00Ia0OckwYfRxCSFrW8RJIBnsBwQsHZbVPspqg== + dependencies: + "@babel/runtime" "^7.3.1" + highlight.js "^10.4.1" + highlightjs-vue "^1.0.0" + lowlight "^1.17.0" + prismjs "^1.27.0" + refractor "^3.6.0" + react@^18.2.0: version "18.3.1" resolved "https://registry.yarnpkg.com/react/-/react-18.3.1.tgz#49ab892009c53933625bd16b2533fc754cab2891" @@ -11066,6 +11173,15 @@ recursive-readdir@^2.2.2: dependencies: minimatch "^3.0.5" +refractor@^3.6.0: + version "3.6.0" + resolved "https://registry.yarnpkg.com/refractor/-/refractor-3.6.0.tgz#ac318f5a0715ead790fcfb0c71f4dd83d977935a" + integrity sha512-MY9W41IOWxxk31o+YvFCNyNzdkc9M20NoZK5vq6jkv4I/uh2zkWcfudj0Q1fovjUQJrNewS9NMzeTtqPf+n5EA== + dependencies: + hastscript "^6.0.0" + parse-entities "^2.0.0" + prismjs "~1.27.0" + regenerate-unicode-properties@^10.1.0: version "10.1.1" resolved "https://registry.yarnpkg.com/regenerate-unicode-properties/-/regenerate-unicode-properties-10.1.1.tgz#6b0e05489d9076b04c436f318d9b067bba459480"