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

Redo of the Plugins PR #339

Merged
3 commits merged into from
Feb 17, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 1 addition & 1 deletion documentation/00_getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ If you're interested in learning more about Aleo:

✍️ | Community Blog ~ **https://medium.com/@AleoHQ**

### Looking for [**Developer Resources?**](./leo/07_resources.md)
### Looking for [**Developer Resources?**](./leo/08_resources.md)
8 changes: 4 additions & 4 deletions documentation/00_leo_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,13 @@ The Leo CLI provides a suite of commands to make programming in Leo easy.
## Additional Material
Install Leo for your favorite code [**editor**](./leo/06_tooling.md).

For additional developer resources such as examples and community projects, see [**Developer Resources**](./leo/07_resources.md).
For additional developer resources such as examples and community projects, see [**Developer Resources**](./leo/08_resources.md).

Is your Leo code formatted correctly? Check out the [**Style Guide**](./leo/07_resources.md#style-guide) and [**Common Patterns**](./leo/07_resources.md#common-patterns) for the official guidelines.
Is your Leo code formatted correctly? Check out the [**Style Guide**](./leo/08_resources.md#style-guide) and [**Common Patterns**](./leo/08_resources.md#common-patterns) for the official guidelines.

Found a bug? Have an idea for a feature? File an issue on the [**Leo GitHub**](https://github.com/AleoHQ/leo/issues/new/choose).

See the [**Contributing Guide**](./leo/07_resources.md#contributing) for more information.
See the [**Contributing Guide**](./leo/08_resources.md#contributing) for more information.

## Examples
- [Private Auction](./leo/08_auction.md)
- [Private Auction](./leo/10_auction.md)
12 changes: 7 additions & 5 deletions documentation/aleo/07_tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ If you have installed a Leo syntax [plugin](../leo/06_tooling.md)
then you should already be able to see syntax highlighting for `.aleo` Aleo instructions.
:::

Aleo maintains several syntax highlighting implementations across different platforms.
If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).
Aleo maintains several syntax highlighting implementations across different platforms. If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).

1. [Sublime Text](#sublime-text).
2. [Visual Studio Code](#vscode).
Expand All @@ -32,7 +31,8 @@ Aleo instructions support for Sublime's LSP plugin is provided through a languag
Follow these steps to toggle the `Aleo instructions` syntax highlighter.

1. Open `Sublime Text`.
2. From Preferences > Select Color Scheme... > LSP-leo
2. From Settings > Select Color Scheme... > LSP-leo
3. This will also allow you to see syntax highlighting for Aleo instructions.

## VSCode

Expand All @@ -42,12 +42,13 @@ Download the editor here: https://code.visualstudio.com/download.
### Install

1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
2. The correct extension ID is `aleohq.leo-extension`.
2. The correct extension ID is `aleohq.leo-extension`, and the description should state "the official VSCode extension for Leo".

### Usage

1. Open `VSCode`.
2. Go to Settings > Extensions or use the left side panel Extensions button to enable the Leo plugin.
3. This will also allow you to see syntax highlighting for Aleo instructions.

## IntelliJ

Expand All @@ -57,4 +58,5 @@ Download the editor here: https://www.jetbrains.com/idea/download/.
### Install

1. Download the [Aleo Developer Plugin](https://plugins.jetbrains.com/plugin/19890-aleo-developer) from JetBrains marketplace.
2. Click on Plugins on the left side panel > gear icon > Install Plugin from Disk > Select the downloaded zip file
2. Click on the gear icon in the upper right > Plugins > gear icon up top > Install Plugin from Disk > Select the downloaded zip file
3. This will also allow you to see syntax highlighting for Aleo instructions.
Binary file modified documentation/aleo/images/intellij.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 modified documentation/aleo/images/sublime.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 modified documentation/aleo/images/vscode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 11 additions & 10 deletions documentation/leo/06_tooling.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ title: Tooling for Leo
sidebar_label: Tooling
---

Aleo maintains syntax highlighting implementations across different platforms.
If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).
Aleo maintains syntax highlighting implementations across different platforms. If you do not see your favorite editor on this list, please reach out on [GitHub](https://github.com/AleoHQ/welcome/issues/new).

1. [Sublime Text](#sublime-text)
2. [Visual Studio Code](#vs-code)
Expand All @@ -15,18 +14,19 @@ If you do not see your favorite editor on this list, please reach out on [GitHub

[//]: # (![](./images/sublime.png) )
Download the editor here: https://www.sublimetext.com/download.
Leo support for Sublime's LSP plugin is provided through a language server.
Aleo instructions support for Sublime's LSP plugin is provided through a language-server.

### Install

1. Install [LSP](https://packagecontrol.io/packages/LSP) and [LSP-Leo](https://packagecontrol.io/packages/LSP-leo) from Package Control.
1. Install [LSP](https://packagecontrol.io/packages/LSP) and [LSP-leo](https://packagecontrol.io/packages/LSP-leo) from Package Control.
2. Restart Sublime.

### Usage

Follow these steps to toggle the `Leo` syntax highlighting, hover, and tokens.

1. Open `Sublime Text`.
2. From Preferences > Select Color Scheme... > LSP-aleo-developer
2. From Settings > Select Color Scheme... > LSP-leo

## VS Code

Expand All @@ -35,13 +35,13 @@ Download the editor here: https://code.visualstudio.com/download.

### Install

Install [Leo for VS Code](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from the VS Code marketplace.
The correct extension ID is `aleohq.leo-extension`.
1. Install [Leo for VSCode](https://marketplace.visualstudio.com/items?itemName=aleohq.leo-extension) from VSCode marketplace.
2. The correct extension ID is `aleohq.leo-extension`, and the description should state "the official VSCode extension for Leo".

### Usage

1. Open `VS Code`.
2. From Preferences > Color Theme... > Aleo Theme
1. Open `VSCode`.
2. Go to Settings > Extensions or use the left side panel Extensions button to enable the Leo plugin.

## Intellij

Expand All @@ -50,4 +50,5 @@ Download the editor here: https://www.jetbrains.com/idea/download/.

### Install

Install the [Leo for Intellij](https://plugins.jetbrains.com/plugin/19979-leo) from the JetBrains marketplace.
1. Download the [Aleo Developer Plugin](https://plugins.jetbrains.com/plugin/19890-aleo-developer) from JetBrains marketplace.
2. Click on the gear icon in the upper right > Plugins > gear icon up top > Install Plugin from Disk > Select the downloaded zip file
8 changes: 8 additions & 0 deletions documentation/leo/07_leo_playground.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ You may choose to download any of the examples or programs you've written on you

## 1. Tools for Deployment

<!-- markdown-link-check-disable -->
- Install [Leo](https://developer.aleo.org/leo/installation)
- Install [Aleo's transaction cannon](https://github.com/AleoHQ/tx-cannon), which will help you deploy, execute, and stress test your Leo programs.
- Install [snarkOS](https://github.com/AleoHQ/snarkOS), which will help spin up a live devnet either locally or on AWS.
- Install [tmux](https://formulae.brew.sh/formula/tmux), because the devnet dashboard uses it.
<!-- markdown-link-check-enable -->

## 2. Start a local Aleo Devnet

Expand Down Expand Up @@ -72,6 +74,7 @@ The height number should be moving up.

### Transaction Cannon Deployment

<!-- markdown-link-check-disable -->
Use the transaction cannon to deploy your program.

```bash
Expand All @@ -80,6 +83,7 @@ tx-cannon deploy <project>/build/<project>.aleo -k <node-private-key-you-jotted-
```

You can check that your deployment was successful on your network using: http://localhost:3030/testnet3/transaction/`<your-txn-id>`.
<!-- markdown-link-check-enable -->

## 6. Execution On-Chain using the Transaction Cannon

Expand All @@ -98,13 +102,15 @@ fee = 3

The `.toml` file basically orders transactions to be executed. When we call the `tx-cannon execute` command, we ask it to look for the program we deployed on our local devnet and execute it using the provided inputs and the corresponding private key.

<!-- markdown-link-check-disable -->
```bash
tx-cannon batch-execute --test helloworld.toml -e http://localhost:3030
```

Again, check that the program executed: http://localhost:3030/testnet3/transaction/`<your-txn-id>`.

There's much more functionality to be explored in the [tx-cannon repository](https://github.com/AleoHQ/tx-cannon). You can batch deploy, execute, and transfer, so take advantage of this tool to run development tests on your application!
<!-- markdown-link-check-disable -->

Congratulations, you took a project off Playground and successfully deployed it to an Aleo devnet!

Expand Down Expand Up @@ -147,7 +153,9 @@ Congratulations on becoming a Leo contributor! 🎉

1. You downloaded a project off of [Leo Playground](https://play.leo-lang.org/).

<!-- markdown-link-check-disable -->
2. You installed [Leo](https://developer.aleo.org/leo/), our statically-typed programming language built for writing private applications, our [transaction cannon](https://github.com/AleoHQ/tx-cannon) for easy deployment and execution, and [snarkOS](https://github.com/AleoHQ/snarkOS), the data availability layer.
<!-- markdown-link-check-enable -->

3. You started a local devnet using the snarkOS repository.

Expand Down
Loading