Skip to content

Commit 4554c2e

Browse files
authored
evm: Update INttToken.sol documentation (#653)
* Update INttToken.sol Clarify that `setMinter` is not a required function for integration with NTT. * Update INttToken.sol
1 parent 39ecf6d commit 4554c2e

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

evm/src/interfaces/INttToken.sol

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,15 @@ interface INttToken {
2424
event NewMinter(address previousMinter, address newMinter);
2525

2626
// NOTE: the `mint` method is not present in the standard ERC20 interface.
27+
// If using NTT in hub-and-spoke mode, this function is required in the token contract for all spoke chains.
28+
// If using NTT in burn-and-mint mode, this function is required in the token contract for all chains.
2729
function mint(address account, uint256 amount) external;
2830

2931
// NOTE: the `setMinter` method is not present in the standard ERC20 interface.
32+
// This is not a required function for integration with NTT. It is recommended to provide flexibility to change the minter in the future,
33+
// or allow for setting multiple token minter addresses.
34+
// There are also other legitimate ways to implement minter management, such as using role-based access control or a custom approach,
35+
// as opposed to the example of using a single setter that's presented here.
3036
function setMinter(
3137
address newMinter
3238
) external;

0 commit comments

Comments
 (0)