Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: change mentions of dappflow to Lora. Updated algokit quick start #1271

Merged
merged 2 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/get-details/algokit/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ Copy the contents of the doctor message (in Markdown format) in your clipboard.

## explore

Explore the specified network in the browser using Dappflow.
Explore the specified network in the browser using Lora.

```shell
algokit explore [OPTIONS] [[localnet|testnet|mainnet]]
Expand Down Expand Up @@ -482,7 +482,7 @@ algokit localnet console [OPTIONS]

### explore

Explore the AlgoKit LocalNet using Dappflow
Explore the AlgoKit LocalNet using Lora

```shell
algokit localnet explore [OPTIONS]
Expand Down
8 changes: 4 additions & 4 deletions docs/get-details/algokit/features/explore.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
title: Explore

AlgoKit provides a quick shortcut to [explore](../cli-reference.md#explore) various Algorand networks using [Dappflow](https://app.dappflow.org/) including [AlogKit LocalNet](./localnet.md)!
AlgoKit provides a quick shortcut to [explore](../cli-reference.md#explore) various Algorand networks using [Lora](https://lora.algokit.io/mainnet) including [AlogKit LocalNet](./localnet.md)!

## LocalNet

The following three commands are all equivalent and will open Dappflow pointing to the local [AlgoKit LocalNet](./localnet.md) instance:
The following three commands are all equivalent and will open [Lora](https://lora.algokit.io/localnet) pointing to the local [AlgoKit LocalNet](./localnet.md) instance:

- `algokit explore`
- `algokit explore localnet`
- `algokit localnet explore`

## Testnet

`algokit explore testnet` will open Dappflow pointing to TestNet via the <https://testnet-api.algonode.cloud> [node](https://algonode.io/api/).
`algokit explore testnet` will open [Lora](https://lora.algokit.io/testnet) pointing to TestNet via the <https://testnet-api.algonode.cloud> [node](https://algonode.io/api/).

## Mainnet

`algokit explore mainnet` will open Dappflow pointing to MainNet via the <https://mainnet-api.algonode.cloud> [node](https://algonode.io/api/).
`algokit explore mainnet` will open [Lora](https://lora.algokit.io/mainnet) pointing to MainNet via the <https://mainnet-api.algonode.cloud> [node](https://algonode.io/api/).

To learn more about the `algokit explore` command, please refer to [explore](../cli-reference.md#explore) in the AlgoKit CLI reference documentation.
Binary file added docs/get-details/algokit/imgs/algokit_v2_demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/algokitv2_json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/get-details/algokit/imgs/dappflow.png
Binary file not shown.
Binary file removed docs/get-details/algokit/imgs/dappflow1.png
Binary file not shown.
Binary file removed docs/get-details/algokit/imgs/dappflow2.png
Binary file not shown.
Binary file removed docs/get-details/algokit/imgs/dappflow3.png
Binary file not shown.
Binary file removed docs/get-details/algokit/imgs/dappflow4.png
Binary file not shown.
Binary file removed docs/get-details/algokit/imgs/dappflow5.png
Binary file not shown.
Binary file removed docs/get-details/algokit/imgs/dappflow6.png
Binary file not shown.
Binary file added docs/get-details/algokit/imgs/lora-wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora17.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/get-details/algokit/imgs/lora7.png
Binary file added docs/get-details/algokit/imgs/lora8.png
Binary file added docs/get-details/algokit/imgs/lora9.png
2 changes: 1 addition & 1 deletion docs/get-details/algokit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For details on how to use individual features see the following
- [Dispenser](./features/dispenser.md) - interactive TestNet Dispenser for receiveing TestALGO
- [Dispenser](./features/dispenser.md) - Fund your TestNet account with ALGOs from the AlgoKit TestNet Dispenser
- [Doctor](./features/doctor.md) - Check AlgoKit installation and dependencies
- [Explore](./features/explore.md) - Explore Algorand Blockchains using Dappflow
- [Explore](./features/explore.md) - Explore Algorand Blockchains using Lora
- [Generate](./features/generate.md) - Generate code for an Algorand project
- [Goal](./features/goal.md) - Run the Algorand goal CLI against the AlgoKit Sandbox
- [Init](./features/init.md) - Quickly initialize new projects using official Algorand Templates or community provided templates
Expand Down
228 changes: 160 additions & 68 deletions docs/get-details/algokit/tutorials/intro.md

Large diffs are not rendered by default.

102 changes: 75 additions & 27 deletions docs/get-started/algokit.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
title: AlgoKit Quick Start Guide

AlgoKit is a simple, one-stop tool for developers to quickly and easily build and launch secure, automated, production-ready decentralized applications on the Algorand protocol -- now also featuring native support for Python! This empowers developers to write Algorand apps in regular Python, one of the world's most popular programming languages.

In addition, AlgoKit features:

- A library of smart contract templates to kickstart your build
- All necessary application infrastructure running locally
- Toolchain integrations for languages you love, like Python and TypeScript
Expand Down Expand Up @@ -122,11 +124,16 @@ Now that AlgoKit is installed, you can rapidly create a new project to get start
algokit init
```

This will launch a guided menu system to create a specific project tailored to your needs. You will first be prompted to select a specific template. The templates are basic starter applications for various Algorand development scenarios. To read more about templates checkout AlgoKit detailed documentation. For now, use the arrow keys to select the `starter` template, which is a lightweight starting point for learning and experimentation.

Next, you will be prompted for the name of your project. Finally, select the default value for the rest of the prompts (enter).
This will launch a guided menu system to create a specific project tailored to your needs. You will first be prompted to select a specific template. The templates are basic starter applications for various Algorand development scenarios. To read more about templates checkout AlgoKit detailed documentation. For this guide, we will use the Python smart contract starter template. Select the following options:
1. `Smart Contracts`
2. `Python`
3. name of your project: `DEMO`
4. Template preset: select `Starter`.
5. Contract deployment code: select `Python`
6. algokit project bootstrap: `Y`
7. git repository: `Y`

Once finished, (if you have it installed) VS Code should automatically be opened with the initialised project and you will be prompted to install appropriate VS Code extensions. This starter app will contain one smart contract (built with [Python](https://algorandfoundation.github.io/puya/) named `contract.py`, in the `hello_world` folder, with one method (`hello`) that takes a `String` and returns a `String`.
Once finished, (if you have it installed) VS Code should automatically be opened with the initialized project and you will be prompted to install appropriate VS Code extensions. This starter app will contain one smart contract (built with [Algorand Python](https://algorandfoundation.github.io/puya/) named `contract.py`, in the `hello_world` folder, with one method (`hello`) that takes a `String` and returns a `String`.

![AlgoKit Starter Contract](../imgs/algokitv2_starter.png)

Expand All @@ -136,13 +143,20 @@ Once the starter project is created, you will notice in the `smart_contracts/hel

![AlgoKit Starter config ](../imgs/algokit_v2_demo.png)

By hitting F5 you will deploy the `HelloWorldApp` smart contract and then call it passing the parameter `name` with a value of `world`. You can edit this parameter in the `deploy_config.py` file and it will:
By hitting F5 you will deploy the `HelloWorld` smart contract and then call it passing the parameter `name` with a value of `world`. You can edit this parameter in the `deploy_config.py` file and it will:

1. Start LocalNet
2. Build the smart contract
3. Deploy and call the smart contract (`contract.py`)

This should produce something similiar to the following in the VSCode terminal.
If you would like to manually build and deploy the `HelloWorld` smart contract run the following AlgoKit commands:

```shell
algokit project run build
algokit project run deploy
```

This should produce something similar to the following in the VSCode terminal.

```shell
HelloWorld not found in PDEEWXLITMAPDMDYGP4XUV2EUJVPNZVKR7OUSSFZ63U4XNL2Y25FN5PYN4 account, deploying app.
Expand All @@ -158,55 +172,89 @@ Additionally, you can find the native TEAL smart contract code and the appropria

![AlgoKit Starter Demo](../imgs/algokitv2_json.png)

These files can be used by tools like [Dappflow](https://dappflow.org/), [goal](https://developer.algorand.org/docs/clis/goal/goal/), etc. to deploy your smart contract to the various Algorand networks.
These files can be used by tools like [Lora](https://lora.algokit.io/localnet), [goal](https://developer.algorand.org/docs/clis/goal/goal/), etc. to deploy your smart contract to the various Algorand networks.

## Using Dappflow
## Using Lora

Dappflow is a web-based user interface that let's you visualise accounts, transactions, assets and applications on an Algorand network and also provides ability to deploy and call smart contracts. This works for TestNet, MainNet and also LocalNet. Furthermore, you can also create and fund accounts on LocalNet. While AlgoKit surfaces both a programming interface and a command line interface for interacting with Algorand, it also allows you to quickly open Dappflow so you can see what's happening visually.
Lora is a web-based user interface that let's you visualize accounts, transactions, assets and applications on an Algorand network and also provides ability to deploy and call smart contracts. This works for TestNet, MainNet and also LocalNet. While AlgoKit surfaces both a programming interface and a command line interface for interacting with Algorand, it also allows you to quickly open Lora so you can see what's happening visually.

Dappflow can be launched from AlgoKit by running the following command from the VS Code terminal.
Lora can be launched from AlgoKit by running the following command from the terminal.

```shell
algokit explore
```

By default it will open Dappflow to point to LocalNet (It will be displayed as `sandbox` in the upper left hand corner.), but you can pass in parameters to point it to TestNet and MainNet too.
By default it will open Lora and point to LocalNet (It will be displayed as `LocalNet` in the upper right hand corner), but you can pass in parameters to point it to TestNet and MainNet too.

This command will launch your default web browser and load the Dappflow web application.
This command will launch your default web browser and load the Lora web application.

**Note:** If you are using Safari, then it won't work against LocalNet and you will need to open it in a different browser.

![AlgoKit Dappflow](../imgs/dappflow1.png)
![Lora](../imgs/lora1.png)

### Create / Connect local account for testing

To issue commands against the LocalNet network you need an account with ALGO in it. Lora gives you three options for connecting to a local wallet: `Connect KMD`, `Connect MNEMONIC`, and `Connect Lute`

### Create test account
- `Connect KMD`: Lora will automatically import KMD wallet.

To issue commands against the LocalNet network you need an account with ALGOs in it. Dappflow lets you easily create one.
- `Connect MNEMONIC`: You can manually input a MNEMONIC for an account you own.

Select `Dev Wallets` from the left menu and click on the `Create wallet` button. This will create an account on the LocalNet and fund it with 100 Algos that can be used to test with.
- `Connect Lute`: You can create local accounts from [Lute](https://lute.app/) and connect to them.

![AlgoKit Dappflow](../imgs/dappflow2.png)
In this guide, we will use the KMD wallet.

In the bottom left hand corner of the menu, select `Connect wallet` and you will be prompted with several wallet choices. Choose the `Dev Wallet` option. This will connect the account you just created to Dappflow so you can use that account for signing transactions from the Dappflow user interface.
Select `Connect wallet` located at top right hand side of the webpage and you will be prompted with the three wallet choices. Choose the `Connect KMD` option. This will prompt you to enter the KMD password. If this is your first time building on Algorand, you do not have a KMD password so leave it blank and click `OK`. This will connect the KMD account to Lora so you can use that account for signing transactions from the Lora user interface.

![Lora](../imgs/lora-wallet.png)

### Deploy the Hello World application

To deploy your smart contract application, select the `Beaker studio` menu and click on the import beaker app. Select `File` and `Upload file`, browse to the artifacts created in the previous section of this guide. Select the `*.arc32.json` manifest file. This will load the specific manifest file for the Hello World sample application.
1. To deploy your smart contract application, select the `App Lab` menu and click on the `Create` button.
![Lora](../imgs/lora2.png)

2. Click `Deploy new` and `Select an ARC-32 JSON app spec file` to browse to the artifacts created in the previous section of this guide. Select the `HelloWorld.arc32.json` manifest file.
![Lora](../imgs/lora3.png)
![Lora](../imgs/lora4.png)
![Lora](../imgs/lora5.png)

3. This will load the specific manifest file for the Hello World sample application. Click `Next`.
![Lora](../imgs/lora6.png)

4. You can change the `Name` and the `Version` of your app. We will keep it as it is. Click `Next`.
![Lora](../imgs/lora7.png)

5. Click the `() Call` button. Then build and add the create transaction by clicking `Add`.
![Lora](../imgs/lora8.png)
![Lora](../imgs/lora9.png)


6. Click `Deploy` and sign the transaction by clicking `OK` in the KMD pop up to deploy the smart contract to the local Algorand network.
![Lora](../imgs/lora10.png)

7. You should now see the deployed `HelloWorld` contract on the `App Lab` page.
![Lora](../imgs/lora11.png)

![AlgoKit Dappflow](../imgs/dappflow3.png)
8. Now click on the `App ID` inside of the `HelloWorld` card to go to the `Application` page.
![Lora](../imgs/lora12.png)

To deploy this application again, select the `Create app` button followed by the `Create` button from the popup. You should get a `Transaction successful` message with the option to view the specific transaction in the explorer. Close out of the popup and then scroll down to the `ABI` section of the page. The `hello` method should be displayed with an execute button beside it.
10. Inside the `ABI Methods` section, you should see the `hello` method. Click on the drop down and the `Call` button. You will be prompted with a popup allowing you to enter the parameter for the `hello` method and call it.
![Lora](../imgs/lora13.png)

![AlgoKit Dappflow](../imgs/dappflow4.png)

Click on the Execute button and a popup will be displayed allowing you to enter the parameter that we defined in the `HelloWorldApp` smart contract.
11. Enter a string in the `value` input and click on `Add`.
![Lora](../imgs/lora14.png)

![AlgoKit Dappflow](../imgs/dappflow5.png)
12. You should now see the transaction you just built on the `Application` page. Click `Send` and sign the transaction with your KMD wallet to execute the transaction.
![Lora](../imgs/lora15.png)

Enter a string in the parameter and click on `Execute`. You should get get a confirmation that the method executed properly and what the smart contract returned.
13. You should now see the `Send Result` showing you the details about the transaction you just executed!
![Lora](../imgs/lora16.png)

![AlgoKit Dappflow](../imgs/dappflow6.png)
1. You can also click on `Transaction ID` to go to the `Transaction` page and see the full detail of the transaction.
![Lora](../imgs/lora17.png)

You have now successfully deployed and executed a smart contract method call using Dappflow!
You have now successfully deployed and executed a smart contract method call using Lora!

## Next steps

Expand Down
Binary file removed docs/imgs/dappflow.png
Diff not rendered.
Binary file removed docs/imgs/dappflow1.png
Diff not rendered.
Binary file removed docs/imgs/dappflow2.png
Diff not rendered.
Binary file removed docs/imgs/dappflow3.png
Diff not rendered.
Binary file removed docs/imgs/dappflow4.png
Diff not rendered.
Binary file removed docs/imgs/dappflow5.png
Diff not rendered.
Binary file removed docs/imgs/dappflow6.png
Diff not rendered.
Binary file removed docs/imgs/dappflow_transaction.png
Diff not rendered.
Binary file added docs/imgs/lora-wallet.png
Binary file added docs/imgs/lora1.png
Binary file added docs/imgs/lora10.png
Binary file added docs/imgs/lora11.png
Binary file added docs/imgs/lora12.png
Binary file added docs/imgs/lora13.png
Binary file added docs/imgs/lora14.png
Binary file added docs/imgs/lora15.png
Binary file added docs/imgs/lora16.png
Binary file added docs/imgs/lora17.png
Binary file added docs/imgs/lora2.png
Binary file added docs/imgs/lora3.png
Binary file added docs/imgs/lora4.png
Binary file added docs/imgs/lora5.png
Binary file added docs/imgs/lora6.png
Binary file added docs/imgs/lora7.png
Binary file added docs/imgs/lora8.png
Binary file added docs/imgs/lora9.png
3 changes: 0 additions & 3 deletions docs/run-a-node/setup/node-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,6 @@ One of the most common issues are that the node is on the wrong network, has the
* **Check that the node is on the right network**: when running `goal node status`, `Genesis ID` must be `mainnet-v1.0` for MainNet, `testnet-v1.0` for TestNet, `betanet-v1.0` for BetaNet. See [Switch Networks](/docs/run-a-node/operations/switch_networks) to solve this issue.
* **Check that the version** reported of `algod -v` and `goal version -v` are the latest stable release (if using MainNet or TestNet) or the latest beta release (if using BetaNet). See the [official repo](https://github.com/algorand/go-algorand/releases) for the list of all releases. Beta releases are clearly marked as such.

You can easily check all of the above using [dAppFlow node status](https://app.dappflow.org/node-manager/dashboard) webapp.
Click on settings on the bottom left, fill in URL (usually `http://localhost`, inside `$ALGORAND_DATA/algod.net`), port (usually 8080, inside `$ALGORAND_DATA/algod.net`), token (from `$ALGORAND_DATA/algod.token`).

## My node is not syncing/catching up at all (Last Committed Block is 0)

As soon as the node is started, the `Last Committed Block` from `goal node status` should be increasing.
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/go/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: Go SDK: Your First Transaction

This section is a quick start guide for interacting with the Algorand network using Go. This guide will help to install [Algorand sandbox](https://github.com/algorand/sandbox){:target="_blank"}, which provides a node for testing and development. This guide will also help to install the Go SDK, create an account and submit your first transaction on Algorand.
This section is a quick start guide for interacting with the Algorand network using Go. This guide will help to install [Algorand sandbox](https://github.com/algorand/sandbox){target=blank}, which provides a node for testing and development. This guide will also help to install the Go SDK, create an account and submit your first transaction on Algorand.

# Install Sandbox

Expand Down Expand Up @@ -184,6 +184,6 @@ fmt.Printf("Confirmed Transaction: %s in Round %d\n", pendingTxID, confirmedTxn.
<!-- ===GOSDK_TRANSACTION_PAYMENT_SUBMIT=== -->

# Viewing the Transaction
To view the transaction we submitted to the sandbox Algod, open [DappFlow](https://app.dappflow.org/explorer/home){target=_blank} and choose `Sandbox` configuration option, then search for the transaction ID.
To view the transaction we submitted to the sandbox Algod, open [Lora](https://lora.algokit.io/localnet){target=_blank} and choose `LocalNet` configuration option, then search for the transaction ID.

To view a transaction submitted to public network like testnet, open [Pera Explorer](https://testnet.explorer.perawallet.app/){:target="_blank"} or [Bitquery](https://explorer.bitquery.io/algorand_testnet){:target="_blank"} and paste the transaction ID into the search bar or simply click on the funded transaction link on the dispenser page.
To view a transaction submitted to public network like testnet, open [Lora](https://lora.algokit.io/testnet){target=_blank} or [Pera Explorer](https://testnet.explorer.perawallet.app/){target=blank} and paste the transaction ID into the search bar.
Loading
Loading