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

docs(world): add comments for prohibitDirectCallback modifier #2312

Merged
merged 6 commits into from
Feb 28, 2024
Merged

docs(world): add comments for prohibitDirectCallback modifier #2312

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ae5d2c3
docs(world): add comments for prohibitDirectCallback modifier
yonadaa Feb 26, 2024
9e23496
docs: tweak comment
yonadaa Feb 28, 2024
e0d5c7c
docs: add more context
yonadaa Feb 28, 2024
cf3f153
docs: generate
yonadaa Feb 28, 2024
3f9fa37
Update docs/pages/world/reference/world.mdx
holic Feb 28, 2024
fa7e700
Update packages/world/src/World.sol
holic Feb 28, 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
5 changes: 4 additions & 1 deletion docs/pages/world/reference/world.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ constructor();

#### prohibitDirectCallback

_Prevents the World contract from calling itself._
_Prevents the World contract from calling itself.
If the World is able to call itself via `delegatecall` from a system, the system would have root access to context like internal tables, causing a potential vulnerability.
Ideally this should not happen because all operations to internal tables happen as internal library calls, and all calls to root systems happen as a `delegatecall` to the system.
However, since this is an important invariant, we make it explicit by reverting if `msg.sender` is `address(this)` in all `World` methods._
Copy link
Member

Choose a reason for hiding this comment

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

:chefkiss:


```solidity
modifier prohibitDirectCallback();
Expand Down
3 changes: 3 additions & 0 deletions packages/world/src/World.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ contract World is StoreData, IWorldKernel {

/**
* @dev Prevents the World contract from calling itself.
* If the World is able to call itself via delegatecall from a system, the system would have root access to context like internal tables, causing a potential vulnerability.
holic marked this conversation as resolved.
Show resolved Hide resolved
* Ideally this should not happen because all operations to internal tables happen as internal library calls, and all calls to root systems happen as a `delegatecall` to the system.
* However, since this is an important invariant, we make it explicit by reverting if `msg.sender` is `address(this)` in all `World` methods.
*/
modifier prohibitDirectCallback() {
if (msg.sender == address(this)) {
Expand Down
Loading