Merge pull request #1991 from demergent-labs/experimental_flag

Experimental flag: azle/experimental and Node APIs
demergent-labs · Aug 19, 2024 · 2e337a7 · 2e337a7
2 parents a5ab26e + 859279e
commit 2e337a7
Show file tree

Hide file tree

Showing 406 changed files with 1,895 additions and 482 deletions.
diff --git a/benchmark/index.ts b/benchmark/index.ts
@@ -1,7 +1,7 @@
 import { execSync } from 'child_process';
 import { writeFileSync } from 'fs';
 
-import { nat64 } from '../src/lib';
+import { nat64 } from '../src/lib/experimental';
 import { create_csv_report } from './csv';
 import { create_markdown_report } from './markdown';
 import { run_setup } from './setup';

diff --git a/canisters/ledger/address/index.ts b/canisters/ledger/address/index.ts
@@ -1,7 +1,7 @@
 import { getCrc32 } from '@dfinity/principal/lib/esm/utils/getCrc';
 import { sha224 } from 'js-sha256';
 
-import { blob, Principal } from '../../../src/lib';
+import { blob, Principal } from '../../../src/lib/experimental';
 import { Address } from '../index';
 
 // TODO we need to review these heavily

diff --git a/examples/basic_bitcoin/dfx.json b/examples/basic_bitcoin/dfx.json
@@ -3,7 +3,10 @@
         "basic_bitcoin": {
             "type": "azle",
             "main": "src/index.ts",
-            "env": ["BITCOIN_NETWORK"]
+            "env": ["BITCOIN_NETWORK"],
+            "custom": {
+                "experimental": true
+            }
         }
     },
     "networks": {

diff --git a/examples/basic_bitcoin/test/tests.ts b/examples/basic_bitcoin/test/tests.ts
@@ -1,3 +1,5 @@
+import 'azle/test/set_experimental';
+
 import { beforeAll } from '@jest/globals';
 import { jsonParse, jsonStringify } from 'azle/experimental';
 import { GetUtxosResult, Utxo } from 'azle/experimental/canisters/management';

diff --git a/examples/bitcoin_psbt/dfx.json b/examples/bitcoin_psbt/dfx.json
@@ -3,7 +3,10 @@
         "bitcoin_psbt": {
             "type": "azle",
             "main": "src/index.ts",
-            "env": ["BITCOIN_NETWORK"]
+            "env": ["BITCOIN_NETWORK"],
+            "custom": {
+                "experimental": true
+            }
         }
     },
     "networks": {

diff --git a/examples/hello_world/dfx.json b/examples/hello_world/dfx.json
@@ -4,7 +4,10 @@
             "type": "azle",
             "main": "src/backend/index.ts",
             "assets": [["src/frontend/dist", "dist"]],
-            "build_assets": "npm run build"
+            "build_assets": "npm run build",
+            "custom": {
+                "experimental": true
+            }
         }
     }
 }
diff --git a/experimental/canisters/icrc/errors.ts b/experimental/canisters/icrc/errors.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import { nat, Record, text } from '../../';
 
 export const BadFee = Record({

diff --git a/experimental/canisters/icrc/icrc_1.ts b/experimental/canisters/icrc/icrc_1.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import {
     blob,
     int,

diff --git a/experimental/canisters/icrc/icrc_2.ts b/experimental/canisters/icrc/icrc_2.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import { blob, nat, nat64, Null, Opt, Record, Variant } from '../../';
 import {
     BadBurn,

diff --git a/experimental/canisters/icrc/index.ts b/experimental/canisters/icrc/index.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import {
     Canister,
     nat,

diff --git a/experimental/canisters/ledger/address/index.ts b/experimental/canisters/ledger/address/index.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import { getCrc32 } from '@dfinity/principal/lib/esm/utils/getCrc';
 import { sha224 } from 'js-sha256';
 

diff --git a/experimental/canisters/ledger/index.ts b/experimental/canisters/ledger/index.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 // Some JS docs licensed under:
 //
 // - https://github.com/dfinity/cdk-rs/blob/main/LICENSE

diff --git a/experimental/canisters/management/bitcoin.ts b/experimental/canisters/management/bitcoin.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 // TODO I am thinking we should use the same names as ic-btc-types
 
 import {

diff --git a/experimental/canisters/management/canister_info.ts b/experimental/canisters/management/canister_info.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 // JS docs licensed under:
 //
 // - https://github.com/dfinity/cdk-rs/blob/main/LICENSE

diff --git a/experimental/canisters/management/canister_management.ts b/experimental/canisters/management/canister_management.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import {
     blob,
     nat,

diff --git a/experimental/canisters/management/http_request.ts b/experimental/canisters/management/http_request.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import {
     blob,
     Func,

diff --git a/experimental/canisters/management/index.ts b/experimental/canisters/management/index.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 // Some JS docs licensed under:
 //
 // - https://github.com/dfinity/cdk-rs/blob/main/LICENSE

diff --git a/experimental/canisters/management/t_ecdsa.ts b/experimental/canisters/management/t_ecdsa.ts
@@ -1,3 +1,9 @@
+import { experimentalMessage } from '../../../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
 import { blob, Null, Opt, Principal, Record, text, Variant, Vec } from '../../';
 
 export const EcdsaCurve = Variant({

diff --git a/experimental/index.ts b/experimental/index.ts
@@ -1 +1,7 @@
-export * from '../src/lib';
+import { experimentalMessage } from '../src/lib/experimental/experimental';
+
+if (globalThis._azleExperimental !== true) {
+    throw new Error(experimentalMessage('azle/experimental'));
+}
+
+export * from '../src/lib/experimental';
diff --git a/property_tests/arbitraries/candid/candid_definition_arb/types.ts b/property_tests/arbitraries/candid/candid_definition_arb/types.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType as RuntimeCandidType } from '../../../../src/lib/candid/candid_type';
+import { CandidType as RuntimeCandidType } from '../../../../src/lib/experimental/candid/candid_type';
 import { CandidType } from '../candid_type';
 import { RecursiveShapes } from '../recursive';
 import { ServiceMethodDefinition } from '../reference/service_arb/service_method_arb';

diff --git a/property_tests/arbitraries/candid/candid_value_and_meta_arb.ts b/property_tests/arbitraries/candid/candid_value_and_meta_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType as RuntimeCandidType } from '../../../src/lib';
+import { CandidType as RuntimeCandidType } from '../../../src/lib/experimental';
 import { CandidValueConstraints } from './candid_values_arb';
 import { BlobArb } from './constructed/blob_arb';
 import { OptArb } from './constructed/opt_arb';

diff --git a/property_tests/arbitraries/candid/constructed/blob_arb/definition_arb.ts b/property_tests/arbitraries/candid/constructed/blob_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { blob } from '../../../../../src/lib';
+import { blob } from '../../../../../src/lib/experimental';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {
     BlobCandidDefinition,

diff --git a/property_tests/arbitraries/candid/constructed/opt_arb/definition_arb.ts b/property_tests/arbitraries/candid/constructed/opt_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Opt } from '../../../../../src/lib';
+import { CandidType, Opt } from '../../../../../src/lib/experimental';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/constructed/record_arb/definition_arb.ts b/property_tests/arbitraries/candid/constructed/record_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Record } from '../../../../../src/lib';
+import { CandidType, Record } from '../../../../../src/lib/experimental';
 import { JsFunctionNameArb } from '../../../js_function_name_arb';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {

diff --git a/property_tests/arbitraries/candid/constructed/tuple_arb/definition_arb.ts b/property_tests/arbitraries/candid/constructed/tuple_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Tuple } from '../../../../../src/lib';
+import { CandidType, Tuple } from '../../../../../src/lib/experimental';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/constructed/variant_arb/definition_arbs.ts b/property_tests/arbitraries/candid/constructed/variant_arb/definition_arbs.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Variant } from '../../../../../src/lib';
+import { CandidType, Variant } from '../../../../../src/lib/experimental';
 import { JsFunctionNameArb } from '../../../js_function_name_arb';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {

diff --git a/property_tests/arbitraries/candid/constructed/vec_arb/definition_arb.ts b/property_tests/arbitraries/candid/constructed/vec_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Vec } from '../../../../../src/lib';
+import { CandidType, Vec } from '../../../../../src/lib/experimental';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/recursive/definition_arb.ts b/property_tests/arbitraries/candid/recursive/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Recursive } from '../../../../src/lib';
+import { CandidType, Recursive } from '../../../../src/lib/experimental';
 import { UniqueIdentifierArb } from '../../unique_identifier_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/reference/func_arb/definition_arb.ts b/property_tests/arbitraries/candid/reference/func_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { CandidType, Func } from '../../../../../src/lib';
+import { CandidType, Func } from '../../../../../src/lib/experimental';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/reference/service_arb/definition_arb.ts b/property_tests/arbitraries/candid/reference/service_arb/definition_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { Canister } from '../../../../../src/lib/candid/types/reference/service';
+import { Canister } from '../../../../../src/lib/experimental/candid/types/reference/service';
 import { UniqueIdentifierArb } from '../../../unique_identifier_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/reference/service_arb/service_method_arb.ts b/property_tests/arbitraries/candid/reference/service_arb/service_method_arb.ts
@@ -3,8 +3,8 @@ import fc from 'fast-check';
 import {
     query,
     update
-} from '../../../../../src/lib/canister_methods/methods/';
-import { CanisterMethodInfo } from '../../../../../src/lib/canister_methods/types/canister_method_info';
+} from '../../../../../src/lib/experimental/canister_methods/methods/';
+import { CanisterMethodInfo } from '../../../../../src/lib/experimental/canister_methods/types/canister_method_info';
 import { JsFunctionNameArb } from '../../../js_function_name_arb';
 import {
     CandidDefinition,

diff --git a/property_tests/arbitraries/candid/simple_type_arbs/candid_type_to_azle_candid_type.ts b/property_tests/arbitraries/candid/simple_type_arbs/candid_type_to_azle_candid_type.ts
@@ -18,7 +18,7 @@ import {
     Principal,
     text,
     Void
-} from '../../../../src/lib';
+} from '../../../../src/lib/experimental';
 import { SimpleCandidType } from '../candid_type';
 
 export function candidTypeToRuntimeCandidTypeObject(

diff --git a/property_tests/arbitraries/http/request_arb.ts b/property_tests/arbitraries/http/request_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { HttpRequest, None, Some } from '../../../src/lib';
+import { HttpRequest, None, Some } from '../../../src/lib/experimental';
 import { CandidValueAndMeta } from '../candid/candid_value_and_meta_arb';
 import { blobToSrcLiteral } from '../candid/to_src_literal/blob';
 import { stringToSrcLiteral } from '../candid/to_src_literal/string';

diff --git a/property_tests/arbitraries/http/response_arb.ts b/property_tests/arbitraries/http/response_arb.ts
@@ -1,6 +1,6 @@
 import fc from 'fast-check';
 
-import { HttpResponse, None } from '../../../src/lib';
+import { HttpResponse, None } from '../../../src/lib/experimental';
 import { CandidValueAndMeta } from '../candid/candid_value_and_meta_arb';
 import { CorrespondingJSType } from '../candid/corresponding_js_type';
 import { blobToSrcLiteral } from '../candid/to_src_literal/blob';

diff --git a/property_tests/index.ts b/property_tests/index.ts
@@ -1,3 +1,5 @@
+import './set_experimental';
+
 import { execSync } from 'child_process';
 // @ts-ignore
 import libraryDeepEqual from 'deep-is';

diff --git a/property_tests/set_experimental.ts b/property_tests/set_experimental.ts
@@ -0,0 +1 @@
+globalThis._azleExperimental = true;
diff --git a/property_tests/test/index.ts b/property_tests/test/index.ts
@@ -4,7 +4,7 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const deepEqual = require('deep-is');
 
-import { jsonStringify } from '../../src/lib/json';
+import { jsonStringify } from '../../src/lib/experimental/json';
 
 export type Test<> = {
     name: string;

diff --git a/property_tests/tests/blob/dfx.json b/property_tests/tests/blob/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }

diff --git a/property_tests/tests/bool/dfx.json b/property_tests/tests/bool/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }

diff --git a/property_tests/tests/canister_methods/http_request/dfx.json b/property_tests/tests/canister_methods/http_request/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }

diff --git a/property_tests/tests/canister_methods/http_request_update/dfx.json b/property_tests/tests/canister_methods/http_request_update/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }

diff --git a/property_tests/tests/canister_methods/init/dfx.json b/property_tests/tests/canister_methods/init/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }

diff --git a/property_tests/tests/canister_methods/inspect_message/dfx.json b/property_tests/tests/canister_methods/inspect_message/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }

diff --git a/property_tests/tests/canister_methods/post_upgrade/dfx.json b/property_tests/tests/canister_methods/post_upgrade/dfx.json
@@ -7,6 +7,9 @@
             "declarations": {
                 "output": "test/dfx_generated/canister",
                 "node_compatibility": true
+            },
+            "custom": {
+                "experimental": true
             }
         }
     }