From 8e6c58277bd138e0dee76e0332dfac4c1f5e4ce5 Mon Sep 17 00:00:00 2001 From: CJ42 <cavallerajean@gmail.com> Date: Tue, 26 Sep 2023 09:40:19 +0100 Subject: [PATCH] chore: fix linter errors and re-generate docs --- .../extensions/LSP8CompatibleERC721.sol | 3 +-- .../LSP8CompatibleERC721InitAbstract.sol | 3 +-- .../extensions/LSP8CompatibleERC721.md | 20 +++++++++---------- .../presets/LSP8CompatibleERC721Mintable.md | 20 +++++++++---------- 4 files changed, 22 insertions(+), 24 deletions(-) diff --git a/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.sol b/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.sol index b0608784d..e849e8e6b 100644 --- a/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.sol +++ b/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.sol @@ -23,7 +23,6 @@ import { } from "../../LSP4DigitalAssetMetadata/LSP4Compatibility.sol"; import { LSP8IdentifiableDigitalAsset, - LSP4DigitalAssetMetadata, ERC725YCore } from "../LSP8IdentifiableDigitalAsset.sol"; import { @@ -408,7 +407,7 @@ abstract contract LSP8CompatibleERC721 is } /** - * @inheritdoc LSP4DigitalAssetMetadata + * @inheritdoc LSP8IdentifiableDigitalAsset */ function _setData( bytes32 key, diff --git a/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721InitAbstract.sol b/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721InitAbstract.sol index c9bb12011..4f6b8769c 100644 --- a/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721InitAbstract.sol +++ b/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721InitAbstract.sol @@ -23,7 +23,6 @@ import { } from "../../LSP4DigitalAssetMetadata/LSP4Compatibility.sol"; import { LSP8IdentifiableDigitalAssetInitAbstract, - LSP4DigitalAssetMetadataInitAbstract, ERC725YCore } from "../LSP8IdentifiableDigitalAssetInitAbstract.sol"; import { @@ -419,7 +418,7 @@ abstract contract LSP8CompatibleERC721InitAbstract is } /** - * @inheritdoc LSP4DigitalAssetMetadataInitAbstract + * @inheritdoc LSP8IdentifiableDigitalAssetInitAbstract */ function _setData( bytes32 key, diff --git a/docs/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md b/docs/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md index 251830fac..00b4ad1b7 100644 --- a/docs/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md +++ b/docs/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md @@ -1358,15 +1358,15 @@ event Approval(address indexed owner, address indexed operator, uint256 indexed _ERC721 `Approval` compatible event emitted. Successfully approved operator `operator` to operate on tokenId `tokenId` on behalf of token owner `owner`._ -Emitted when the allowance of a `spender` for an `owner` is set by a call to [`approve`](#approve). `value` is the new allowance. +ERC721 `Approval` event emitted when `owner` enables `operator` for `tokenId`. To provide compatibility with indexing ERC721 events. #### Parameters -| Name | Type | Description | -| ------------------------ | :-------: | ---------------------------- | -| `owner` **`indexed`** | `address` | The account giving approval | -| `operator` **`indexed`** | `address` | The address set as operator. | -| `tokenId` **`indexed`** | `uint256` | The approved tokenId. | +| Name | Type | Description | +| ------------------------ | :-------: | ------------------------------------------ | +| `owner` **`indexed`** | `address` | The address of the owner of the `tokenId`. | +| `operator` **`indexed`** | `address` | The address set as operator. | +| `tokenId` **`indexed`** | `uint256` | The approved tokenId. | <br/> @@ -1387,7 +1387,7 @@ event ApprovalForAll(address indexed owner, address indexed operator, bool appro _ERC721 `ApprovalForAll` compatible event emitted. Successfully set "approved for all" status to `approved` for operator `operator` for token owner `owner`._ -Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to `approved`. +ERC721 `ApprovalForAll` event emitted when an `operator` is enabled or disabled for an owner to transfer any of its tokenIds. The operator can manage all NFTs of the owner. #### Parameters @@ -1524,14 +1524,14 @@ event Transfer(address indexed from, address indexed to, uint256 indexed tokenId _ERC721 `Transfer` compatible event emitted. Successfully transferred tokenId `tokenId` from `from` to `to`._ -Emitted when `value` tokens are moved from one account (`from`) to another (`to`). Note that `value` may be zero. +ERC721 `Transfer` event emitted when `tokenId` token is transferred from `from` to `to`. To provide compatibility with indexing ERC721 events. #### Parameters | Name | Type | Description | | ----------------------- | :-------: | ------------------------ | -| `from` **`indexed`** | `address` | The sending address | -| `to` **`indexed`** | `address` | The receiving address | +| `from` **`indexed`** | `address` | The sending address. | +| `to` **`indexed`** | `address` | The receiving address. | | `tokenId` **`indexed`** | `uint256` | The tokenId to transfer. | <br/> diff --git a/docs/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md b/docs/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md index 62dbfd8e3..f9dc87982 100644 --- a/docs/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md +++ b/docs/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md @@ -1404,15 +1404,15 @@ event Approval(address indexed owner, address indexed operator, uint256 indexed _ERC721 `Approval` compatible event emitted. Successfully approved operator `operator` to operate on tokenId `tokenId` on behalf of token owner `owner`._ -Emitted when the allowance of a `spender` for an `owner` is set by a call to [`approve`](#approve). `value` is the new allowance. +ERC721 `Approval` event emitted when `owner` enables `operator` for `tokenId`. To provide compatibility with indexing ERC721 events. #### Parameters -| Name | Type | Description | -| ------------------------ | :-------: | ---------------------------- | -| `owner` **`indexed`** | `address` | The account giving approval | -| `operator` **`indexed`** | `address` | The address set as operator. | -| `tokenId` **`indexed`** | `uint256` | The approved tokenId. | +| Name | Type | Description | +| ------------------------ | :-------: | ------------------------------------------ | +| `owner` **`indexed`** | `address` | The address of the owner of the `tokenId`. | +| `operator` **`indexed`** | `address` | The address set as operator. | +| `tokenId` **`indexed`** | `uint256` | The approved tokenId. | <br/> @@ -1433,7 +1433,7 @@ event ApprovalForAll(address indexed owner, address indexed operator, bool appro _ERC721 `ApprovalForAll` compatible event emitted. Successfully set "approved for all" status to `approved` for operator `operator` for token owner `owner`._ -Emitted when `account` grants or revokes permission to `operator` to transfer their tokens, according to `approved`. +ERC721 `ApprovalForAll` event emitted when an `operator` is enabled or disabled for an owner to transfer any of its tokenIds. The operator can manage all NFTs of the owner. #### Parameters @@ -1570,14 +1570,14 @@ event Transfer(address indexed from, address indexed to, uint256 indexed tokenId _ERC721 `Transfer` compatible event emitted. Successfully transferred tokenId `tokenId` from `from` to `to`._ -Emitted when `value` tokens are moved from one account (`from`) to another (`to`). Note that `value` may be zero. +ERC721 `Transfer` event emitted when `tokenId` token is transferred from `from` to `to`. To provide compatibility with indexing ERC721 events. #### Parameters | Name | Type | Description | | ----------------------- | :-------: | ------------------------ | -| `from` **`indexed`** | `address` | The sending address | -| `to` **`indexed`** | `address` | The receiving address | +| `from` **`indexed`** | `address` | The sending address. | +| `to` **`indexed`** | `address` | The receiving address. | | `tokenId` **`indexed`** | `uint256` | The tokenId to transfer. | <br/>