From d805ee3a52928563e6133356d413ec88911a3dfc Mon Sep 17 00:00:00 2001 From: Jordan Last Date: Thu, 9 Jan 2025 14:26:32 -0700 Subject: [PATCH] update the disclaimer, add sections on stable and experimental modes, get rid of extension installation --- .github/workflows/run_test.yml | 3 --- README.md | 18 ++++++++++++++---- the_azle_book/src/azle.md | 18 ++++++++++++++---- the_azle_book/src/caveats.md | 4 ---- 4 files changed, 28 insertions(+), 15 deletions(-) diff --git a/.github/workflows/run_test.yml b/.github/workflows/run_test.yml index 57dc01fe90..1ac49524da 100644 --- a/.github/workflows/run_test.yml +++ b/.github/workflows/run_test.yml @@ -115,9 +115,6 @@ jobs: if: matrix.azle_source == 'repo' working-directory: ${{ matrix.test.path }} - - run: npx azle install-dfx-extension - working-directory: ${{ matrix.test.path }} - - name: Start dfx with artificial delay 0 if: ${{ steps.set-conditions.outputs.is_feature_branch_pr == 'true' || steps.set-conditions.outputs.is_feature_branch_draft_pr == 'true' || steps.set-conditions.outputs.is_main_branch_push_from_feature_merge == 'true' }} working-directory: ${{ matrix.test.path }} diff --git a/README.md b/README.md index cfe598c418..b8237146bf 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,21 @@ TypeScript and JavaScript CDK for the [Internet Computer](https://internetcomput ## Disclaimer -Please remember that Azle is in beta and thus it may have unknown security vulnerabilities due to the following: +Azle stable mode is continuously subjected to [intense scrutiny and testing](https://github.com/demergent-labs/azle/actions), however it does not yet have multiple independent security reviews/audits. -- Azle is built with various software packages that have not yet reached maturity -- Azle does not yet have multiple independent security reviews/audits -- Azle does not yet have many live, successful, continuously operating applications deployed to ICP +## Stable Mode + +Azle runs in stable mode by default. + +This mode is intended for production use after Azle's 1.0 release. Its focus is on API and runtime stability, security, performance, TypeScript and JavaScript language support, the ICP APIs, and Candid remote procedure calls (RPC). There is minimal support for the Node.js standard library, npm ecosystem, and HTTP server functionality. + +## Experimental Mode + +Azle runs in experimental mode through explicitly enabling a flag in `dfx.json` or certain CLI commands. + +This mode is intended for developers who are willing to accept the risk of using an alpha or beta project. Its focus is on quickly enabling new features and functionality without requiring the time and other resources necessary to advance them to the stable mode. The Node.js standard libary, npm ecosystem, and HTTP server functionality are also major areas of focus. + +> NOTE: Keep clearly in mind that the experimental mode fundamentally changes the Azle Wasm binary. It is not guaranteed to be secure or stable in API changes or runtime behavior. If you enable the experimental mode, even if you only use APIs from the stable mode, you are accepting a higher risk of bugs, errors, crashes, security exploits, breaking API changes, etc. ## Get Started diff --git a/the_azle_book/src/azle.md b/the_azle_book/src/azle.md index 8c44783c7f..bb4b51d8ee 100644 --- a/the_azle_book/src/azle.md +++ b/the_azle_book/src/azle.md @@ -8,11 +8,21 @@ Azle is a [TypeScript](https://www.typescriptlang.org/) and [JavaScript](https:/ ## Disclaimer -Please remember that Azle is in beta and thus it may have unknown security vulnerabilities due to the following: +Azle stable mode is continuously subjected to [intense scrutiny and testing](https://github.com/demergent-labs/azle/actions), however it does not yet have multiple independent security reviews/audits. -- Azle is built with various software packages that have not yet reached maturity -- Azle does not yet have multiple independent security reviews/audits -- Azle does not yet have many live, successful, continuously operating applications deployed to ICP +## Stable Mode + +Azle runs in stable mode by default. + +This mode is intended for production use after Azle's 1.0 release. Its focus is on API and runtime stability, security, performance, TypeScript and JavaScript language support, the ICP APIs, and Candid remote procedure calls (RPC). There is minimal support for the Node.js standard library, npm ecosystem, and HTTP server functionality. + +## Experimental Mode + +Azle runs in experimental mode through explicitly enabling a flag in `dfx.json` or certain CLI commands. + +This mode is intended for developers who are willing to accept the risk of using an alpha or beta project. Its focus is on quickly enabling new features and functionality without requiring the time and other resources necessary to advance them to the stable mode. The Node.js standard libary, npm ecosystem, and HTTP server functionality are also major areas of focus. + +> NOTE: Keep clearly in mind that the experimental mode fundamentally changes the Azle Wasm binary. It is not guaranteed to be secure or stable in API changes or runtime behavior. If you enable the experimental mode, even if you only use APIs from the stable mode, you are accepting a higher risk of bugs, errors, crashes, security exploits, breaking API changes, etc. ## Demergent Labs diff --git a/the_azle_book/src/caveats.md b/the_azle_book/src/caveats.md index 1b9ce1bb42..c5bc2bdc39 100644 --- a/the_azle_book/src/caveats.md +++ b/the_azle_book/src/caveats.md @@ -1,9 +1,5 @@ # Caveats -## Unknown security vulnerabilities - -Azle is a beta project. See [the disclaimer](/azle.md#disclaimer) for more information. - ## npm packages Some npm packages will work and some will not work. It is our long-term goal to support as many npm packages as possible. There are various reasons why an npm package may not currently work, including the small Wasm binary limit of the IC and unimplemented web or Node.js APIs. Feel free to open issues if your npm package does not work in Azle.