feat: Add HTS Fungible Token Standard Collection #1240

Nana-EC · 2025-02-09T08:36:01Z

Description:
Currently developers need to have a deep understanding of IHederaTokenService.sol to expose all the features for fungible tokens and management contracts.

Add a set of standard contracts a developer can simple inherit from and deploy that offer expected ERC20 functions

Add a description to the HTS README section with an initial overview of the standard
Add an IHtsFungibleToken.sol that cover HTS token + ERC20 behaviour that can be operated on a token via a deployed contract
Add an IHtsFungibleTokenProxy.sol that extends IHtsFungibleToken.sol behaviour to support interaction with an already existing token that can be operated on a token directly via an EOA
Add a HtsFungibleToken.sol abstract contract that implements creation flow of a new fungible token and allows key delegated transfer related behaviour
Add an ExampleHtsFungibleToken.sol that showcases the ease in which the standard can be used to create a fungible token
Add a HtsFungibleTokenSupplyManager.sol abstract contract that implements creation flow of a new fungible token and allows supply management via mint and burn functions
Add an ExampleHtsFungibleToken.sol that show cases the ease in which the standard can be used to create a fungible token
Add an ExampleHtsFungibleTokenSupplyManager.sol that showcases the ease in which the standard can be used to create a fungible token with mint and burn support
Add an IHtsNonFungibleToken.sol that cover HTS token + ERC721 behaviour that can be operated on a token via a deployed contract
Add an IHtsNonFungibleTokenProxy.sol that extends IHtsNonFungibleToken.sol behaviour to support interaction with an already existing token that can be operated on a token directly via an EOA
Add a test file nativeFungibleToken.js with test coverage for initial fungible use cases
Add a GHA test suite with coverage for native token standard

These contract aren't meant to satisfy requests from community so that devs don't have to worry about all the innards and amongst other things a dev can easily take a contract and

deploy a FT native Hedera token like they do ERC20 w access to additional HTS functionality
deploy a NFT native Hedera Token like they do ERC 721 w access to additional HTS functionality
interact with an existing native Hedera Token like they do ERC 20
interact with an existing native Hedera Token like they do ERC 721
deploy a contract that manages the supply of said tokens and supports transfer where Hedera permissions are present

Related issue(s):

Fixes #1026
Fixes #781

Notes for reviewer:

Current implementation is missing all FT functions under IHederaTokenService.sol, these could be added to abstract contracts.
NFT related abstract and concrete example contracts are missing

Checklist

Documented (Code comments, README, etc.)
Tested (unit, integration, etc.)

github-actions · 2025-02-09T08:47:03Z

Test Results

18 files + 1 110 suites +7 13m 3s ⏱️ - 3m 21s
318 tests - 19 303 ✅ - 10 9 💤 - 4 6 ❌ - 5
474 runs + 7 457 ✅ +15 10 💤 - 4 7 ❌ - 4

For more details on these failures, see this check.

Results for commit f77bcfb. ± Comparison against base commit 3aa1542.

This pull request removes 37 and adds 18 tests. Note that renamed tests count towards both.

"before each" hook for "Should check if an address is another address's operator" ‑ @OZERC1155Token Test Suite "before each" hook for "Should check if an address is another address's operator"
should airdrop 10 NFTs to multiple accounts ‑ HIP904 AirdropContract Test Suite should airdrop 10 NFTs to multiple accounts
should airdrop 10 tokens to multiple accounts ‑ HIP904 AirdropContract Test Suite should airdrop 10 tokens to multiple accounts
should airdrop a fungible token (FT) to a single account ‑ HIP904 AirdropContract Test Suite should airdrop a fungible token (FT) to a single account
should airdrop a non-fungible token (NFT) to a single account ‑ HIP904 AirdropContract Test Suite should airdrop a non-fungible token (NFT) to a single account
should airdrop fungible token (FT) to a single account using distribute ‑ HIP904 AirdropContract Test Suite should airdrop fungible token (FT) to a single account using distribute
should airdrop fungible tokens (FT) to multiple accounts ‑ HIP904 AirdropContract Test Suite should airdrop fungible tokens (FT) to multiple accounts
should airdrop non-fungible token (NFT) to a single account using distribute ‑ HIP904 AirdropContract Test Suite should airdrop non-fungible token (NFT) to a single account using distribute
should airdrop non-fungible tokens (NFT) to multiple accounts ‑ HIP904 AirdropContract Test Suite should airdrop non-fungible tokens (NFT) to multiple accounts
should cancel a pending airdrop for a fungible token (FT) ‑ HIP904 IHRC904Facade ContractTest Suite should cancel a pending airdrop for a fungible token (FT)
…

"before all" hook for "should airdrop a fungible token (FT) to a single account" ‑ HIP904 AirdropContract Test Suite "before all" hook for "should airdrop a fungible token (FT) to a single account"
Confirm initial balance values ‑ NativeTokenStandard Test Suite ExampleHtsFungibleToken Tests Confirm initial balance values
Confirm initial balance values ‑ NativeTokenStandard Test Suite ExampleHtsFungibleTokenSupplyManager Tests Confirm initial balance values
Confirm mint, mintTo and burn effects on balances ‑ NativeTokenStandard Test Suite ExampleHtsFungibleTokenSupplyManager Tests Confirm mint, mintTo and burn effects on balances
Confirm name, symbol, decimals and totalSupply default values ‑ NativeTokenStandard Test Suite ExampleHtsFungibleToken Tests Confirm name, symbol, decimals and totalSupply default values
Confirm name, symbol, decimals and totalSupply default values ‑ NativeTokenStandard Test Suite ExampleHtsFungibleTokenSupplyManager Tests Confirm name, symbol, decimals and totalSupply default values
Confirm name, symbol, decimals and totalSupply default values ‑ NativeTokenStandard Test Suite IHtsFungibleTokenProxy Tests Confirm name, symbol, decimals and totalSupply default values
Should NOT allow a non-operator to transfer tokens to another account ‑ @OZERC1155Token Test Suite Should NOT allow a non-operator to transfer tokens to another account
Should NOT burn insufficient amount of token ‑ @OZERC1155Token Test Suite Should NOT burn insufficient amount of token
Should NOT transfer the ownership to another account if the caller is not owner ‑ @OZERC1155Token Test Suite Should NOT transfer the ownership to another account if the caller is not owner
…

♻️ This comment has been updated with latest results.

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

acuarica · 2025-02-11T19:53:37Z

contracts/system-contracts/hedera-token-service/native-token/.DS_Store

we should remove this.

acuarica · 2025-02-11T19:59:27Z

contracts/system-contracts/hedera-token-service/native-token/HtsFungibleToken.sol

+    function _createHTSToken(string memory _name, string memory _symbol, int64 _initialTotalSupply, uint8 _decimals) internal virtual {
+        IHederaTokenService.HederaToken memory tokenInfo = _setupHTSToken(_name, _symbol);
+
+        (bool success, bytes memory result) = htsSystemContractAddress.call{value : msg.value}(


is there a specific reason to use .call here? should we call it using IHederaTokenService(0x167).createFungibleToken(...) instead?

acuarica · 2025-02-11T20:01:27Z

contracts/system-contracts/hedera-token-service/native-token/HtsFungibleToken.sol

+
+        (int responseCode, address tokenAddress) = success ? abi.decode(result, (int32, address)) : (HederaResponseCodes.UNKNOWN, address(0));
+
+        require(responseCode == HederaResponseCodes.SUCCESS, "Failed to create HTS token");


this pattern masks the responseCode in case of error, making it difficult to debug. Should we introduce a custom error, such as HtsError(int), so at least the caller can see the error code?

acuarica · 2025-02-11T20:02:14Z

contracts/system-contracts/hedera-token-service/native-token/HtsFungibleToken.sol

+
+        require(responseCode == HederaResponseCodes.SUCCESS, "Failed to create HTS token");
+
+        htsTokenAddress = tokenAddress;


I'd moved this into the constructor so it's clear that htsTokenAddress is only assigned once.

acuarica · 2025-02-11T20:04:28Z

contracts/system-contracts/hedera-token-service/native-token/interfaces/IHtsFungibleToken.sol

+import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import "../../IHTSStructs.sol";


nit: list imported symbols

Nana-EC self-assigned this Feb 9, 2025

Nana-EC added this to the 0.12.0 milestone Feb 9, 2025

Nana-EC added the enhancement New feature or request label Feb 10, 2025

Nana-EC added 5 commits February 9, 2025 21:33

Add HTS Fungible Token Standard Collection

ab29703

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Remove unnecessary import

93f9dbe

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Minor formatting changes

f1872c3

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Reorganize and add proxy interface

bd1a43a

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

fix conflict and remove older files

925d1c9

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Nana-EC force-pushed the 1026-hts-token-standard branch from 5937416 to 925d1c9 Compare February 10, 2025 02:37

Nana-EC added 2 commits February 9, 2025 22:58

Switch to use OZ IERC 20 and 721 metadata interfaces

096dc38

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Add get token info methods

34248e5

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Nana-EC requested review from quiet-node, Ferparishuertas, acuarica, natanasow and lukelee-sl February 10, 2025 13:42

Nana-EC added 2 commits February 10, 2025 16:26

Fixed test gas, value amounts and imports

7650d3e

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

Added tx waits to ensure details make it through

f77bcfb

Signed-off-by: Nana Essilfie-Conduah <[email protected]>

acuarica reviewed Feb 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add HTS Fungible Token Standard Collection #1240

feat: Add HTS Fungible Token Standard Collection #1240

Nana-EC commented Feb 9, 2025 •

edited

Loading

github-actions bot commented Feb 9, 2025 •

edited

Loading

acuarica Feb 11, 2025

acuarica Feb 11, 2025

acuarica Feb 11, 2025

acuarica Feb 11, 2025

acuarica Feb 11, 2025


		(int responseCode, address tokenAddress) = success ? abi.decode(result, (int32, address)) : (HederaResponseCodes.UNKNOWN, address(0));

		require(responseCode == HederaResponseCodes.SUCCESS, "Failed to create HTS token");


		require(responseCode == HederaResponseCodes.SUCCESS, "Failed to create HTS token");

		htsTokenAddress = tokenAddress;

		import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
		import "../../IHTSStructs.sol";

feat: Add HTS Fungible Token Standard Collection #1240

Are you sure you want to change the base?

feat: Add HTS Fungible Token Standard Collection #1240

Conversation

Nana-EC commented Feb 9, 2025 • edited Loading

github-actions bot commented Feb 9, 2025 • edited Loading

Test Results

acuarica Feb 11, 2025

Choose a reason for hiding this comment

acuarica Feb 11, 2025

Choose a reason for hiding this comment

acuarica Feb 11, 2025

Choose a reason for hiding this comment

acuarica Feb 11, 2025

Choose a reason for hiding this comment

acuarica Feb 11, 2025

Choose a reason for hiding this comment

Nana-EC commented Feb 9, 2025 •

edited

Loading

github-actions bot commented Feb 9, 2025 •

edited

Loading