Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bd7a2dd
commit 636b33f
Showing
2 changed files
with
82 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Ownable | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
*Contract module which provides a basic access control mechanism, where there is an account (an owner) that can be granted exclusive access to specific functions. By default, the owner account will be the one that deploys the contract. This can later be changed with {transferOwnership}. This module is used through inheritance. It will make available the modifier `onlyOwner`, which can be applied to your functions to restrict their use to the owner.* | ||
|
||
## Methods | ||
|
||
### owner | ||
|
||
```solidity | ||
function owner() external view returns (address) | ||
``` | ||
|
||
|
||
|
||
*Returns the address of the current owner.* | ||
|
||
|
||
#### Returns | ||
|
||
| Name | Type | Description | | ||
|---|---|---| | ||
| _0 | address | undefined | | ||
|
||
### renounceOwnership | ||
|
||
```solidity | ||
function renounceOwnership() external nonpayable | ||
``` | ||
|
||
|
||
|
||
*Leaves the contract without owner. It will not be possible to call `onlyOwner` functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.* | ||
|
||
|
||
### transferOwnership | ||
|
||
```solidity | ||
function transferOwnership(address newOwner) external nonpayable | ||
``` | ||
|
||
|
||
|
||
*Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.* | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
|---|---|---| | ||
| newOwner | address | undefined | | ||
|
||
|
||
|
||
## Events | ||
|
||
### OwnershipTransferred | ||
|
||
```solidity | ||
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner) | ||
``` | ||
|
||
|
||
|
||
|
||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
|---|---|---| | ||
| previousOwner `indexed` | address | undefined | | ||
| newOwner `indexed` | address | undefined | | ||
|
||
|
||
|