From 87bfac4ae33ded774ffaf96416dead5dbe4384e9 Mon Sep 17 00:00:00 2001 From: Mirella de Medeiros Date: Wed, 19 Jun 2024 19:28:46 -0300 Subject: [PATCH] #86dtu8zqj - Remove boa feature from Getting started documentation --- docs/source/getting-started.md | 26 ++------------------------ 1 file changed, 2 insertions(+), 24 deletions(-) diff --git a/docs/source/getting-started.md b/docs/source/getting-started.md index 68f80289..9706332b 100644 --- a/docs/source/getting-started.md +++ b/docs/source/getting-started.md @@ -11,30 +11,6 @@ there are some key differences that you should be aware of, here's the 4 most pr - if you want to call other smart contracts, you can only call public functions; - to interact with the Neo blockchain, you need to use a function, variable, or class inside the `boa3.builtin` package. -### Overview of Neo3-Boa features - -| Packages | Contains: | Important features | -|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [boa3.builtin](auto-package/boa3/builtin/boa3-builtins) | all packages below, it also contains an env variable that lets you change the value of a variable when compiling the smart contract. | {data}`env ` | -| [boa3.builtin.compile_time](auto-package/boa3/builtin/compile-time/boa3-builtin-compile-time) | methods and classes that are needed when you are compiling your smart contract, as opposed to when it's being executed on the blockchain. | {func}`public `, {func}`metadata `, {func}`contract `, {func}`CreateNewEvent `, {class}`NeoMetadata ` | -| [boa3.builtin.contract](auto-package/boa3/builtin/contract/boa3-builtin-contract) | events and methods that might help when writing something specific about Neo blockchain | {func}`abort `, {data}`Nep17TransferEvent `, {data}`Nep11TransferEvent ` | -| [boa3.builtin.interop](auto-package/boa3/builtin/interop/boa3-builtin-interop) | other packages that have a lot of helpful interoperable services. Has some overlap with the native contracts. | {mod}`storage `, {mod}`runtime `, {mod}`contract `, {mod}`blockchain ` | -| [boa3.builtin.interop.blockchain](auto-package/boa3/builtin/interop/blockchain/boa3-builtin-interop-blockchain) | features to get information on the Neo blockchain. | {data}`current_hash `, {func}`get_contract `, {class}`Transaction ` | -| [boa3.builtin.interop.contract](auto-package/boa3/builtin/interop/contract/boa3-builtin-interop-contract) | features related to smart contracts. | {func}`call_contract `, {func}`update_contract `, {class}`Contract ` | -| [boa3.builtin.interop.crypto](auto-package/boa3/builtin/interop/crypto/boa3-builtin-interop-crypto) | features related to cryptography. | {func}`sha256 `, {func}`hash160 `, {func}`hash256 `, {func}`check_sig ` | -| [boa3.builtin.interop.iterator](auto-package/boa3/builtin/interop/iterator/boa3-builtin-interop-iterator) | the iterator class. | {class}`Iterator ` | -| [boa3.builtin.interop.json](auto-package/boa3/builtin/interop/json/boa3-builtin-interop-json) | methods to serialize and deserialize JSON. | {func}`json_serialize `, {func}`json_deserialize ` | -| [boa3.builtin.interop.oracle](auto-package/boa3/builtin/interop/oracle/boa3-builtin-interop-oracle) | features related with Neo Oracle, it is used to get information from outside the blockchain. | {class}`Oracle ` | -| [boa3.builtin.interop.policy](auto-package/boa3/builtin/interop/policy/boa3-builtin-interop-policy) | features related to policies that affect the entire Neo blockchain. | {func}`get_exec_fee_factor `, {func}`get_storage_price ` | -| [boa3.builtin.interop.role](auto-package/boa3/builtin/interop/role/boa3-builtin-interop-role) | methods to get information about the nodes on the blockchain. | {func}`get_designated_by_role ` | -| [boa3.builtin.interop.runtime](auto-package/boa3/builtin/interop/runtime/boa3-builtin-interop-runtime) | features to get information that can only be acquired when running the smart contract. | {func}`check_witness `, {func}`calling_script_hash `, {func}`executing_script_hash `, {func}`script_container `, {class}`Notification ` | -| [boa3.builtin.interop.stdlib](auto-package/boa3/builtin/interop/stdlib/boa3-builtin-interop-stdlib) | methods that convert one data to another or methods that can check and compare memory. | {func}`serialize `, {func}`deserialize ` | -| [boa3.builtin.interop.storage](auto-package/boa3/builtin/interop/storage/boa3-builtin-interop-storage) | features to store, get, or change values inside the blockchain. | {func}`get `, {func}`put `, {func}`find `, {class}`FindOptions ` | -| [boa3.builtin.nativecontract](auto-package/boa3/builtin/nativecontract/boa3-builtin-nativecontract) | classes that interface Neo's native contracts. | {class}`ContractManagement `, {class}`GAS `, {class}`NEO `, {class}`StdLib ` | -| [boa3.builtin.type](auto-package/boa3/builtin/type/boa3-builtin-type) | Neo types. | {class}`UInt160 `, {class}`UInt256 `, {class}`Event `, {class}`ECPoint ` | -| [boa3.builtin.vm](auto-package/boa3/builtin/vm/boa3-builtin-vm) | Opcodes used internally by the Neo VM, used to create scripts dynamically. | {class}`Opcode ` | -| [boa3.builtin.math](auto-package/boa3/builtin/boa3-builtin-math) | a small sample of functions similar to Python's math. | {func}`sqrt `, {func}`floor `, {func}`ceil ` | - ### Hello World Let's write a quick Hello World script that has a method that will save `"Hello World"` on the blockchain @@ -154,6 +130,8 @@ For an extensive collection of examples: - [Smart contract examples](https://github.com/CityOfZion/neo3-boa/blob/development/boa3_test/examples) - [Features tests](https://github.com/CityOfZion/neo3-boa/blob/development/boa3_test/test_sc) +For reference of boa3 smart contract package utilities, take a look at [Package Reference](https://dojo.coz.io/neo3/boa/auto-package/package-reference.html) from boa3 documentation + ## What's next - [Testing and debugging your smart contract](./testing-and-debugging.md)