Stylus add security contract field

.changeset/fair-plums-throw.md

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

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

@@ -3,6 +3,7 @@ import test from 'ava';
 import type { BaseFunction, BaseImplementedTrait } from './contract';
 import { ContractBuilder } from './contract';
 import { printContract } from './print';
+import { TAG_SECURITY_CONTACT } from './set-info';
 
 test('contract basics', t => {
   const Foo = new ContractBuilder('Foo');
@@ -77,3 +78,9 @@ test('contract with sorted traits', t => {
   );
   t.snapshot(printContract(Foo));
 });
+
+test('contract with info', t => {
+  const Foo = new ContractBuilder('Foo');
+  Foo.addDocumentationTag(TAG_SECURITY_CONTACT, '[email protected]');
+  t.snapshot(printContract(Foo));
+});

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

@@ -167,3 +167,26 @@ Generated by [AVA](https://avajs.dev).
         fn funcSpecial() {}␊
     }␊
     `
+
+## contract with info
+
+> Snapshot 1
+
+    `// SPDX-License-Identifier: MIT␊
+    // Compatible with OpenZeppelin Contracts for Stylus ^0.2.0-alpha.4␊
+    ␊
+    #![cfg_attr(not(any(test, feature = "export-abi")), no_main)]␊
+    extern crate alloc;␊
+    ␊
+    use stylus_sdk::prelude::*;␊
+    ␊
+    /// @custom:security-contact [email protected]␊
+    ␊
+    #[entrypoint]␊
+    #[storage]␊
+    struct Foo {}␊
+    ␊
+    #[public]␊
+    #[inherit]␊
+    impl Foo {}␊
+    `

packages/core/stylus/src/contract.ts

@@ -8,6 +8,7 @@ type Name = {
 export interface Contract {
   license: string;
   name: Name;
+  documentationTags: DocumentationTag[];
   useClauses: UseClause[];
   implementedTraits: ImplementedTrait[];
   constants: Variable[];
@@ -70,10 +71,17 @@ export interface Argument {
   type?: string;
 }
 
+export interface DocumentationTag {
+  key: string;
+  value: string;
+}
+
 export class ContractBuilder implements Contract {
   readonly name: Name;
   license = 'MIT';
 
+  readonly documentationTags: DocumentationTag[] = [];
+
   private implementedTraitsMap: Map<string, ImplementedTrait> = new Map();
   private useClausesMap: Map<string, UseClause> = new Map();
   private errorsMap: Map<string, Error> = new Map();
@@ -199,4 +207,10 @@ export class ContractBuilder implements Contract {
     const existingFn = this.addFunction(baseTrait, fn);
     existingFn.attribute = attribute;
   }
+
+  addDocumentationTag(key: string, value: string) {
+    // eslint-disable-next-line no-useless-escape
+    if (!/^(@custom:)?[a-z][a-z\-]*$/.exec(key)) throw new Error(`Invalid documentation key: ${key}`);
+    this.documentationTags.push({ key, value });
+  }
 }

packages/core/stylus/src/print.ts

@@ -1,4 +1,4 @@
-import type { Contract, Argument, ContractFunction, ImplementedTrait, UseClause } from './contract';
+import type { Contract, Argument, ContractFunction, ImplementedTrait, UseClause, DocumentationTag } from './contract';
 
 import type { Lines } from './utils/format-lines';
 import { formatLines, spaceBetween } from './utils/format-lines';
@@ -20,6 +20,7 @@ export function printContract(contract: Contract): string {
       [`#![cfg_attr(not(any(test, feature = "export-abi")), no_main)]`, `extern crate alloc;`],
       spaceBetween(
         printUseClauses(contract),
+        printDocumentationTags(contract.documentationTags),
         printConstants(contract),
         printStorage(contract.name.identifier, sortedGroups),
         contract.eip712Needed ? printEip712(contract.name.stringLiteral) : [],
@@ -284,3 +285,7 @@ function printArgument(arg: Argument): string {
     return `${arg.name}`;
   }
 }
+
+function printDocumentationTags(tags: DocumentationTag[]): string[] {
+  return tags.map(({ key, value }) => `/// ${key} ${value}`);
+}

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

@@ -1,15 +1,22 @@
 import type { ContractBuilder } from './contract';
 
+export const TAG_SECURITY_CONTACT = `@custom: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.addDocumentationTag(TAG_SECURITY_CONTACT, securityContact);
+  }
 
   if (license) {
     c.license = license;

packages/ui/api/ai-assistant/function-definitions/stylus-shared.ts

@@ -13,6 +13,12 @@ export const stylusCommonFunctionDescription = {
     type: 'object',
     description: 'Metadata about the contract and author',
     properties: {
+      securityContact: {
+        type: 'string',
+        description:
+          'Email where people can contact you to report security issues. Will only be visible if contract metadata is verified.',
+      },
+
       license: {
         type: 'string',
         description: 'The license used by the contract, default is "MIT"',

packages/ui/src/stylus/InfoSection.svelte

@@ -1,6 +1,7 @@
 <script lang="ts">
   import type { Info } from '@openzeppelin/wizard-stylus';
   import { infoDefaults } from '@openzeppelin/wizard-stylus';
+  import HelpTooltip from '../common/HelpTooltip.svelte';
 
   export let info: Info;
 </script>
@@ -13,6 +14,16 @@
     </label>
   </h1>
 
+  <label class="labeled-input">
+    <span class="flex justify-between pr-2">
+      Security Contact
+      <HelpTooltip>
+        Where people can contact you to report security issues. Will only be visible if contract metadata is verified.
+      </HelpTooltip>
+    </span>
+    <input bind:value={info.securityContact} placeholder="[email protected]" />
+  </label>
+
   <label class="labeled-input">
     <span>License</span>
     <input bind:value={info.license} placeholder={infoDefaults.license} />