Skip to content

Commit

Permalink
Update natspec
Browse files Browse the repository at this point in the history
  • Loading branch information
DarksightKellar committed Oct 28, 2024
1 parent d2b15f1 commit 866716c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions contracts/DecentHats_0_1_0.sol
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,14 @@ contract DecentHats_0_1_0 {
}

/**
* Creates a new role hat and any streams on it.
* @notice Creates a new role hat and any streams on it.
*
* This contract should be enabled a module on the Safe for which the role is to be created, and disable after.
* In order for the module to be able to create hats on behalf of the Safe, the Safe must first
* transfer its top hat to this contract. This function transfers the top hat back to the Safe after
* @notice This contract should be enabled a module on the Safe for which the role is to be created, and disabled after.
*
* @dev In order for the module to be able to create hats on behalf of the Safe, the Safe must first transfer its top hat to this contract. This function transfers the top hat back to the Safe after
* creating the role hat.
*
* The function simply calls `createHatAndAccountAndMintAndStreams` and then transfers the top hat back to the Safe.
* @dev The function simply calls `createHatAndAccountAndMintAndStreams` and then transfers the top hat back to the Safe.
*
* @dev Role hat creation, minting, smart account creation and stream creation are handled here in order
* to avoid a race condition where not more than one active proposal to create a new role can exist at a time.
Expand Down Expand Up @@ -233,10 +233,10 @@ contract DecentHats_0_1_0 {
}

/**
* For a safe without any roles previously created on it, this function should be called. It sets up the
* @notice For a safe without any roles previously created on it, this function should be called. It sets up the
* top hat and admin hat, as well as any other hats and their streams that are provided.
*
* This contract should be enabled a module on the Safe for which the role(s) are to be created, and disabled after.
* @notice This contract should be enabled a module on the Safe for which the role(s) are to be created, and disabled after.
*
* @dev In order for a Safe to seamlessly create roles even if it has never previously created a role and thus has
* no hat tree, we defer the creation of the hat tree and its setup to this contract. This way, in a single tx block,
Expand Down

0 comments on commit 866716c

Please sign in to comment.