1. 1. The Azle Book (Beta)
  2. 2. Get Started
  3. 3. Examples
  4. 4. Deployment
  5. 5. Server
  6. 6. Assets
  7. 7. Debugging
  8. 8. Limitations
  9. 9. Authentication
  10. 10. Databases
  11. 11. fetch
  12. 12. npm
  13. 13. Cycles
  14. 14. Tokens
  15. 15. Bitcoin
  16. 16. Ethereum
  17. 17. Reference
    1. 17.1. Autoreload
  18. 18. Old Candid-based Documentation
    1. 18.1. Azle (Beta)
    2. 18.2. Internet Computer Overview
    3. 18.3. Canisters Overview
    4. 18.4. Installation
    5. 18.5. Hello World
    6. 18.6. Deployment
    7. 18.7. Examples
    8. 18.8. Query Methods
    9. 18.9. Update Methods
    10. 18.10. Candid
    11. 18.11. Stable Structures
    12. 18.12. Cross-canister
    13. 18.13. HTTP
    14. 18.14. Management Canister
    15. 18.15. Canister Lifecycle
    16. 18.16. Timers
    17. 18.17. Cycles
    18. 18.18. Caveats
    19. 18.19. Reference
      1. 18.19.1. Bitcoin
      2. 18.19.2. Call APIs
        1. 18.19.2.1. accept message
        2. 18.19.2.2. arg data raw
        3. 18.19.2.3. arg data raw size
        4. 18.19.2.4. call
        5. 18.19.2.5. call raw
        6. 18.19.2.6. call raw 128
        7. 18.19.2.7. call with payment
        8. 18.19.2.8. call with payment 128
        9. 18.19.2.9. caller
        10. 18.19.2.10. method name
        11. 18.19.2.11. msg cycles accept
        12. 18.19.2.12. msg cycles accept 128
        13. 18.19.2.13. msg cycles available
        14. 18.19.2.14. msg cycles available 128
        15. 18.19.2.15. msg cycles refunded
        16. 18.19.2.16. msg cycles refunded 128
        17. 18.19.2.17. notify
        18. 18.19.2.18. notify raw
        19. 18.19.2.19. notify with payment 128
        20. 18.19.2.20. reject
        21. 18.19.2.21. reject code
        22. 18.19.2.22. reject message
        23. 18.19.2.23. reply
        24. 18.19.2.24. reply raw
      3. 18.19.3. Candid
        1. 18.19.3.1. blob
        2. 18.19.3.2. bool
        3. 18.19.3.3. empty
        4. 18.19.3.4. float32
        5. 18.19.3.5. float64
        6. 18.19.3.6. func
        7. 18.19.3.7. int
        8. 18.19.3.8. int8
        9. 18.19.3.9. int16
        10. 18.19.3.10. int32
        11. 18.19.3.11. int64
        12. 18.19.3.12. nat
        13. 18.19.3.13. nat8
        14. 18.19.3.14. nat16
        15. 18.19.3.15. nat32
        16. 18.19.3.16. nat64
        17. 18.19.3.17. null
        18. 18.19.3.18. opt
        19. 18.19.3.19. principal
        20. 18.19.3.20. record
        21. 18.19.3.21. reserved
        22. 18.19.3.22. service
        23. 18.19.3.23. text
        24. 18.19.3.24. variant
        25. 18.19.3.25. vec
      4. 18.19.4. Canister APIs
        1. 18.19.4.1. candid decode
        2. 18.19.4.2. candid encode
        3. 18.19.4.3. canister balance
        4. 18.19.4.4. canister balance 128
        5. 18.19.4.5. canister version
        6. 18.19.4.6. canister id
        7. 18.19.4.7. data certificate
        8. 18.19.4.8. instruction counter
        9. 18.19.4.9. is controller
        10. 18.19.4.10. performance counter
        11. 18.19.4.11. print
        12. 18.19.4.12. set certified data
        13. 18.19.4.13. time
        14. 18.19.4.14. trap
      5. 18.19.5. Canister Methods
        1. 18.19.5.1. heartbeat
        2. 18.19.5.2. http_request
        3. 18.19.5.3. http_request_update
        4. 18.19.5.4. init
        5. 18.19.5.5. inspect message
        6. 18.19.5.6. post upgrade
        7. 18.19.5.7. pre upgrade
        8. 18.19.5.8. query
        9. 18.19.5.9. update
      6. 18.19.6. Environment Variables
      7. 18.19.7. Management Canister
        1. 18.19.7.1. bitcoin_get_balance
        2. 18.19.7.2. bitcoin_get_current_fee_percentiles
        3. 18.19.7.3. bitcoin_get_utxos
        4. 18.19.7.4. bitcoin_send_transaction
        5. 18.19.7.5. canister_status
        6. 18.19.7.6. create_canister
        7. 18.19.7.7. delete_canister
        8. 18.19.7.8. deposit_cycles
        9. 18.19.7.9. ecdsa_public_key
        10. 18.19.7.10. http_request
        11. 18.19.7.11. install_code
        12. 18.19.7.12. provisional_create_canister_with_cycles
        13. 18.19.7.13. provisional_top_up_canister
        14. 18.19.7.14. raw_rand
        15. 18.19.7.15. sign_with_ecdsa
        16. 18.19.7.16. start_canister
        17. 18.19.7.17. stop_canister
        18. 18.19.7.18. uninstall_code
        19. 18.19.7.19. update_settings
      8. 18.19.8. Plugins
      9. 18.19.9. Stable Memory
        1. 18.19.9.1. stable structures
        2. 18.19.9.2. stable bytes
        3. 18.19.9.3. stable grow
        4. 18.19.9.4. stable read
        5. 18.19.9.5. stable size
        6. 18.19.9.6. stable write
        7. 18.19.9.7. stable64 grow
        8. 18.19.9.8. stable64 read
        9. 18.19.9.9. stable64 size
        10. 18.19.9.10. stable64 write
      10. 18.19.10. Timers
        1. 18.19.10.1. clear timer
        2. 18.19.10.2. set timer
        3. 18.19.10.3. set timer interval
      11. 18.19.11. Wasm Binary Optimization

The Azle Book

Examples

Azle has many example projects showing nearly all Azle APIs. They can be found in the examples directory of the Azle GitHub repository.

We'll highlight a few of them and some others here:

  • Query
  • Update
  • Primitive Types
  • Stable Structures
  • Cycles
  • Cross Canister Calls
  • Management Canister
  • Outgoing HTTP Requests
  • Incoming HTTP Requests
  • Pre and Post Upgrade
  • Timers
  • Multisig Vault
  • ICRC-1
  • IC Chainlink Data Feeds
  • Bitcoin
  • ckBTC