Cairo add security contract field (#558)

Co-authored-by: Eric Lau <[email protected]>

Author: CoveMB

.changeset/whole-buses-call.md

@@ -0,0 +1,6 @@
+---
+'@openzeppelin/wizard-cairo': patch
+---
+
+Add security contact in contract info
+

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

@@ -3,6 +3,7 @@ import test from 'ava';
 import type { BaseFunction, BaseImplementedTrait, Component } from './contract';
 import { ContractBuilder } from './contract';
 import { printContract } from './print';
+import { SECURITY_CONTACT_DOCUMENTATION } from './set-info';
 
 const FOO_COMPONENT: Component = {
   name: 'FooComponent',
@@ -106,3 +107,9 @@ test('contract with sorted use clauses', t => {
   Foo.addUseClause('another::library', 'Foo', { alias: 'Custom1' });
   t.snapshot(printContract(Foo));
 });
+
+test('contract with info', t => {
+  const Foo = new ContractBuilder('Foo');
+  Foo.addDocumentation(`${SECURITY_CONTACT_DOCUMENTATION}[email protected]`);
+  t.snapshot(printContract(Foo));
+});

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

@@ -231,3 +231,19 @@ Generated by [AVA](https://avajs.dev).
         }␊
     }␊
     `
+
+## contract with info
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    // Compatible with OpenZeppelin Contracts for Cairo ^1.0.0␊
+    ␊
+    // Security contact: [email protected]␊
+    #[starknet::contract]␊
+    mod Foo {␊
+        #[storage]␊
+        struct Storage {␊
+        }␊
+    }␊
+    `

packages/core/cairo/src/contract.test.ts.snap

@@ -2,6 +2,7 @@ import { toIdentifier } from './utils/convert-strings';
 
 export interface Contract {
   license: string;
+  documentations: string[];
   name: string;
   account: boolean;
   useClauses: UseClause[];
@@ -103,6 +104,8 @@ export class ContractBuilder implements Contract {
   license = 'MIT';
   upgradeable = false;
 
+  readonly documentations: string[] = [];
+
   readonly constructorArgs: Argument[] = [];
   readonly constructorCode: string[] = [];
 
@@ -298,4 +301,8 @@ export class ContractBuilder implements Contract {
   addInterfaceFlag(flag: string): void {
     this.interfaceFlagsSet.add(flag);
   }
+
+  addDocumentation(description: string) {
+    this.documentations.push(description);
+  }
 }

packages/core/cairo/src/contract.ts

@@ -29,6 +29,7 @@ export function printContract(contract: Contract): string {
       ],
       printSuperVariables(contract),
       [
+        ...printDocumentations(contract.documentations),
         `${contractAttribute}`,
         `mod ${contract.name} {`,
         spaceBetween(
@@ -427,3 +428,7 @@ function printArgument(arg: Argument): string {
     return `${arg.name}`;
   }
 }
+
+function printDocumentations(documentations: string[]): string[] {
+  return documentations.map(documentation => `// ${documentation}`);
+}

packages/core/cairo/src/print.ts

@@ -1,15 +1,22 @@
 import type { ContractBuilder } from './contract';
 
+export const SECURITY_CONTACT_DOCUMENTATION = `Security contact: `;
+
 export const infoOptions = [{}, { license: 'WTFPL' }] as const;
 
 export const defaults: Info = { license: 'MIT' };
 
 export type Info = {
   license?: string;
+  securityContact?: string;
 };
 
 export function setInfo(c: ContractBuilder, info: Info): void {
-  const { license } = info;
+  const { securityContact, license } = info;
+
+  if (securityContact) {
+    c.addDocumentation(`${SECURITY_CONTACT_DOCUMENTATION}${securityContact}`);
+  }
 
   if (license) {
     c.license = license;

packages/core/cairo/src/set-info.ts

@@ -3,6 +3,7 @@ import test from 'ava';
 import type { BaseFunction, BaseImplementedTrait, Component } from './contract';
 import { ContractBuilder } from './contract';
 import { printContract } from './print';
+import { SECURITY_CONTACT_DOCUMENTATION } from './set-info';
 
 const FOO_COMPONENT: Component = {
   name: 'FooComponent',
@@ -106,3 +107,9 @@ test('contract with sorted use clauses', t => {
   Foo.addUseClause('another::library', 'Foo', { alias: 'Custom1' });
   t.snapshot(printContract(Foo));
 });
+
+test('contract with info', t => {
+  const Foo = new ContractBuilder('Foo');
+  Foo.addDocumentation(`${SECURITY_CONTACT_DOCUMENTATION}[email protected]`);
+  t.snapshot(printContract(Foo));
+});

packages/core/cairo_alpha/src/contract.test.ts

@@ -231,3 +231,19 @@ Generated by [AVA](https://avajs.dev).
         }␊
     }␊
     `
+
+## contract with info
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    // Compatible with OpenZeppelin Contracts for Cairo 2.0.0-alpha.1␊
+    ␊
+    // Security contact: [email protected]␊
+    #[starknet::contract]␊
+    mod Foo {␊
+        #[storage]␊
+        struct Storage {␊
+        }␊
+    }␊
+    `