Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: merge doc fixes into main #278

Merged
merged 2 commits into from
Dec 11, 2024
Merged

fix: merge doc fixes into main #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c4e794
Update Arbitrum Expansion Program links (#271)
PlasmaPower Dec 9, 2024
1bd3840
update links in README.md (#277)
gzeoneth Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Additional Use Grant: You may use the Licensed Work in a production environment
validating the correctness of the posted chain state, or to deploy
and operate (x) a blockchain that settles to a Covered Arbitrum Chain
or (y) a blockchain in accordance with, and subject to, the [Arbitrum
Expansion Program Term of Use](https://docs.arbitrum.foundation/assets/files/Arbitrum%20Expansion%20Program%20Jan182024-4f08b0c2cb476a55dc153380fa3e64b0.pdf). For purposes of this
Expansion Program Term of Use](https://docs.arbitrum.foundation/aep/ArbitrumExpansionProgramTerms.pdf). For purposes of this
Additional Use Grant, the "Covered Arbitrum Chains" are
(a) Arbitrum One (chainid:42161), Arbitrum Nova (chainid:42170),
Arbitrum Rinkeby testnet/Rinkarby (chainid:421611),Arbitrum Nitro
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ It includes the rollup and fraud proof smart contracts, as well as interfaces fo

For more information see https://developer.arbitrum.io/intro

For the deployed addresses of these contracts for Arbitrum chains see https://developer.arbitrum.io/useful-addresses
For the deployed addresses of these contracts for Arbitrum chains see [https://docs.arbitrum.io/for-devs/dev-tools-and-resources/chain-info#core-contracts](https://docs.arbitrum.io/for-devs/dev-tools-and-resources/chain-info#core-contracts)

For the token bridge contracts see https://github.com/OffchainLabs/token-bridge-contracts
For the token bridge contracts see [https://github.com/OffchainLabs/token-bridge-contracts](https://github.com/OffchainLabs/token-bridge-contracts)

Compile these contracts locally by running

Expand All @@ -24,7 +24,7 @@ Nitro is currently licensed under a [Business Source License](./LICENSE.md), sim

The Additional Use Grant also permits the deployment of the Nitro software, in a permissionless fashion and without cost, as a new blockchain provided that the chain settles to either Arbitrum One or Arbitrum Nova.

For those that prefer to deploy the Nitro software either directly on Ethereum (i.e. an L2) or have it settle to another Layer-2 on top of Ethereum, the [Arbitrum Expansion Program (the "AEP")](https://docs.arbitrum.foundation/assets/files/Arbitrum%20Expansion%20Program%20Jan182024-4f08b0c2cb476a55dc153380fa3e64b0.pdf) was recently established. The AEP allows for the permissionless deployment in the aforementioned fashion provided that 10% of net revenue is contributed back to the Arbitrum community in accordance with the requirements of the AEP.
For those that prefer to deploy the Nitro software either directly on Ethereum (i.e. an L2) or have it settle to another Layer-2 on top of Ethereum, the [Arbitrum Expansion Program (the "AEP")](https://docs.arbitrum.foundation/aep/ArbitrumExpansionProgramTerms.pdf) was recently established. The AEP allows for the permissionless deployment in the aforementioned fashion provided that 10% of net revenue is contributed back to the Arbitrum community in accordance with the requirements of the AEP.

## Contact

Expand Down
18 changes: 17 additions & 1 deletion test/storage/Bridge
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@

╭----------------------------------+------------------------------------------------+------+--------+-------+------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
|----------------------------------|------------------------------------------------|------|--------|-------|------------------------------|
+==========================================================================================================================================+
| _initialized | bool | 0 | 0 | 1 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| allowedDelayedInboxesMap | mapping(address => struct AbsBridge.InOutInfo) | 1 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| allowedOutboxesMap | mapping(address => struct AbsBridge.InOutInfo) | 2 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| allowedDelayedInboxList | address[] | 3 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| allowedOutboxList | address[] | 4 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| _activeOutbox | address | 5 | 0 | 20 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| delayedInboxAccs | bytes32[] | 6 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| sequencerInboxAccs | bytes32[] | 7 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| rollup | contract IOwnable | 8 | 0 | 20 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| sequencerInbox | address | 9 | 0 | 20 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| sequencerReportedSubMessageCount | uint256 | 10 | 0 | 32 | src/bridge/Bridge.sol:Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+------------------------------|
| __gap | uint256[40] | 11 | 0 | 1280 | src/bridge/Bridge.sol:Bridge |
╰----------------------------------+------------------------------------------------+------+--------+-------+------------------------------╯

13 changes: 12 additions & 1 deletion test/storage/CacheManager
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@

╭---------------+-----------------------------+------+--------+-------+-----------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
|---------------|-----------------------------|------|--------|-------|-----------------------------------------|
+===============================================================================================================+
| _initialized | bool | 0 | 0 | 1 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| bids | struct MinHeapLib.Heap | 1 | 0 | 32 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| entries | struct CacheManager.Entry[] | 2 | 0 | 32 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| cacheSize | uint64 | 3 | 0 | 8 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| queueSize | uint64 | 3 | 8 | 8 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| decay | uint64 | 3 | 16 | 8 | src/chain/CacheManager.sol:CacheManager |
|---------------+-----------------------------+------+--------+-------+-----------------------------------------|
| isPaused | bool | 3 | 24 | 1 | src/chain/CacheManager.sol:CacheManager |
╰---------------+-----------------------------+------+--------+-------+-----------------------------------------╯

12 changes: 11 additions & 1 deletion test/storage/ChallengeManager
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,19 @@

╭------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
|------------------------|---------------------------------------------------|------|--------|-------|-----------------------------------------------------|
+==========================================================================================================================================================+
| totalChallengesCreated | uint64 | 0 | 0 | 8 | src/challenge/ChallengeManager.sol:ChallengeManager |
|------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| challenges | mapping(uint256 => struct ChallengeLib.Challenge) | 1 | 0 | 32 | src/challenge/ChallengeManager.sol:ChallengeManager |
|------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| resultReceiver | contract IChallengeResultReceiver | 2 | 0 | 20 | src/challenge/ChallengeManager.sol:ChallengeManager |
|------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| sequencerInbox | contract ISequencerInbox | 3 | 0 | 20 | src/challenge/ChallengeManager.sol:ChallengeManager |
|------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| bridge | contract IBridge | 4 | 0 | 20 | src/challenge/ChallengeManager.sol:ChallengeManager |
|------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| osp | contract IOneStepProofEntry | 5 | 0 | 20 | src/challenge/ChallengeManager.sol:ChallengeManager |
|------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------|
| ospCond | mapping(bytes32 => contract IOneStepProofEntry) | 6 | 0 | 32 | src/challenge/ChallengeManager.sol:ChallengeManager |
╰------------------------+---------------------------------------------------+------+--------+-------+-----------------------------------------------------╯

20 changes: 19 additions & 1 deletion test/storage/ERC20Bridge
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,35 @@

╭----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------╮
| Name | Type | Slot | Offset | Bytes | Contract |
|----------------------------------|------------------------------------------------|------|--------|-------|----------------------------------------|
+====================================================================================================================================================+
| _initialized | bool | 0 | 0 | 1 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| _initializing | bool | 0 | 1 | 1 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| allowedDelayedInboxesMap | mapping(address => struct AbsBridge.InOutInfo) | 1 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| allowedOutboxesMap | mapping(address => struct AbsBridge.InOutInfo) | 2 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| allowedDelayedInboxList | address[] | 3 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| allowedOutboxList | address[] | 4 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| _activeOutbox | address | 5 | 0 | 20 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| delayedInboxAccs | bytes32[] | 6 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| sequencerInboxAccs | bytes32[] | 7 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| rollup | contract IOwnable | 8 | 0 | 20 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| sequencerInbox | address | 9 | 0 | 20 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| sequencerReportedSubMessageCount | uint256 | 10 | 0 | 32 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| __gap | uint256[40] | 11 | 0 | 1280 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| nativeToken | address | 51 | 0 | 20 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
|----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------|
| nativeTokenDecimals | uint8 | 51 | 20 | 1 | src/bridge/ERC20Bridge.sol:ERC20Bridge |
╰----------------------------------+------------------------------------------------+------+--------+-------+----------------------------------------╯

Loading
Loading