feat: add ERC-6909 Token and Supply extension

[onurinanc]

PR Checklist

• Tests
• Documentation
• Changelog

ERC6909 Implementation in rust-contracts-stylus

Summary

This PR implements the ERC-6909 token and Supply extension in Rust for Arbitrum Stylus.

The following implementation is provided in this PR:

• ERC-6909 + unit tests with motsu
• Supply Extension + unit tests with motsu
• Example usage of ERC-6909 and Supply Extension
• Integration Tests for ERC-6909 and Supply Extension
• Benchmark for both ERC6909 and Supply Extension

Comments

Integration tests and the benchmarks inside rust-contracts-stylus, which use nitro-testnode, didn't work with the M3 Pro Chip (would be an issue related to Docker). To solve the problem, firstly, [nitro-devnode] is tried to use. However, I observed that it is not suitable for the e2e::test workflow. So, an LTS Ubuntu machine is rented on AWS to run the integration tests and the benchmark.

For the Supply Extension implementation, Deref traits are implemented. Using Deref allows direct access to Erc6909 methods, improving readability and maintainability. However, deferencing operations might increase the gas. Designing Supply Token Extension in this way increases the abstraction and makes it easy to use for users who would like to use the Supply Extension with ERC-6909 Token Contract.

Future Improvements

Currently, this PR does not include other ERC-6909 Extensions, specifically ContentURI and Metadata. Their example usage and the benchmarks should be added to the repository.

The unit tests that differentiate the id should be added.

Benchmark

Benchmarks for ERC-6909 can be seen as follows:

| Contract::function                                                        | WASM Opt & Cached | Cached | Not Cached |
| ------------------------------------------------------------------------- | ----------------- | ------ | ---------- |
| Erc6909::mint(address,uint256,uint256)                                    |             27925 |  29307 |      45089 |
| Erc6909::balanceOf(address,uint256)                                       |              5101 |   6448 |      22230 |
| Erc6909::allowance(address,address,uint256)                               |              5875 |   7228 |      23010 |
| Erc6909::isOperator(address,address)                                      |              5322 |   6666 |      22448 |
| Erc6909::setOperator(address,bool)                                        |             27045 |  28433 |      44215 |
| Erc6909::transfer(address,uint256,uint256)                                |             34364 |  35786 |      51568 |
| Erc6909::approve(address,uint256,uint256)                                 |             27939 |  29332 |      45114 |
| Erc6909::transferFrom(address,address,uint256,uint256)                    |             20503 |  21943 |      37725 |
| Erc6909::burn(address,uint256,uint256)                                    |             11495 |  12893 |      28675 |

[netlify]

✅ Deploy Preview for contracts-stylus canceled.

Name	Link
🔨 Latest commit	813831b
🔍 Latest deploy log	https://app.netlify.com/projects/contracts-stylus/deploys/6925784ea6b69800081d6889

[onurinanc]

Hey, any update on this PR @0xNeshi ?

[bidzyyys]

Hey, any update on this PR @0xNeshi ?

Hey @onurinanc!
We will review your changes early next week -- we are currently applying audit fixes for v0.3.

[codecov]

Codecov Report

❌ Patch coverage is 99.28498% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 95.68%. Comparing base (b648011) to head (813831b).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
contracts/src/token/erc6909/mod.rs	99.13%	4 Missing ⚠️
...racts/src/token/erc6909/extensions/token_supply.rs	99.42%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #777      +/-   ##
==========================================
+ Coverage   95.46%   95.68%   +0.22%     
==========================================
  Files          89       91       +2     
  Lines       15814    16793     +979     
==========================================
+ Hits        15097    16069     +972     
- Misses        717      724       +7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.