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

Update index.md (fix typos) #45

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion docs/develop/get-started/art-dev-intro/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Artela blockchain defines a new programmable module to work as native extension,

You can maintain the core logic within EVM smart contracts, and implement custom features in Aspects using the gas-efficient and computational powerful WASM runtime, all in a plug-and-play manner.

The initial version of Artela Aspect is built with [Assembly Script](https://www.assemblyscript.org/)(a sub set of TypeScript, strictly typed).
The initial version of Artela Aspect is built with [Assembly Script](https://www.assemblyscript.org/) (a sub set of TypeScript, strictly typed).

<!-- The name “Aspect” is inspired by Aspect-oriented Programming. Aspect can tap into the complete API set of the base layer, and inject extended logic into specific join points during a transaction's lifecycle. -->

Expand Down
5 changes: 2 additions & 3 deletions docs/develop/guides/contract-via-aspect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ npm run account:create

✅ If an account gets created successfully, its private key will be dumped as `privateKey.txt` in the current directory.

If you don't have a test token in your account, please join [our discard](https://discord.com/invite/artela)
,require testnet faucet.
If you don't have a test token in your account, please join [our Discord](https://discord.com/invite/artela),require testnet faucet.

## 3. Create Smart Contract

Expand Down Expand Up @@ -249,4 +248,4 @@ If the command is executed successfully, will see
```shell
==== reuslt=== true
```


5 changes: 2 additions & 3 deletions docs/develop/guides/operation-aspect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ npm run account:create
If the command is executed successfully, the following log will be printed and a `privateKey.txt` file will be
generated.

If you don't have a test token in your account, please join [our discard](https://discord.com/invite/artela)
,require testnet faucet.
If you don't have a test token in your account, please join [our Discord](https://discord.com/invite/artela),require testnet faucet.

## 3. Create Aspect

Expand Down Expand Up @@ -188,4 +187,4 @@ If the command succeeded, you will see a receipt like this:
type: '0x0'
}

```
```
5 changes: 2 additions & 3 deletions docs/develop/guides/reentrancy-guard/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ npm run account:create -- --skfile ./attack_accounts.txt

```

If you don't have a test token in your account, please join [our discard](https://discord.com/invite/artela)
,require testnet faucet.
If you don't have a test token in your account, please join [our Discord](https://discord.com/invite/artela),require testnet faucet.

If you lack test tokens, request some in our [Discord]((https://discord.com/invite/artela)) testnet-faucet channel.

Expand Down Expand Up @@ -314,4 +313,4 @@ Execute the re-entrant attack on the simplified Curve contract with Aspect prote
If the protection succeeded, you will see the transaction reverted.

![img.svg](img.svg)


2 changes: 1 addition & 1 deletion docs/develop/guides/verify-aspect/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ the [bind-aspect command](/develop/reference/aspect-tool/bind-aspect) documentat

## 6. Test the Smart Contract and Aspect Integration

Within the `scripts` directory of your project,Create a Verify tx call script that generates a transaction that is not
Within the `scripts` directory of your project, create a verify tx call script that generates a transaction that is not
signed by {owner} and uses the password provided by {owner} to make the transaction.
For example, create a `verify.cjs` file:

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/node/run-full-node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ mv genesis.json $HOME/.artelad/config/genesis.json

**3). Configure**

Get presistent seeds from [2. Persistent nodes](./access-testnet#public-information-on-testnet)
Get persistent seeds from [2. Persistent nodes](./access-testnet#public-information-on-testnet)

Add two of them to `seeds` in `config.toml`

Expand Down
4 changes: 2 additions & 2 deletions docs/develop/reference/aspect-lib/aspect-structure/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The init command automatically creates the recommended directory structure and c
└── tsconfig.json
```

### 2. Create a Aspect
### 2. Create an Aspect

Within the `./aspect` directory of your project, create your aspect files with a `.ts` extension.
For example, create a `HelloWorld.ts` file:
Expand Down Expand Up @@ -185,4 +185,4 @@ Doing so will emit the compiled binaries, bindings and definition files to the `
use [@artela/aspect-tool](/develop/reference/aspect-tool/overview). The tool offers functionality to create Aspect
development scaffolding and seamlessly integrates with the Artela Blockchain.



Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public get(key: string): Uint8Array

* Returns
* data: Uint8Array,The data type returned varies depending on the key of the
query,Each key table for every join point has a column named "Value Type" to display the corresponding return type for that key. for example: [PreContractCall Key table's](/develop/reference/aspect-lib/join-points/pre-contract-call#key-table) Value type.
query, each key table for every join point has a column named "Value Type" to display the corresponding return type for that key. for example: [PreContractCall Key table's](/develop/reference/aspect-lib/join-points/pre-contract-call#key-table) Value type.

* Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ import {

## 11. decodeUTF8

> Decodes the specified buffer from UTF-8 bytes to a string, optionally null terminated..
> Decodes the specified buffer from UTF-8 bytes to a string, optionally null terminated.

<!-- @formatter:off -->
```typescript
Expand Down Expand Up @@ -411,7 +411,7 @@ function base64Decode(str: string): Uint8Array
<!-- @formatter:on -->

* Parameter
* str: string; The input sting to be decoded.
* str: string; The input string to be decoded.
* Returns
* result: Uint8Array; The base64 decoded Uint8Array.
* Example
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/reference/aspect-lib/operation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,5 +204,5 @@ sys.log( 'aspect.version' + ' ' + aspectVerData.data.toString(10));
| aspect.id | <a href="/api/docs/classes/proto.BytesData.html" target="_blank">BytesData</a> | Returns current aspect id. |
| aspect.version | <a href="/api/docs/classes/proto.UintData.html" target="_blank">UintData</a> | Returns current aspect version. |

Here is a case demonstration on how to [create a operation call](/develop/guides/operation-aspect).
Through this example, you can gain a clearer understanding of how to utilize Operation Interface.
Here is a case demonstration on how to [create an operation call](/develop/guides/operation-aspect).
Through this example, you can gain a clearer understanding of how to utilize Operation Interface.
4 changes: 2 additions & 2 deletions docs/develop/reference/aspect-lib/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_position: 2

## Introduction

A [AssemblyScript](https://assemblyscript.bootcss.com/) library for writing aspect to be deployed to
ArtelaThe `aspect-libs` provides Host APIs to interact with the Aspect
An [AssemblyScript](https://assemblyscript.bootcss.com/) library for writing aspect to be deployed to
Artela. The `aspect-libs` provides Host APIs to interact with the Aspect
runtime, with this set of APIs, you can access blockchain data, smart
contracts, cryptographic functions, invoking system calls and more.

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/reference/aspect-tool/create-account/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Create a Account
# Create an Account

This command can quickly create a new account in the project, and you will use it in other commands which need to sign
transactions, and you also can use it in your test scripts.
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/reference/aspect-tool/init/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ aspect-tool init

The command automatically creates the recommended directory structure and configuration files:

* `./aspect` Directory used to store the aspect you wrote. this sources being compiled to WebAssembly, more details to learn [how to write an aspect](/develop/reference/aspect-lib/aspect-structure).
* `./aspect` Directory used to store the aspect you wrote. This sources being compiled to WebAssembly, more details to learn [how to write an aspect](/develop/reference/aspect-lib/aspect-structure).

* `./aspect/index.ts` Default entry file being compiled to WebAssembly to get you started.

Expand Down Expand Up @@ -88,4 +88,4 @@ The command automatically creates the recommended directory structure and config
"yargs": "last Version"
}
}
```
```
4 changes: 2 additions & 2 deletions docs/develop/reference/aspect-tool/operation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on concepts related to Operation, please refer to:

### 1. Operation call

This Command allows you to query the state of a Aspect Operation Interface or perform read-only operations without creating a new transaction on the blockchain.
This Command allows you to query the state of an Aspect Operation Interface or perform read-only operations without creating a new transaction on the blockchain.

```bash
npm run operation:call -- --skfile {privateKey-path} \
Expand Down Expand Up @@ -48,7 +48,7 @@ operation call result: test

### 2. Operation Send

This Command sending a Operation transaction refers to the process of initiating and broadcasting a transaction on the Ethereum blockchain.
This Command sending an Operation transaction refers to the process of initiating and broadcasting a transaction on the Ethereum blockchain.

```bash
npm run operation:send -- --skfile {privateKey-path} \
Expand Down
2 changes: 1 addition & 1 deletion docs/develop/reference/aspect-tool/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ FLAGS

* [Init project](/develop/reference/aspect-tool/init)
* [Configuration](/develop/reference/aspect-tool/config)
* [Create a account](/develop/reference/aspect-tool/create-account)
* [Create an account](/develop/reference/aspect-tool/create-account)
* [Build contract](/develop/reference/aspect-tool/build-contract)
* [Deploy contract](/develop/reference/aspect-tool/deploy-contract)
* [Build Aspect](/develop/reference/aspect-tool/build-aspect)
Expand Down
4 changes: 2 additions & 2 deletions docs/develop/validate/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ For example, the environment variable `AA_CHAIN_ID` will map to the command line
## Checklist

Find below a security checklist survey to go through the security measures of a validator.
Conduct survey on the hosting data centre and Node Setup, and compare your result with the best practice suggested below.
Conduct survey on the hosting data center and Node Setup, and compare your result with the best practice suggested below.

### General Controls of Hosting Data Centre
### General Controls of Hosting Data Center

| Controls Category | Description of Best Practice |
|-------------------|---------------------------------|
Expand Down