Skip to content

Commit

Permalink
chore: Update NatSpec
Browse files Browse the repository at this point in the history
  • Loading branch information
mgnfy-view committed May 19, 2024
1 parent ffa3854 commit bc289b2
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 1 deletion.
5 changes: 5 additions & 0 deletions src/core/lib/LiquiditySupplyAndSwapMath.sol
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
// SPDX-License-Identifier: MIT
pragma solidity 0.8.20;

/**
* @title LiquiditySupplyAndSwapMath
* @author mgnfy-view
* @notice A library to aid in calcultion for supplying liquidity and swapping tokens
*/
library LiquiditySupplyAndSwapMath {
function getPoolToken2LiquidityToAddBasedOnPoolToken1Amount(
uint256 _poolToken1Amount,
Expand Down
2 changes: 1 addition & 1 deletion src/governance/Thud.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { ERC20Permit, Nonces } from "@openzeppelin/contracts/token/ERC20/extensi
import { ERC20Votes } from "@openzeppelin/contracts/token/ERC20/extensions/ERC20Votes.sol";

/**
* @title THUD TOken
* @title THUD Token
* @author Sahil Gujrati aka mgnfy.view
* @notice This is the key utility and governance token of the Thunder Swap protocol
*/
Expand Down
5 changes: 5 additions & 0 deletions src/governance/ThunderGovernor.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ import {
import { GovernorVotesQuorumFraction } from
"@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol";

/**
* @title ThunderGovernor
* @author mgnfy-view
* @notice Governor contract for creating governance proposals
*/
contract ThunderGovernor is
Governor,
GovernorSettings,
Expand Down
5 changes: 5 additions & 0 deletions src/governance/ThunderTimelock.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ pragma solidity ^0.8.0;

import { TimelockController } from "@openzeppelin/contracts/governance/TimelockController.sol";

/**
* @title ThunderGovernor
* @author mgnfy-view
* @notice The timelock allows execution of passed governance proposals after a certain delay.
*/
contract ThunderTimeLock is TimelockController {
// minDelay is how long you have to wait before executing
// proposers is the list of addresses that can propose
Expand Down

0 comments on commit bc289b2

Please sign in to comment.