From 0346b35989eec63159240aa545ffb258b4e474c6 Mon Sep 17 00:00:00 2001 From: Gino Date: Thu, 4 Jul 2024 21:42:29 +0100 Subject: [PATCH] remove the notice tag --- packages/vm/core/evm/iscmagic/ISCAccounts.sol | 9 ------- .../vm/core/evm/iscmagic/ISCPrivileged.sol | 4 --- packages/vm/core/evm/iscmagic/ISCSandbox.sol | 25 ------------------- 3 files changed, 38 deletions(-) diff --git a/packages/vm/core/evm/iscmagic/ISCAccounts.sol b/packages/vm/core/evm/iscmagic/ISCAccounts.sol index d7cc76c9e6..e6bd578306 100644 --- a/packages/vm/core/evm/iscmagic/ISCAccounts.sol +++ b/packages/vm/core/evm/iscmagic/ISCAccounts.sol @@ -11,7 +11,6 @@ import "./ISCTypes.sol"; */ interface ISCAccounts { /** - * @notice Get the L2 base tokens balance of an account * @dev This function retrieves the balance of L2 base tokens for a given account. * @param agentID The ID of the agent (account) whose balance is to be retrieved * @return The L2 base tokens balance of the specified account @@ -19,7 +18,6 @@ interface ISCAccounts { function getL2BalanceBaseTokens(ISCAgentID memory agentID) external view returns (uint64); /** - * @notice Get the L2 native tokens balance of an account * @dev This function retrieves the balance of L2 native tokens for a given account. * @param id The ID of the native token * @param agentID The ID of the agent (account) whose balance is to be retrieved @@ -28,7 +26,6 @@ interface ISCAccounts { function getL2BalanceNativeTokens(NativeTokenID memory id, ISCAgentID memory agentID) external view returns (uint256); /** - * @notice Get the L2 NFTs owned by an account * @dev This function retrieves the number 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 @@ -36,7 +33,6 @@ interface ISCAccounts { function getL2NFTs(ISCAgentID memory agentID) external view returns (NFTID[] memory); /** - * @notice Get the amount of L2 NFTs owned by an account * @dev This function retrieves the 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 @@ -44,7 +40,6 @@ interface ISCAccounts { function getL2NFTAmount(ISCAgentID memory agentID) external view returns (uint256); /** - * @notice Get the L2 NFTs of a given collection owned by an account * @dev This function retrieves the NFTs of a specific collection owned by a given account. * @param agentID The ID of the agent (account) whose NFTs are to be retrieved * @param collectionId The ID of the NFT collection @@ -53,7 +48,6 @@ interface ISCAccounts { function getL2NFTsInCollection(ISCAgentID memory agentID, NFTID collectionId) external view returns (NFTID[] memory); /** - * @notice Get the amount of L2 NFTs of a given collection owned by an account * @dev This function retrieves the number of NFTs in a specific collection owned by a given account. * @param agentID The ID of the agent (account) whose NFT amount is to be retrieved * @param collectionId The ID of the NFT collection @@ -62,7 +56,6 @@ interface ISCAccounts { function getL2NFTAmountInCollection(ISCAgentID memory agentID, NFTID collectionId) external view returns (uint256); /** - * @notice Create a new foundry * @dev This function allows the creation of a new foundry with a specified token scheme and asset allowance. * @param tokenScheme The token scheme for the new foundry * @param allowance The assets to be allowed for the foundry creation @@ -71,7 +64,6 @@ interface ISCAccounts { function foundryCreateNew(NativeTokenScheme memory tokenScheme, ISCAssets memory allowance) external returns(uint32); /** - * @notice Creates foundry + IRC30 metadata + ERC20 token registration * @dev This function allows the creation of a new native token foundry along with its IRC30 metadata and ERC20 token registration. * @param tokenName The name of the new token * @param tokenSymbol The symbol of the new token @@ -83,7 +75,6 @@ interface ISCAccounts { function createNativeTokenFoundry(string memory tokenName, string memory tokenSymbol, uint8 tokenDecimals, NativeTokenScheme memory tokenScheme, ISCAssets memory allowance) external returns(uint32); /** - * @notice Mint new tokens. Only the owner of the foundry can call this function. * @dev This function allows the owner of a foundry to mint new native tokens. * @param foundrySN The serial number of the foundry * @param amount The amount of tokens to mint diff --git a/packages/vm/core/evm/iscmagic/ISCPrivileged.sol b/packages/vm/core/evm/iscmagic/ISCPrivileged.sol index 81a67685a6..fa2dbfe25a 100644 --- a/packages/vm/core/evm/iscmagic/ISCPrivileged.sol +++ b/packages/vm/core/evm/iscmagic/ISCPrivileged.sol @@ -12,7 +12,6 @@ import "./ISCTypes.sol"; */ interface ISCPrivileged { /** - * @notice Move assets between accounts * @dev This function allows privileged contracts to move assets between accounts. * @param sender The address of the sender account * @param receiver The address of the receiver account @@ -25,7 +24,6 @@ interface ISCPrivileged { ) external; /** - * @notice Set allowance of base tokens * @dev This function allows privileged contracts to set the allowance of base tokens from one account to another. * @param from The address of the account from which tokens are allowed * @param to The address of the account to which tokens are allowed @@ -38,7 +36,6 @@ interface ISCPrivileged { ) external; /** - * @notice Set allowance of native tokens * @dev This function allows privileged contracts to set the allowance of native tokens from one account to another. * @param from The address of the account from which tokens are allowed * @param to The address of the account to which tokens are allowed @@ -53,7 +50,6 @@ interface ISCPrivileged { ) external; /** - * @notice Move allowed funds between accounts * @dev This function allows privileged contracts to move allowed funds from one account to another. * @param from The address of the account from which funds are allowed * @param to The address of the account to which funds are allowed diff --git a/packages/vm/core/evm/iscmagic/ISCSandbox.sol b/packages/vm/core/evm/iscmagic/ISCSandbox.sol index c5156c8603..e78b919d51 100644 --- a/packages/vm/core/evm/iscmagic/ISCSandbox.sol +++ b/packages/vm/core/evm/iscmagic/ISCSandbox.sol @@ -11,35 +11,30 @@ import "./ISCTypes.sol"; */ interface ISCSandbox { /** - * @notice Get the ISC request ID * @dev Retrieves the ID of the current ISC request. * @return The ISCRequestID of the current request. */ function getRequestID() external view returns (ISCRequestID memory); /** - * @notice Get the AgentID of the sender of the ISC request * @dev Retrieves the AgentID of the account that sent the current ISC request. * @return The ISCAgentID of the sender. */ function getSenderAccount() external view returns (ISCAgentID memory); /** - * @notice Trigger an ISC event * @dev Triggers an event in the ISC system with the given string. * @param s The string to include in the event. */ function triggerEvent(string memory s) external; /** - * @notice Get a random 32-bit value based on the hash of the current ISC state transaction * @dev Retrieves a random 32-bit value derived from the hash of the current ISC state transaction. * @return A random bytes32 value. */ function getEntropy() external view returns (bytes32); /** - * @notice Allow the `target` EVM contract to take some funds from the caller's L2 account * @dev Authorizes the specified target address to take the given assets from the caller's account. * @param target The address of the target EVM contract. * @param allowance The assets to be allowed. @@ -47,7 +42,6 @@ interface ISCSandbox { function allow(address target, ISCAssets memory allowance) external; /** - * @notice Take some funds from the given address, which must have authorized first with `allow`. * @dev Takes the specified assets from the given address if they have authorized the caller. If the allowance is empty, all allowed funds are taken. * @param addr The address to take funds from. * @param allowance The assets to take. @@ -58,7 +52,6 @@ interface ISCSandbox { ) external; /** - * @notice Get the amount of funds currently allowed by the given address to the caller * @dev Retrieves the amount of assets the specified address has allowed the caller to take. * @param addr The address that has allowed funds. * @return The allowed ISCAssets. @@ -68,7 +61,6 @@ interface ISCSandbox { ) external view returns (ISCAssets memory); /** - * @notice Get the amount of funds currently allowed by the caller to the given address * @dev Retrieves the amount of assets the caller has allowed the specified address to take. * @param target The address allowed to take funds. * @return The allowed ISCAssets. @@ -78,7 +70,6 @@ interface ISCSandbox { ) external view returns (ISCAssets memory); /** - * @notice Get the amount of funds currently allowed between the given addresses * @dev Retrieves the amount of assets allowed between the specified addresses. * @param from The address that has allowed funds. * @param to The address allowed to take funds. @@ -90,7 +81,6 @@ interface ISCSandbox { ) external view returns (ISCAssets memory); /** - * @notice Send an on-ledger request (or a regular transaction to any L1 address). * @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. * @param targetAddress The L1 address to send the assets to. * @param assets The assets to be sent. @@ -107,7 +97,6 @@ interface ISCSandbox { ) external payable; /** - * @notice Call the entry point of an ISC contract on the same chain. * @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 entryPoint The entry point to be called. @@ -123,7 +112,6 @@ interface ISCSandbox { ) external returns (ISCDict memory); /** - * @notice Call a view entry point of an ISC contract on the same chain. * @dev Calls the specified view entry point of the ISC contract with the given parameters. * @param contractHname The hash name of the contract. * @param entryPoint The view entry point to be called. @@ -137,28 +125,24 @@ interface ISCSandbox { ) external view returns (ISCDict memory); /** - * @notice Get the ChainID of the underlying ISC chain * @dev Retrieves the ChainID of the current ISC chain. * @return The ISCChainID of the current chain. */ function getChainID() external view returns (ISCChainID); /** - * @notice Get the ISC chain's owner * @dev Retrieves the AgentID of the owner of the current ISC chain. * @return The ISCAgentID of the chain owner. */ function getChainOwnerID() external view returns (ISCAgentID memory); /** - * @notice Get the timestamp of the ISC block (seconds since UNIX epoch) * @dev Retrieves the timestamp of the current ISC block in seconds since the UNIX epoch. * @return The timestamp of the current block. */ function getTimestampUnixSeconds() external view returns (int64); /** - * @notice Get the properties of the ISC base token * @dev Retrieves the properties of the base token used in the ISC system. * @return The ISCTokenProperties of the base token. */ @@ -168,7 +152,6 @@ interface ISCSandbox { returns (ISCTokenProperties memory); /** - * @notice Get the ID of a L2-controlled native token, given its foundry serial number * @dev Retrieves the NativeTokenID of a native token based on its foundry serial number. * @param foundrySN The serial number of the foundry. * @return The NativeTokenID of the specified native token. @@ -178,7 +161,6 @@ interface ISCSandbox { ) external view returns (NativeTokenID memory); /** - * @notice Get the token scheme of a L2-controlled native token, given its foundry serial number * @dev Retrieves the NativeTokenScheme of a native token based on its foundry serial number. * @param foundrySN The serial number of the foundry. * @return The NativeTokenScheme of the specified native token. @@ -188,7 +170,6 @@ interface ISCSandbox { ) external view returns (NativeTokenScheme memory); /** - * @notice Get information about an on-chain NFT * @dev Retrieves the details of an NFT based on its ID. * @param id The ID of the NFT. * @return The ISCNFT data of the specified NFT. @@ -196,7 +177,6 @@ interface ISCSandbox { function getNFTData(NFTID id) external view returns (ISCNFT memory); /** - * @notice Get information about an on-chain IRC27 NFT * @dev Retrieves the details of an IRC27 NFT based on its ID. * @param id The ID of the IRC27 NFT. * @return The IRC27NFT data of the specified NFT. @@ -210,7 +190,6 @@ interface ISCSandbox { function getIRC27NFTData(NFTID id) external view returns (IRC27NFT memory); /** - * @notice Get the URI of an on-chain IRC27 NFT * @dev Retrieves the URI of an IRC27 NFT based on its ID. * @param id The ID of the IRC27 NFT. * @return The URI of the specified IRC27 NFT. @@ -224,7 +203,6 @@ interface ISCSandbox { function getIRC27TokenURI(NFTID id) external view returns (string memory); /** - * @notice Get the address of an ERC20NativeTokens contract for the given foundry serial number * @dev Retrieves the address of an ERC20NativeTokens contract based on the foundry serial number. * @param foundrySN The serial number of the foundry. * @return The address of the specified ERC20NativeTokens contract. @@ -234,7 +212,6 @@ interface ISCSandbox { ) external view returns (address); /** - * @notice Get the address of an ERC721NFTCollection contract for the given collection ID * @dev Retrieves the address of an ERC721NFTCollection contract based on the collection ID. * @param collectionID The ID of the NFT collection. * @return The address of the specified ERC721NFTCollection contract. @@ -244,7 +221,6 @@ interface ISCSandbox { ) external view returns (address); /** - * @notice Extract the foundry serial number from an ERC20NativeTokens contract's address * @dev Retrieves the foundry serial number from the address of an ERC20NativeTokens contract. * @param addr The address of the ERC20NativeTokens contract. * @return The foundry serial number. @@ -254,7 +230,6 @@ interface ISCSandbox { ) external view returns (uint32); /** - * @notice Creates an ERC20NativeTokens contract instance and register it with the foundry as a native token. Only the foundry owner can call this function. * @dev Registers a new ERC20NativeTokens contract with the specified foundry and token details. Only callable by the foundry owner. * @param foundrySN The serial number of the foundry. * @param name The name of the new token.