Use callback instead of hooks everywhere (#90)

Author: nkrishang

core/src/callback/BeforeApproveCallbackERC20.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeApproveCallbackERC20 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeApproveCallbackERC20NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeApproveERC20 hook that is called by a core token before approving tokens.
+     *  @param _from The address that is approving tokens.
+     *  @param _to The address that is being approved.
+     *  @param _amount The amount of tokens being approved.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeApproveERC20(address _from, address _to, uint256 _amount)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeApproveCallbackERC20NotImplemented();
+    }
+}

core/src/callback/BeforeApproveCallbackERC721.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeApproveCallbackERC721 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeApproveCallbackERC721NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeApproveERC721 hook that is called by a core token before approving a token.
+     *  @param _from The address that is approving tokens.
+     *  @param _to The address that is being approved.
+     *  @param _tokenId The token ID being approved.
+     *  @param _approve The approval status to set.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeApproveERC721(address _from, address _to, uint256 _tokenId, bool _approve)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeApproveCallbackERC721NotImplemented();
+    }
+}

core/src/callback/BeforeApproveForAllCallback.sol

@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeApproveForAllCallback {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeApproveForAllCallbackNotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeApproveForAll hook that is called by a core token before approving an operator to transfer all tokens.
+     *  @param _from The address that is approving tokens.
+     *  @param _to The address that is being approved.
+     *  @param _approved Whether to grant or revoke approval.
+     */
+    function beforeApproveForAll(address _from, address _to, bool _approved)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeApproveForAllCallbackNotImplemented();
+    }
+}

core/src/callback/BeforeBatchTransferCallbackERC1155.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeBatchTransferCallbackERC1155 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeBatchTransferCallbackERC1155NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeBatchTransferERC1155 hook that is called by a core token before batch transferring tokens.
+     *  @param from The address that is transferring tokens.
+     *  @param to The address that is receiving tokens.
+     *  @param ids The token IDs being transferred.
+     *  @param values The quantities of tokens being transferred.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeBatchTransferERC1155(address from, address to, uint256[] calldata ids, uint256[] calldata values)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeBatchTransferCallbackERC1155NotImplemented();
+    }
+}

core/src/callback/BeforeBurnCallbackERC1155.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeBurnCallbackERC1155 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeBurnCallbackERC1155NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeBurnERC1155 hook that is called by a core token before burning a token.
+     *  @param _operator The address that is burning tokens.
+     *  @param _id The token ID being burned.
+     *  @param _value The quantity of tokens being burned.
+     *  @param _data The encoded arguments for the beforeBurn hook.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeBurnERC1155(address _operator, uint256 _id, uint256 _value, bytes memory _data)
+        external
+        payable
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeBurnCallbackERC1155NotImplemented();
+    }
+}

core/src/callback/BeforeBurnCallbackERC20.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeBurnCallbackERC20 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeBurnCallbackERC20NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeBurnERC20 hook that is called by a core token before burning tokens.
+     *  @param _from The address that is burning tokens.
+     *  @param _amount The amount of tokens being burned.
+     *  @param _data The encoded arguments for the beforeBurn hook.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeBurnERC20(address _from, uint256 _amount, bytes memory _data)
+        external
+        payable
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeBurnCallbackERC20NotImplemented();
+    }
+}

core/src/callback/BeforeBurnCallbackERC721.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeBurnCallbackERC721 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeBurnCallbackERC721NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeBurnERC721 hook that is called by a core token before burning a token.
+     *  @param _operator The address that is burning tokens.
+     *  @param _tokenId The token ID being burned.
+     *  @param _data The encoded arguments for the beforeBurn hook.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeBurnERC721(address _operator, uint256 _tokenId, bytes memory _data)
+        external
+        payable
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeBurnCallbackERC721NotImplemented();
+    }
+}

core/src/callback/BeforeMintCallbackERC1155.sol

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeMintCallbackERC1155 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeMintCallbackERC1155NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeMintERC1155 hook that is called by a core token before minting tokens.
+     *  @param _to The address that is minting tokens.
+     *  @param _id The token ID being minted.
+     *  @param _quantity The quantity of tokens to mint.
+     *  @param _data Optional extra data passed to the hook.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeMintERC1155(address _to, uint256 _id, uint256 _quantity, bytes memory _data)
+        external
+        payable
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeMintCallbackERC1155NotImplemented();
+    }
+}

core/src/callback/BeforeMintCallbackERC20.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeMintCallbackERC20 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeMintCallbackERC20NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeMintERC20 hook that is called by a core token before minting tokens.
+     *  @param _to The address to mint tokens to.
+     *  @param _amount The amount of tokens to mint.
+     *  @param _data Optional extra data passed to the hook.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeMintERC20(address _to, uint256 _amount, bytes memory _data)
+        external
+        payable
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeMintCallbackERC20NotImplemented();
+    }
+}

core/src/callback/BeforeMintCallbackERC721.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeMintCallbackERC721 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeMintCallbackERC721NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeMintERC721 hook that is called by a core token before minting tokens.
+     *  @param _to The address that is minting tokens.
+     *  @param _quantity The quantity of tokens to mint.
+     *  @param _data Optional extra data passed to the hook.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeMintERC721(address _to, uint256 _quantity, bytes memory _data)
+        external
+        payable
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeMintCallbackERC721NotImplemented();
+    }
+}

core/src/callback/BeforeTransferCallbackERC1155.sol

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeTransferCallbackERC1155 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeTransferCallbackERC1155NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeTransferERC1155 hook that is called by a core token before transferring a token.
+     *  @param _from The address that is transferring tokens.
+     *  @param _to The address that is receiving tokens.
+     *  @param _id The token ID being transferred.
+     *  @param _value The quantity of tokens being transferred.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeTransferERC1155(address _from, address _to, uint256 _id, uint256 _value)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeTransferCallbackERC1155NotImplemented();
+    }
+}

core/src/callback/BeforeTransferCallbackERC20.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeTransferCallbackERC20 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeTransferCallbackERC20NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeTransferERC20 hook that is called by a core token before transferring tokens.
+     *  @param _from The address that is transferring tokens.
+     *  @param _to The address that is receiving tokens.
+     *  @param _amount The amount of tokens being transferred.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeTransferERC20(address _from, address _to, uint256 _amount)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeTransferCallbackERC20NotImplemented();
+    }
+}

core/src/callback/BeforeTransferCallbackERC721.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: Apache 2.0
+pragma solidity ^0.8.0;
+
+contract BeforeTransferCallbackERC721 {
+    /*//////////////////////////////////////////////////////////////
+                                ERRORS
+    //////////////////////////////////////////////////////////////*/
+
+    error BeforeTransferCallbackERC721NotImplemented();
+
+    /*//////////////////////////////////////////////////////////////
+                            EXTERNAL FUNCTIONS
+    //////////////////////////////////////////////////////////////*/
+
+    /**
+     *  @notice The beforeTransferERC721 hook that is called by a core token before transferring a token.
+     *  @param _from The address that is transferring tokens.
+     *  @param _to The address that is receiving tokens.
+     *  @param _tokenId The token ID being transferred.
+     *  @return result Abi encoded bytes result of the hook.
+     */
+    function beforeTransferERC721(address _from, address _to, uint256 _tokenId)
+        external
+        virtual
+        returns (bytes memory result)
+    {
+        revert BeforeTransferCallbackERC721NotImplemented();
+    }
+}