add candidDecode, add raw option to call

demergent-labs · Jun 24, 2024 · 3a3fc78 · 3a3fc78
1 parent 59327a4
commit 3a3fc78
Show file tree

Hide file tree

Showing 17 changed files with 10,118 additions and 39 deletions.
diff --git a/examples/call_raw/package-lock.json b/examples/call_raw/package-lock.json
diff --git a/examples/call_raw/package.json b/examples/call_raw/package.json
@@ -1,4 +1,5 @@
 {
+    "name": "call_raw_end_to_end_test_functional_syntax",
     "scripts": {
         "pretest": "ts-node --transpile-only --ignore=false test/pretest.ts",
         "test": "jest"

diff --git a/examples/call_raw/src/index.ts b/examples/call_raw/src/index.ts
@@ -3,17 +3,15 @@ import {
     ic,
     nat,
     nat64,
-    Ok,
     Principal,
-    Result,
     text,
     update
 } from 'azle/experimental';
 
 export default Canister({
     executeCallRaw: update(
         [Principal, text, text, nat64],
-        Result(text, text),
+        text,
         async (canisterId, method, candidArgs, payment) => {
             const result = await ic.callRaw(
                 canisterId,
@@ -22,12 +20,12 @@ export default Canister({
                 payment
             );
 
-            return Ok(ic.candidDecode(result));
+            return ic.candidDecode(result);
         }
     ),
     executeCallRaw128: update(
         [Principal, text, text, nat],
-        Result(text, text),
+        text,
         async (canisterId, method, candidArgs, payment) => {
             const result = await ic.callRaw128(
                 canisterId,
@@ -36,7 +34,7 @@ export default Canister({
                 payment
             );
 
-            return Ok(ic.candidDecode(result));
+            return ic.candidDecode(result);
         }
     )
 });
diff --git a/examples/call_raw/test/tests.ts b/examples/call_raw/test/tests.ts
@@ -15,12 +15,7 @@ export function getTests(call_raw_canister: ActorSubclass<_SERVICE>): Test {
                 0n
             );
 
-            if ('Err' in result) {
-                throw new Error(result.Err);
-            }
-
-            expect(result).toHaveProperty('Ok');
-            expect(result.Ok).toMatch('blob');
+            expect(result).toMatch('blob');
         });
 
         it('calls create_canister via execute_call_raw', async () => {
@@ -30,13 +25,8 @@ export function getTests(call_raw_canister: ActorSubclass<_SERVICE>): Test {
                 '(record { settings = null })',
                 100_000_000_000n
             );
-
-            if ('Err' in result) {
-                throw new Error(result.Err);
-            }
-
-            expect(result.Ok).toMatch('record');
-            expect(result.Ok).toMatch('principal');
+            expect(result).toMatch('record');
+            expect(result).toMatch('principal');
         });
 
         it('calls raw_rand via execute_call_raw128', async () => {
@@ -47,11 +37,7 @@ export function getTests(call_raw_canister: ActorSubclass<_SERVICE>): Test {
                 0n
             );
 
-            if ('Err' in result) {
-                throw new Error(result.Err);
-            }
-
-            expect(result.Ok).toMatch('blob');
+            expect(result).toMatch('blob');
         });
 
         it('calls create_canister via execute_call_raw128', async () => {
@@ -62,12 +48,8 @@ export function getTests(call_raw_canister: ActorSubclass<_SERVICE>): Test {
                 100_000_000_000n
             );
 
-            if ('Err' in result) {
-                throw new Error(result.Err);
-            }
-
-            expect(result.Ok).toMatch('record');
-            expect(result.Ok).toMatch('principal');
+            expect(result).toMatch('record');
+            expect(result).toMatch('principal');
         });
     };
 }
diff --git a/src/lib/stable/ic_apis/call.ts b/src/lib/stable/ic_apis/call.ts
@@ -2,16 +2,17 @@ import { v4 } from 'uuid'; // TODO is uuid experimental?
 
 import { IDL, Principal } from '../';
 
-export async function call<T>(
+export async function call(
     canisterId: Principal | string,
     method: string,
     options?: {
         paramIdls?: IDL.Type[];
         returnIdl?: IDL.Type;
         args?: any[];
         payment?: bigint;
+        raw?: Uint8Array;
     }
-): Promise<T> {
+): Promise<any> {
     // TODO this should use a Result remember
     return new Promise((resolve, reject) => {
         if (globalThis._azleIc === undefined) {
@@ -23,15 +24,18 @@ export async function call<T>(
         const globalRejectId = `_reject_${promiseId}`;
 
         const returnIdl = options?.returnIdl;
+        const raw = options?.raw;
 
         // TODO perhaps we should be more robust
         // TODO for example, we can keep the time with these
         // TODO if they are over a certain amount old we can delete them
         globalThis._azleResolveIds[globalResolveId] = (result: ArrayBuffer) => {
-            if (returnIdl === undefined) {
-                resolve(undefined as T);
+            if (raw !== undefined) {
+                resolve(new Uint8Array(result));
+            } else if (returnIdl === undefined) {
+                resolve(undefined);
             } else {
-                resolve(IDL.decode([returnIdl], result)[0] as T);
+                resolve(IDL.decode([returnIdl], result)[0]);
             }
 
             delete globalThis._azleResolveIds[globalResolveId];
@@ -54,13 +58,15 @@ export async function call<T>(
                 ? Principal.fromText(canisterId)
                 : canisterId;
         const canisterIdBytes = canisterIdPrincipal.toUint8Array().buffer;
-        const argsRawBuffer = new Uint8Array(IDL.encode(paramIdls, args))
-            .buffer;
+        const argsRawBuffer =
+            raw === undefined
+                ? new Uint8Array(IDL.encode(paramIdls, args)).buffer
+                : raw.buffer;
         const paymentString = payment.toString();
 
         // TODO consider finally, what if deletion goes wrong
         try {
-            globalThis._azleIc.callRaw(
+            globalThis._azleIc.callRaw128(
                 promiseId,
                 canisterIdBytes,
                 method,

diff --git a/src/lib/stable/ic_apis/candid_decode.ts b/src/lib/stable/ic_apis/candid_decode.ts
@@ -0,0 +1,12 @@
+/**
+ * Converts a candid value into a Candid string
+ * @param candidEncoded a raw Candid value
+ * @returns the Candid string
+ */
+export function candidDecode(candidEncoded: Uint8Array): string {
+    if (globalThis._azleIc === undefined) {
+        return undefined as any;
+    }
+
+    return globalThis._azleIc.candidDecode(candidEncoded.buffer);
+}
diff --git a/src/lib/stable/ic_apis/index.ts b/src/lib/stable/ic_apis/index.ts
@@ -1,4 +1,5 @@
 export { call } from './call';
+export { candidDecode } from './candid_decode';
 export { candidEncode } from './candid_encode';
 export { id } from './id';
 export { notify } from './notify';

diff --git a/tests/end_to_end/candid_rpc/class_syntax/call_raw/.gitignore b/tests/end_to_end/candid_rpc/class_syntax/call_raw/.gitignore
@@ -0,0 +1,4 @@
+.azle
+.dfx
+dfx_generated
+node_modules
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
@@ -0,0 +1,14 @@
+{
+    "canisters": {
+        "call_raw": {
+            "type": "azle",
+            "main": "src/index.ts",
+            "candid": "src/index.did",
+            "candid_gen": "custom",
+            "declarations": {
+                "output": "test/dfx_generated/call_raw",
+                "node_compatibility": true
+            }
+        }
+    }
+}
diff --git a/tests/end_to_end/candid_rpc/class_syntax/call_raw/jest.config.js b/tests/end_to_end/candid_rpc/class_syntax/call_raw/jest.config.js
@@ -0,0 +1,10 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.ts$': 'ts-jest',
+        '^.+\\.js$': 'ts-jest'
+    },
+    transformIgnorePatterns: ['/node_modules/(?!(azle)/)'] // Make sure azle is transformed
+};