Hooks Wizard v0.0.0 [WIP]

packages/core/solidity/src/contract.test.ts.md

@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -21,7 +21,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Footec {␊
@@ -33,7 +33,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -47,7 +47,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -62,7 +62,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -77,7 +77,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -93,7 +93,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -105,7 +105,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -125,7 +125,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -149,7 +149,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -162,7 +162,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -177,7 +177,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -192,7 +192,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     import {Bar} from "./Bar.sol";␊
@@ -209,7 +209,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -224,7 +224,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -240,7 +240,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -253,7 +253,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Foo {␊
@@ -267,7 +267,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract FooBarBaz {␊
@@ -279,7 +279,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     /// @custom:security-contact security@example.com␊

packages/core/solidity/src/contract.ts

@@ -5,6 +5,7 @@ export interface Contract {
   license: string;
   parents: Parent[];
   natspecTags: NatspecTag[];
+  libraries: Library[];
   imports: ImportContract[];
   functions: ContractFunction[];
   constructorCode: string[];
@@ -30,9 +31,9 @@ export interface ReferencedContract {
   transpiled?: boolean;
 }
 
-export interface Using {
+export interface Library {
   library: ImportContract;
-  usingFor: string;
+  usingFor: Set<string>;
 }
 
 export interface BaseFunction {
@@ -52,7 +53,7 @@ export interface ContractFunction extends BaseFunction {
   comments: string[];
 }
 
-export type FunctionKind = 'internal' | 'public';
+export type FunctionKind = 'private' | 'internal' | 'public' | 'external';
 export type FunctionMutability = (typeof mutabilityRank)[number];
 
 // Order is important
@@ -77,15 +78,15 @@ export class ContractBuilder implements Contract {
   license: string = 'MIT';
   upgradeable = false;
 
-  readonly using: Using[] = [];
   readonly natspecTags: NatspecTag[] = [];
 
   readonly constructorArgs: FunctionArgument[] = [];
   readonly constructorCode: string[] = [];
   readonly variableSet: Set<string> = new Set();
 
   private parentMap: Map<string, Parent> = new Map<string, Parent>();
-  private functionMap: Map<string, ContractFunction> = new Map();
+  private functionMap: Map<string, ContractFunction> = new Map<string, ContractFunction>();
+  private libraryMap: Map<string, Library> = new Map<string, Library>();
 
   constructor(name: string) {
     this.name = toIdentifier(name, true);
@@ -106,7 +107,13 @@ export class ContractBuilder implements Contract {
   }
 
   get imports(): ImportContract[] {
-    return [...[...this.parentMap.values()].map(p => p.contract), ...this.using.map(u => u.library)];
+    const parents = [...this.parentMap.values()].map(p => p.contract);
+    const libraries = [...this.libraryMap.values()].map(l => l.library);
+    return [...parents, ...libraries];
+  }
+
+  get libraries(): Library[] {
+    return [...this.libraryMap.values()];
   }
 
   get functions(): ContractFunction[] {
@@ -133,6 +140,21 @@ export class ContractBuilder implements Contract {
     return !present;
   }
 
+  addLibrary(library: ImportContract, usingFor: string[]): boolean {
+    let modified = false;
+    if (this.libraryMap.has(library.name)) {
+      const existing = this.libraryMap.get(library.name)!;
+      const initialSize = existing.usingFor.size;
+      usingFor.forEach(type => existing.usingFor.add(type));
+      modified = existing.usingFor.size > initialSize;
+    } else {
+      this.libraryMap.set(library.name, { library, usingFor: new Set(usingFor) });
+      modified = true;
+    }
+
+    return modified;
+  }
+
   addOverride(parent: ReferencedContract, baseFn: BaseFunction, mutability?: FunctionMutability) {
     const fn = this.addFunction(baseFn);
     fn.override.add(parent);

packages/core/solidity/src/custom.test.ts.md

@@ -9,7 +9,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract MyContract {␊
@@ -21,7 +21,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract Contract {␊
@@ -106,7 +106,7 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     `// SPDX-License-Identifier: MIT␊
-    // Compatible with OpenZeppelin Contracts ^5.4.0␊
+    ␊
     pragma solidity ^0.8.27;␊
     ␊
     contract MyContract {␊

packages/core/solidity/src/index.ts

@@ -1,7 +1,9 @@
 export type { GenericOptions, KindedOptions } from './build-generic';
 export { buildGeneric } from './build-generic';
 
-export type { Contract } from './contract';
+export { generateAlternatives } from './generate/alternatives';
+
+export type { Contract, BaseFunction, Value, ReferencedContract } from './contract';
 export { ContractBuilder } from './contract';
 
 export { printContract } from './print';
@@ -11,7 +13,9 @@ export type { Upgradeable } from './set-upgradeable';
 export type { Info } from './set-info';
 
 export { premintPattern, chainIdPattern } from './erc20';
-export { defaults as infoDefaults } from './set-info';
+export { defaults as infoDefaults, infoOptions, setInfo } from './set-info';
+export { accessOptions, setAccessControl } from './set-access-control';
+export { addPausable } from './add-pausable';
 
 export type { OptionsErrorMessages } from './error';
 export { OptionsError } from './error';
@@ -20,8 +24,15 @@ 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 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';

packages/core/solidity/src/options.ts

@@ -27,6 +27,10 @@ export function upgradeableImport(p: ImportContract): ImportContract {
 
 export interface Options {
   transformImport?: (parent: ImportContract) => ImportContract;
+  /**
+   * Add additional libraries to the compatibility banner printed at the top of the contract.
+   */
+  additionalCompatibleLibraries?: { name: string; path: string; version: string }[];
 }
 
 export interface Helpers extends Required<Options> {
@@ -45,5 +49,6 @@ export function withHelpers(contract: Contract, opts: Options = {}): Helpers {
       const p2 = contractUpgradeable && inferTranspiled(p1) ? upgradeableImport(p1) : p1;
       return opts.transformImport?.(p2) ?? p2;
     },
+    additionalCompatibleLibraries: opts.additionalCompatibleLibraries ?? [],
   };
 }