Add ERC20 Cross-Chain Bridging, SuperchainERC20 (#436)

Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: makiopen <[email protected]>

Author: 3 people

.github/workflows/test.yml

@@ -39,7 +39,7 @@ jobs:
         if: matrix.package == 'solidity'
         uses: foundry-rs/foundry-toolchain@v1
       - name: Install dependencies
-        run: yarn install --network-concurrency 1
+        run: yarn install
       - name: Compile TypeScript
         run: yarn tsc
         working-directory: packages/core/${{matrix.package}}

netlify.toml

@@ -4,9 +4,6 @@ publish = "packages/ui/public"
 
 edge_functions = "packages/ui/api"
 
-[build.environment]
-  YARN_FLAGS = "--network-concurrency 1"
-
 [[edge_functions]]
   path = "/ai"
   function = "ai"

packages/core/solidity/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.5.3 (2025-03-13)
+
+- Add ERC20 Cross-Chain Bridging, SuperchainERC20. ([#436](https://github.com/OpenZeppelin/contracts-wizard/pull/436))
+**Note:** Cross-Chain Bridging is experimental and may be subject to change.
+
+- **Potentially breaking changes**:
+  - Change order of constructor argument `recipient` when using `premint`.
+
 ## 0.5.2 (2025-02-21)
 
 - Fix modifiers order to follow Solidity style guides. ([#450](https://github.com/OpenZeppelin/contracts-wizard/pull/450))
@@ -8,7 +16,7 @@
 ## 0.5.1 (2025-02-05)
 
 - **Potentially breaking changes**:
-  - Add constructor argument `recipient` when using `premint` in `erc20`, `stablecoin`, and `realWorldAsset`.
+  - Add constructor argument `recipient` when using `premint` in `erc20`, `stablecoin`, and `realWorldAsset`. ([#435](https://github.com/OpenZeppelin/contracts-wizard/pull/435))
 
 ## 0.5.0 (2025-01-23)
 

packages/core/solidity/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/wizard",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "description": "A boilerplate generator to get started with OpenZeppelin Contracts",
   "license": "AGPL-3.0-only",
   "repository": "https://github.com/OpenZeppelin/contracts-wizard",

packages/core/solidity/src/erc20.test.ts

@@ -1,4 +1,5 @@
 import test from 'ava';
+import type { OptionsError } from '.';
 import { erc20 } from '.';
 
 import type { ERC20Options } from './erc20';
@@ -98,6 +99,126 @@ testERC20('erc20 flashmint', {
   flashmint: true,
 });
 
+testERC20('erc20 crossChainBridging custom', {
+  crossChainBridging: 'custom',
+});
+
+testERC20('erc20 crossChainBridging custom ownable', {
+  crossChainBridging: 'custom',
+  access: 'ownable',
+});
+
+testERC20('erc20 crossChainBridging custom ownable mintable burnable', {
+  crossChainBridging: 'custom',
+  access: 'ownable',
+  mintable: true,
+  burnable: true,
+});
+
+testERC20('erc20 crossChainBridging custom roles', {
+  crossChainBridging: 'custom',
+  access: 'roles',
+});
+
+testERC20('erc20 crossChainBridging custom managed', {
+  crossChainBridging: 'custom',
+  access: 'managed',
+});
+
+testERC20('erc20 crossChainBridging superchain', {
+  crossChainBridging: 'superchain',
+});
+
+testERC20('erc20 crossChainBridging superchain ownable', {
+  crossChainBridging: 'superchain',
+  access: 'ownable',
+});
+
+testERC20('erc20 crossChainBridging superchain roles', {
+  crossChainBridging: 'superchain',
+  access: 'roles',
+});
+
+testERC20('erc20 crossChainBridging superchain managed', {
+  crossChainBridging: 'superchain',
+  access: 'managed',
+});
+
+test('erc20 crossChainBridging custom, upgradeable not allowed', async t => {
+  const error = t.throws(() =>
+    buildERC20({
+      name: 'MyToken',
+      symbol: 'MTK',
+      crossChainBridging: 'custom',
+      upgradeable: 'transparent',
+    }),
+  );
+  t.is(
+    (error as OptionsError).messages.crossChainBridging,
+    'Upgradeability is not currently supported with Cross-Chain Bridging',
+  );
+});
+
+test('erc20 crossChainBridging superchain, upgradeable not allowed', async t => {
+  const error = t.throws(() =>
+    buildERC20({
+      name: 'MyToken',
+      symbol: 'MTK',
+      crossChainBridging: 'superchain',
+      upgradeable: 'transparent',
+    }),
+  );
+  t.is(
+    (error as OptionsError).messages.crossChainBridging,
+    'Upgradeability is not currently supported with Cross-Chain Bridging',
+  );
+});
+
+test('erc20 crossChainBridging superchain, premintChainId required', async t => {
+  const error = t.throws(() =>
+    buildERC20({
+      name: 'MyToken',
+      symbol: 'MTK',
+      crossChainBridging: 'superchain',
+      premint: '2000',
+    }),
+  );
+  t.is(
+    (error as OptionsError).messages.premintChainId,
+    'Chain ID is required when using Premint with Cross-Chain Bridging',
+  );
+});
+
+testERC20('erc20 premint ignores chainId when not crossChainBridging', {
+  premint: '2000',
+  premintChainId: '10',
+});
+
+testERC20('erc20 premint chainId crossChainBridging custom', {
+  premint: '2000',
+  premintChainId: '10',
+  crossChainBridging: 'custom',
+});
+
+testERC20('erc20 premint chainId crossChainBridging superchain', {
+  premint: '2000',
+  premintChainId: '10',
+  crossChainBridging: 'superchain',
+});
+
+testERC20('erc20 full crossChainBridging custom non-upgradeable', {
+  premint: '2000',
+  access: 'roles',
+  burnable: true,
+  mintable: true,
+  pausable: true,
+  permit: true,
+  votes: true,
+  flashmint: true,
+  crossChainBridging: 'custom',
+  premintChainId: '10',
+});
+
 testERC20('erc20 full upgradeable transparent', {
   premint: '2000',
   access: 'roles',