diff --git a/docs/develop/get-started/art-dev-intro/index.md b/docs/develop/get-started/art-dev-intro/index.md index 9d691ec7..962b5897 100644 --- a/docs/develop/get-started/art-dev-intro/index.md +++ b/docs/develop/get-started/art-dev-intro/index.md @@ -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). diff --git a/docs/develop/guides/contract-via-aspect/index.md b/docs/develop/guides/contract-via-aspect/index.md index a887c929..adfe84a1 100644 --- a/docs/develop/guides/contract-via-aspect/index.md +++ b/docs/develop/guides/contract-via-aspect/index.md @@ -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 @@ -249,4 +248,4 @@ If the command is executed successfully, will see ```shell ==== reuslt=== true ``` - \ No newline at end of file + diff --git a/docs/develop/guides/operation-aspect/index.md b/docs/develop/guides/operation-aspect/index.md index 30d9a144..e018c290 100644 --- a/docs/develop/guides/operation-aspect/index.md +++ b/docs/develop/guides/operation-aspect/index.md @@ -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 @@ -188,4 +187,4 @@ If the command succeeded, you will see a receipt like this: type: '0x0' } -``` \ No newline at end of file +``` diff --git a/docs/develop/guides/reentrancy-guard/index.md b/docs/develop/guides/reentrancy-guard/index.md index 154285d9..d2d5e6dc 100644 --- a/docs/develop/guides/reentrancy-guard/index.md +++ b/docs/develop/guides/reentrancy-guard/index.md @@ -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. @@ -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) - \ No newline at end of file + diff --git a/docs/develop/guides/verify-aspect/index.md b/docs/develop/guides/verify-aspect/index.md index 21d8c61d..2527b9f5 100644 --- a/docs/develop/guides/verify-aspect/index.md +++ b/docs/develop/guides/verify-aspect/index.md @@ -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: diff --git a/docs/develop/node/run-full-node/index.md b/docs/develop/node/run-full-node/index.md index 7126b779..c45622fd 100644 --- a/docs/develop/node/run-full-node/index.md +++ b/docs/develop/node/run-full-node/index.md @@ -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` diff --git a/docs/develop/reference/aspect-lib/aspect-structure/index.md b/docs/develop/reference/aspect-lib/aspect-structure/index.md index 62c39261..f67c4b8b 100644 --- a/docs/develop/reference/aspect-lib/aspect-structure/index.md +++ b/docs/develop/reference/aspect-lib/aspect-structure/index.md @@ -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: @@ -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. - \ No newline at end of file + diff --git a/docs/develop/reference/aspect-lib/components/3-sys-hostapi/index.md b/docs/develop/reference/aspect-lib/components/3-sys-hostapi/index.md index 8fc7a9ba..5136433c 100644 --- a/docs/develop/reference/aspect-lib/components/3-sys-hostapi/index.md +++ b/docs/develop/reference/aspect-lib/components/3-sys-hostapi/index.md @@ -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 diff --git a/docs/develop/reference/aspect-lib/components/5-helper/index.md b/docs/develop/reference/aspect-lib/components/5-helper/index.md index eeda96f7..38f6de91 100644 --- a/docs/develop/reference/aspect-lib/components/5-helper/index.md +++ b/docs/develop/reference/aspect-lib/components/5-helper/index.md @@ -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. ```typescript @@ -411,7 +411,7 @@ function base64Decode(str: string): Uint8Array * 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 diff --git a/docs/develop/reference/aspect-lib/operation/index.md b/docs/develop/reference/aspect-lib/operation/index.md index a5921f88..74edfd69 100644 --- a/docs/develop/reference/aspect-lib/operation/index.md +++ b/docs/develop/reference/aspect-lib/operation/index.md @@ -204,5 +204,5 @@ sys.log( 'aspect.version' + ' ' + aspectVerData.data.toString(10)); | aspect.id | BytesData | Returns current aspect id. | | aspect.version | UintData | 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. \ No newline at end of file +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. diff --git a/docs/develop/reference/aspect-lib/overview/index.md b/docs/develop/reference/aspect-lib/overview/index.md index aa309f2b..7696b724 100644 --- a/docs/develop/reference/aspect-lib/overview/index.md +++ b/docs/develop/reference/aspect-lib/overview/index.md @@ -6,8 +6,8 @@ sidebar_position: 2 ## Introduction -A [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 +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. diff --git a/docs/develop/reference/aspect-tool/create-account/index.md b/docs/develop/reference/aspect-tool/create-account/index.md index 05de7fcf..4c780f50 100644 --- a/docs/develop/reference/aspect-tool/create-account/index.md +++ b/docs/develop/reference/aspect-tool/create-account/index.md @@ -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. diff --git a/docs/develop/reference/aspect-tool/init/index.md b/docs/develop/reference/aspect-tool/init/index.md index 99fd2506..c16ebf8d 100644 --- a/docs/develop/reference/aspect-tool/init/index.md +++ b/docs/develop/reference/aspect-tool/init/index.md @@ -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. @@ -88,4 +88,4 @@ The command automatically creates the recommended directory structure and config "yargs": "last Version" } } -``` \ No newline at end of file +``` diff --git a/docs/develop/reference/aspect-tool/operation/index.md b/docs/develop/reference/aspect-tool/operation/index.md index cb56c4c3..13cf367a 100644 --- a/docs/develop/reference/aspect-tool/operation/index.md +++ b/docs/develop/reference/aspect-tool/operation/index.md @@ -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} \ @@ -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} \ diff --git a/docs/develop/reference/aspect-tool/overview/index.md b/docs/develop/reference/aspect-tool/overview/index.md index b8198068..3c922c5d 100644 --- a/docs/develop/reference/aspect-tool/overview/index.md +++ b/docs/develop/reference/aspect-tool/overview/index.md @@ -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) diff --git a/docs/develop/validate/security/index.md b/docs/develop/validate/security/index.md index 626476de..a7253bc5 100644 --- a/docs/develop/validate/security/index.md +++ b/docs/develop/validate/security/index.md @@ -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 | |-------------------|---------------------------------|