Skip to content

Commit

Permalink
Updates docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@steven2308
steven2308 committed Sep 19, 2023
1 parent 4333d9c commit b473069
Show file tree
Hide file tree
Showing 42 changed files with 324 additions and 324 deletions.
2 changes: 1 addition & 1 deletion docs/RMRK/emotable/IRMRKEmotesRepository.md → docs/RMRK/emotable/IERC7409.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# IRMRKEmotesRepository
# IERC7409



Expand Down
16 changes: 8 additions & 8 deletions docs/RMRK/equippable/RMRKEquippable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Used to verify whether a token can be equipped into a given parent's slot.
### childOf

```solidity
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific active child token for a given parent token.
Expand All @@ -240,12 +240,12 @@ Used to retrieve a specific active child token for a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containing data about the specified child |
| _0 | IERC7401.Child | A Child struct containing data about the specified child |

### childrenOf

```solidity
function childrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function childrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the active child tokens of a given parent token.
Expand All @@ -262,7 +262,7 @@ Used to retrieve the active child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's active child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's active child tokens |

### directOwnerOf

Expand Down Expand Up @@ -625,7 +625,7 @@ Used to retrieve the *root* owner of a given token.
### pendingChildOf

```solidity
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific pending child token from a given parent token.
Expand All @@ -643,12 +643,12 @@ Used to retrieve a specific pending child token from a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containting data about the specified child |
| _0 | IERC7401.Child | A Child struct containting data about the specified child |

### pendingChildrenOf

```solidity
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the pending child tokens of a given parent token.
Expand All @@ -665,7 +665,7 @@ Used to retrieve the pending child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's pending child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's pending child tokens |

### rejectAllAssets

Expand Down
16 changes: 8 additions & 8 deletions docs/RMRK/equippable/RMRKMinifiedEquippable.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ Used to verify whether a token can be equipped into a given parent's slot.
### childOf

```solidity
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific active child token for a given parent token.
Expand All @@ -240,12 +240,12 @@ Used to retrieve a specific active child token for a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containing data about the specified child |
| _0 | IERC7401.Child | A Child struct containing data about the specified child |

### childrenOf

```solidity
function childrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function childrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the active child tokens of a given parent token.
Expand All @@ -262,7 +262,7 @@ Used to retrieve the active child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's active child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's active child tokens |

### directOwnerOf

Expand Down Expand Up @@ -625,7 +625,7 @@ Used to retrieve the *root* owner of a given token.
### pendingChildOf

```solidity
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific pending child token from a given parent token.
Expand All @@ -643,12 +643,12 @@ Used to retrieve a specific pending child token from a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containting data about the specified child |
| _0 | IERC7401.Child | A Child struct containting data about the specified child |

### pendingChildrenOf

```solidity
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the pending child tokens of a given parent token.
Expand All @@ -665,7 +665,7 @@ Used to retrieve the pending child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's pending child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's pending child tokens |

### rejectAllAssets

Expand Down
16 changes: 8 additions & 8 deletions docs/RMRK/extension/nestableAutoIndex/IRMRKNestableAutoIndex.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Used to burn a given token.
### childOf

```solidity
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific active child token for a given parent token.
Expand All @@ -109,12 +109,12 @@ Used to retrieve a specific active child token for a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containing data about the specified child |
| _0 | IERC7401.Child | A Child struct containing data about the specified child |

### childrenOf

```solidity
function childrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function childrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the active child tokens of a given parent token.
Expand All @@ -131,7 +131,7 @@ Used to retrieve the active child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's active child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's active child tokens |

### directOwnerOf

Expand Down Expand Up @@ -202,7 +202,7 @@ Used to retrieve the *root* owner of a given token.
### pendingChildOf

```solidity
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific pending child token from a given parent token.
Expand All @@ -220,12 +220,12 @@ Used to retrieve a specific pending child token from a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containting data about the specified child |
| _0 | IERC7401.Child | A Child struct containting data about the specified child |

### pendingChildrenOf

```solidity
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the pending child tokens of a given parent token.
Expand All @@ -242,7 +242,7 @@ Used to retrieve the pending child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's pending child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's pending child tokens |

### rejectAllChildren

Expand Down
16 changes: 8 additions & 8 deletions docs/RMRK/extension/nestableAutoIndex/RMRKNestableAutoIndex.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Used to burn a given token.
### childOf

```solidity
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific active child token for a given parent token.
Expand All @@ -198,12 +198,12 @@ Used to retrieve a specific active child token for a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containing data about the specified child |
| _0 | IERC7401.Child | A Child struct containing data about the specified child |

### childrenOf

```solidity
function childrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function childrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the active child tokens of a given parent token.
Expand All @@ -220,7 +220,7 @@ Used to retrieve the active child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's active child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's active child tokens |

### directOwnerOf

Expand Down Expand Up @@ -336,7 +336,7 @@ function ownerOf(uint256 tokenId) external view returns (address)
### pendingChildOf

```solidity
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific pending child token from a given parent token.
Expand All @@ -354,12 +354,12 @@ Used to retrieve a specific pending child token from a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containting data about the specified child |
| _0 | IERC7401.Child | A Child struct containting data about the specified child |

### pendingChildrenOf

```solidity
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the pending child tokens of a given parent token.
Expand All @@ -376,7 +376,7 @@ Used to retrieve the pending child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's pending child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's pending child tokens |

### rejectAllChildren

Expand Down
16 changes: 8 additions & 8 deletions docs/RMRK/extension/reclaimableChild/RMRKReclaimableChild.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Used to burn a given token.
### childOf

```solidity
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function childOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific active child token for a given parent token.
Expand All @@ -180,12 +180,12 @@ Used to retrieve a specific active child token for a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containing data about the specified child |
| _0 | IERC7401.Child | A Child struct containing data about the specified child |

### childrenOf

```solidity
function childrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function childrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the active child tokens of a given parent token.
Expand All @@ -202,7 +202,7 @@ Used to retrieve the active child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's active child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's active child tokens |

### directOwnerOf

Expand Down Expand Up @@ -318,7 +318,7 @@ Used to retrieve the *root* owner of a given token.
### pendingChildOf

```solidity
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC6059.Child)
function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child)
```

Used to retrieve a specific pending child token from a given parent token.
Expand All @@ -336,12 +336,12 @@ Used to retrieve a specific pending child token from a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child | A Child struct containting data about the specified child |
| _0 | IERC7401.Child | A Child struct containting data about the specified child |

### pendingChildrenOf

```solidity
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC6059.Child[])
function pendingChildrenOf(uint256 parentId) external view returns (struct IERC7401.Child[])
```

Used to retrieve the pending child tokens of a given parent token.
Expand All @@ -358,7 +358,7 @@ Used to retrieve the pending child tokens of a given parent token.

| Name | Type | Description |
|---|---|---|
| _0 | IERC6059.Child[] | An array of Child structs containing the parent token's pending child tokens |
| _0 | IERC7401.Child[] | An array of Child structs containing the parent token's pending child tokens |

### reclaimChild

Expand Down
Loading

0 comments on commit b473069

Please sign in to comment.