Deno ci check (#511)

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

Author: 3 people

.github/workflows/test.yml

@@ -21,6 +21,23 @@ jobs:
       - name: Run linter
         run: yarn lint
 
+  deno-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Deno 1.46.3 (matching Netlify edge function environment)
+        uses: denoland/setup-deno@v2
+        with:
+          deno-version: '1.46.3'
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          cache: 'yarn'
+      - name: Install dependencies and build wizard packages
+        run: yarn install --frozen-lockfile
+      - name: Deno check API
+        run: yarn type:check:api
+
   build:
     strategy:
       matrix:

.vscode/example.settings.json

@@ -1,10 +1,8 @@
 {
   "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
-  "deno.enablePaths": [
-    "packages/ui/api",
-    "packages/ui/scripts/development-server.ts"
-  ],
   "deno.enable": true,
-  "deno.path": "/opt/homebrew/bin/deno" // Update this to your Deno path	
+  "deno.enablePaths": [
+    "packages/ui/scripts/deno/"
+  ]
 }

CONTRIBUTING.md

@@ -14,8 +14,10 @@ Contributions to OpenZeppelin Contracts Wizard are welcome. Please review the in
 The following prerequisites are required to build the project locally:
 - [Node.js](https://nodejs.org/)
 - [Yarn](https://yarnpkg.com/getting-started/install)
-
-If you want to run the local API server for the AI Assistant, you also need to install [Deno](https://github.com/denoland/deno?tab=readme-ov-file#installation).
+- [Deno](https://github.com/denoland/deno?tab=readme-ov-file#installation) to run a local API server for the AI Assistant
+  - Note that using the shell installation method is recommended (the `upgrade` command, which allows you to install a specific Deno version, is not always available when installing Deno with other installers).  
+  - To install the version of Deno that matches the Netlify deploy environment, run `deno upgrade --version 1.46.3`.
+  - When adding dependencies for the Deno app add the dependency as a dev dependency using yarn, map the dependency to the Deno equivalent url in import_map.json and import it like a typescript dependency in the app.
 
 ### Installing dependencies
 From the root directory:

package.json

@@ -6,9 +6,10 @@
     "lint": "eslint",
     "format:write": "prettier --write \"**/*\"",
     "format:check": "prettier --check \"**/*\"",
+    "type:check:api": "yarn --cwd ./packages/ui type:check:api",
     "dev:ui": "yarn --cwd ./packages/ui dev",
     "dev:api": "yarn --cwd ./packages/ui dev:api",
-    "dev": "concurrently --kill-others-on-fail --names \"ui,api\" --prefix-colors \"magenta.bold,green.bold\" \"yarn dev:ui\" \"yarn dev:api\"",
+    "dev": "concurrently --kill-others-on-fail --names \"UI,API\" --prefix-colors \"magenta.bold,green.bold\" \"yarn dev:ui\" \"yarn dev:api\"",
     "run:core": "node ./scripts/run-command.mjs"
   },
   "workspaces": {

packages/ui/api/ai-assistant/function-definitions/solidity.ts

@@ -2,7 +2,7 @@ import type { AiFunctionDefinition } from '../types/function-definition.ts';
 import { addFunctionPropertiesFrom } from './shared.ts';
 import { commonFunctionDescription } from './solidity-shared.ts';
 
-export const erc20Function = {
+export const solidityERC20AIFunctionDefinition = {
   name: 'ERC20',
   description: 'Make a fungible token per the ERC-20 standard',
   parameters: {
@@ -63,7 +63,7 @@ export const erc20Function = {
   },
 } as const satisfies AiFunctionDefinition<'solidity', 'ERC20'>;
 
-export const erc721Function = {
+export const solidityERC721AIFunctionDefinition = {
   name: 'ERC721',
   description: 'Make a non-fungible token per the ERC-721 standard',
   parameters: {
@@ -107,7 +107,7 @@ export const erc721Function = {
   },
 } as const satisfies AiFunctionDefinition<'solidity', 'ERC721'>;
 
-export const erc1155Function = {
+export const solidityERC1155AIFunctionDefinition = {
   name: 'ERC1155',
   description: 'Make a non-fungible token per the ERC-1155 standard',
   parameters: {
@@ -141,14 +141,14 @@ export const erc1155Function = {
   },
 } as const satisfies AiFunctionDefinition<'solidity', 'ERC1155'>;
 
-export const stablecoinFunction = {
+export const solidityStablecoinAIFunctionDefinition = {
   name: 'Stablecoin',
   description:
     'Make a stablecoin token that uses the ERC-20 standard. Emphasize that this is experimental, and some features are not audited and subject to change.',
   parameters: {
     type: 'object',
     properties: {
-      ...erc20Function.parameters.properties,
+      ...solidityERC20AIFunctionDefinition.parameters.properties,
       custodian: {
         type: 'boolean',
         description:
@@ -173,14 +173,14 @@ export const stablecoinFunction = {
   },
 } as const satisfies AiFunctionDefinition<'solidity', 'Stablecoin'>;
 
-export const realWorldAssetFunction = {
+export const solidityRealWorldAssetAIFunctionDefinition = {
   name: 'RealWorldAsset',
   description:
     'Make a real-world asset token that uses the ERC-20 standard. Emphasize that this is experimental, and some features are not audited and subject to change.',
-  parameters: stablecoinFunction.parameters,
+  parameters: solidityStablecoinAIFunctionDefinition.parameters,
 } as const satisfies AiFunctionDefinition<'solidity', 'RealWorldAsset'>;
 
-export const governorFunction = {
+export const solidityGovernorAIFunctionDefinition = {
   name: 'Governor',
   description: 'Make a contract to implement governance, such as for a DAO',
   parameters: {
@@ -253,7 +253,7 @@ export const governorFunction = {
   },
 } as const satisfies AiFunctionDefinition<'solidity', 'Governor'>;
 
-export const customFunction = {
+export const solidityCustomAIFunctionDefinition = {
   name: 'Custom',
   description: 'Make a custom smart contract',
   parameters: {

packages/ui/api/ai-assistant/types/function-definition.ts

@@ -5,7 +5,12 @@ import type {
   IsPrimitiveUnion,
   Permutation,
 } from './helpers.ts';
-import type { AllLanguagesContractsOptions, LanguageContractsOptions, SupportedLanguage } from './languages.ts';
+import type {
+  AllLanguagesContractsOptions,
+  LanguageContractsNames,
+  LanguageContractsOptions,
+  SupportedLanguage,
+} from './languages.ts';
 
 type AiFunctionType<TType> = {
   type?: StringifyPrimaryType<TType>;
@@ -67,3 +72,9 @@ export type SimpleAiFunctionDefinition = {
     additionalProperties: false;
   };
 };
+
+export type AllContractsAIFunctionDefinitions = {
+  [L in SupportedLanguage]: {
+    [K in LanguageContractsNames<L> as `${L}${K}AIFunctionDefinition`]: { name: K } & SimpleAiFunctionDefinition;
+  };
+};

packages/ui/api/ai-assistant/types/languages.ts

@@ -1,5 +1,5 @@
-import type { KindedOptions as SolidityKindedOptions } from '@openzeppelin/wizard';
-export type { CommonOptions as SolidityCommonOptions } from '@openzeppelin/wizard/src/common-options.ts';
+import type { KindedOptions as SolidityKindedOptions } from '../../../../core/solidity/dist';
+export type { CommonOptions as SolidityCommonOptions } from '../../../../core/solidity/dist/common-options';
 
 // Add supported language here
 export type LanguagesContractsOptions = {
@@ -18,7 +18,7 @@ export type LanguageContractsOptions<TLanguage extends SupportedLanguage> = Lang
 
 export type AllLanguageContractsNames = AllLanguagesContractsOptions[keyof AllLanguagesContractsOptions]['kind'];
 
-type ExtractKind<T> = T extends { kind: infer K } ? K : never;
+type ExtractKind<T> = T extends { kind: infer K } ? (K extends string ? K : never) : never;
 
 export type LanguageContractsNames<TLanguage extends SupportedLanguage> = ExtractKind<
   LanguageContractsOptions<TLanguage>[keyof LanguageContractsOptions<TLanguage>]

packages/ui/api/ai.ts

@@ -1,14 +1,19 @@
-import { OpenAIStream } from 'https://esm.sh/[email protected]';
+import { OpenAIStream } from 'ai';
 import * as solidityFunctions from './ai-assistant/function-definitions/solidity.ts';
 import { saveChatInRedisIfDoesNotExist } from './services/redis.ts';
 import { getOpenAiInstance } from './services/open-ai.ts';
 import { getEnvironmentVariableOr } from './utils/env.ts';
 import type { AiChatBodyRequest, Chat } from './ai-assistant/types/assistant.ts';
 import type { SupportedLanguage } from './ai-assistant/types/languages.ts';
-import type { SimpleAiFunctionDefinition } from './ai-assistant/types/function-definition.ts';
+import type {
+  AllContractsAIFunctionDefinitions,
+  SimpleAiFunctionDefinition,
+} from './ai-assistant/types/function-definition.ts';
 
-const getFunctionsContext = <TLanguage extends SupportedLanguage = SupportedLanguage>(language: TLanguage) => {
-  const functionPerLanguages: Record<SupportedLanguage, Record<string, SimpleAiFunctionDefinition>> = {
+const getFunctionsContext = <TLanguage extends SupportedLanguage = SupportedLanguage>(
+  language: TLanguage,
+): SimpleAiFunctionDefinition[] => {
+  const functionPerLanguages: AllContractsAIFunctionDefinitions = {
     solidity: solidityFunctions,
   };
 

packages/ui/api/services/dev-mocks/redis.ts

@@ -1,5 +1,5 @@
 // deno-lint-ignore-file require-await
-import type { Redis } from 'https://esm.sh/@upstash/redis@1.25.1';
+import type { Redis } from '@upstash/redis';
 
 export default class RedisMock implements Pick<Redis, 'exists' | 'hset'> {
   private store: Record<

packages/ui/api/services/open-ai.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'https://esm.sh/openai@4.11.0';
+import OpenAI from 'openai';
 import { getEnvironmentVariablesOrFail } from '../utils/env.ts';
 
 export const getOpenAiInstance = () => {