diff --git a/docs/contracts/interfaces/IBasicGuildRewardNFT.md b/docs/contracts/interfaces/IBasicGuildRewardNFT.md index 97e1835..c366281 100644 --- a/docs/contracts/interfaces/IBasicGuildRewardNFT.md +++ b/docs/contracts/interfaces/IBasicGuildRewardNFT.md @@ -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. | - diff --git a/docs/contracts/interfaces/IERC5192.md b/docs/contracts/interfaces/IERC5192.md new file mode 100644 index 0000000..97fb0c1 --- /dev/null +++ b/docs/contracts/interfaces/IERC5192.md @@ -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. | + diff --git a/docs/contracts/token/SoulboundERC721.md b/docs/contracts/token/SoulboundERC721.md index e2a0b7a..7ab6946 100644 --- a/docs/contracts/token/SoulboundERC721.md +++ b/docs/contracts/token/SoulboundERC721.md @@ -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 @@ -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