Skip to content

docs: mark INativeToken functions as external #66

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

Merged
tac0turtle merged 1 commit into from
Oct 23, 2025
Merged

docs: mark INativeToken functions as external #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions crates/ev-precompiles/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ The precompile is deployed at a reserved address in the precompile address space

```solidity
interface INativeToken {
function mint(address to, uint256 amount);
function burn(address from, uint256 amount);
function addToAllowList(address account);
function removeFromAllowList(address account);
function mint(address to, uint256 amount) external;
function burn(address from, uint256 amount) external;
function addToAllowList(address account) external;
function removeFromAllowList(address account) external;
Comment on lines +25 to +28

@gemini-code-assist gemini-code-assist Bot Oct 22, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Adding the external keyword to the function definitions in the interface makes it explicit that these functions are intended to be called from outside the contract. This is a good practice for interface definitions.

Consider adding a brief comment explaining why these functions are marked as external for better understanding.

}
```

Expand Down
8 changes: 4 additions & 4 deletions crates/ev-precompiles/src/mint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ use std::sync::OnceLock;

sol! {
interface INativeToken {
function mint(address to, uint256 amount);
function burn(address from, uint256 amount);
function addToAllowList(address account);
function removeFromAllowList(address account);
function mint(address to, uint256 amount) external;
function burn(address from, uint256 amount) external;
function addToAllowList(address account) external;
function removeFromAllowList(address account) external;
Comment on lines +15 to +18

@gemini-code-assist gemini-code-assist Bot Oct 22, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Adding the external keyword to the function definitions in the interface makes it explicit that these functions are intended to be called from outside the contract. This is a good practice for interface definitions.

Consider adding a brief comment explaining why these functions are marked as external for better understanding.

}
}

Expand Down
8 changes: 4 additions & 4 deletions docs/adr/ADR-0002-native-minting-precompile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ We will implement a custom precompile for native token minting. The precompile w

```solidity
interface INativeToken {
function mint(address to, uint256 amount);
function burn(address from, uint256 amount);
function addToAllowList(address account);
function removeFromAllowList(address account);
function mint(address to, uint256 amount) external;
function burn(address from, uint256 amount) external;
function addToAllowList(address account) external;
function removeFromAllowList(address account) external;
Comment on lines +48 to +51

@gemini-code-assist gemini-code-assist Bot Oct 22, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

Adding the external keyword to the function definitions in the interface makes it explicit that these functions are intended to be called from outside the contract. This is a good practice for interface definitions.

Consider adding a brief comment explaining why these functions are marked as external for better understanding.

}
```

Expand Down
Loading