Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TomiOhl committed Nov 15, 2023
1 parent 057a7fc commit 5467f7b
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 14 deletions.
14 changes: 0 additions & 14 deletions docs/contracts/interfaces/IBasicGuildRewardNFT.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,17 +220,3 @@ error IncorrectSignature()

Error thrown when the supplied signature is invalid.

### NonExistentToken

```solidity
error NonExistentToken(uint256 tokenId)
```

Error thrown when trying to query info about a token that's not (yet) minted.

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| tokenId | uint256 | The queried id. |

60 changes: 60 additions & 0 deletions docs/contracts/interfaces/IERC5192.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# IERC5192

## Functions

### locked

```solidity
function locked(
uint256 tokenId
) external returns (bool)
```

Returns the locking status of an Soulbound Token

SBTs assigned to zero address are considered invalid, and queries
about them do throw.

#### Parameters

| Name | Type | Description |
| :--- | :--- | :---------- |
| `tokenId` | uint256 | The identifier for an SBT. |

## Events

### Locked

```solidity
event Locked(
uint256 tokenId
)
```

Emitted when the locking status is changed to locked.

If a token is minted and the status is locked, this event should be emitted.

#### Parameters

| Name | Type | Description |
| :--- | :--- | :---------- |
| `tokenId` | uint256 | The identifier for a token. |
### Unlocked

```solidity
event Unlocked(
uint256 tokenId
)
```

Emitted when the locking status is changed to unlocked.

If a token is minted and the status is unlocked, this event should be emitted.

#### Parameters

| Name | Type | Description |
| :--- | :--- | :---------- |
| `tokenId` | uint256 | The identifier for a token. |

33 changes: 33 additions & 0 deletions docs/contracts/token/SoulboundERC721.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ See {IERC165-supportsInterface}.
| :--- | :--- | :---------- |
| `interfaceId` | bytes4 | |

### locked

```solidity
function locked(
uint256 tokenId
) external returns (bool)
```

Returns the locking status of an Soulbound Token

SBTs assigned to zero address are considered invalid, and queries
about them do throw.

#### Parameters

| Name | Type | Description |
| :--- | :--- | :---------- |
| `tokenId` | uint256 | The identifier for an SBT. |

### approve

```solidity
Expand Down Expand Up @@ -169,6 +188,20 @@ Still used for minting/burning.

## Custom errors

### NonExistentToken

```solidity
error NonExistentToken(uint256 tokenId)
```

Error thrown when trying to query info about a token that's not (yet) minted.

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| tokenId | uint256 | The queried id. |

### Soulbound

```solidity
Expand Down

0 comments on commit 5467f7b

Please sign in to comment.