Merge pull request #1907 from demergent-labs/candid_generation

Candid generation
demergent-labs · Jul 17, 2024 · 1efffe4 · 1efffe4
2 parents a787888 + 68479d2
commit 1efffe4
Show file tree

Hide file tree

Showing 150 changed files with 5,200 additions and 1,069 deletions.
diff --git a/src/compiler/compile_typescript_code.ts b/src/compiler/compile_typescript_code.ts
@@ -13,7 +13,7 @@ export async function compileTypeScriptToJavaScript(
     esmExternals: string[]
 ): Promise<Result<JavaScript, unknown>> {
     try {
-        const imports = `
+        const imports = /*TS*/ `
             import 'reflect-metadata';
 
             // Trying to make sure that all globalThis dependencies are defined
@@ -26,19 +26,26 @@ export async function compileTypeScriptToJavaScript(
             ethers.FetchRequest.registerGetUrl(ethersGetUrl);
 
             import { toDidString } from 'azle/src/lib/candid/did_file/to_did_string';
+            import { IDL } from 'azle';
             import { DidVisitor, getDefaultVisitorData } from 'azle/src/lib/candid/did_file/visitor';
             export { Principal } from '@dfinity/principal';
             export * from './${main}';
             import * as CanisterMethods from './${main}';
 
             if (isClassSyntaxExport(CanisterMethods)) {
                 const canister = new CanisterMethods.default();
+                const canisterIdlType = IDL.Service(globalThis._azleCanisterMethodIdlTypes);
+                const candid = canisterIdlType.accept(new DidVisitor(), {
+                    ...getDefaultVisitorData(),
+                    isFirstService: true,
+                    systemFuncs: globalThis._azleInitAndPostUpgradeIdlTypes
+                });
 
                 globalThis._azleCanisterClassInstance = canister;
 
                 globalThis.candidInfoFunction = () => {
                     return JSON.stringify({
-                        candid: '',
+                        candid: toDidString(candid),
                         canisterMethods: globalThis._azleCanisterMethods
                     });
                 };

diff --git a/src/lib/globals.ts b/src/lib/globals.ts
@@ -7,6 +7,7 @@ import { v4 } from 'uuid';
 import { azleFetch } from './fetch';
 import { ic } from './ic';
 import { AzleIc } from './ic/types/azle_ic';
+import { IDL } from './stable';
 import { jsonReplacer } from './stable_structures/stable_json';
 
 type CanisterMethods = {
@@ -64,6 +65,10 @@ declare global {
     var _azleCanisterMethods: CanisterMethods;
     // eslint-disable-next-line no-var
     var _azleCanisterMethodsIndex: number;
+    // eslint-disable-next-line no-var
+    var _azleCanisterMethodIdlTypes: { [key: string]: IDL.FuncClass };
+    // eslint-disable-next-line no-var
+    var _azleInitAndPostUpgradeIdlTypes: IDL.FuncClass[];
 }
 
 globalThis._azleInsideCanister =
@@ -79,6 +84,10 @@ if (globalThis._azleInsideCanister) {
         callbacks: {}
     };
 
+    globalThis._azleCanisterMethodIdlTypes = {};
+
+    globalThis._azleInitAndPostUpgradeIdlTypes = [];
+
     globalThis._azleInitCalled = false;
     globalThis._azlePostUpgradeCalled = false;
 

diff --git a/src/lib/stable/globals.ts b/src/lib/stable/globals.ts
@@ -9,5 +9,9 @@ declare global {
 
 globalThis._azleCanisterMethodsIndex = 0;
 
+globalThis._azleCanisterMethodIdlTypes = {};
+
+globalThis._azleInitAndPostUpgradeIdlTypes = [];
+
 globalThis.TextDecoder = TextDecoder;
 globalThis.TextEncoder = TextEncoder;
diff --git a/src/lib/stable/init.ts b/src/lib/stable/init.ts
@@ -16,6 +16,10 @@ export function init<This, Args extends any[], Return>(
             index
         };
 
+        globalThis._azleInitAndPostUpgradeIdlTypes.push(
+            IDL.Func(paramIdlTypes, [], ['init'])
+        );
+
         globalThis._azleCanisterMethods.callbacks[index.toString()] = (
             ...args: any[]
         ): void => {

diff --git a/src/lib/stable/post_upgrade.ts b/src/lib/stable/post_upgrade.ts
@@ -16,6 +16,10 @@ export function postUpgrade<This, Args extends any[], Return>(
             index
         };
 
+        globalThis._azleInitAndPostUpgradeIdlTypes.push(
+            IDL.Func(paramIdlTypes, [], ['post_upgrade'])
+        );
+
         globalThis._azleCanisterMethods.callbacks[index.toString()] = (
             ...args: any[]
         ): void => {

diff --git a/src/lib/stable/query.ts b/src/lib/stable/query.ts
@@ -15,13 +15,21 @@ export function query<This, Args extends any[], Return>(
         context: ClassMethodDecoratorContext
     ): void => {
         const index = globalThis._azleCanisterMethodsIndex++;
+        const name = context.name as string;
+        const composite = options?.composite ?? false;
 
         globalThis._azleCanisterMethods.queries.push({
-            name: context.name as string,
+            name,
             index,
-            composite: options?.composite ?? false
+            composite
         });
 
+        globalThis._azleCanisterMethodIdlTypes[name] = IDL.Func(
+            paramIdlTypes,
+            returnIdlType === undefined ? [] : [returnIdlType],
+            ['query']
+        );
+
         globalThis._azleCanisterMethods.callbacks[index.toString()] = (
             ...args: any[]
         ): void => {

diff --git a/src/lib/stable/update.ts b/src/lib/stable/update.ts
@@ -14,11 +14,14 @@ export function update<This, Args extends any[], Return>(
         context: ClassMethodDecoratorContext
     ): void => {
         const index = globalThis._azleCanisterMethodsIndex++;
+        const name = context.name as string;
 
-        globalThis._azleCanisterMethods.updates.push({
-            name: context.name as string,
-            index
-        });
+        globalThis._azleCanisterMethods.updates.push({ name, index });
+
+        globalThis._azleCanisterMethodIdlTypes[name] = IDL.Func(
+            paramIdlTypes,
+            returnIdlType === undefined ? [] : [returnIdlType]
+        );
 
         globalThis._azleCanisterMethods.callbacks[index.toString()] = (
             ...args: any[]

diff --git a/tests/end_to_end/candid_rpc/class_syntax/async_await/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/async_await/dfx.json
@@ -3,8 +3,7 @@
         "async_await": {
             "type": "azle",
             "main": "src/async_await.ts",
-            "candid": "src/async_await.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/async_await",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/async_await/src/async_await.did b/tests/end_to_end/candid_rpc/class_syntax/async_await/src/async_await.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/audio_recorder/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/audio_recorder/dfx.json
@@ -3,8 +3,7 @@
         "audio_recorder": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/audio_recorder",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/audio_recorder/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/audio_recorder/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/bitcoin/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/bitcoin/dfx.json
@@ -3,8 +3,7 @@
         "bitcoin": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/bitcoin",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/bitcoin/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/bitcoin/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/blob_array/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/blob_array/dfx.json
@@ -3,8 +3,7 @@
         "blob_array": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/blob_array",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/blob_array/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/blob_array/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/bytes/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/bytes/dfx.json
@@ -3,8 +3,7 @@
         "bytes_canister": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/bytes_canister",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/bytes/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/bytes/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/call_raw/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/call_raw/dfx.json
@@ -3,8 +3,7 @@
         "call_raw": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/call_raw",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/call_raw/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/call_raw/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/candid_encoding/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/candid_encoding/dfx.json
@@ -3,8 +3,7 @@
         "candid_encoding": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/candid_encoding",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/candid_encoding/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/candid_encoding/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/candid_keywords/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/candid_keywords/dfx.json
@@ -3,8 +3,7 @@
         "candid_keywords": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/candid_keywords",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/candid_keywords/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/candid_keywords/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/canister/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/canister/dfx.json
@@ -3,8 +3,7 @@
         "canister": {
             "type": "azle",
             "main": "src/index.ts",
-            "candid": "src/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "env": ["SOME_CANISTER_PRINCIPAL"],
             "assets": [["src/some_canister.did", "candid/some_canister.did"]],
             "declarations": {
@@ -16,7 +15,7 @@
             "type": "azle",
             "main": "src/some_canister.ts",
             "candid": "src/some_canister.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/some_canister",
                 "node_compatibility": true

diff --git a/tests/end_to_end/candid_rpc/class_syntax/canister/src/index.did b/tests/end_to_end/candid_rpc/class_syntax/canister/src/index.did
diff --git a/tests/end_to_end/candid_rpc/class_syntax/complex_init/dfx.json b/tests/end_to_end/candid_rpc/class_syntax/complex_init/dfx.json
@@ -3,8 +3,7 @@
         "complex_init": {
             "type": "azle",
             "main": "src/complex_init/index.ts",
-            "candid": "src/complex_init/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/complex_init",
                 "node_compatibility": true
@@ -13,8 +12,7 @@
         "rec_init": {
             "type": "azle",
             "main": "src/rec_init/index.ts",
-            "candid": "src/rec_init/index.did",
-            "candid_gen": "custom",
+            "candid_gen": "automatic",
             "declarations": {
                 "output": "test/dfx_generated/rec_init",
                 "node_compatibility": true