prepare for merge to master

windingtree · Feb 26, 2020 · 6e8a837 · 6e8a837
1 parent 42eb6ab
commit 6e8a837
Show file tree

Hide file tree

Showing 7 changed files with 1,289 additions and 25 deletions.
diff --git a/contracts/OrgId.sol b/contracts/OrgId.sol
@@ -461,18 +461,22 @@ contract OrgId is OrgIdInterface, Ownable, ERC165, Initializable {
 
     /**
      * @dev Returns Lif token address
-     * @return address
+     * @return {
+         "lifToken": "Address of the Lif token"
+     }
      */
-    function getLifTokenAddress() external view returns (address) {
-        return address(lif);
+    function getLifTokenAddress() external view returns (address lifToken) {
+        lifToken = address(lif);
     }
 
     /**
      * @dev Returns withdrawDelay value
-     * @return uint256
+     * @return {
+         "delay": "Delay time in seconds before the requested withdrawal will be possible"
+     }
      */
-    function getWithdrawDelay() external view returns (uint256) {
-        return withdrawDelay;
+    function getWithdrawDelay() external view returns (uint256 delay) {
+        delay = withdrawDelay;
     }
 
     /**

diff --git a/contracts/test/OrgIdTimeMachine.sol b/contracts/test/OrgIdTimeMachine.sol
@@ -20,10 +20,12 @@ contract OrgIdTimeMachine is OrgId {
 
     /**
      * @dev Get current contract time
-     * @return uint256
+     * @return {
+         "contractTime": "Current time inside the contract used as 'now'"
+     }
      */
-    function currentTime() public view returns (uint256) {
-        return time();
+    function currentTime() public view returns (uint256 contractTime) {
+        contractTime = time();
     }
 
     /**

diff --git a/docs/LifTest.md b/docs/LifTest.md
@@ -0,0 +1,247 @@
+* [LifTest](#liftest)
+  * [Approval](#event-approval)
+  * [MinterAdded](#event-minteradded)
+  * [MinterRemoved](#event-minterremoved)
+  * [Transfer](#event-transfer)
+  * [addMinter](#function-addminter)
+  * [allowance](#function-allowance)
+  * [approve](#function-approve)
+  * [balanceOf](#function-balanceof)
+  * [decimals](#function-decimals)
+  * [decreaseAllowance](#function-decreaseallowance)
+  * [increaseAllowance](#function-increaseallowance)
+  * [isMinter](#function-isminter)
+  * [mint](#function-mint)
+  * [name](#function-name)
+  * [renounceMinter](#function-renounceminter)
+  * [symbol](#function-symbol)
+  * [totalSupply](#function-totalsupply)
+  * [transfer](#function-transfer)
+  * [transferFrom](#function-transferfrom)
+
+# LifTest
+
+
+## *event* Approval
+
+LifTest.Approval(owner, spender, value) `8c5be1e5`
+
+Arguments
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | owner | indexed |
+| *address* | spender | indexed |
+| *uint256* | value | not indexed |
+
+## *event* MinterAdded
+
+LifTest.MinterAdded(account) `6ae17283`
+
+Arguments
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | account | indexed |
+
+## *event* MinterRemoved
+
+LifTest.MinterRemoved(account) `e94479a9`
+
+Arguments
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | account | indexed |
+
+## *event* Transfer
+
+LifTest.Transfer(from, to, value) `ddf252ad`
+
+Arguments
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | from | indexed |
+| *address* | to | indexed |
+| *uint256* | value | not indexed |
+
+
+## *function* addMinter
+
+LifTest.addMinter(account) `nonpayable` `983b2d56`
+
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | account | undefined |
+
+
+## *function* allowance
+
+LifTest.allowance(owner, spender) `view` `dd62ed3e`
+
+> See {IERC20-allowance}.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | owner | undefined |
+| *address* | spender | undefined |
+
+
+## *function* approve
+
+LifTest.approve(spender, amount) `nonpayable` `095ea7b3`
+
+> See {IERC20-approve}.     * Requirements:     * - `spender` cannot be the zero address.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | spender | undefined |
+| *uint256* | amount | undefined |
+
+
+## *function* balanceOf
+
+LifTest.balanceOf(account) `view` `70a08231`
+
+> See {IERC20-balanceOf}.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | account | undefined |
+
+
+## *function* decimals
+
+LifTest.decimals() `view` `313ce567`
+
+
+
+
+
+## *function* decreaseAllowance
+
+LifTest.decreaseAllowance(spender, subtractedValue) `nonpayable` `a457c2d7`
+
+> Atomically decreases the allowance granted to `spender` by the caller.     * This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}.     * Emits an {Approval} event indicating the updated allowance.     * Requirements:     * - `spender` cannot be the zero address. - `spender` must have allowance for the caller of at least `subtractedValue`.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | spender | undefined |
+| *uint256* | subtractedValue | undefined |
+
+
+## *function* increaseAllowance
+
+LifTest.increaseAllowance(spender, addedValue) `nonpayable` `39509351`
+
+> Atomically increases the allowance granted to `spender` by the caller.     * This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}.     * Emits an {Approval} event indicating the updated allowance.     * Requirements:     * - `spender` cannot be the zero address.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | spender | undefined |
+| *uint256* | addedValue | undefined |
+
+
+## *function* isMinter
+
+LifTest.isMinter(account) `view` `aa271e1a`
+
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | account | undefined |
+
+
+## *function* mint
+
+LifTest.mint(account, amount) `nonpayable` `40c10f19`
+
+> See {ERC20-_mint}.     * Requirements:     * - the caller must have the {MinterRole}.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | account | undefined |
+| *uint256* | amount | undefined |
+
+
+## *function* name
+
+LifTest.name() `view` `06fdde03`
+
+
+
+
+
+## *function* renounceMinter
+
+LifTest.renounceMinter() `nonpayable` `98650275`
+
+
+
+
+
+## *function* symbol
+
+LifTest.symbol() `view` `95d89b41`
+
+
+
+
+
+## *function* totalSupply
+
+LifTest.totalSupply() `view` `18160ddd`
+
+> See {IERC20-totalSupply}.
+
+
+
+
+## *function* transfer
+
+LifTest.transfer(recipient, amount) `nonpayable` `a9059cbb`
+
+> See {IERC20-transfer}.     * Requirements:     * - `recipient` cannot be the zero address. - the caller must have a balance of at least `amount`.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | recipient | undefined |
+| *uint256* | amount | undefined |
+
+
+## *function* transferFrom
+
+LifTest.transferFrom(sender, recipient, amount) `nonpayable` `23b872dd`
+
+> See {IERC20-transferFrom}.     * Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20};     * Requirements: - `sender` and `recipient` cannot be the zero address. - `sender` must have a balance of at least `amount`. - the caller must have allowance for `sender`'s tokens of at least `amount`.
+
+Inputs
+
+| **type** | **name** | **description** |
+|-|-|-|
+| *address* | sender | undefined |
+| *address* | recipient | undefined |
+| *uint256* | amount | undefined |
+
+
+---