Add Multisig

.github/workflows/compile-cairo-alpha-project.yml

@@ -44,7 +44,7 @@ jobs:
           # Exit immediately if a command exits with a non-zero status
           set -e
 
-          declare -a all_kinds=("ERC20" "ERC721" "ERC1155" "Account" "Vesting" "Governor" "Custom")
+          declare -a all_kinds=("ERC20" "ERC721" "ERC1155" "Account" "Multisig" "Governor" "Vesting" "Custom")
           declare -a all_royalty_info_options=("disabled" "enabled_default" "enabled_custom")
           for kind in "${all_kinds[@]}"; do
             scarb clean

.github/workflows/compile-cairo-project.yml

@@ -44,7 +44,7 @@ jobs:
           # Exit immediately if a command exits with a non-zero status
           set -e
 
-          declare -a all_kinds=("ERC20" "ERC721" "ERC1155" "Account" "Vesting" "Governor" "Custom")
+          declare -a all_kinds=("ERC20" "ERC721" "ERC1155" "Account" "Multisig" "Governor" "Vesting" "Custom")
           declare -a all_royalty_info_options=("disabled" "enabled_default" "enabled_custom")
           for kind in "${all_kinds[@]}"; do
             scarb clean

packages/core/cairo/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.1.0 (2025-04-01)
+
+- Add Multisig tab. ([#433](https://github.com/OpenZeppelin/contracts-wizard/pull/433))
+
 ## 1.0.0 (2025-02-25)
 
 - **Breaking changes**:

packages/core/cairo/README.md

@@ -18,6 +18,7 @@ The following contract types are supported:
 - `erc1155`
 - `account`
 - `governor`
+- `multisig`
 - `vesting`
 - `custom`
 
@@ -39,6 +40,9 @@ function print(opts?: ERC1155Options): string
 function print(opts?: AccountOptions): string
 ```
 ```js
+function print(opts?: MultisigOptions): string
+```
+```js
 function print(opts?: GovernorOptions): string
 ```
 ```js
@@ -63,6 +67,9 @@ const defaults: Required<ERC1155Options>
 const defaults: Required<AccountOptions>
 ```
 ```js
+const defaults: Required<MultisigOptions>
+```
+```js
 const defaults: Required<GovernorOptions>
 ```
 ```js

packages/core/cairo/package.json

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

packages/core/cairo/src/api.ts

@@ -21,6 +21,8 @@ import type { AccountOptions } from './account';
 import { printAccount, defaults as accountDefaults } from './account';
 import type { GovernorOptions } from './governor';
 import { printGovernor, defaults as governorDefaults } from './governor';
+import type { MultisigOptions } from './multisig';
+import { printMultisig, defaults as multisigDefaults } from './multisig';
 import type { CustomOptions } from './custom';
 import {
   printCustom,
@@ -66,6 +68,7 @@ export type ERC20 = WizardContractAPI<ERC20Options> & AccessControlAPI<ERC20Opti
 export type ERC721 = WizardContractAPI<ERC721Options> & AccessControlAPI<ERC721Options>;
 export type ERC1155 = WizardContractAPI<ERC1155Options> & AccessControlAPI<ERC1155Options>;
 export type Account = WizardAccountAPI<AccountOptions>;
+export type Multisig = WizardContractAPI<MultisigOptions>;
 export type Governor = WizardContractAPI<GovernorOptions>;
 export type Vesting = WizardContractAPI<VestingOptions>;
 export type Custom = WizardContractAPI<CustomOptions> & AccessControlAPI<CustomOptions>;
@@ -89,6 +92,10 @@ export const account: Account = {
   print: printAccount,
   defaults: accountDefaults,
 };
+export const multisig: Multisig = {
+  print: printMultisig,
+  defaults: multisigDefaults,
+};
 export const governor: Governor = {
   print: printGovernor,
   defaults: governorDefaults,

packages/core/cairo/src/build-generic.ts

@@ -10,6 +10,8 @@ import type { AccountOptions } from './account';
 import { buildAccount } from './account';
 import type { GovernorOptions } from './governor';
 import { buildGovernor } from './governor';
+import type { MultisigOptions } from './multisig';
+import { buildMultisig } from './multisig';
 import type { VestingOptions } from './vesting';
 import { buildVesting } from './vesting';
 
@@ -18,6 +20,7 @@ export interface KindedOptions {
   ERC721: { kind: 'ERC721' } & ERC721Options;
   ERC1155: { kind: 'ERC1155' } & ERC1155Options;
   Account: { kind: 'Account' } & AccountOptions;
+  Multisig: { kind: 'Multisig' } & MultisigOptions;
   Governor: { kind: 'Governor' } & GovernorOptions;
   Vesting: { kind: 'Vesting' } & VestingOptions;
   Custom: { kind: 'Custom' } & CustomOptions;
@@ -39,6 +42,9 @@ export function buildGeneric(opts: GenericOptions) {
     case 'Account':
       return buildAccount(opts);
 
+    case 'Multisig':
+      return buildMultisig(opts);
+
     case 'Governor':
       return buildGovernor(opts);
 

packages/core/cairo/src/generate/multisig.ts

@@ -0,0 +1,14 @@
+import { infoOptions } from '../set-info';
+import type { MultisigOptions } from '../multisig';
+import { generateAlternatives } from './alternatives';
+
+const blueprint = {
+  name: ['MyMultisig'],
+  quorum: ['1', '2', '42'],
+  upgradeable: [true, false],
+  info: infoOptions,
+};
+
+export function* generateMultisigOptions(): Generator<Required<MultisigOptions>> {
+  yield* generateAlternatives(blueprint);
+}

packages/core/cairo/src/generate/sources.ts

@@ -8,6 +8,7 @@ import { generateERC1155Options } from './erc1155';
 import { generateAccountOptions } from './account';
 import { generateCustomOptions } from './custom';
 import { generateGovernorOptions } from './governor';
+import { generateMultisigOptions } from './multisig';
 import { generateVestingOptions } from './vesting';
 import type { GenericOptions, KindedOptions } from '../build-generic';
 import { buildGeneric } from '../build-generic';
@@ -50,9 +51,9 @@ export function* generateOptions(params: {
     }
   }
 
-  if (kind === 'all' || kind === 'Custom') {
-    for (const kindOpts of generateCustomOptions()) {
-      yield { kind: 'Custom', ...kindOpts };
+  if (kind === 'all' || kind === 'Multisig') {
+    for (const kindOpts of generateMultisigOptions()) {
+      yield { kind: 'Multisig', ...kindOpts };
     }
   }
 
@@ -67,6 +68,12 @@ export function* generateOptions(params: {
       yield { kind: 'Vesting', ...kindOpts };
     }
   }
+
+  if (kind === 'all' || kind === 'Custom') {
+    for (const kindOpts of generateCustomOptions()) {
+      yield { kind: 'Custom', ...kindOpts };
+    }
+  }
 }
 
 interface GeneratedContract {
@@ -110,10 +117,11 @@ function generateContractSubset(params: {
         switch (c.options.kind) {
           case 'Vesting':
             return isUpgradeable === false;
-          case 'Account':
           case 'ERC20':
           case 'ERC721':
           case 'ERC1155':
+          case 'Account':
+          case 'Multisig':
           case 'Governor':
           case 'Custom':
             return c.options.upgradeable === isUpgradeable;
@@ -183,8 +191,9 @@ function resolveSourceLabel(params: { kind: KindSubset; royaltyInfo: RoyaltyInfo
       return 'All contract kinds';
     case 'ERC20':
     case 'Account':
-    case 'Vesting':
+    case 'Multisig':
     case 'Governor':
+    case 'Vesting':
     case 'Custom':
       return kind;
     default: {

packages/core/cairo/src/governor.ts

@@ -9,7 +9,7 @@ import { setUpgradeableGovernor } from './set-upgradeable';
 import { defineComponents } from './utils/define-components';
 import { durationToTimestamp } from './utils/duration';
 import { addSNIP12Metadata, addSRC5Component } from './common-components';
-import { toUint } from './utils/convert-strings';
+import { toUint, isNaturalNumber } from './utils/convert-strings';
 export const clockModeOptions = ['timestamp'] as const;
 export const clockModeDefault = 'timestamp' as const;
 export type ClockMode = (typeof clockModeOptions)[number];
@@ -436,7 +436,7 @@ function addQuorumAndVotes(c: ContractBuilder, allOpts: Required<GovernorOptions
 
     addVotesQuorumFractionComponent(c, allOpts.quorumPercent);
   } else if (allOpts.quorumMode === 'absolute') {
-    if (!numberPattern.test(allOpts.quorumAbsolute)) {
+    if (!isNaturalNumber(allOpts.quorumAbsolute)) {
       throw new OptionsError({
         quorumAbsolute: 'Not a valid number',
       });
@@ -534,5 +534,3 @@ function addExecution(c: ContractBuilder, { timelock }: Required<GovernorOptions
     c.addComponent(components.GovernorTimelockExecutionComponent, [{ lit: 'timelock_controller' }], true);
   }
 }
-
-export const numberPattern = /^(?!$)(\d*)(?:\.(\d+))?(?:e(\d+))?$/;

packages/core/cairo/src/index.ts

@@ -25,4 +25,4 @@ export { sanitizeKind } from './kind';
 
 export { contractsVersion, contractsVersionTag, compatibleContractsSemver } from './utils/version';
 
-export { erc20, erc721, erc1155, account, governor, vesting, custom } from './api';
+export { erc20, erc721, erc1155, account, multisig, governor, vesting, custom } from './api';

packages/core/cairo/src/kind.ts

@@ -18,6 +18,7 @@ function isKind<T>(value: Kind | T): value is Kind {
     case 'ERC721':
     case 'ERC1155':
     case 'Account':
+    case 'Multisig':
     case 'Governor':
     case 'Vesting':
     case 'Custom':

packages/core/cairo/src/multisig.test.ts

@@ -0,0 +1,120 @@
+import test from 'ava';
+import type { OptionsError } from '.';
+import { multisig } from '.';
+import type { MultisigOptions } from './multisig';
+import { buildMultisig } from './multisig';
+import { contractDefaults as commonDefaults } from './common-options';
+import { printContract } from './print';
+
+const defaults: MultisigOptions = {
+  name: 'MyMultisig',
+  quorum: '2',
+  upgradeable: commonDefaults.upgradeable,
+  info: commonDefaults.info,
+};
+
+const CUSTOM_NAME = 'CustomMultisig';
+const CUSTOM_QUORUM = '42';
+
+//
+// Test helpers
+//
+
+function testMultisig(title: string, opts: Partial<MultisigOptions>) {
+  test(title, t => {
+    const c = buildMultisig({
+      ...defaults,
+      ...opts,
+    });
+    t.snapshot(printContract(c));
+  });
+}
+
+function testAPIEquivalence(title: string, opts?: MultisigOptions) {
+  test(title, t => {
+    t.is(
+      multisig.print(opts),
+      printContract(
+        buildMultisig({
+          ...defaults,
+          ...opts,
+        }),
+      ),
+    );
+  });
+}
+
+//
+// Snapshot tests
+//
+
+testMultisig('custom name', {
+  name: CUSTOM_NAME,
+});
+
+testMultisig('custom quorum', {
+  quorum: CUSTOM_QUORUM,
+});
+
+testMultisig('all custom settings', {
+  name: CUSTOM_NAME,
+  quorum: CUSTOM_QUORUM,
+});
+
+testMultisig('upgradeable', {
+  upgradeable: true,
+});
+
+testMultisig('non-upgradeable', {
+  upgradeable: false,
+});
+
+//
+// API tests
+//
+
+testAPIEquivalence('API custom name', {
+  ...defaults,
+  name: CUSTOM_NAME,
+});
+
+testAPIEquivalence('API custom quorum', {
+  ...defaults,
+  quorum: CUSTOM_QUORUM,
+});
+
+testAPIEquivalence('API all custom settings', {
+  ...defaults,
+  name: CUSTOM_NAME,
+  quorum: CUSTOM_QUORUM,
+});
+
+testAPIEquivalence('API upgradeable', {
+  ...defaults,
+  upgradeable: true,
+});
+
+testAPIEquivalence('API non-upgradeable', {
+  ...defaults,
+  upgradeable: false,
+});
+
+test('quorum is 0', async t => {
+  const error = t.throws(() =>
+    buildMultisig({
+      ...defaults,
+      quorum: '0',
+    }),
+  );
+  t.is((error as OptionsError).messages.quorum, 'Quorum cannot be 0');
+});
+
+test('negative quorum', async t => {
+  const error = t.throws(() =>
+    buildMultisig({
+      ...defaults,
+      quorum: '-1',
+    }),
+  );
+  t.is((error as OptionsError).messages.quorum, 'Not a valid number');
+});