Skip to content

docs: mark INativeToken functions as external#66

Merged
tac0turtle merged 1 commit into
evstack:mainfrom
noble-assets:john/mint-precompile-interface
Oct 23, 2025
Merged

docs: mark INativeToken functions as external#66
tac0turtle merged 1 commit into
evstack:mainfrom
noble-assets:john/mint-precompile-interface

Conversation

@johnletey

Copy link
Copy Markdown
Contributor

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Performance improvement
  • Refactoring

Related Issues

Fixes #(issue)

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Testing

Additional Notes

@johnletey johnletey requested a review from a team as a code owner October 22, 2025 15:47
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @johnletey, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the clarity and accuracy of the INativeToken interface definition. By explicitly adding the external keyword to all functions within this interface, the change ensures that the interface correctly reflects the intended external callability of these functions, improving consistency across the codebase and documentation.

Highlights

  • Interface Definition Update: The INativeToken interface definition has been consistently updated across documentation and source code to explicitly mark all its functions (mint, burn, addToAllowList, removeFromAllowList) as external.
  • Solidity Keyword Addition: The external keyword was added to the function signatures within the INativeToken interface, clarifying their intended visibility and callability from outside the contract.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

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.

Code Review

This pull request modifies the INativeToken interface in the ev-precompiles crate and related documentation to mark the functions as external. This change explicitly defines the functions' visibility, enhancing code clarity and preventing potential misuse.

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

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.

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

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.

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

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.

@damiannolan damiannolan left a comment

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.

ACK.

Side note, looks like the docker build workflow in this repo doesn't support forks. Or rather should probably be skipped on forks since its not required for automated CI deployments.

@tac0turtle tac0turtle merged commit 7bb0c85 into evstack:main Oct 23, 2025
19 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants