Skip to content

Commit

Permalink
CI: 2.7.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Docs Syncer committed Feb 27, 2024
1 parent fe6cc40 commit 1decdc7
Show file tree
Hide file tree
Showing 15 changed files with 70 additions and 45 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,6 @@ The Diamond standard module

This is modified version of OpenZeppelin's AccessControl contract to be used as a Storage contract
by the Diamond Standard.
## Modifiers info

### onlyRole

```solidity
modifier onlyRole(bytes32 role_)
```

Modifier that checks that an account has a specific role. Reverts
with a standardized message including the required role.

The format of the revert reason is given by the following regular expression:

/^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
## Functions info

### grantRole (0x2f2ff15d)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,20 @@ bytes32 constant DEFAULT_ADMIN_ROLE = 0x00
```


## Modifiers info

### onlyRole

```solidity
modifier onlyRole(bytes32 role_)
```

Modifier that checks that an account has a specific role. Reverts
with a standardized message including the required role.

The format of the revert reason is given by the following regular expression:

/^AccessControl: account (0x[0-9a-f]{40}) is missing role (0x[0-9a-f]{64})$/
## Functions info

### hasRole (0x91d14854)
Expand Down
47 changes: 47 additions & 0 deletions docs/reference/contracts/diamond/access/ownable/DiamondOwnable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# DiamondOwnable

## Overview

#### License: MIT

```solidity
contract DiamondOwnable is DiamondOwnableStorage
```

The Diamond standard module

This is modified version of OpenZeppelin's Ownable contract to be used as a Storage contract
by the Diamond Standard.
## Events info

### OwnershipTransferred

```solidity
event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)
```


## Functions info

### transferOwnership (0xf2fde38b)

```solidity
function transferOwnership(address newOwner_) public virtual onlyOwner
```

The function to transfer the Diamond ownership


Parameters:

| Name | Type | Description |
| :-------- | :------ | :--------------------------- |
| newOwner_ | address | the new owner of the Diamond |

### renounceOwnership (0x715018a6)

```solidity
function renounceOwnership() public virtual onlyOwner
```

The function to leave Diamond without an owner
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
# OwnableDiamondStorage
# DiamondOwnableStorage

## Overview

#### License: MIT

```solidity
abstract contract OwnableDiamondStorage
abstract contract DiamondOwnableStorage is InitializableStorage
```

The Diamond standard module

The storage contract of Ownable Diamond preset
This is an Ownable Storage contract with Diamond Standard support
## Structs info

### ODStorage
### DOStorage

```solidity
struct ODStorage {
struct DOStorage {
address owner;
}
```


## Constants info

### OWNABLE_DIAMOND_STORAGE_SLOT (0xe3e077ad)
### DIAMOND_OWNABLE_STORAGE_SLOT (0x4ac3371e)

```solidity
bytes32 constant OWNABLE_DIAMOND_STORAGE_SLOT = keccak256("diamond.standard.ownablediamond.storage")
bytes32 constant DIAMOND_OWNABLE_STORAGE_SLOT = keccak256("diamond.standard.diamond.ownable.storage")
```


Expand All @@ -45,7 +45,7 @@ modifier onlyOwner()
### owner (0x8da5cb5b)

```solidity
function owner() public view returns (address)
function owner() public view virtual returns (address)
```

The function to get the Diamond owner
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,36 +5,14 @@
#### License: MIT

```solidity
contract OwnableDiamond is Diamond, OwnableDiamondStorage
contract OwnableDiamond is Diamond, DiamondOwnable
```

The Diamond standard module

The Ownable preset of Diamond proxy
## Functions info

### constructor

```solidity
constructor()
```


### transferOwnership (0xf2fde38b)

```solidity
function transferOwnership(address newOwner_) public onlyOwner
```

The function to transfer the Diamond ownerhip


Parameters:

| Name | Type | Description |
| :-------- | :------ | :--------------------------- |
| newOwner_ | address | the new owner of the Diamond |

### diamondCut (0xe57e69c6)

```solidity
Expand Down
File renamed without changes.

0 comments on commit 1decdc7

Please sign in to comment.