update documentation
This commit is contained in:
@@ -1,46 +1,42 @@
|
||||
# Owned
|
||||
# Solidity API
|
||||
|
||||
_Solmate (https://github.com/Rari-Capital/solmate/blob/main/src/auth/Owned.sol)_
|
||||
## Owned
|
||||
|
||||
Simple single owner authorization mixin.
|
||||
|
||||
## Methods
|
||||
|
||||
### owner
|
||||
### Unauthorized
|
||||
|
||||
```solidity
|
||||
function owner() external view returns (address)
|
||||
error Unauthorized()
|
||||
```
|
||||
|
||||
#### Returns
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | ------- | ----------- |
|
||||
| \_0 | address | undefined |
|
||||
|
||||
### setOwner
|
||||
|
||||
```solidity
|
||||
function setOwner(address newOwner) external nonpayable
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
| Name | Type | Description |
|
||||
| -------- | ------- | ----------- |
|
||||
| newOwner | address | undefined |
|
||||
|
||||
## Events
|
||||
|
||||
### OwnerUpdated
|
||||
|
||||
```solidity
|
||||
event OwnerUpdated(address indexed user, address indexed newOwner)
|
||||
event OwnerUpdated(address user, address newOwner)
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
### owner
|
||||
|
||||
```solidity
|
||||
address owner
|
||||
```
|
||||
|
||||
### onlyOwner
|
||||
|
||||
```solidity
|
||||
modifier onlyOwner()
|
||||
```
|
||||
|
||||
### constructor
|
||||
|
||||
```solidity
|
||||
constructor(address _owner) internal
|
||||
```
|
||||
|
||||
### setOwner
|
||||
|
||||
```solidity
|
||||
function setOwner(address newOwner) public virtual
|
||||
```
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------------ | ------- | ----------- |
|
||||
| user `indexed` | address | undefined |
|
||||
| newOwner `indexed` | address | undefined |
|
||||
|
||||
Reference in New Issue
Block a user