fix(docs): implement review suggestions

iotaledger · Jul 24, 2024 · 9307c85 · 9307c85
1 parent 6c424e1
commit 9307c85
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/packages/vm/core/evm/iscmagic/ISCAccounts.sol b/packages/vm/core/evm/iscmagic/ISCAccounts.sol
@@ -26,14 +26,14 @@ interface ISCAccounts {
     function getL2BalanceNativeTokens(NativeTokenID memory id, ISCAgentID memory agentID) external view returns (uint256);
 
     /**
-     * @dev This function retrieves the number of NFTs owned by a given account.
+     * @dev This function retrieves the IDs of NFTs owned by a given account.
      * @param agentID The ID of the agent (account) whose NFTs are to be retrieved
      * @return An array of NFTIDs representing the NFTs owned by the specified account
      */
     function getL2NFTs(ISCAgentID memory agentID) external view returns (NFTID[] memory);
 
     /**
-     * @dev This function retrieves the NFTs owned by a given account.
+     * @dev This function retrieves the number of NFTs owned by a given account.
      * @param agentID The ID of the agent (account) whose NFT amount is to be retrieved
      * @return The amount of L2 NFTs owned by the specified account
      */

diff --git a/packages/vm/core/evm/iscmagic/ISCSandbox.sol b/packages/vm/core/evm/iscmagic/ISCSandbox.sol
@@ -81,7 +81,7 @@ interface ISCSandbox {
     ) external view returns (ISCAssets memory);
 
     /**
-     * @dev Sends the specified assets from the caller's L2 account to the EVM core contract's account and includes the specified metadata and options.
+     * @dev Sends the specified assets from the caller's L2 account to a L1 address and includes the specified metadata and options. This can also be used to create on-ledger requests to the chain itself.
      * @param targetAddress The L1 address to send the assets to.
      * @param assets The assets to be sent.
      * @param adjustMinimumStorageDeposit Whether to adjust the minimum storage deposit.
@@ -98,7 +98,7 @@ interface ISCSandbox {
 
     /**
      * @dev Calls the specified entry point of the ISC contract with the given parameters and allowance.
-     * @param contractHname The hash name of the contract.
+     * @param contractHname The hname of the contract.
      * @param entryPoint The entry point to be called.
      * @param params The parameters to pass to the entry point.
      * @param allowance The assets to be allowed for the call.
@@ -113,7 +113,7 @@ interface ISCSandbox {
 
     /**
      * @dev Calls the specified view entry point of the ISC contract with the given parameters.
-     * @param contractHname The hash name of the contract.
+     * @param contractHname The hname of the contract.
      * @param entryPoint The view entry point to be called.
      * @param params The parameters to pass to the view entry point.
      * @return The return data from the ISC contract view call.

diff --git a/packages/vm/core/evm/iscmagic/ISCTypes.sol b/packages/vm/core/evm/iscmagic/ISCTypes.sol
@@ -145,6 +145,9 @@ library ISCTypes {
      * @dev Get the type of an L1 address.
      * @param addr The L1 address.
      * @return The type of the L1 address.
+     *
+     * For more details about the types of L1 addresses, please refer to the IOTA Tangle Improvement Proposal (TIP) 18:
+     * https://wiki.iota.org/tips/tips/TIP-0018/#address-unlock-condition
      */
     function L1AddressType(
         L1Address memory addr