Skip to content

Commit

Permalink
#86dtu8zqj - Remove boa feature from Getting started documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Mirella de Medeiros committed Jun 19, 2024
1 parent c16becf commit 87bfac4
Showing 1 changed file with 2 additions and 24 deletions.
26 changes: 2 additions & 24 deletions docs/source/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.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 <boa3.builtin.compile_time.public>`, {func}`metadata <boa3.builtin.compile_time.metadata>`, {func}`contract <boa3.builtin.compile_time.contract>`, {func}`CreateNewEvent <boa3.builtin.compile_time.CreateNewEvent>`, {class}`NeoMetadata <boa3.builtin.compile_time.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 <boa3.builtin.contract.abort>`, {data}`Nep17TransferEvent <boa3.builtin.contract.Nep17TransferEvent>`, {data}`Nep11TransferEvent <boa3.builtin.contract.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 <boa3.builtin.interop.storage>`, {mod}`runtime <boa3.builtin.interop.runtime>`, {mod}`contract <boa3.builtin.interop.contract>`, {mod}`blockchain <boa3.builtin.interop.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 <boa3.builtin.interop.blockchain.current_hash>`, {func}`get_contract <boa3.builtin.interop.blockchain.get_contract>`, {class}`Transaction <boa3.builtin.interop.blockchain.transaction.Transaction>` |
| [boa3.builtin.interop.contract](auto-package/boa3/builtin/interop/contract/boa3-builtin-interop-contract) | features related to smart contracts. | {func}`call_contract <boa3.builtin.interop.contract.call_contract>`, {func}`update_contract <boa3.builtin.interop.contract.update_contract>`, {class}`Contract <boa3.builtin.interop.contract.contract.Contract>` |
| [boa3.builtin.interop.crypto](auto-package/boa3/builtin/interop/crypto/boa3-builtin-interop-crypto) | features related to cryptography. | {func}`sha256 <boa3.builtin.interop.crypto.sha256>`, {func}`hash160 <boa3.builtin.interop.crypto.hash160>`, {func}`hash256 <boa3.builtin.interop.crypto.hash256>`, {func}`check_sig <boa3.builtin.interop.crypto.check_sig>` |
| [boa3.builtin.interop.iterator](auto-package/boa3/builtin/interop/iterator/boa3-builtin-interop-iterator) | the iterator class. | {class}`Iterator <boa3.builtin.interop.iterator.Iterator>` |
| [boa3.builtin.interop.json](auto-package/boa3/builtin/interop/json/boa3-builtin-interop-json) | methods to serialize and deserialize JSON. | {func}`json_serialize <boa3.builtin.interop.json.json_serialize>`, {func}`json_deserialize <boa3.builtin.interop.json.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.nativecontract.oracle.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 <boa3.builtin.interop.policy.get_exec_fee_factor>`, {func}`get_storage_price <boa3.builtin.interop.policy.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.role.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 <boa3.builtin.interop.runtime.check_witness>`, {func}`calling_script_hash <boa3.builtin.interop.runtime.calling_script_hash>`, {func}`executing_script_hash <boa3.builtin.interop.runtime.executing_script_hash>`, {func}`script_container <boa3.builtin.interop.runtime.script_container>`, {class}`Notification <boa3.builtin.interop.runtime.notification.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 <boa3.builtin.interop.stdlib.serialize>`, {func}`deserialize <boa3.builtin.interop.stdlib.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 <boa3.builtin.interop.storage.get>`, {func}`put <boa3.builtin.interop.storage.put>`, {func}`find <boa3.builtin.interop.storage.find>`, {class}`FindOptions <boa3.builtin.interop.storage.findoptions.FindOptions>` |
| [boa3.builtin.nativecontract](auto-package/boa3/builtin/nativecontract/boa3-builtin-nativecontract) | classes that interface Neo's native contracts. | {class}`ContractManagement <boa3.builtin.nativecontract.contractmanagement.ContractManagement>`, {class}`GAS <boa3.builtin.nativecontract.gas.GAS>`, {class}`NEO <boa3.builtin.nativecontract.neo.NEO>`, {class}`StdLib <boa3.builtin.nativecontract.stdlib.StdLib>` |
| [boa3.builtin.type](auto-package/boa3/builtin/type/boa3-builtin-type) | Neo types. | {class}`UInt160 <boa3.builtin.type.UInt160>`, {class}`UInt256 <boa3.builtin.type.UInt256>`, {class}`Event <boa3.builtin.type.Event>`, {class}`ECPoint <boa3.builtin.type.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.vm.Opcode>` |
| [boa3.builtin.math](auto-package/boa3/builtin/boa3-builtin-math) | a small sample of functions similar to Python's math. | {func}`sqrt <boa3.builtin.math.sqrt>`, {func}`floor <boa3.builtin.math.floor>`, {func}`ceil <boa3.builtin.math.ceil>` |


### Hello World
Let's write a quick Hello World script that has a method that will save `"Hello World"` on the blockchain
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit 87bfac4

Please sign in to comment.