Commit 53d1db02 authored by Indeavr's avatar Indeavr

feat: added @param & @return checks for functions in the output-validator

parent 6c6af634
...@@ -16,7 +16,7 @@ ...@@ -16,7 +16,7 @@
function messenger() external view returns (address) function messenger() external view returns (address)
``` ```
Messenger contract used to send and recieve messages from the other domain.
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
*This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed behind a proxy. Since a proxied contract can't have a constructor, it's common to move constructor logic to an external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer function so it can only be called once. The {initializer} modifier provided by this contract will have this effect. TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}. CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure that all initializers are idempotent. This is not verified automatically as constructors are by Solidity. [CAUTION] ==== Avoid leaving a contract uninitialized. An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation contract, which may impact the proxy. To initialize the implementation contract, you can either invoke the initializer manually, or you can include a constructor to automatically mark it as initialized when it is deployed: [.hljs-theme-light.nopadding] ```* *This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed behind a proxy. Since a proxied contract can't have a constructor, it's common to move constructor logic to an external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer function so it can only be called once. The {initializer} modifier provided by this contract will have this effect. TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}. CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure that all initializers are idempotent. This is not verified automatically as constructors are by Solidity.*
...@@ -200,7 +200,7 @@ function l2TokenBridge() external view returns (address) ...@@ -200,7 +200,7 @@ function l2TokenBridge() external view returns (address)
function messenger() external view returns (address) function messenger() external view returns (address)
``` ```
Messenger contract used to send and recieve messages from the other domain.
......
...@@ -54,7 +54,7 @@ function l1TokenBridge() external view returns (address) ...@@ -54,7 +54,7 @@ function l1TokenBridge() external view returns (address)
function messenger() external view returns (address) function messenger() external view returns (address)
``` ```
Messenger contract used to send and recieve messages from the other domain.
......
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
"@ethersproject/abstract-signer": "^5.4.1", "@ethersproject/abstract-signer": "^5.4.1",
"@ethersproject/hardware-wallets": "^5.4.0", "@ethersproject/hardware-wallets": "^5.4.0",
"@primitivefi/hardhat-dodoc": "^0.1.3", "@primitivefi/hardhat-dodoc": "^0.1.3",
"hardhat-output-validator": "^0.1.7" "hardhat-output-validator": "^0.1.11"
}, },
"devDependencies": { "devDependencies": {
"@codechecks/client": "^0.1.11", "@codechecks/client": "^0.1.11",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment