docs: add documentation about constructor parameters

cartesi · Aug 7, 2024 · 73fbcea · 73fbcea
1 parent 3d40890
commit 73fbcea
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 0 deletions.
diff --git a/contracts/consensus/authority/IAuthorityFactory.sol b/contracts/consensus/authority/IAuthorityFactory.sol
@@ -20,13 +20,15 @@ interface IAuthorityFactory {
     /// @param authorityOwner The initial authority owner
     /// @return The authority
     /// @dev On success, MUST emit an `AuthorityCreated` event.
+    /// @dev Reverts if the authority owner address is zero.
     function newAuthority(address authorityOwner) external returns (Authority);
 
     /// @notice Deploy a new authority deterministically.
     /// @param authorityOwner The initial authority owner
     /// @param salt The salt used to deterministically generate the authority address
     /// @return The authority
     /// @dev On success, MUST emit an `AuthorityCreated` event.
+    /// @dev Reverts if the authority owner address is zero.
     function newAuthority(
         address authorityOwner,
         bytes32 salt

diff --git a/contracts/consensus/quorum/IQuorumFactory.sol b/contracts/consensus/quorum/IQuorumFactory.sol
@@ -20,13 +20,15 @@ interface IQuorumFactory {
     /// @param validators the list of validators
     /// @return The quorum
     /// @dev On success, MUST emit a `QuorumCreated` event.
+    /// @dev Duplicates in the `validators` array are ignored.
     function newQuorum(address[] calldata validators) external returns (Quorum);
 
     /// @notice Deploy a new quorum deterministically.
     /// @param validators the list of validators
     /// @param salt The salt used to deterministically generate the quorum address
     /// @return The quorum
     /// @dev On success, MUST emit a `QuorumCreated` event.
+    /// @dev Duplicates in the `validators` array are ignored.
     function newQuorum(
         address[] calldata validators,
         bytes32 salt

diff --git a/contracts/dapp/Application.sol b/contracts/dapp/Application.sol
@@ -44,6 +44,7 @@ contract Application is
     /// @param consensus The initial consensus contract
     /// @param initialOwner The initial application owner
     /// @param templateHash The initial machine state hash
+    /// @dev Reverts if the initial application owner address is zero.
     constructor(
         IConsensus consensus,
         address initialOwner,

diff --git a/contracts/dapp/IApplicationFactory.sol b/contracts/dapp/IApplicationFactory.sol
@@ -31,6 +31,7 @@ interface IApplicationFactory {
     /// @param templateHash The initial machine state hash
     /// @return The application
     /// @dev On success, MUST emit an `ApplicationCreated` event.
+    /// @dev Reverts if the application owner address is zero.
     function newApplication(
         IConsensus consensus,
         address appOwner,
@@ -44,6 +45,7 @@ interface IApplicationFactory {
     /// @param salt The salt used to deterministically generate the application contract address
     /// @return The application
     /// @dev On success, MUST emit an `ApplicationCreated` event.
+    /// @dev Reverts if the application owner address is zero.
     function newApplication(
         IConsensus consensus,
         address appOwner,

diff --git a/contracts/dapp/ISelfHostedApplicationFactory.sol b/contracts/dapp/ISelfHostedApplicationFactory.sol
@@ -28,6 +28,8 @@ interface ISelfHostedApplicationFactory {
     /// @param salt The salt used to deterministically generate the addresses
     /// @return The application contract
     /// @return The authority contract
+    /// @dev Reverts if the authority owner address is zero.
+    /// @dev Reverts if the application owner address is zero.
     function deployContracts(
         address authorityOwner,
         address appOwner,