feat: create customizeable token contract #1018

b00ste · 2025-05-22T14:08:22Z

What does this PR introduce?

PR Checklist

Wrote Tests
Wrote & Generated Documentation (readme/natspec/dodoc)
Ran npm run lint && npm run lint:solidity (solhint)
Ran npm run format (prettier)
Ran npm run build
Ran npm run test

packages/lsp7-contracts/hardhat.config.ts

CJ42 · 2025-06-16T12:46:58Z

@b00ste we also need to allow developers to import these new extensions from the @lukso/lsp-smart-contracts package, so like this for instance:

lsp-smart-contracts/packages/lsp-smart-contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.sol

Lines 1 to 4 in 8d4fef1

    
           // SPDX-License-Identifier: Apache-2.0 
        
           pragma solidity ^0.8.4; 
        
           import "@lukso/lsp7-contracts/contracts/extensions/LSP7Burnable.sol";

CJ42

Added first round of review. It is already much better with the contracts broken down in multiple inheritance. Also great Natspec comments overall and well documented 👏🏻

CJ42 · 2025-06-16T12:44:06Z

foundry.toml

@@ -5,7 +5,7 @@ libs = ['node_modules','lib']
 gas_reports = ["LSP6ExecuteRestrictedController", "LSP6ExecuteUnrestrictedController", "LSP6SetDataRestrictedController", "LSP6SetDataUnrestrictedController"]
 cache_path = 'forge-cache'
 test = 'tests/foundry'
-solc = "0.8.17"
+solc = "0.8.22"


I think since we are using the feature from 0.8.22 `(to access events inside contracts), it will not compile with Hardhat for these new token extensions no? (Since Hardhat defines 0.8.17 version

i think if you're using hardhat compile, it will use the version defined in hardhat config

Yes you are right indeed.
Then we need in the Foundry tests to increase the pragma to ^0.8.22

CJ42 · 2025-06-16T12:47:58Z

packages/lsp7-contracts/contracts/customizable/ILSP7Allowlist.sol

+pragma solidity ^0.8.4;
+
+/// @title ILSP7Allowlist
+/// @dev Interface for managing an allowlist of addresses that can bypass certain restrictions in an LSP7 token contract.


What is meant by "bypass" certain restrictions here? Maybe we could put some examples?

I see there is an example below. Could we put other examples to illustrate more the use case of this token extension?

packages/lsp7-contracts/contracts/customizable/ILSP7Allowlist.sol

packages/lsp7-contracts/contracts/customizable/LSP7AllowlistAbstract.sol

CJ42 · 2025-06-16T14:12:10Z

packages/lsp7-contracts/contracts/customizable/LSP7MintableAbstract.sol

+    }
+
+    /// @inheritdoc ILSP7Mintable
+    function mint(


I would discuss this public function, as there could be any public function for minting. Maybe we should just keep the public mint(...) function only for the preset and keep only the internal _mint(...) function inside this token extension contract?

CJ42 · 2025-06-16T14:13:55Z

packages/lsp7-contracts/contracts/customizable/LSP7NonTransferableAbstract.sol

+        uint256 transferLockStart_,
+        uint256 transferLockEnd_
+    ) {
+        if (transferLockEnd_ < transferLockStart_) {


What would be the behaviour if transferLockEnd_ and transferLockStart_ are the same value being set?

There will be no transfer lock period

packages/lsp7-contracts/contracts/customizable/LSP7NonTransferableAbstract.sol

packages/lsp7-contracts/contracts/CustomizableToken.sol

aurelianoa · 2025-06-21T15:24:58Z

Just came across with this and i like the idea of a customizable token. I will propose ways to work with the allow list (merkle tree or signature method) and batch add/removes

…hange LSP7Mintable

CJ42 · 2025-06-23T09:44:48Z

packages/lsp7-contracts/foundry/LSP7Allowlist.t.sol

@@ -0,0 +1,279 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.4;


We need to specify ^0.8.22 for all the test files that use the feature from 0.8.22 to access events defined in interfaces.

Suggested change

pragma solidity ^0.8.4;

pragma solidity ^0.8.22;

CJ42 · 2025-06-23T09:44:51Z

foundry.toml

@@ -5,7 +5,7 @@ libs = ['node_modules','lib']
 gas_reports = ["LSP6ExecuteRestrictedController", "LSP6ExecuteUnrestrictedController", "LSP6SetDataRestrictedController", "LSP6SetDataUnrestrictedController"]
 cache_path = 'forge-cache'
 test = 'tests/foundry'
-solc = "0.8.17"
+solc = "0.8.22"


Yes you are right indeed.
Then we need in the Foundry tests to increase the pragma to ^0.8.22

CJ42 · 2025-06-23T09:52:27Z

packages/lsp7-contracts/contracts/customizable/LSP7CappedBalanceAbstract.sol

+    ) internal virtual {
+        // Allow burning
+        if (to == address(0)) return;
+        if (balanceOf(to) + amount <= tokenBalanceCap()) return;


Ok for the early return statement. Let's then add some extra parameters to the custom error to improve logging

CJ42 · 2025-06-23T09:55:55Z

packages/lsp7-contracts/contracts/customizable/LSP7CappedBalanceAbstract.sol

+    /// @param from The address sending the tokens (ignored in this implementation).
+    /// @param to The address receiving the tokens.
+    /// @param amount The amount of tokens being transferred.
+    /// @param force Whether to force the transfer (ignored in this implementation).


btw i didn't comment out the params because natspec errors out with them commented

Yes good point for the Natspec compiler error 🤔

b00ste marked this pull request as draft May 22, 2025 14:08

b00ste force-pushed the customizeable-tokens branch 2 times, most recently from 9034a3c to 71f51dc Compare May 26, 2025 18:19

b00ste and others added 2 commits June 9, 2025 08:59

feat: create customizeable token contract

651614b

test: add basic foundry tests for capped balance extension

171aae5

b00ste force-pushed the customizeable-tokens branch 16 times, most recently from a7407c0 to 53e8785 Compare June 16, 2025 07:26

CJ42 reviewed Jun 16, 2025

View reviewed changes

packages/lsp7-contracts/hardhat.config.ts Outdated Show resolved Hide resolved

CJ42 reviewed Jun 16, 2025

View reviewed changes

b00ste force-pushed the customizeable-tokens branch from 53e8785 to 0b03da2 Compare June 16, 2025 15:59

b00ste added 3 commits June 23, 2025 08:17

refactor: move code from singleton to extensions

0c58ffe

refactor: add abstract to contract names, separate from deployable. c…

fdafaba

…hange LSP7Mintable

test: add fuzzing tests

e61fd62

b00ste force-pushed the customizeable-tokens branch from c4af453 to e61fd62 Compare June 23, 2025 08:17

CJ42 reviewed Jun 23, 2025

View reviewed changes

		@@ -0,0 +1,279 @@
		// SPDX-License-Identifier: Apache-2.0
		pragma solidity ^0.8.4;

feat: create customizeable token contract #1018

Are you sure you want to change the base?

feat: create customizeable token contract #1018

Uh oh!

Conversation

b00ste commented May 22, 2025

What does this PR introduce?

PR Checklist

Uh oh!

Uh oh!

CJ42 commented Jun 16, 2025

Uh oh!

CJ42 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aurelianoa commented Jun 21, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!