Skip to content

Commit e07f088

Browse files
authoredAug 23, 2024··
evm: add additional natspec in ManagerBase.sol (#494)
* evm: add additional natspec in ManagerBase.sol * evm: fix enum values for mode * Fix formatting
1 parent af67b2a commit e07f088

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎evm/src/NttManager/ManagerBase.sol

+9
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,19 @@ abstract contract ManagerBase is
2525
{
2626
// =============== Immutables ============================================================
2727

28+
/// @dev Address of the token that this NTT Manager is tied to
2829
address public immutable token;
30+
/// @dev Contract deployer address
2931
address immutable deployer;
32+
/// @dev Mode of the NTT Manager -- this is either LOCKING (Mode = 0) or BURNING (Mode = 1)
33+
/// In LOCKING mode, tokens are locked/unlocked by the NTT Manager contract when sending/redeeming cross-chain transfers.
34+
/// In BURNING mode, tokens are burned/minted by the NTT Manager contract when sending/redeeming cross-chain transfers.
3035
Mode public immutable mode;
36+
/// @dev Wormhole chain ID that the NTT Manager is deployed on.
37+
/// This chain ID is formatted Wormhole Chain IDs -- https://docs.wormhole.com/wormhole/reference/constants
3138
uint16 public immutable chainId;
39+
/// @dev EVM chain ID that the NTT Manager is deployed on.
40+
/// This chain ID is formatted based on standardized chain IDs, e.g. Ethereum mainnet is 1, Sepolia is 11155111, etc.
3241
uint256 immutable evmChainId;
3342

3443
// =============== Setup =================================================================

0 commit comments

Comments
 (0)
Please sign in to comment.