@openzeppelin/wizard 0.10.5 → 0.10.7

package/src/common-options.ts

@@ -19,6 +19,6 @@ export function withCommonDefaults(opts: CommonOptions): Required<CommonOptions>
   return {
     access: opts.access ?? false,
     upgradeable: opts.upgradeable ?? false,
-    info: opts.info ?? {},
+    info: { ...defaults.info, ...(opts.info ?? {}) },
   };
 }

package/src/contract.ts

@@ -100,9 +100,9 @@ export class ContractBuilder implements Contract {
 
   readonly variableOrErrorMap: Map<string, VariableOrErrorDefinition> = new Map<string, VariableOrErrorDefinition>();
   private parentMap: Map<string, Parent> = new Map<string, Parent>();
+  private functionMap: Map<string, ContractFunction> = new Map<string, ContractFunction>();
   private libraryMap: Map<string, Library> = new Map<string, Library>();
-  private functionMap: Map<string, ContractFunction> = new Map();
-  private structMap: Map<string, ContractStruct> = new Map();
+  private structMap: Map<string, ContractStruct> = new Map<string, ContractStruct>();
 
   constructor(name: string) {
     this.name = toIdentifier(name, true);

package/src/environments/hardhat/package-lock.json

@@ -10,7 +10,7 @@
       "license": "ISC",
       "devDependencies": {
         "@nomicfoundation/hardhat-toolbox": "^6.1.0",
-        "@openzeppelin/contracts": "^5.5.0",
+        "@openzeppelin/contracts": "^5.6.0",
         "hardhat": "^2.22.0"
       }
     },
@@ -1219,9 +1219,9 @@
       }
     },
     "node_modules/@openzeppelin/contracts": {
-      "version": "5.5.0",
-      "resolved": "https://registry.npmjs.org/@openzeppelin/contracts/-/contracts-5.5.0.tgz",
-      "integrity": "sha512-R8hq4zmKKWP2c7OxeRgAcjZwvF5W0Qq2OIX7degrtdM52Q9xYr4MLJdUAVPKGUewNJ1qo+M6YiZLLnNUnjP/gg==",
+      "version": "5.6.0",
+      "resolved": "https://registry.npmjs.org/@openzeppelin/contracts/-/contracts-5.6.0.tgz",
+      "integrity": "sha512-eZJSS8+RbWzX/7oDJPi+lYzfeuWwHXSsw336Yff35pTkmLEwRWKde2PQMW2objjMi1C1hNn9QiHjGktEJPSSWQ==",
       "dev": true,
       "license": "MIT"
     },

package/src/environments/hardhat/package.json

@@ -10,7 +10,7 @@
   "license": "ISC",
   "devDependencies": {
     "@nomicfoundation/hardhat-toolbox": "^6.1.0",
-    "@openzeppelin/contracts": "^5.5.0",
+    "@openzeppelin/contracts": "^5.6.0",
     "hardhat": "^2.22.0"
   }
 }

package/src/environments/hardhat/upgradeable/package-lock.json

@@ -10,8 +10,8 @@
       "license": "ISC",
       "devDependencies": {
         "@nomicfoundation/hardhat-toolbox": "^6.1.0",
-        "@openzeppelin/contracts": "^5.5.0",
-        "@openzeppelin/contracts-upgradeable": "^5.5.0",
+        "@openzeppelin/contracts": "^5.6.0",
+        "@openzeppelin/contracts-upgradeable": "^5.6.0",
         "@openzeppelin/hardhat-upgrades": "^3.0.0",
         "hardhat": "^2.22.0"
       }
@@ -1924,20 +1924,20 @@
       }
     },
     "node_modules/@openzeppelin/contracts": {
-      "version": "5.5.0",
-      "resolved": "https://registry.npmjs.org/@openzeppelin/contracts/-/contracts-5.5.0.tgz",
-      "integrity": "sha512-R8hq4zmKKWP2c7OxeRgAcjZwvF5W0Qq2OIX7degrtdM52Q9xYr4MLJdUAVPKGUewNJ1qo+M6YiZLLnNUnjP/gg==",
+      "version": "5.6.0",
+      "resolved": "https://registry.npmjs.org/@openzeppelin/contracts/-/contracts-5.6.0.tgz",
+      "integrity": "sha512-eZJSS8+RbWzX/7oDJPi+lYzfeuWwHXSsw336Yff35pTkmLEwRWKde2PQMW2objjMi1C1hNn9QiHjGktEJPSSWQ==",
       "dev": true,
       "license": "MIT"
     },
     "node_modules/@openzeppelin/contracts-upgradeable": {
-      "version": "5.5.0",
-      "resolved": "https://registry.npmjs.org/@openzeppelin/contracts-upgradeable/-/contracts-upgradeable-5.5.0.tgz",
-      "integrity": "sha512-Va5hKG5oaK0EE5bXTVWugcGimMHazxL+SL523dH6WVbGiuLXwuWr9oxtLyPHQSVGtgmlIgtKNR5V+OUpCIUwFQ==",
+      "version": "5.6.0",
+      "resolved": "https://registry.npmjs.org/@openzeppelin/contracts-upgradeable/-/contracts-upgradeable-5.6.0.tgz",
+      "integrity": "sha512-pJ4Qb4EGjemdvP/pbBZ+etXDB5PQJJf1tbIBDQqfQZMK3Lk8UuNCK+cWDluHZ28UfwH2WAwJLftyhJid4w63QA==",
       "dev": true,
       "license": "MIT",
       "peerDependencies": {
-        "@openzeppelin/contracts": "5.5.0"
+        "@openzeppelin/contracts": "5.6.0"
       }
     },
     "node_modules/@openzeppelin/defender-sdk-base-client": {

package/src/environments/hardhat/upgradeable/package.json

@@ -10,8 +10,8 @@
   "license": "ISC",
   "devDependencies": {
     "@nomicfoundation/hardhat-toolbox": "^6.1.0",
-    "@openzeppelin/contracts": "^5.5.0",
-    "@openzeppelin/contracts-upgradeable": "^5.5.0",
+    "@openzeppelin/contracts": "^5.6.0",
+    "@openzeppelin/contracts-upgradeable": "^5.6.0",
     "@openzeppelin/hardhat-upgrades": "^3.0.0",
     "hardhat": "^2.22.0"
   }

package/src/erc20.ts

@@ -16,7 +16,7 @@ import { OptionsError } from './error';
 import { toUint256, UINT256_MAX } from './utils/convert-strings';
 import { setNamespacedStorage, toStorageStructInstantiation } from './set-namespaced-storage';
 
-export const crossChainBridgingOptions = [false, 'custom', 'superchain'] as const;
+export const crossChainBridgingOptions = [false, 'custom', 'erc7786native', 'superchain'] as const;
 export type CrossChainBridging = (typeof crossChainBridgingOptions)[number];
 
 export interface ERC20Options extends CommonOptions {
@@ -36,6 +36,7 @@ export interface ERC20Options extends CommonOptions {
   votes?: boolean | ClockMode;
   flashmint?: boolean;
   crossChainBridging?: CrossChainBridging;
+  crossChainLinkAllowOverride?: boolean;
   namespacePrefix?: string;
 }
 
@@ -53,6 +54,7 @@ export const defaults: Required<ERC20Options> = {
   votes: false,
   flashmint: false,
   crossChainBridging: false,
+  crossChainLinkAllowOverride: false,
   namespacePrefix: 'myProject',
 } as const;
 
@@ -70,6 +72,7 @@ export function withDefaults(opts: ERC20Options): Required<ERC20Options> {
     votes: opts.votes ?? defaults.votes,
     flashmint: opts.flashmint ?? defaults.flashmint,
     crossChainBridging: opts.crossChainBridging ?? defaults.crossChainBridging,
+    crossChainLinkAllowOverride: opts.crossChainLinkAllowOverride ?? defaults.crossChainLinkAllowOverride,
     namespacePrefix: opts.namespacePrefix ?? defaults.namespacePrefix,
   };
 }
@@ -79,7 +82,13 @@ export function printERC20(opts: ERC20Options = defaults): string {
 }
 
 export function isAccessControlRequired(opts: Partial<ERC20Options>): boolean {
-  return opts.mintable || opts.pausable || opts.upgradeable === 'uups';
+  return (
+    opts.mintable ||
+    opts.pausable ||
+    opts.upgradeable === 'uups' ||
+    opts.crossChainBridging === 'custom' ||
+    opts.crossChainBridging === 'erc7786native'
+  );
 }
 
 export function buildERC20(opts: ERC20Options): ContractBuilder {
@@ -92,7 +101,14 @@ export function buildERC20(opts: ERC20Options): ContractBuilder {
   addBase(c, allOpts.name, allOpts.symbol);
 
   if (allOpts.crossChainBridging) {
-    addCrossChainBridging(c, allOpts.crossChainBridging, access, upgradeable, allOpts.namespacePrefix);
+    addCrossChainBridging(
+      c,
+      allOpts.crossChainBridging,
+      allOpts.crossChainLinkAllowOverride,
+      access,
+      upgradeable,
+      allOpts.namespacePrefix,
+    );
   }
 
   if (allOpts.premint) {
@@ -115,14 +131,13 @@ export function buildERC20(opts: ERC20Options): ContractBuilder {
     addCallback(c);
   }
 
-  // Note: Votes requires Permit
-  if (allOpts.permit || allOpts.votes) {
+  if (allOpts.permit) {
     addPermit(c, allOpts.name);
   }
 
   if (allOpts.votes) {
     const clockMode = allOpts.votes === true ? clockModeDefault : allOpts.votes;
-    addVotes(c, clockMode);
+    addVotes(c, allOpts.name, clockMode);
   }
 
   if (allOpts.flashmint) {
@@ -173,7 +188,7 @@ export function isValidChainId(str: string): boolean {
   return chainIdPattern.test(str);
 }
 
-function scaleByPowerOfTen(base: bigint, exponent: number): bigint {
+export function scaleByPowerOfTen(base: bigint, exponent: number): bigint {
   if (exponent < 0) {
     return base / BigInt(10) ** BigInt(-exponent);
   } else {
@@ -181,55 +196,74 @@ function scaleByPowerOfTen(base: bigint, exponent: number): bigint {
   }
 }
 
+export interface PremintCalculation {
+  units: string;
+  exp: string;
+  decimalPlace: number;
+}
+
+export function calculatePremint(amount: string): PremintCalculation | undefined {
+  const m = amount.match(premintPattern);
+  if (!m) {
+    throw new OptionsError({
+      premint: 'Not a valid number',
+    });
+  }
+
+  const integer = m[1]?.replace(/^0+/, '') ?? '';
+  const decimals = m[2]?.replace(/0+$/, '') ?? '';
+  const exponent = Number(m[3] ?? 0);
+
+  if (Number(integer + decimals) > 0) {
+    const decimalPlace = decimals.length - exponent;
+    const zeroes = new Array(Math.max(0, -decimalPlace)).fill('0').join('');
+    const units = integer + decimals + zeroes;
+    const exp = decimalPlace <= 0 ? 'decimals()' : `(decimals() - ${decimalPlace})`;
+
+    return { units, exp, decimalPlace };
+  } else {
+    return undefined;
+  }
+}
+
 function addPremint(
   c: ContractBuilder,
   amount: string,
   premintChainId: string,
   crossChainBridging: CrossChainBridging,
 ) {
-  const m = amount.match(premintPattern);
-  if (m) {
-    const integer = m[1]?.replace(/^0+/, '') ?? '';
-    const decimals = m[2]?.replace(/0+$/, '') ?? '';
-    const exponent = Number(m[3] ?? 0);
-
-    if (Number(integer + decimals) > 0) {
-      const decimalPlace = decimals.length - exponent;
-      const zeroes = new Array(Math.max(0, -decimalPlace)).fill('0').join('');
-      const units = integer + decimals + zeroes;
-      const exp = decimalPlace <= 0 ? 'decimals()' : `(decimals() - ${decimalPlace})`;
+  const premintCalculation = calculatePremint(amount);
+  if (premintCalculation === undefined) {
+    return;
+  }
 
-      const validatedBaseUnits = toUint256(units, 'premint');
-      checkPotentialPremintOverflow(validatedBaseUnits, decimalPlace);
+  const { units, exp, decimalPlace } = premintCalculation;
 
-      c.addConstructorArgument({ type: 'address', name: 'recipient' });
+  const validatedBaseUnits = toUint256(units, 'premint');
+  checkPotentialPremintOverflow(validatedBaseUnits, decimalPlace);
 
-      const mintLine = `_mint(recipient, ${units} * 10 ** ${exp});`;
+  c.addConstructorArgument({ type: 'address', name: 'recipient' });
 
-      if (crossChainBridging) {
-        if (premintChainId === '') {
-          throw new OptionsError({
-            premintChainId: 'Chain ID is required when using Premint with Cross-Chain Bridging',
-          });
-        }
+  const mintLine = `_mint(recipient, ${units} * 10 ** ${exp});`;
 
-        if (!isValidChainId(premintChainId)) {
-          throw new OptionsError({
-            premintChainId: 'Not a valid chain ID',
-          });
-        }
+  if (crossChainBridging) {
+    if (premintChainId === '') {
+      throw new OptionsError({
+        premintChainId: 'Chain ID is required when using Premint with Cross-Chain Bridging',
+      });
+    }
 
-        c.addConstructorCode(`if (block.chainid == ${premintChainId}) {`);
-        c.addConstructorCode(`    ${mintLine}`);
-        c.addConstructorCode(`}`);
-      } else {
-        c.addConstructorCode(mintLine);
-      }
+    if (!isValidChainId(premintChainId)) {
+      throw new OptionsError({
+        premintChainId: 'Not a valid chain ID',
+      });
     }
+
+    c.addConstructorCode(`if (block.chainid == ${premintChainId}) {`);
+    c.addConstructorCode(`    ${mintLine}`);
+    c.addConstructorCode(`}`);
   } else {
-    throw new OptionsError({
-      premint: 'Not a valid number',
-    });
+    c.addConstructorCode(mintLine);
   }
 }
 
@@ -274,9 +308,14 @@ function addPermit(c: ContractBuilder, name: string) {
   c.addOverride(ERC20Permit, functions.nonces);
 }
 
-function addVotes(c: ContractBuilder, clockMode: ClockMode) {
+function addVotes(c: ContractBuilder, name: string, clockMode: ClockMode) {
   if (!c.parents.some(p => p.contract.name === 'ERC20Permit')) {
-    throw new Error('Missing ERC20Permit requirement for ERC20Votes');
+    // ERC20Permit initializes the EIP712 domain separator. If ERC20Permit is not a parent, we need to do it here.
+    const EIP712 = {
+      name: 'EIP712',
+      path: '@openzeppelin/contracts/utils/cryptography/EIP712.sol',
+    };
+    c.addParent(EIP712, [name, '1']);
   }
 
   const ERC20Votes = {
@@ -308,6 +347,40 @@ function addFlashMint(c: ContractBuilder) {
 }
 
 function addCrossChainBridging(
+  c: ContractBuilder,
+  crossChainBridging: 'custom' | 'erc7786native' | 'superchain',
+  crossChainLinkAllowOverride: boolean,
+  access: Access,
+  upgradeable: Upgradeable,
+  namespacePrefix: string,
+) {
+  if (crossChainBridging === 'erc7786native') {
+    addERC20Crosschain(c, crossChainLinkAllowOverride, access);
+  } else {
+    addERC20Bridgeable(c, crossChainBridging, access, upgradeable, namespacePrefix);
+  }
+}
+
+function addERC20Crosschain(c: ContractBuilder, crossChainLinkAllowOverride: boolean, access: Access) {
+  c.addParent({
+    name: 'ERC20Crosschain',
+    path: '@openzeppelin/contracts/token/ERC20/extensions/ERC20Crosschain.sol',
+  });
+
+  c.addConstructionOnly(
+    {
+      name: 'CrosschainLinked',
+      path: '@openzeppelin/contracts/crosschain/CrosschainLinked.sol',
+    },
+    [{ lit: 'links' }],
+  );
+  c.addConstructorArgument({ type: 'CrosschainLinked.Link[] memory', name: 'links' });
+
+  requireAccessControl(c, functions.setLink, access, 'CROSSCHAIN_LINKER', 'crosschainLinker');
+  c.addFunctionCode(`_setLink(gateway, counterpart, ${crossChainLinkAllowOverride});`, functions.setLink);
+}
+
+function addERC20Bridgeable(
   c: ContractBuilder,
   crossChainBridging: 'custom' | 'superchain',
   access: Access,
@@ -339,31 +412,57 @@ function addCrossChainBridging(
 }
 
 function addCustomBridging(c: ContractBuilder, access: Access, upgradeable: Upgradeable, namespacePrefix: string) {
+  if (access === false) {
+    access = 'ownable';
+  }
+
   switch (access) {
-    case false:
     case 'ownable': {
       if (!upgradeable) {
+        const LINES_CHECK_AND_SET_TOKEN_BRIDGE = [
+          `require(tokenBridge_ != address(0), "Invalid tokenBridge_ address");`,
+          `tokenBridge = tokenBridge_;`,
+        ];
+
+        // Add variable and constructor logic using state variable
         const addedBridge = c.addStateVariable(`address public tokenBridge;`, false);
         if (addedBridge) {
           c.addConstructorArgument({ type: 'address', name: 'tokenBridge_' });
-          c.addConstructorCode(`require(tokenBridge_ != address(0), "Invalid tokenBridge_ address");`);
-          c.addConstructorCode(`tokenBridge = tokenBridge_;`);
+          LINES_CHECK_AND_SET_TOKEN_BRIDGE.forEach(line => {
+            c.addConstructorCode(line);
+          });
         }
         c.setFunctionBody([`if (caller != tokenBridge) revert Unauthorized();`], functions._checkTokenBridge, 'view');
+
+        // Add bridge setter
+        requireAccessControl(c, functions.setTokenBridge, access, 'TOKEN_BRIDGE_SETTER', 'tokenBridgeSetter');
+        LINES_CHECK_AND_SET_TOKEN_BRIDGE.forEach(line => {
+          c.addFunctionCode(line, functions.setTokenBridge);
+        });
       } else {
+        const LINES_CHECK_AND_SET_TOKEN_BRIDGE = [
+          `require(tokenBridge_ != address(0), "Invalid tokenBridge_ address");`,
+          toStorageStructInstantiation(c.name),
+          '$.tokenBridge = tokenBridge_;',
+        ];
+
+        // Add variable and constructor logic using namespaced storage
         setNamespacedStorage(c, ['address tokenBridge;'], namespacePrefix);
 
         c.addConstructorArgument({ type: 'address', name: 'tokenBridge_' });
-        c.addConstructorCode(`require(tokenBridge_ != address(0), "Invalid tokenBridge_ address");`);
-
-        c.addConstructorCode(toStorageStructInstantiation(c.name));
-        c.addConstructorCode(`$.tokenBridge = tokenBridge_;`);
+        LINES_CHECK_AND_SET_TOKEN_BRIDGE.forEach(line => {
+          c.addConstructorCode(line);
+        });
 
         c.setFunctionBody(
           [toStorageStructInstantiation(c.name), `if (caller != $.tokenBridge) revert Unauthorized();`],
           functions._checkTokenBridge,
           'view',
         );
+
+        // Add bridge setter
+        requireAccessControl(c, functions.setTokenBridge, access, 'TOKEN_BRIDGE_SETTER', 'tokenBridgeSetter');
+        c.setFunctionBody(LINES_CHECK_AND_SET_TOKEN_BRIDGE, functions.setTokenBridge);
       }
       break;
     }
@@ -483,4 +582,17 @@ export const functions = defineFunctions({
     kind: 'internal' as const,
     args: [{ name: 'caller', type: 'address' }],
   },
+
+  setTokenBridge: {
+    kind: 'public' as const,
+    args: [{ name: 'tokenBridge_', type: 'address' }],
+  },
+
+  setLink: {
+    kind: 'public' as const,
+    args: [
+      { name: 'gateway', type: 'address' },
+      { name: 'counterpart', type: 'bytes memory' },
+    ],
+  },
 });

package/src/generate/erc20.ts

@@ -7,27 +7,48 @@ import { generateAlternatives } from './alternatives';
 
 const booleans = [true, false];
 
-const blueprint = {
+const blueprintWithoutBasicFeatures = {
   name: ['MyToken'],
   symbol: ['MTK'],
-  burnable: booleans,
   pausable: booleans,
   mintable: booleans,
-  callback: booleans,
-  permit: booleans,
   votes: [...booleans, ...clockModeOptions] as const,
-  flashmint: booleans,
   premint: ['1'],
   premintChainId: ['10'],
   crossChainBridging: crossChainBridgingOptions,
+  crossChainLinkAllowOverride: [false],
   access: accessOptions,
   upgradeable: upgradeableOptions,
   namespacePrefix: ['myProject'],
   info: infoOptions,
 };
 
+// Basic features that do not depend on other features like access control
+const basicFeatures = {
+  OFF: {
+    burnable: [false],
+    callback: [false],
+    permit: [false],
+    flashmint: [false],
+  },
+  ON: {
+    burnable: [true],
+    callback: [true],
+    permit: [true],
+    flashmint: [true],
+  },
+};
+
 export function* generateERC20Options(): Generator<Required<ERC20Options>> {
-  for (const opts of generateAlternatives(blueprint)) {
+  // Separate generation steps with basic features OFF and ON to avoid having too many combinations
+  for (const opts of generateAlternatives({ ...blueprintWithoutBasicFeatures, ...basicFeatures.OFF })) {
+    // crossChainBridging does not currently support upgradeable
+    if (!(opts.crossChainBridging && opts.upgradeable)) {
+      yield opts;
+    }
+  }
+
+  for (const opts of generateAlternatives({ ...blueprintWithoutBasicFeatures, ...basicFeatures.ON })) {
     // crossChainBridging does not currently support upgradeable
     if (!(opts.crossChainBridging && opts.upgradeable)) {
       yield opts;

package/src/generate/stablecoin.ts

@@ -19,6 +19,7 @@ const erc20Basic = {
   premint: ['1'],
   premintChainId: [''],
   crossChainBridging: [false] as const,
+  crossChainLinkAllowOverride: [false] as const,
   access: [false] as const,
   info: [{}] as const,
   namespacePrefix: ['myProject'],
@@ -37,6 +38,7 @@ const erc20Full = {
   premint: ['1'],
   premintChainId: ['10'],
   crossChainBridging: crossChainBridgingOptions,
+  crossChainLinkAllowOverride: [true] as const,
   access: accessOptions,
   info: infoOptions,
   namespacePrefix: ['myProject'],

package/src/index.ts

@@ -1,21 +1,37 @@
+// ===== Public API =====
+
+export { erc20, erc721, erc1155, stablecoin, realWorldAsset, account, governor, custom } from './api';
+export type { WizardContractAPI, AccessControlAPI } from './api';
+
+export type { ERC20Options } from './erc20';
+export type { ERC721Options } from './erc721';
+export type { ERC1155Options } from './erc1155';
+export type { StablecoinOptions } from './stablecoin';
+export type { AccountOptions } from './account';
+export type { GovernorOptions } from './governor';
+export type { CustomOptions } from './custom';
+
+// ===== Internal API - Intended for use by other Wizard packages only =====
+
 export type { GenericOptions, KindedOptions } from './build-generic';
 export { buildGeneric } from './build-generic';
 
 export { generateAlternatives } from './generate/alternatives';
 
-export type { Contract, BaseFunction, Value, ReferencedContract } from './contract';
+export type { Contract, BaseFunction, Value, ReferencedContract, FunctionArgument } from './contract';
 export { ContractBuilder } from './contract';
 
 export { printContract } from './print';
 
 export type { Access } from './set-access-control';
+export { accessOptions, setAccessControl, requireAccessControl } from './set-access-control';
+export { addPausable } from './add-pausable';
 export type { Upgradeable } from './set-upgradeable';
 export type { Info } from './set-info';
 
 export { premintPattern, chainIdPattern } from './erc20';
-export { defaults as infoDefaults, infoOptions, setInfo } from './set-info';
-export { accessOptions, setAccessControl, requireAccessControl } from './set-access-control';
-export { addPausable } from './add-pausable';
+export { defaults as infoDefaults, setInfo, infoOptions } from './set-info';
+export { supportsInterface } from './common-functions';
 
 export type { OptionsErrorMessages } from './error';
 export { OptionsError } from './error';
@@ -23,21 +39,17 @@ export { OptionsError } from './error';
 export type { Kind } from './kind';
 export { sanitizeKind } from './kind';
 
-export { erc20, erc721, erc1155, stablecoin, realWorldAsset, account, governor, custom } from './api';
-export type { WizardContractAPI, AccessControlAPI } from './api';
-
 export { compatibleContractsSemver } from './utils/version';
-export { findCover } from './utils/find-cover';
-export { defineFunctions } from './utils/define-functions';
 
+export { defineFunctions } from './utils/define-functions';
 export type { CommonOptions } from './common-options';
 export { withCommonDefaults, defaults as commonDefaults } from './common-options';
-export { supportsInterface } from './common-functions';
-
-export type { ERC20Options } from './erc20';
-export type { ERC721Options } from './erc721';
-export type { ERC1155Options } from './erc1155';
-export type { StablecoinOptions } from './stablecoin';
-export type { AccountOptions } from './account';
-export type { GovernorOptions } from './governor';
-export type { CustomOptions } from './custom';
+export type { ClockMode } from './set-clock-mode';
+export { clockModeDefault, setClockMode, clockModeOptions } from './set-clock-mode';
+export { toBigInt } from './utils/convert-strings';
+export type { Options } from './options';
+export type { Lines } from './utils/format-lines';
+export { formatLinesWithSpaces, spaceBetween } from './utils/format-lines';
+export { findCover } from './utils/find-cover';
+export type { PremintCalculation } from './erc20';
+export { calculatePremint as calculateERC20Premint, scaleByPowerOfTen } from './erc20';

package/src/options.ts

@@ -29,8 +29,10 @@ export interface Options {
   transformImport?: (parent: ImportContract) => ImportContract;
   /**
    * Add additional libraries to the compatibility banner printed at the top of the contract.
+   *
+   * If `alwaysKeepOzPrefix` is true, the library name will always keep the "OpenZeppelin " prefix, even if there are multiple libraries from OpenZeppelin being imported.
    */
-  additionalCompatibleLibraries?: { name: string; path: string; version: string }[];
+  additionalCompatibleLibraries?: { name: string; path: string; version: string; alwaysKeepOzPrefix?: boolean }[];
 }
 
 export interface Helpers extends Required<Options> {