feat(wiki): implement review suggestions

iotaledger · Jul 5, 2024 · 00bb64a · 00bb64a
1 parent 535d0d1
commit 00bb64a
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 102 deletions.
diff --git a/docs/build/isc/v1.1/docs/_admonitions/_AgentID.md b/docs/build/isc/v1.1/docs/_admonitions/_AgentID.md
@@ -0,0 +1,3 @@
+:::Info ISC Agent ID
+The `ISCAgentID` represents the identifier of the agent (user or contract) whose NFTs you want to retrieve. You can get the [`AgentID`](../../../explanations/how-accounts-work.md) from the sender by calling `ISC.sandbox.getSenderAccount()`.
+:::
diff --git a/docs/build/isc/v1.1/docs/how-tos/core-contracts/nft/get-L2-nfts.mdx b/docs/build/isc/v1.1/docs/how-tos/core-contracts/nft/get-L2-nfts.mdx
@@ -8,60 +8,19 @@ tags:
   - L2 NFTs
 ---
 import GetNftMetadata from '../../../_partials/how-tos/token/_get-nft-metadata.md';
+import ISCAgentID from '../../../_admonitions/_AgentID.md';
 
 # Get NFTs Owned by an Account
 
-This guide will show you how to get the L2 NFTs owned by an account using the [`ISCAccounts.getL2NFTs`](../../../reference/magic-contract/ISCAccounts.md#getl2nfts) function from the [`ISCAccounts.getL2NFTs`](../../../reference/magic-contract/ISCAccounts.md) [magic contract](../../../reference/magic-contract/introduction.md).
-
-<GetNftMetadata />
+This guide will show you how to get the L2 NFTs owned by an account using the [`ISCAccounts.getL2NFTs`](../../../reference/magic-contract/ISCAccounts.md#getl2nfts) function from the [`ISCAccounts`](../../../reference/magic-contract/ISCAccounts.md) [magic contract](../../../reference/magic-contract/introduction.md).
+<GetNftMetadata/>
 
 ## Understanding the `getL2NFTs` Function
 
-The `getL2NFTs` function is a view function provided by the `ISCAccounts` interface. It takes an `ISCAgentID` as an argument and returns an array of `NFTID` objects. This function allows users to query and retrieve the list of L2 NFTs owned by a specified agent. The `ISCAgentID` represents the identifier of the agent (user or contract) whose NFTs you want to retrieve. The returned array contains the identifiers of the NFTs, which can then be used to fetch more details about each NFT if needed.
-
-## Why Would a User Need to Retrieve Owned NFTs?
-
-Retrieving the NFTs owned by a user can serve several purposes:
-
-- ### Portfolio Management
-
-  - Users can manage their digital assets effectively by viewing all their NFTs in one place.
-
-- ### Marketplace Listing
-
-  - Users can list their NFTs on various marketplaces by verifying their ownership.
-
-- ### Collection Display
-
-  - Users can showcase their NFT collections on social media, personal websites, or within specific applications.
-
-- ### Trading and Transfers
-
-  - Knowing the NFTs owned helps users decide which assets to trade or transfer to other users.
+The `getL2NFTs` function is a view function provided by the `ISCAccounts` interface. It takes an `ISCAgentID` as an argument and returns an array of `NFTID` objects. This function allows users to query and retrieve the list of L2 NFTs owned by a specified agent.
+<ISCAgentID/>
 
-- ### Application Integration
-
-  - Applications can provide customized experiences based on the NFTs a user owns, such as granting access to special content or features.
-
-## Prerequisites
-
-### 1. Install the ISC Magic Library
-
-   Ensure you have the ISC Magic library installed in your project:
-
-   ```bash
-   npm install @iota/iscmagic
-   ```
-
-### 2. Import the ISC Library
-
-   In your Solidity file, import the ISC Library:
-
-   ```solidity
-   pragma solidity >=0.8.24;
-
-   import "@iota/iscmagic/ISC.sol";
-   ```
+The returned array contains the identifiers of the NFTs, which can then be used to fetch more details about each NFT if needed.
 
 ## Implement the `getL2NFTs` Function
 
@@ -91,7 +50,4 @@ function getOwnedNFTs(ISCAgentID memory agentID) public view returns (NFTID[] me
     return ownedNFTs;
     }
 }
-```
-## Conclusion
-
-Using the `getL2NFTs` function from the `ISCAccounts` interface provides an efficient way to retrieve and manage the Layer 2 NFTs owned by an account. By integrating this functionality into your smart contracts, you can enhance user experience by enabling features such as [portfolio management](#portfolio-management), [marketplace listings](#marketplace-listing), [collection displays](#collection-display), and more. With this guide, you have the foundational knowledge to implement and utilize the `getL2NFTs` function in your projects, allowing for seamless interaction with `ISC Magic` and its associated NFTs.
+```
diff --git a/docs/build/isc/v1.3/docs/_admonitions/_AgentID.md b/docs/build/isc/v1.3/docs/_admonitions/_AgentID.md
@@ -0,0 +1,3 @@
+:::info ISC Agent ID
+The `ISCAgentID` represents the identifier of the agent (user or contract) whose NFTs you want to retrieve. You can get the [`AgentID`](../../../explanations/how-accounts-work.md) from the sender by calling `ISC.sandbox.getSenderAccount()`.
+:::
diff --git a/docs/build/isc/v1.3/docs/how-tos/core-contracts/nft/get-L2-nfts.mdx b/docs/build/isc/v1.3/docs/how-tos/core-contracts/nft/get-L2-nfts.mdx
@@ -8,60 +8,19 @@ tags:
   - L2 NFTs
 ---
 import GetNftMetadata from '../../../_partials/how-tos/token/_get-nft-metadata.md';
+import ISCAgentID from '../../../_admonitions/_AgentID.md';
 
 # Get NFTs Owned by an Account
 
-This guide will show you how to get the L2 NFTs owned by an account using the [`ISCAccounts.getL2NFTs`](../../../reference/magic-contract/ISCAccounts.md#getl2nfts) function from the [`ISCAccounts.getL2NFTs`](../../../reference/magic-contract/ISCAccounts.md) [magic contract](../../../reference/magic-contract/introduction.md).
-
-<GetNftMetadata />
+This guide will show you how to get the L2 NFTs owned by an account using the [`ISCAccounts.getL2NFTs`](../../../reference/magic-contract/ISCAccounts.md#getl2nfts) function from the [`ISCAccounts`](../../../reference/magic-contract/ISCAccounts.md) [magic contract](../../../reference/magic-contract/introduction.md).
+<GetNftMetadata/>
 
 ## Understanding the `getL2NFTs` Function
 
-The `getL2NFTs` function is a view function provided by the `ISCAccounts` interface. It takes an `ISCAgentID` as an argument and returns an array of `NFTID` objects. This function allows users to query and retrieve the list of L2 NFTs owned by a specified agent. The `ISCAgentID` represents the identifier of the agent (user or contract) whose NFTs you want to retrieve. The returned array contains the identifiers of the NFTs, which can then be used to fetch more details about each NFT if needed.
-
-## Why Would a User Need to Retrieve Owned NFTs?
-
-Retrieving the NFTs owned by a user can serve several purposes:
-
-- ### Portfolio Management
-
-  - Users can manage their digital assets effectively by viewing all their NFTs in one place.
-
-- ### Marketplace Listing
-
-  - Users can list their NFTs on various marketplaces by verifying their ownership.
-
-- ### Collection Display
-
-  - Users can showcase their NFT collections on social media, personal websites, or within specific applications.
-
-- ### Trading and Transfers
-
-  - Knowing the NFTs owned helps users decide which assets to trade or transfer to other users.
+The `getL2NFTs` function is a view function provided by the `ISCAccounts` interface. It takes an `ISCAgentID` as an argument and returns an array of `NFTID` objects. This function allows users to query and retrieve the list of L2 NFTs owned by a specified agent.
+<ISCAgentID/>
 
-- ### Application Integration
-
-  - Applications can provide customized experiences based on the NFTs a user owns, such as granting access to special content or features.
-
-## Prerequisites
-
-### 1. Install the ISC Magic Library
-
-   Ensure you have the ISC Magic library installed in your project:
-
-   ```bash
-   npm install @iota/iscmagic
-   ```
-
-### 2. Import the ISC Library
-
-   In your Solidity file, import the ISC Library:
-
-   ```solidity
-   pragma solidity >=0.8.24;
-
-   import "@iota/iscmagic/ISC.sol";
-   ```
+The returned array contains the identifiers of the NFTs, which can then be used to fetch more details about each NFT if needed.
 
 ## Implement the `getL2NFTs` Function
 
@@ -91,7 +50,4 @@ function getOwnedNFTs(ISCAgentID memory agentID) public view returns (NFTID[] me
     return ownedNFTs;
     }
 }
-```
-## Conclusion
-
-Using the `getL2NFTs` function from the `ISCAccounts` interface provides an efficient way to retrieve and manage the Layer 2 NFTs owned by an account. By integrating this functionality into your smart contracts, you can enhance user experience by enabling features such as [portfolio management](#portfolio-management), [marketplace listings](#marketplace-listing), [collection displays](#collection-display), and more. With this guide, you have the foundational knowledge to implement and utilize the `getL2NFTs` function in your projects, allowing for seamless interaction with `ISC Magic` and its associated NFTs.
+```