Add Multisig

packages/core-cairo/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Add Multisig tab. ([#433](https://github.com/OpenZeppelin/contracts-wizard/pull/433))
+
 ## 0.21.1 (2025-01-23)
 
 - Update to use TypeScript v5. ([#231](https://github.com/OpenZeppelin/contracts-wizard/pull/231))

packages/core-cairo/src/api.ts

@@ -4,6 +4,7 @@ import { printERC721, defaults as erc721defaults, isAccessControlRequired as erc
 import { printERC1155, defaults as erc1155defaults, isAccessControlRequired as erc1155IsAccessControlRequired, ERC1155Options } from './erc1155';
 import { printAccount, defaults as accountDefaults, AccountOptions } from './account';
 import { printGovernor, defaults as governorDefaults, GovernorOptions } from './governor';
+import { printMultisig, defaults as multisigDefaults, MultisigOptions } from './multisig';
 import { printCustom, defaults as customDefaults, isAccessControlRequired as customIsAccessControlRequired, CustomOptions } from './custom';
 import { printVesting, defaults as vestingDefaults, VestingOptions } from './vesting';
 
@@ -44,6 +45,7 @@ export type ERC721 = WizardContractAPI<ERC721Options> & AccessControlAPI<ERC721O
 export type ERC1155 = WizardContractAPI<ERC1155Options> & AccessControlAPI<ERC1155Options>;
 export type Account = WizardAccountAPI<AccountOptions>;
 export type Governor = WizardContractAPI<GovernorOptions>;
+export type Multisig = WizardContractAPI<MultisigOptions>;
 export type Vesting = WizardContractAPI<VestingOptions>;
 export type Custom = WizardContractAPI<CustomOptions> & AccessControlAPI<CustomOptions>;
 
@@ -70,6 +72,10 @@ export const governor: Governor = {
   print: printGovernor,
   defaults: governorDefaults,
 }
+export const multisig: Multisig = {
+  print: printMultisig,
+  defaults: multisigDefaults
+}
 export const vesting: Vesting = {
   print: printVesting,
   defaults: vestingDefaults,

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

@@ -4,6 +4,7 @@ import { ERC1155Options, buildERC1155 } from './erc1155';
 import { CustomOptions, buildCustom } from './custom';
 import { AccountOptions, buildAccount } from './account';
 import { GovernorOptions, buildGovernor } from './governor';
+import { MultisigOptions, buildMultisig } from './multisig';
 import { VestingOptions, buildVesting } from './vesting';
 
 export interface KindedOptions {
@@ -12,6 +13,7 @@ export interface KindedOptions {
   ERC1155:  { kind: 'ERC1155' }  & ERC1155Options;
   Account:  { kind: 'Account' }  & AccountOptions;
   Governor: { kind: 'Governor' } & GovernorOptions;
+  Multisig: { kind: 'Multisig' } & MultisigOptions;
   Vesting: { kind: 'Vesting' } & VestingOptions;
   Custom:   { kind: 'Custom' }   & CustomOptions;
 }
@@ -35,6 +37,9 @@ export function buildGeneric(opts: GenericOptions) {
     case 'Governor':
       return buildGovernor(opts);
 
+    case 'Multisig':
+      return buildMultisig(opts);
+
     case 'Vesting':
       return buildVesting(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 { buildGeneric, GenericOptions, KindedOptions } from '../build-generic';
 import { printContract } from '../print';
@@ -56,6 +57,12 @@ export function* generateOptions(kind?: Kind): Generator<GenericOptions> {
     }
   }
 
+  if (!kind || kind === 'Multisig') {
+    for (const kindOpts of generateMultisigOptions()) {
+      yield { kind: 'Multisig', ...kindOpts };
+    }
+  }
+
   if (!kind || kind === 'Vesting') {
     for (const kindOpts of generateVestingOptions()) {
       yield { kind: 'Vesting', ...kindOpts };
@@ -109,6 +116,7 @@ function generateContractSubset(subset: Subset, kind?: Kind): GeneratedContract[
           case 'ERC721':
           case 'ERC1155':
           case 'Governor':
+          case 'Multisig':
           case 'Custom':
             return c.options.upgradeable === isUpgradeable;
           default:

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, governor, multisig, vesting, custom } from './api';

packages/core-cairo/src/kind.ts

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

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

@@ -0,0 +1,110 @@
+import test from 'ava';
+import { OptionsError, multisig } from '.';
+import { buildMultisig, MultisigOptions } from './multisig';
+import { contractDefaults as commonDefaults } from './common-options';
+import { printContract } from './print';
+
+const defaults: MultisigOptions = {
+  name: 'MultisigWallet',
+  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');
+});