Merge pull request #1134 from demergent-labs/final_documentation

Add canister version, is controller, instruction counter documentation
demergent-labs · Jul 28, 2023 · f2dd845 · f2dd845
2 parents 0e36d23 + 5424612
commit f2dd845
Show file tree

Hide file tree

Showing 167 changed files with 996 additions and 209 deletions.
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/azle.html b/docs/azle.html
diff --git a/docs/candid.html b/docs/candid.html
diff --git a/docs/canister_lifecycle.html b/docs/canister_lifecycle.html
diff --git a/docs/canisters_overview.html b/docs/canisters_overview.html
diff --git a/docs/caveats.html b/docs/caveats.html
diff --git a/docs/cross_canister.html b/docs/cross_canister.html
diff --git a/docs/cycles.html b/docs/cycles.html
diff --git a/docs/deployment.html b/docs/deployment.html
diff --git a/docs/examples.html b/docs/examples.html
diff --git a/docs/hello_world.html b/docs/hello_world.html
diff --git a/docs/http.html b/docs/http.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/installation.html b/docs/installation.html
diff --git a/docs/internet_computer_overview.html b/docs/internet_computer_overview.html
diff --git a/docs/management_canister.html b/docs/management_canister.html
diff --git a/docs/print.html b/docs/print.html
diff --git a/docs/query_methods.html b/docs/query_methods.html
diff --git a/docs/reference/bitcoin.html b/docs/reference/bitcoin.html
diff --git a/docs/reference/call_apis/accept_message.html b/docs/reference/call_apis/accept_message.html
diff --git a/docs/reference/call_apis/arg_data_raw.html b/docs/reference/call_apis/arg_data_raw.html
diff --git a/docs/reference/call_apis/arg_data_raw_size.html b/docs/reference/call_apis/arg_data_raw_size.html
diff --git a/docs/reference/call_apis/call.html b/docs/reference/call_apis/call.html
diff --git a/docs/reference/call_apis/call_apis.html b/docs/reference/call_apis/call_apis.html
diff --git a/docs/reference/call_apis/call_raw.html b/docs/reference/call_apis/call_raw.html
diff --git a/docs/reference/call_apis/call_raw128.html b/docs/reference/call_apis/call_raw128.html
diff --git a/docs/reference/call_apis/call_with_payment.html b/docs/reference/call_apis/call_with_payment.html
diff --git a/docs/reference/call_apis/call_with_payment128.html b/docs/reference/call_apis/call_with_payment128.html
diff --git a/docs/reference/call_apis/caller.html b/docs/reference/call_apis/caller.html
diff --git a/docs/reference/call_apis/method_name.html b/docs/reference/call_apis/method_name.html
diff --git a/docs/reference/call_apis/msg_cycles_accept.html b/docs/reference/call_apis/msg_cycles_accept.html
diff --git a/docs/reference/call_apis/msg_cycles_accept128.html b/docs/reference/call_apis/msg_cycles_accept128.html
diff --git a/docs/reference/call_apis/msg_cycles_available.html b/docs/reference/call_apis/msg_cycles_available.html
diff --git a/docs/reference/call_apis/msg_cycles_available128.html b/docs/reference/call_apis/msg_cycles_available128.html
diff --git a/docs/reference/call_apis/msg_cycles_refunded.html b/docs/reference/call_apis/msg_cycles_refunded.html
diff --git a/docs/reference/call_apis/msg_cycles_refunded128.html b/docs/reference/call_apis/msg_cycles_refunded128.html
diff --git a/docs/reference/call_apis/notify.html b/docs/reference/call_apis/notify.html
diff --git a/docs/reference/call_apis/notify_raw.html b/docs/reference/call_apis/notify_raw.html
diff --git a/docs/reference/call_apis/notify_with_payment_128.html b/docs/reference/call_apis/notify_with_payment_128.html
diff --git a/docs/reference/call_apis/reject.html b/docs/reference/call_apis/reject.html
diff --git a/docs/reference/call_apis/reject_code.html b/docs/reference/call_apis/reject_code.html
diff --git a/docs/reference/call_apis/reject_message.html b/docs/reference/call_apis/reject_message.html
diff --git a/docs/reference/call_apis/reply.html b/docs/reference/call_apis/reply.html
diff --git a/docs/reference/call_apis/reply_raw.html b/docs/reference/call_apis/reply_raw.html
diff --git a/docs/reference/candid/blob.html b/docs/reference/candid/blob.html
diff --git a/docs/reference/candid/bool.html b/docs/reference/candid/bool.html
diff --git a/docs/reference/candid/candid.html b/docs/reference/candid/candid.html
diff --git a/docs/reference/candid/empty.html b/docs/reference/candid/empty.html
diff --git a/docs/reference/candid/float32.html b/docs/reference/candid/float32.html
diff --git a/docs/reference/candid/float64.html b/docs/reference/candid/float64.html
diff --git a/docs/reference/candid/func.html b/docs/reference/candid/func.html
diff --git a/docs/reference/candid/int.html b/docs/reference/candid/int.html
diff --git a/docs/reference/candid/int16.html b/docs/reference/candid/int16.html
diff --git a/docs/reference/candid/int32.html b/docs/reference/candid/int32.html
diff --git a/docs/reference/candid/int64.html b/docs/reference/candid/int64.html
diff --git a/docs/reference/candid/int8.html b/docs/reference/candid/int8.html
diff --git a/docs/reference/candid/nat.html b/docs/reference/candid/nat.html
diff --git a/docs/reference/candid/nat16.html b/docs/reference/candid/nat16.html
diff --git a/docs/reference/candid/nat32.html b/docs/reference/candid/nat32.html
diff --git a/docs/reference/candid/nat64.html b/docs/reference/candid/nat64.html
diff --git a/docs/reference/candid/nat8.html b/docs/reference/candid/nat8.html
diff --git a/docs/reference/candid/null.html b/docs/reference/candid/null.html
diff --git a/docs/reference/candid/opt.html b/docs/reference/candid/opt.html
diff --git a/docs/reference/candid/principal.html b/docs/reference/candid/principal.html
diff --git a/docs/reference/candid/record.html b/docs/reference/candid/record.html
diff --git a/docs/reference/candid/reserved.html b/docs/reference/candid/reserved.html
diff --git a/docs/reference/candid/service.html b/docs/reference/candid/service.html
diff --git a/docs/reference/candid/text.html b/docs/reference/candid/text.html
diff --git a/docs/reference/candid/variant.html b/docs/reference/candid/variant.html
diff --git a/docs/reference/candid/vec.html b/docs/reference/candid/vec.html
diff --git a/docs/reference/canister_apis/candid_decode.html b/docs/reference/canister_apis/candid_decode.html
diff --git a/docs/reference/canister_apis/candid_encode.html b/docs/reference/canister_apis/candid_encode.html
diff --git a/docs/reference/canister_apis/canister_apis.html b/docs/reference/canister_apis/canister_apis.html
diff --git a/docs/reference/canister_apis/canister_balance.html b/docs/reference/canister_apis/canister_balance.html
diff --git a/docs/reference/canister_apis/canister_balance128.html b/docs/reference/canister_apis/canister_balance128.html
diff --git a/docs/reference/canister_apis/canister_id.html b/docs/reference/canister_apis/canister_id.html
diff --git a/docs/reference/canister_apis/canister_version.html b/docs/reference/canister_apis/canister_version.html
diff --git a/docs/reference/canister_apis/data_certificate.html b/docs/reference/canister_apis/data_certificate.html
diff --git a/docs/reference/canister_apis/instruction_counter.html b/docs/reference/canister_apis/instruction_counter.html
diff --git a/docs/reference/canister_apis/is_controller.html b/docs/reference/canister_apis/is_controller.html
diff --git a/...erence/call_apis/performance_counter.html → ...ce/canister_apis/performance_counter.html b/...erence/call_apis/performance_counter.html → ...ce/canister_apis/performance_counter.html
diff --git a/docs/reference/canister_apis/print.html b/docs/reference/canister_apis/print.html
diff --git a/docs/reference/canister_apis/set_certified_data.html b/docs/reference/canister_apis/set_certified_data.html
diff --git a/docs/reference/canister_apis/time.html b/docs/reference/canister_apis/time.html
diff --git a/docs/reference/canister_apis/trap.html b/docs/reference/canister_apis/trap.html
diff --git a/docs/reference/canister_methods/canister_methods.html b/docs/reference/canister_methods/canister_methods.html
diff --git a/docs/reference/canister_methods/heartbeat.html b/docs/reference/canister_methods/heartbeat.html
diff --git a/docs/reference/canister_methods/http_request.html b/docs/reference/canister_methods/http_request.html
diff --git a/docs/reference/canister_methods/http_request_update.html b/docs/reference/canister_methods/http_request_update.html
diff --git a/docs/reference/canister_methods/init.html b/docs/reference/canister_methods/init.html
diff --git a/docs/reference/canister_methods/inspect_message.html b/docs/reference/canister_methods/inspect_message.html
diff --git a/docs/reference/canister_methods/post_upgrade.html b/docs/reference/canister_methods/post_upgrade.html
diff --git a/docs/reference/canister_methods/pre_upgrade.html b/docs/reference/canister_methods/pre_upgrade.html
diff --git a/docs/reference/canister_methods/query.html b/docs/reference/canister_methods/query.html
diff --git a/docs/reference/canister_methods/update.html b/docs/reference/canister_methods/update.html
diff --git a/docs/reference/environment_variables.html b/docs/reference/environment_variables.html
diff --git a/docs/reference/management_canister/bitcoin_get_balance.html b/docs/reference/management_canister/bitcoin_get_balance.html
diff --git a/docs/reference/management_canister/bitcoin_get_current_fee_percentiles.html b/docs/reference/management_canister/bitcoin_get_current_fee_percentiles.html
diff --git a/docs/reference/management_canister/bitcoin_get_utxos.html b/docs/reference/management_canister/bitcoin_get_utxos.html
diff --git a/docs/reference/management_canister/bitcoin_send_transaction.html b/docs/reference/management_canister/bitcoin_send_transaction.html
diff --git a/docs/reference/management_canister/canister_status.html b/docs/reference/management_canister/canister_status.html
diff --git a/docs/reference/management_canister/create_canister.html b/docs/reference/management_canister/create_canister.html
diff --git a/docs/reference/management_canister/delete_canister.html b/docs/reference/management_canister/delete_canister.html
diff --git a/docs/reference/management_canister/deposit_cycles.html b/docs/reference/management_canister/deposit_cycles.html
diff --git a/docs/reference/management_canister/ecdsa_public_key.html b/docs/reference/management_canister/ecdsa_public_key.html
diff --git a/docs/reference/management_canister/http_request.html b/docs/reference/management_canister/http_request.html
diff --git a/docs/reference/management_canister/install_code.html b/docs/reference/management_canister/install_code.html
diff --git a/docs/reference/management_canister/management_canister.html b/docs/reference/management_canister/management_canister.html
diff --git a/docs/reference/management_canister/provisional_create_canister_with_cycles.html b/docs/reference/management_canister/provisional_create_canister_with_cycles.html
diff --git a/docs/reference/management_canister/provisional_top_up_canister.html b/docs/reference/management_canister/provisional_top_up_canister.html
diff --git a/docs/reference/management_canister/raw_rand.html b/docs/reference/management_canister/raw_rand.html
diff --git a/docs/reference/management_canister/sign_with_ecdsa.html b/docs/reference/management_canister/sign_with_ecdsa.html
diff --git a/docs/reference/management_canister/start_canister.html b/docs/reference/management_canister/start_canister.html
diff --git a/docs/reference/management_canister/stop_canister.html b/docs/reference/management_canister/stop_canister.html
diff --git a/docs/reference/management_canister/uninstall_code.html b/docs/reference/management_canister/uninstall_code.html
diff --git a/docs/reference/management_canister/update_settings.html b/docs/reference/management_canister/update_settings.html
diff --git a/docs/reference/plugins.html b/docs/reference/plugins.html
diff --git a/docs/reference/reference.html b/docs/reference/reference.html
diff --git a/docs/reference/stable_memory/stable64_grow.html b/docs/reference/stable_memory/stable64_grow.html
diff --git a/docs/reference/stable_memory/stable64_read.html b/docs/reference/stable_memory/stable64_read.html
diff --git a/docs/reference/stable_memory/stable64_size.html b/docs/reference/stable_memory/stable64_size.html
diff --git a/docs/reference/stable_memory/stable64_write.html b/docs/reference/stable_memory/stable64_write.html
diff --git a/docs/reference/stable_memory/stable_bytes.html b/docs/reference/stable_memory/stable_bytes.html
diff --git a/docs/reference/stable_memory/stable_grow.html b/docs/reference/stable_memory/stable_grow.html
diff --git a/docs/reference/stable_memory/stable_memory.html b/docs/reference/stable_memory/stable_memory.html
diff --git a/docs/reference/stable_memory/stable_read.html b/docs/reference/stable_memory/stable_read.html
diff --git a/docs/reference/stable_memory/stable_size.html b/docs/reference/stable_memory/stable_size.html
diff --git a/docs/reference/stable_memory/stable_structures.html b/docs/reference/stable_memory/stable_structures.html
diff --git a/docs/reference/stable_memory/stable_write.html b/docs/reference/stable_memory/stable_write.html
diff --git a/docs/reference/timers/clear_timer.html b/docs/reference/timers/clear_timer.html
diff --git a/docs/reference/timers/set_timer.html b/docs/reference/timers/set_timer.html
diff --git a/docs/reference/timers/set_timer_interval.html b/docs/reference/timers/set_timer_interval.html
diff --git a/docs/reference/timers/timers.html b/docs/reference/timers/timers.html
diff --git a/docs/reference/wasm_binary_optimization.html b/docs/reference/wasm_binary_optimization.html
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/searchindex.json b/docs/searchindex.json
diff --git a/docs/stable_structures.html b/docs/stable_structures.html
diff --git a/docs/the_azle_book.html b/docs/the_azle_book.html
diff --git a/docs/timers.html b/docs/timers.html
diff --git a/docs/update_methods.html b/docs/update_methods.html
diff --git a/examples/ic_api/src/ic_api.ts b/examples/ic_api/src/ic_api.ts
@@ -90,7 +90,7 @@ export function canisterBalance128(): nat {
 
 // returns the canister's version number
 $query;
-export function canisterVersion(): nat {
+export function canisterVersion(): nat64 {
     return ic.canisterVersion();
 }
 

diff --git a/the_azle_book/book/404.html b/the_azle_book/book/404.html
diff --git a/the_azle_book/book/azle.html b/the_azle_book/book/azle.html
diff --git a/the_azle_book/book/candid.html b/the_azle_book/book/candid.html
diff --git a/the_azle_book/book/canisters_overview.html b/the_azle_book/book/canisters_overview.html
diff --git a/the_azle_book/book/cross_canister.html b/the_azle_book/book/cross_canister.html
diff --git a/the_azle_book/book/cycles.html b/the_azle_book/book/cycles.html
diff --git a/the_azle_book/book/deployment.html b/the_azle_book/book/deployment.html
diff --git a/the_azle_book/book/examples.html b/the_azle_book/book/examples.html
diff --git a/the_azle_book/book/http.html b/the_azle_book/book/http.html
diff --git a/the_azle_book/book/index.html b/the_azle_book/book/index.html
diff --git a/the_azle_book/book/installation.html b/the_azle_book/book/installation.html
diff --git a/the_azle_book/book/internet_computer_overview.html b/the_azle_book/book/internet_computer_overview.html
diff --git a/the_azle_book/book/print.html b/the_azle_book/book/print.html
diff --git a/the_azle_book/book/searchindex.js b/the_azle_book/book/searchindex.js
diff --git a/the_azle_book/book/searchindex.json b/the_azle_book/book/searchindex.json
diff --git a/the_azle_book/book/timers.html b/the_azle_book/book/timers.html
diff --git a/the_azle_book/src/SUMMARY.md b/the_azle_book/src/SUMMARY.md
@@ -41,7 +41,6 @@
         -   [notify](./reference/call_apis/notify.md)
         -   [notify raw](./reference/call_apis/notify_raw.md)
         -   [notify with payment 128](./reference/call_apis/notify_with_payment_128.md)
-        -   [performance counter](./reference/call_apis/performance_counter.md)
         -   [reject](./reference/call_apis/reject.md)
         -   [reject code](./reference/call_apis/reject_code.md)
         -   [reject message](./reference/call_apis/reject_message.md)
@@ -78,8 +77,12 @@
         -   [candid encode](./reference/canister_apis/candid_encode.md)
         -   [canister balance](./reference/canister_apis/canister_balance.md)
         -   [canister balance 128](./reference/canister_apis/canister_balance128.md)
+        -   [canister version](./reference/canister_apis/canister_version.md)
         -   [canister id](./reference/canister_apis/canister_id.md)
         -   [data certificate](./reference/canister_apis/data_certificate.md)
+        -   [instruction counter](./reference/canister_apis/instruction_counter.md)
+        -   [is controller](./reference/canister_apis/is_controller.md)
+        -   [performance counter](./reference/canister_apis/performance_counter.md)
         -   [print](./reference/canister_apis/print.md)
         -   [set certified data](./reference/canister_apis/set_certified_data.md)
         -   [time](./reference/canister_apis/time.md)

diff --git a/the_azle_book/src/http.md b/the_azle_book/src/http.md
@@ -80,7 +80,6 @@ Examples:
 
 ```typescript
 import {
-    Alias,
     ic,
     $init,
     match,
@@ -98,7 +97,7 @@ import {
 import decodeUtf8 from 'decode-utf8';
 import encodeUtf8 from 'encode-utf8';
 
-type JSON = Alias<string>;
+type JSON = string;
 
 let stableStorage = new StableBTreeMap<string, string>(0, 25, 1_000);
 

diff --git a/the_azle_book/src/reference/call_apis/call_apis.md b/the_azle_book/src/reference/call_apis/call_apis.md
@@ -19,7 +19,6 @@
 -   [notify](./notify.md)
 -   [notify raw](./notify_raw.md)
 -   [notify with payment 128](./notify_with_payment_128.md)
--   [performance counter](./performance_counter.md)
 -   [reject](./reject.md)
 -   [reject code](./reject_code.md)
 -   [reject message](./reject_message.md)

diff --git a/the_azle_book/src/reference/canister_apis/canister_apis.md b/the_azle_book/src/reference/canister_apis/canister_apis.md
@@ -4,8 +4,12 @@
 -   [candid encode](./candid_encode.md)
 -   [canister balance](./canister_balance.md)
 -   [canister balance 128](./canister_balance128.md)
+-   [canister version](./canister_version.md)
 -   [canister id](./canister_id.md)
 -   [data certificate](./data_certificate.md)
+-   [instruction counter](./instruction_counter.md)
+-   [is controller](./is_controller.md)
+-   [performance counter](./performance_counter.md)
 -   [print](./print.md)
 -   [set certified data](./set_certified_data.md)
 -   [time](./time.md)

diff --git a/the_azle_book/src/reference/canister_apis/canister_version.md b/the_azle_book/src/reference/canister_apis/canister_version.md
@@ -0,0 +1,17 @@
+# canister version
+
+This section is a work in progress.
+
+Examples:
+
+-   [ic_api](https://github.com/demergent-labs/azle/tree/main/examples/ic_api)
+
+```typescript
+import { ic, nat64, $query } from 'azle';
+
+// returns the canister's version number
+$query;
+export function canisterVersion(): nat64 {
+    return ic.canisterVersion();
+}
+```
diff --git a/the_azle_book/src/reference/canister_apis/instruction_counter.md b/the_azle_book/src/reference/canister_apis/instruction_counter.md
@@ -0,0 +1,18 @@
+# instruction counter
+
+This section is a work in progress.
+
+Examples:
+
+-   [ic_api](https://github.com/demergent-labs/azle/tree/main/examples/ic_api)
+
+```typescript
+import { ic, nat64, $query } from 'azle';
+
+// Returns the number of instructions that the canister executed since the last
+// entry point.
+$query;
+export function instructionCounter(): nat64 {
+    return ic.instructionCounter();
+}
+```
diff --git a/the_azle_book/src/reference/canister_apis/is_controller.md b/the_azle_book/src/reference/canister_apis/is_controller.md
@@ -0,0 +1,17 @@
+# is controller
+
+This section is a work in progress.
+
+Examples:
+
+-   [ic_api](https://github.com/demergent-labs/azle/tree/main/examples/ic_api)
+
+```typescript
+import { ic, Principal, $query } from 'azle';
+
+// determines whether the given principal is a controller of the canister
+$query;
+export function isController(principal: Principal): boolean {
+    return ic.isController(principal);
+}
+```
diff --git a/...eference/call_apis/performance_counter.md → ...ence/canister_apis/performance_counter.md b/...eference/call_apis/performance_counter.md → ...ence/canister_apis/performance_counter.md
diff --git a/the_azle_book/src/reference/stable_memory/stable_structures.md b/the_azle_book/src/reference/stable_memory/stable_structures.md
@@ -15,7 +15,6 @@ Examples:
 
 ```typescript
 import {
-    Alias,
     nat64,
     nat8,
     Opt,
@@ -26,8 +25,8 @@ import {
     Vec
 } from 'azle';
 
-type Key = Alias<nat8>;
-type Value = Alias<string>;
+type Key = nat8;
+type Value = string;
 
 let map = new StableBTreeMap<Key, Value>(0, 100, 1_000);
 

diff --git a/the_azle_book/src/stable_structures.md b/the_azle_book/src/stable_structures.md
@@ -36,7 +36,6 @@ Here's an example showing all of the basic `StableBTreeMap` operations:
 
 ```typescript
 import {
-    Alias,
     nat64,
     nat8,
     Opt,
@@ -47,8 +46,8 @@ import {
     Vec
 } from 'azle';
 
-type Key = Alias<nat8>;
-type Value = Alias<string>;
+type Key = nat8;
+type Value = string;
 
 let map = new StableBTreeMap<Key, Value>(0, 100, 1_000);