Skip to content

Commit

Permalink
Merge pull request #253 from yash251/main
Browse files Browse the repository at this point in the history
fix: typos
  • Loading branch information
twilson63 authored Dec 29, 2024
2 parents df07ccb + 4bdb050 commit 1bc1e85
Show file tree
Hide file tree
Showing 26 changed files with 40 additions and 40 deletions.
2 changes: 1 addition & 1 deletion src/concepts/lua.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ There are a few different ways to loop in your code in Lua. Here are our favorit

- **While loops**:

Start by initalizing your counter to zero by typing `n = 0` and pressing enter.
Start by initializing your counter to zero by typing `n = 0` and pressing enter.

Then open the inline editor again with `.editor` .

Expand Down
2 changes: 1 addition & 1 deletion src/guides/0rbit/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ next:

[0rbit](https://0rbit.co/) is the first-ever Decentralised Oracle Network on Arweave using `ao`.

0rbit enables Access to ANY Real-World data present and accessible across interent into your `ao` process.
0rbit enables Access to ANY Real-World data present and accessible across internet into your `ao` process.

0rbit provides the following features to get access to the data using the HTTP protocol:

Expand Down
2 changes: 1 addition & 1 deletion src/guides/aoconnect/connecting.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Connecting to specific ao nodes

When including ao connect in your code you have the ability to connect to a specific MU and CU, as well as being able to specifiy an Arweave gateway. This can be done by importing the "connect" function and extracting the functions from a call to the "connect" function.
When including ao connect in your code you have the ability to connect to a specific MU and CU, as well as being able to specify an Arweave gateway. This can be done by importing the "connect" function and extracting the functions from a call to the "connect" function.

You may want to do this if you want to know which MU is being called when you send your message so that later you can debug from the specified MU. You also may want to read a result from a specific CU. You may in fact just prefer a particular MU and CU for a different reason. You can specify the gateway in order to use something other than the default, which is arweave.net.

Expand Down
2 changes: 1 addition & 1 deletion src/guides/aoconnect/monitoring-cron.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Monitoring Cron

When using cron messages, ao users need a way to start injesting the messages, using this monitor method, ao users can initiate the subscription service for cron messages. Setting cron tags means that your process will start producing cron results in its outbox, but you need to monitor these results if you want messages from those results to be pushed through the network.
When using cron messages, ao users need a way to start ingesting the messages, using this monitor method, ao users can initiate the subscription service for cron messages. Setting cron tags means that your process will start producing cron results in its outbox, but you need to monitor these results if you want messages from those results to be pushed through the network.

```js
import { readFileSync } from "node:fs";
Expand Down
2 changes: 1 addition & 1 deletion src/guides/aoconnect/signers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A wallet/keyfile is a public/private key pair that can be used to sign and encry

## What is an ao message/dataItem?

You often see the terms `message` and `dataItem` used interchangably in the documentation, a message is a data-protocol type in ao that uses the dataItem specification to describe the messages intent. A dataItem is defined in the `ans-104` bundle specification. A dataItem is the preferred format of storage for arweave bundles. A bundle is a collection of these signed dataItems. A message implements specific tags using the dataItem specification. When developers send messages to ao, they are publishing dataItems on arweave.
You often see the terms `message` and `dataItem` used interchangeably in the documentation, a message is a data-protocol type in ao that uses the dataItem specification to describe the messages intent. A dataItem is defined in the `ans-104` bundle specification. A dataItem is the preferred format of storage for arweave bundles. A bundle is a collection of these signed dataItems. A message implements specific tags using the dataItem specification. When developers send messages to ao, they are publishing dataItems on arweave.

> 🎓 To learn more about messages [click here](/concepts/messages) and to learn more about ans-104 dataItems [click here](https://specs.g8way.io/?tx=xwOgX-MmqN5_-Ny_zNu2A8o-PnTGsoRb_3FrtiMAkuw)
Expand Down
4 changes: 2 additions & 2 deletions src/guides/aos/editor.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Editor setup

Remembering all the built in ao functions and utilites can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../aos/modules/index) and [globals](../aos/intro#globals).
Remembering all the built in ao functions and utilities can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../aos/modules/index) and [globals](../aos/intro#globals).

## VS Code

Expand All @@ -14,7 +14,7 @@ Install the [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=su
> Lua: Open Addon Manager
```

4. In the Addon Manager, search for "ao", it should be the first result. Click "Enable" and enjoy autcomplete!
4. In the Addon Manager, search for "ao", it should be the first result. Click "Enable" and enjoy autocomplete!

## Other editors

Expand Down
4 changes: 2 additions & 2 deletions src/guides/aos/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Ownership

<details>
<summary><strong>Understaning Process Ownership</strong></summary>
<summary><strong>Understanding Process Ownership</strong></summary>

Start a new process with the aos console, the ownership of the process is set to your wallet address. **aos** uses the **Owner** global variable to define the ownership of the process. If you wish to transfer ownership or lock the process so that no one can own, you simply modify the **Owner** variable to another wallet address or set it to **nil**.

Expand All @@ -27,6 +27,6 @@ Send({Target = Router, Data = require('json').encode({hello = "world"})})
<details>
<summary><strong>When to use Send vs ao.send</strong></summary>

Both functions send a message to a process, the difference is ao.send returns the message, in case you want to log it or troubleshoot. The **Send** function is intended to be used in the console for easier access. It is preferred to use **ao.send** in the **handlers**. But they are both interchangable in **aos**.
Both functions send a message to a process, the difference is ao.send returns the message, in case you want to log it or troubleshoot. The **Send** function is intended to be used in the console for easier access. It is preferred to use **ao.send** in the **handlers**. But they are both interchangeable in **aos**.

</details>
2 changes: 1 addition & 1 deletion src/guides/aos/modules/ao.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ ao.send({

### `ao.env`

The `ao.env` global variable holds informationg about the initializing message of the process. It follows the schema below:
The `ao.env` global variable holds information about the initializing message of the process. It follows the schema below:

```json
{
Expand Down
2 changes: 1 addition & 1 deletion src/guides/aos/modules/utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ utils.reverse({ 1, 2, 3 })

### `includes()`

Determinates whether a value is part of an array.
Determines whether a value is part of an array.

- **Parameters:**
- `val`: `{any}` The element to check for
Expand Down
6 changes: 3 additions & 3 deletions src/guides/aos/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following guide will guide you through the process of creating a token from

### **Step 1: Initializing the Token**

- Open our preferred text editor, preferrably from within the same folder you used during the previous tutorial.
- Open our preferred text editor, preferably from within the same folder you used during the previous tutorial.
- Create a new file named `token.lua`.
- Within `token.lua`, you'll begin by initializing the token's state, defining its balance, name, ticker, and more:

Expand Down Expand Up @@ -76,7 +76,7 @@ end)
::: info
At this point, you've probably noticed that we're building all of the handlers inside the `token.lua` file rather than using .`editor`.

With many handlers and processes, it's perfectly fine to create your handlers using `.editor`, but because we're creating a full process for initizialing a token, setting up info and balances handlers, transfer handlers, and a minting handler, it's best to keep everything in one file.
With many handlers and processes, it's perfectly fine to create your handlers using `.editor`, but because we're creating a full process for initializing a token, setting up info and balances handlers, transfer handlers, and a minting handler, it's best to keep everything in one file.

This also allows us to maintain consistency since each handler will be updated every time we reload the `token.lua` file into `aos`.
:::
Expand Down Expand Up @@ -249,7 +249,7 @@ Make sure you've started your aos process by running `aos` in your terminal.

#### 2 - Loading the token.lua file

If you've followd along with the guide, you'll have a `token.lua` file in the same directory as your aos process. From the aos prompt, load in the file.
If you've followed along with the guide, you'll have a `token.lua` file in the same directory as your aos process. From the aos prompt, load in the file.

```lua
.load token.lua
Expand Down
2 changes: 1 addition & 1 deletion src/guides/aos/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If you notice on the left you see the interaction with the process displayed on
In this case, this is DevChat, and you can see all the processes that have interacted by Registering and Broadcasting Messages.

You can effortless check the Info Handler, by pressing the "Fetch" button.
![ao.link fetching the info hanlder](aolink-info-handler-example.png)
![ao.link fetching the info handler](aolink-info-handler-example.png)

On the bottom you see the processes balance and all messages send, with the option to break it down into Token transfers and Token balances using the tabs.
![ao.link process message and token info](aolink-message-and-token-example.png)
Expand Down
2 changes: 1 addition & 1 deletion src/guides/snacks/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Sqlite is a relational database engine. In this guide, we will show how you can

> NOTE: make sure you have aos installed, if not checkout [Getting Started](/welcome/getting-started)
spawn a new process `mydb` with a `--sqlite` flag, this instucts ao to use the latest sqlite module.
spawn a new process `mydb` with a `--sqlite` flag, this instructs ao to use the latest sqlite module.

```sh
aos mydb --sqlite
Expand Down
2 changes: 1 addition & 1 deletion src/guides/snacks/weavedrive.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Lets create a new AOS process with WeaveDrive enabled and the wallet we created
aos test-weavedrive --tag-name Extension --tag-value WeaveDrive --tag-name Attestor --tag-value vfSWG3girEwCBggs9xeztuRyiltsT2CJH_m-S8A58yQ --tag-name Availability-Type --tag-value Assignments
```

> NOTE: It does take a few minutes for the data to get 20 plus confirmations which is the treshold for data existing on arweave. You may want to go grab a coffee. :coffee:
> NOTE: It does take a few minutes for the data to get 20 plus confirmations which is the threshold for data existing on arweave. You may want to go grab a coffee. :coffee:
## Install apm and WeaveDrive

Expand Down
6 changes: 3 additions & 3 deletions src/references/ao.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@ Schema

### spawn(module : string, spawn : Spawn\<table>) : Spawn\<table>

The `spawn` function takes a module TXID as the first argument and a full or parital Spawn table. The result will return a full Spawn table. The spawn function will also generate a `Ref_` tag with a unique reference identifier.
The `spawn` function takes a module TXID as the first argument and a full or partial Spawn table. The result will return a full Spawn table. The spawn function will also generate a `Ref_` tag with a unique reference identifier.

**parameters**

| Name | Description | Type |
| ------ | --------------------------------------------------------------------------------------- | ------ |
| module | The TXID that identifies the module binary to use to instaniate the process with | string |
| spawn | The `spawn` full or parital table object that contains the `Data` and `Tags` properties | table |
| module | The TXID that identifies the module binary to use to instantiate the process with | string |
| spawn | The `spawn` full or partial table object that contains the `Data` and `Tags` properties | table |

Schema

Expand Down
2 changes: 1 addition & 1 deletion src/references/cron.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cron Messages

ao has the ability to generate messages on a specified interval, this interval could be seconds, minutes, hours, or blocks. These messages automatically get evaluated by a monitoring process to inform the Process to evalute these messages over time. The result is a real-time Process that can communicate with the full ao network or oracles in the outside network.
ao has the ability to generate messages on a specified interval, this interval could be seconds, minutes, hours, or blocks. These messages automatically get evaluated by a monitoring process to inform the Process to evaluate these messages over time. The result is a real-time Process that can communicate with the full ao network or oracles in the outside network.

## Setting up cron in a process

Expand Down
4 changes: 2 additions & 2 deletions src/references/editor-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ next:

# Editor setup

Remembering all the built in ao functions and utilites can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../guides/aos/modules/index.md) and [globals](../guides/aos/intro.md#globals).
Remembering all the built in ao functions and utilities can sometimes be hard. To enhance your developer experience, it is recommended to install the [Lua Language Server](https://luals.github.io) extension into your favorite text editor and add the [ao addon](https://github.com/martonlederer/ao-definitions). It supports all built in aos [modules](../guides/aos/modules/index.md) and [globals](../guides/aos/intro.md#globals).

## VS Code

Expand All @@ -20,7 +20,7 @@ Install the [sumneko.lua](https://marketplace.visualstudio.com/items?itemName=su
> Lua: Open Addon Manager
```

4. In the Addon Manager, search for "ao", it should be the first result. Click "Enable" and enjoy autcomplete!
4. In the Addon Manager, search for "ao", it should be the first result. Click "Enable" and enjoy autocomplete!

## Other editors

Expand Down
4 changes: 2 additions & 2 deletions src/references/eval.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ await message({
// The arweave TXID of the process, this will become the "target".
process: "process-id", // Replace with the actual process ID

// Tagging the Eval Action so the recieving process evaluates and adds the new Handler from the Data field.
// Tagging the Eval Action so the receiving process evaluates and adds the new Handler from the Data field.
tags: [
{ name: "Action", value: "Eval" },
{ name: "Data", value: 'Handlers.add("ping", Handlers.utils.reply("pong"))' },
Expand All @@ -39,7 +39,7 @@ await message({
// The arweave TXID of the process, this will become the "target".
process: "process-id", // Replace with the actual process ID

// Tagging the Eval Action so the recieving process evaluates and adds the new Handler from the Data field.
// Tagging the Eval Action so the receiving process evaluates and adds the new Handler from the Data field.
tags: [
{ name: "Action", value: "Eval" },
{ name: "Data", value: 'Handlers.add("ping", Handlers.utils.reply("pong"))' },
Expand Down
8 changes: 4 additions & 4 deletions src/references/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A specification-compliant token process responds to a number of different forms

| Name | Description | Read-Only |
| -------- | ------------------------------------------------------------------------------------------------------ | ------------------ |
| Balance | get the balance of an identifer | :heavy_check_mark: |
| Balance | get the balance of an identifier | :heavy_check_mark: |
| Balances | get a list of all ledger/account balances | :heavy_check_mark: |
| Transfer | send 1 or more units from the callers balance to one or move targets with the option to notify targets | :x: |
| Mint | if the ledger process is the root and you would like to increase token supply | :x: |
Expand All @@ -30,7 +30,7 @@ Every compliant token process must carry the following immutable parameters upon
| ------------ | --------------------------------------------------------------------------------------------------------------------- | ------------------ |
| Name | The title of the token, as it should be displayed to users. | :heavy_check_mark: |
| Ticker | A suggested shortened name for the token, such that it can be referenced quickly. | :heavy_check_mark: |
| Logo | An image that applications may deserire to show next to the token, in order to make it quickly visually identifiable. | :heavy_check_mark: |
| Logo | An image that applications may desire to show next to the token, in order to make it quickly visually identifiable. | :heavy_check_mark: |
| Denomination | The number of the token that should be treated as a single unit when quantities and balances are displayed to users. | :x: |

## Messaging Protocol
Expand Down Expand Up @@ -73,7 +73,7 @@ send({
Tags = {
Action = "Balances",
Limit = 1000, # TODO: Is this necessary if the user is paying for the compute and response?
Cursor? = "BalanceIdentifer"
Cursor? = "BalanceIdentifier"
}
})
```
Expand Down Expand Up @@ -236,7 +236,7 @@ handlers.add(

local qty = tonumber(msg.Tags.Quantity)
assert(type(qty) == 'number', 'qty must be number')
-- handlers.utils.reply("Transfering qty")(msg)
-- handlers.utils.reply("Transferring qty")(msg)
if balances[msg.From] >= qty then
balances[msg.From] = balances[msg.From] - qty
balances[msg.Tags.Recipient] = balances[msg.Tags.Recipient] + qty
Expand Down
2 changes: 1 addition & 1 deletion src/releasenotes/aos-2_0_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Create a graphql/sqlite process by using the module name.

### Graphql Modules

You can now bulid graphql processes using the graphql custom module:
You can now build graphql processes using the graphql custom module:

https://github.com/TillaTheHun0/aos-graphq

Expand Down
2 changes: 1 addition & 1 deletion src/releasenotes/aos-2_0_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Create a graphql/sqlite process by using the module name.

### Graphql Modules

You can now bulid graphql processes using the graphql custom module:
You can now build graphql processes using the graphql custom module:

https://github.com/TillaTheHun0/aos-graphql

Expand Down
4 changes: 2 additions & 2 deletions src/tutorials/begin/dao.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This guide brings you through the process of building a DAO using aos. If you have not already, you will need to first build a [token](./token.md) in aos. We will load the DAO code into aos alongside the token code from the [token](./token.md) guide. In the context of ao a DAO may be used to govern MU, CU, and SU nodes.

In our DAO we will implement a process knwon as "slashing". In the case of ao, if a unit is misbehaving, other units may vote to slash them. Slashing means they will lose their stake, we will get more into stake later.
In our DAO we will implement a process known as "slashing". In the case of ao, if a unit is misbehaving, other units may vote to slash them. Slashing means they will lose their stake, we will get more into stake later.

Make a new directory called `dao` and copy in the token.lua created in the token guide.

Expand Down Expand Up @@ -153,7 +153,7 @@ Handlers.add("finalize", function (msg) return -1 end, finalizationHandler)

## Loading and Testing

Now that we have dao.lua complete we can load it into aos alongside token.lua from the [token](./token.md) guide. Run a new aos Proces called `dao` while also loading dao.lua and token.lua
Now that we have dao.lua complete we can load it into aos alongside token.lua from the [token](./token.md) guide. Run a new aos Process called `dao` while also loading dao.lua and token.lua

```sh
aos dao --load token.lua --load dao.lua
Expand Down
Loading

0 comments on commit 1bc1e85

Please sign in to comment.