Remix - Use remappings file instead of import version pins

.changeset/remix-remappings-api.md

@@ -0,0 +1,10 @@
+---
+'@openzeppelin/wizard': patch
+'@openzeppelin/wizard-confidential': patch
+'@openzeppelin/wizard-uniswap-hooks': patch
+---
+
+Add package APIs for getting versioned remappings.
+- Export `getVersionedRemappings` from the Solidity, Confidential, and Uniswap Hooks package roots for internal use by other Wizard packages.
+- Add `getVersionedRemappings` to the Confidential `erc7984` API and the Uniswap Hooks `hooks` API for consistency with the Solidity contract APIs.
+- **Internal breaking change**: Removed the internal `print-versioned` entrypoints; internal consumers should use `getVersionedRemappings` instead.

packages/core/confidential/README.md

@@ -26,6 +26,20 @@ function print(opts?: ERC7984Options): string
 
 Returns a string representation of a contract generated using the provided options. If `opts` is not provided, uses [`defaults`](#defaults).
 
+#### `getVersionedRemappings`
+```js
+function getVersionedRemappings(): string[]
+```
+
+Returns an array of remappings that map unversioned import prefixes to versioned import prefixes. For example:
+```js
+[
+  "@openzeppelin/contracts/=@openzeppelin/contracts@5.6.0/",
+  "@openzeppelin/confidential-contracts/=@openzeppelin/confidential-contracts@0.3.1/",
+  "@fhevm/solidity/=@fhevm/solidity@0.9.1/"
+]
+```
+
 #### `defaults`
 ```js
 const defaults: Required<ERC7984Options>

packages/core/confidential/package.json

@@ -11,6 +11,8 @@
     "NOTICE",
     "/dist",
     "/src",
+    "contract-version-pins.json",
+    "contract-version-pins.d.ts",
     "!**/*.test.*"
   ],
   "scripts": {
@@ -41,4 +43,4 @@
     "semver": "^7.6.0",
     "ts-node": "^10.4.0"
   }
-}
+}

packages/core/confidential/src/api.ts

@@ -1,22 +1,12 @@
-import type { CommonOptions } from './common-options';
+import type { WizardContractAPI } from '@openzeppelin/wizard';
 import type { ERC7984Options } from './erc7984';
 import { printERC7984, defaults as erc7984Defaults } from './erc7984';
-
-export interface WizardContractAPI<Options extends CommonOptions> {
-  /**
-   * Returns a string representation of a contract generated using the provided options. If opts is not provided, uses `defaults`.
-   */
-  print: (opts?: Options) => string;
-
-  /**
-   * The default options that are used for `print`.
-   */
-  defaults: Required<Options>;
-}
+import { getVersionedRemappings } from './get-versioned-remappings';
 
 export type ERC7984 = WizardContractAPI<ERC7984Options>;
 
 export const erc7984: ERC7984 = {
   print: printERC7984,
+  getVersionedRemappings: getVersionedRemappings,
   defaults: erc7984Defaults,
 };

packages/core/confidential/src/get-versioned-remappings.test.ts

@@ -0,0 +1,17 @@
+import test from 'ava';
+import { getVersionedRemappings } from './get-versioned-remappings';
+import openzeppelinContracts from '../../solidity/openzeppelin-contracts';
+import contractVersionPins from '../contract-version-pins';
+
+test('getVersionedRemappings returns remappings for all confidential dependencies', t => {
+  const remappings = getVersionedRemappings();
+  t.is(remappings.length, 3);
+  t.is(remappings[0], `@openzeppelin/contracts/=@openzeppelin/contracts@${openzeppelinContracts.version}/`);
+  t.is(
+    remappings[1],
+    `@openzeppelin/confidential-contracts/=@openzeppelin/confidential-contracts@${contractVersionPins.confidentialContractsVersion}/`,
+  );
+  t.is(remappings[2], `@fhevm/solidity/=@fhevm/solidity@${contractVersionPins.fhevmSolidityVersion}/`);
+  t.false(remappings.some(remapping => remapping.includes('^')));
+  t.snapshot(remappings);
+});

packages/core/confidential/src/get-versioned-remappings.test.ts.md

@@ -0,0 +1,15 @@
+# Snapshot report for `src/get-versioned-remappings.test.ts`
+
+The actual snapshot is saved in `get-versioned-remappings.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## getVersionedRemappings returns remappings for all confidential dependencies
+
+> Snapshot 1
+
+    [
+      '@openzeppelin/contracts/=@openzeppelin/contracts@5.6.0/',
+      '@openzeppelin/confidential-contracts/=@openzeppelin/confidential-contracts@0.3.1/',
+      '@fhevm/solidity/=@fhevm/solidity@0.9.1/',
+    ]

packages/core/confidential/src/get-versioned-remappings.ts

@@ -0,0 +1,10 @@
+import openzeppelinContractsVersion from '@openzeppelin/wizard/openzeppelin-contracts-version.json';
+import contractVersionPins from '../contract-version-pins';
+
+export function getVersionedRemappings(): string[] {
+  return [
+    `@openzeppelin/contracts/=@openzeppelin/contracts@${openzeppelinContractsVersion.version}/`,
+    `@openzeppelin/confidential-contracts/=@openzeppelin/confidential-contracts@${contractVersionPins.confidentialContractsVersion}/`,
+    `@fhevm/solidity/=@fhevm/solidity@${contractVersionPins.fhevmSolidityVersion}/`,
+  ];
+}

packages/core/confidential/src/index.ts

@@ -2,6 +2,7 @@ export type { GenericOptions, KindedOptions } from './build-generic';
 export { buildGeneric } from './build-generic';
 
 export { printContract } from './print';
+export { getVersionedRemappings } from './get-versioned-remappings';
 
 export { premintPattern } from './erc7984';
 

packages/core/solidity/src/get-versioned-remappings.test.ts

@@ -6,6 +6,7 @@ test('getVersionedRemappings not upgradeable', t => {
   const remappings = getVersionedRemappings({});
   t.is(remappings.length, 1);
   t.is(remappings[0], `@openzeppelin/contracts/=@openzeppelin/contracts@${contracts.version}/`);
+  t.false(remappings.some(remapping => remapping.includes('^')));
   t.snapshot(remappings);
 });
 
@@ -14,6 +15,7 @@ test('getVersionedRemappings upgradeable uups', t => {
   t.is(remappings.length, 2);
   t.is(remappings[0], `@openzeppelin/contracts/=@openzeppelin/contracts@${contracts.version}/`);
   t.is(remappings[1], `@openzeppelin/contracts-upgradeable/=@openzeppelin/contracts-upgradeable@${contracts.version}/`);
+  t.false(remappings.some(remapping => remapping.includes('^')));
   t.snapshot(remappings);
 });
 
@@ -22,5 +24,6 @@ test('getVersionedRemappings upgradeable transparent', t => {
   t.is(remappings.length, 2);
   t.is(remappings[0], `@openzeppelin/contracts/=@openzeppelin/contracts@${contracts.version}/`);
   t.is(remappings[1], `@openzeppelin/contracts-upgradeable/=@openzeppelin/contracts-upgradeable@${contracts.version}/`);
+  t.false(remappings.some(remapping => remapping.includes('^')));
   t.snapshot(remappings);
 });

packages/core/solidity/src/index.ts

@@ -22,6 +22,7 @@ export type { Contract, BaseFunction, Value, ReferencedContract, FunctionArgumen
 export { ContractBuilder } from './contract';
 
 export { printContract } from './print';
+export { getVersionedRemappings } from './get-versioned-remappings';
 
 export type { Access } from './set-access-control';
 export { accessOptions, setAccessControl, requireAccessControl } from './set-access-control';

packages/core/uniswap-hooks/README.md

@@ -10,6 +10,11 @@ This package provides a programmatic API. For a web interface, see https://wizar
 
 `npm install @openzeppelin/wizard-uniswap-hooks`
 
+### Contract types
+
+The following contract types are supported:
+- `hooks`
+
 ### Hook templates
 
 The following hook templates are supported:
@@ -26,6 +31,43 @@ The following hook templates are supported:
 - `LiquidityPenaltyHook` - Applies penalties to early liquidity removals
 - `ReHypothecationHook` - Enables yield generation from deposited liquidity
 
+### Functions
+
+#### `print`
+```js
+function print(opts?: HooksOptions): string
+```
+
+Returns a string representation of a hook generated using the provided options. If `opts` is not provided, uses [`defaults`](#defaults).
+
+#### `getVersionedRemappings`
+```js
+function getVersionedRemappings(): string[]
+```
+
+Returns an array of remappings that map unversioned import prefixes to versioned import prefixes. For example:
+```js
+[
+  "@openzeppelin/contracts/=@openzeppelin/contracts@5.6.0/",
+  "@openzeppelin/uniswap-hooks/=@openzeppelin/uniswap-hooks@1.2.1/src/"
+]
+```
+
+#### `defaults`
+```js
+const defaults: Required<HooksOptions>
+```
+
+The default options that are used for [`print`](#print).
+
+#### `isAccessControlRequired`
+```js
+function isAccessControlRequired(opts: Partial<HooksOptions>): boolean
+```
+
+Whether any of the provided options require access control to be enabled. If this returns `true`, then calling `print` with the
+same options would cause the `access` option to default to `'ownable'` if it was `undefined` or `false`.
+
 ### Examples
 
 Import the hooks API from the `@openzeppelin/wizard-uniswap-hooks` package:

packages/core/uniswap-hooks/contract-version-pins.d.ts

@@ -0,0 +1,7 @@
+export interface ContractVersionPins {
+  uniswapHooksVersion: string;
+}
+
+declare const contractVersionPins: ContractVersionPins;
+
+export default contractVersionPins;

packages/core/uniswap-hooks/contract-version-pins.json

@@ -0,0 +1,3 @@
+{
+  "uniswapHooksVersion": "1.2.1"
+}