From c26425eee07830eab6e9ec74eb0ea1863c6df4db Mon Sep 17 00:00:00 2001 From: TucksonDev Date: Wed, 27 Mar 2024 16:35:42 +0000 Subject: [PATCH] Add note about token compatibility in the IArbToken interface --- contracts/tokenbridge/arbitrum/IArbToken.sol | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contracts/tokenbridge/arbitrum/IArbToken.sol b/contracts/tokenbridge/arbitrum/IArbToken.sol index b38ca8b376..192b2f9a10 100644 --- a/contracts/tokenbridge/arbitrum/IArbToken.sol +++ b/contracts/tokenbridge/arbitrum/IArbToken.sol @@ -19,6 +19,8 @@ /** * @title Minimum expected interface for L2 token that interacts with the L2 token bridge (this is the interface necessary * for a custom token that interacts with the bridge, see TestArbCustomToken.sol for an example implementation). + * @dev For the token to be compatible out of the box with the tooling available (e.g., the Arbitrum bridge), it is + * recommended to keep the implementation of this interface as close as possible to the `TestArbCustomToken` example. */ // solhint-disable-next-line compiler-version