doc: add MIT license and license/author in natspec

baofinance · Aug 8, 2020 · ec351ae · ec351ae
1 parent 02a411b
commit ec351ae
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Curve Finance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/contracts/ERC20CRV.vy b/contracts/ERC20CRV.vy
@@ -1,5 +1,8 @@
 # @version 0.2.4
 """
+@title Curve DAO Token
+@author Curve Finance
+@license MIT
 @notice ERC20 with piecewise-linear mining supply.
 @dev Based on the ERC-20 token standard as defined at
      https://eips.ethereum.org/EIPS/eip-20

diff --git a/contracts/GaugeController.vy b/contracts/GaugeController.vy
@@ -2,6 +2,8 @@
 
 """
 @title Gauge Controller
+@author Curve Finance
+@license MIT
 @notice Controls liquidity gauges and the issuance of coins through the gauges
 """
 

diff --git a/contracts/LiquidityGauge.vy b/contracts/LiquidityGauge.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Liquidity Gauge
+@author Curve Finance
+@license MIT
 @notice Used for measuring liquidity and insurance
 """
 

diff --git a/contracts/LiquidityGaugeReward.vy b/contracts/LiquidityGaugeReward.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Staking Liquidity Gauge
+@author Curve Finance
+@license MIT
 @notice Simultaneously stakes using Synthetix (== YFI) rewards contract
 """
 

diff --git a/contracts/Minter.vy b/contracts/Minter.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Token Minter
+@author Curve Finance
+@license MIT
 """
 
 interface LiquidityGauge:

diff --git a/contracts/PoolProxy.vy b/contracts/PoolProxy.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Curve StableSwap Proxy
+@author Curve Finance
+@license MIT
 """
 
 from vyper.interfaces import ERC20

diff --git a/contracts/VestingEscrow.vy b/contracts/VestingEscrow.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Vesting Escrow
+@author Curve Finance
+@license MIT
 @notice Vests `ERC20CRV` tokens for multiple addresses over multiple vesting periods
 """
 

diff --git a/contracts/VestingEscrowFactory.vy b/contracts/VestingEscrowFactory.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Vesting Escrow Factory
+@author Curve Finance
+@license MIT
 @notice Stores and distributes `ERC20CRV` tokens by deploying `VestingEscrowSimple` contracts
 """
 

diff --git a/contracts/VestingEscrowSimple.vy b/contracts/VestingEscrowSimple.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Simple Vesting Escrow
+@author Curve Finance
+@license MIT
 @notice Vests `ERC20CRV` tokens for a single address
 @dev Intended to be deployed many times via `VotingEscrowFactory`
 """

diff --git a/contracts/VotingEscrow.vy b/contracts/VotingEscrow.vy
@@ -1,6 +1,8 @@
 # @version 0.2.4
 """
 @title Voting Escrow
+@author Curve Finance
+@license MIT
 @notice Votes have a weight depending on time, so that users are
         committed to the future of (whatever they are voting for)
 @dev Vote weight decays linearly over time. Lock time cannot be