From c58e6c797fffdfe9d726d475e99000df5c0751fa Mon Sep 17 00:00:00 2001 From: Nikhil Suri Date: Thu, 1 Aug 2024 11:11:59 -0700 Subject: [PATCH] evm: add additional natspec in ManagerBase.sol --- evm/src/NttManager/ManagerBase.sol | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/evm/src/NttManager/ManagerBase.sol b/evm/src/NttManager/ManagerBase.sol index 7ae363037..841e15dc3 100644 --- a/evm/src/NttManager/ManagerBase.sol +++ b/evm/src/NttManager/ManagerBase.sol @@ -25,10 +25,19 @@ abstract contract ManagerBase is { // =============== Immutables ============================================================ + /// @dev Address of the token that this NTT Manager is tied to address public immutable token; + /// @dev Contract deployer address address immutable deployer; + /// @dev Mode of the NTT Manager -- this is either LOCKING (Mode = 1) or BURNING (Mode = 2) + /// In LOCKING mode, tokens are locked/unlocked by the NTT Manager contract when sending/redeeming cross-chain transfers. + /// In BURNING mode, tokens are burned/minted by the NTT Manager contract when sending/redeeming cross-chain transfers. Mode public immutable mode; + /// @dev Wormhole chain ID that the NTT Manager is deployed on. + /// This chain ID is formatted Wormhole Chain IDs -- https://docs.wormhole.com/wormhole/reference/constants uint16 public immutable chainId; + /// @dev EVM chain ID that the NTT Manager is deployed on. + /// This chain ID is formatted based on standardized chain IDs, e.g. Ethereum mainnet is 1, Sepolia is 11155111, etc. uint256 immutable evmChainId; // =============== Setup =================================================================