Skip to content

Commit

Permalink
regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@miquelcabot
miquelcabot committed Aug 16, 2022
1 parent 2e4c373 commit d7bfee0
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 308 deletions.
61 changes: 0 additions & 61 deletions docs/SoulBoundCreditReport.md
View file
Expand Up @@ -301,23 +301,6 @@ function name() external view returns (string)
|---|---|---|
| _0 | string | undefined |

### owner

```solidity
function owner() external view returns (address)
```



*Returns the address of the current owner.*


#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |

### ownerOf

```solidity
Expand Down Expand Up @@ -368,17 +351,6 @@ function paused() external view returns (bool)
|---|---|---|
| _0 | bool | 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.*


### renounceRole

```solidity
Expand Down Expand Up @@ -625,22 +597,6 @@ function transferFrom(address, address, uint256) external pure
| _1 | address | undefined |
| _2 | uint256 | undefined |

### 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 |

### unpause

```solidity
Expand Down Expand Up @@ -692,23 +648,6 @@ event ApprovalForAll(address indexed owner, address indexed operator, bool appro
| operator `indexed` | address | undefined |
| approved | bool | undefined |

### OwnershipTransferred

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





#### Parameters

| Name | Type | Description |
|---|---|---|
| previousOwner `indexed` | address | undefined |
| newOwner `indexed` | address | undefined |

### Paused

```solidity
Expand Down
61 changes: 0 additions & 61 deletions docs/SoulBoundIdentity.md
View file
Expand Up @@ -301,23 +301,6 @@ function name() external view returns (string)
|---|---|---|
| _0 | string | undefined |

### owner

```solidity
function owner() external view returns (address)
```



*Returns the address of the current owner.*


#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |

### ownerOf

```solidity
Expand Down Expand Up @@ -368,17 +351,6 @@ function paused() external view returns (bool)
|---|---|---|
| _0 | bool | 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.*


### renounceRole

```solidity
Expand Down Expand Up @@ -625,22 +597,6 @@ function transferFrom(address, address, uint256) external pure
| _1 | address | undefined |
| _2 | uint256 | undefined |

### 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 |

### unpause

```solidity
Expand Down Expand Up @@ -692,23 +648,6 @@ event ApprovalForAll(address indexed owner, address indexed operator, bool appro
| operator `indexed` | address | undefined |
| approved | bool | undefined |

### OwnershipTransferred

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





#### Parameters

| Name | Type | Description |
|---|---|---|
| previousOwner `indexed` | address | undefined |
| newOwner `indexed` | address | undefined |

### Paused

```solidity
Expand Down
145 changes: 20 additions & 125 deletions docs/SoulBoundName.md
View file
Expand Up @@ -177,51 +177,6 @@ function getRoleAdmin(bytes32 role) external view returns (bytes32)
|---|---|---|
| _0 | bytes32 | undefined |

### getRoleMember

```solidity
function getRoleMember(bytes32 role, uint256 index) external view returns (address)
```



*Returns one of the accounts that have `role`. `index` must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] for more information.*

#### Parameters

| Name | Type | Description |
|---|---|---|
| role | bytes32 | undefined |
| index | uint256 | undefined |

#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |

### getRoleMemberCount

```solidity
function getRoleMemberCount(bytes32 role) external view returns (uint256)
```



*Returns the number of accounts that have `role`. Can be used together with {getRoleMember} to enumerate all bearers of a role.*

#### Parameters

| Name | Type | Description |
|---|---|---|
| role | bytes32 | undefined |

#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |

### grantRole

```solidity
Expand Down Expand Up @@ -285,22 +240,6 @@ function isApprovedForAll(address owner, address operator) external view returns
|---|---|---|
| _0 | bool | undefined |

### mint

```solidity
function mint(address to) external nonpayable
```



*Creates a new token for `to`. Its token ID will be automatically assigned (and available on the emitted {IERC721-Transfer} event), and the token URI autogenerated based on the base URI passed at construction. See {ERC721-_mint}. Requirements: - the caller must have the `MINTER_ROLE`.*

#### Parameters

| Name | Type | Description |
|---|---|---|
| to | address | undefined |

### name

```solidity
Expand Down Expand Up @@ -340,23 +279,6 @@ function nameExists(string name) external nonpayable returns (bool exists)
|---|---|---|
| exists | bool | undefined |

### owner

```solidity
function owner() external view returns (address)
```



*Returns the address of the current owner.*


#### Returns

| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |

### ownerOf

```solidity
Expand Down Expand Up @@ -387,7 +309,7 @@ function pause() external nonpayable



*Pauses all token transfers. See {ERC721Pausable} and {Pausable-_pause}. Requirements: - the caller must have the `PAUSER_ROLE`.*



### paused
Expand All @@ -407,17 +329,6 @@ function paused() external view returns (bool)
|---|---|---|
| _0 | bool | 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.*


### renounceRole

```solidity
Expand Down Expand Up @@ -476,6 +387,23 @@ function revokeRole(bytes32 role, address account) external nonpayable
| role | bytes32 | undefined |
| account | address | undefined |

### safeMint

```solidity
function safeMint(address to, string name) external nonpayable
```





#### Parameters

| Name | Type | Description |
|---|---|---|
| to | address | undefined |
| name | string | undefined |

### safeTransferFrom

```solidity
Expand Down Expand Up @@ -587,7 +515,7 @@ function supportsInterface(bytes4 interfaceId) external view returns (bool)



*See {IERC165-supportsInterface}.*


#### Parameters

Expand Down Expand Up @@ -720,22 +648,6 @@ function transferFrom(address from, address to, uint256 tokenId) external nonpay
| to | address | undefined |
| tokenId | uint256 | undefined |

### 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 |

### unpause

```solidity
Expand All @@ -744,7 +656,7 @@ function unpause() external nonpayable



*Unpauses all token transfers. See {ERC721Pausable} and {Pausable-_unpause}. Requirements: - the caller must have the `PAUSER_ROLE`.*




Expand Down Expand Up @@ -787,23 +699,6 @@ event ApprovalForAll(address indexed owner, address indexed operator, bool appro
| operator `indexed` | address | undefined |
| approved | bool | undefined |

### OwnershipTransferred

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





#### Parameters

| Name | Type | Description |
|---|---|---|
| previousOwner `indexed` | address | undefined |
| newOwner `indexed` | address | undefined |

### Paused

```solidity
Expand Down

0 comments on commit d7bfee0

Please sign in to comment.