production (#114)

* ci: add pr check * fix: pr check * fix: pr check * Update Doc “index” * Quick Start Hello World (#95) * Updated hello world content * Updated hello world structure * Updated hello world title * fix: build * fix: build * fix homepage order * Hello world Tutorial (#97) * Updated hello world content * Updated hello world structure * Updated hello world title * fix: updated instructions for correct flow * fix: merge fail * feat: sidebar * Update Doc “quick-start/hello-world/index” * Update Doc “quick-start/explore-running-aelf-side-chain/index” * Update Doc “quick-start/hello-world/index” * Update Doc “quick-start/hello-world/index” * doc: modify doc for aelf-web-login (#99) * doc: modify doc for aelf-web-login * fix: formatting --------- Co-authored-by: yongen.loong <[email protected]> * Update Doc “quick-start/hello-world/index” * Update Doc “quick-start/hello-world/index” * Update index.md * Pushing Lottery smart contract (#100) * Pushing Lottery smart contract * Fixing the structure * Adding the tabs for setup Enviornment * Worked on Vote Smart contract page (#102) * Worked on Vote Smart contract page * Resolved conflict --------- Co-authored-by: Rutvik <[email protected]> * Update Doc “quick-start/lottery-game/index” * Update Doc “quick-start/hello-world/index” * Update Doc “quick-start/lottery-game/index” * Update Doc “quick-start/hello-world/index” * Update Doc “quick-start/vote-contract/index” * Update index.md * Update Doc “quick-start/hello-world/index” * Update Doc “quick-start/overview/index” * Update Doc “quick-start/intro-to-aelf-development/index” * Update Doc “quick-start/intro-to-aelf-development/index” * Update Doc “learn/overview/index” * Delete Doc “quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/index” * Update Doc “tutorials/operate-a-node/run-aelf-on-cloud/index” * Delete Doc “quick-start/run-a-side-chain/index” * Create Doc “quick-start/run-a-mainnet-node/index” * Update Doc “tutorials/smart-contract-development/lottery-game/index” * Update Doc “tutorials/smart-contract-development/vote-contract/index” * Update Doc “tutorials/dapp-development/lottery-game/index” * Update Doc “tutorials/dapp-development/vote-contract/index” * Update Doc “quick-start/explore-running-aelf-side-chain/index” * Create Doc “tutorials/operate-a-node/run-a-side-chain/index” * Update Doc “quick-start/explore-running-aelf-side-chain/index” * Update Doc “tutorials/operate-a-node/run-a-side-chain/index” * Update Doc “tutorials/operate-a-node/run-a-mainnet-node/index” * Update Doc “tutorials/operate-a-node/run-aelf-on-cloud/index” * Update Doc “tutorials/operate-a-node/run-a-testnet-node/index” * Update Doc “quick-start/intro-to-aelf-development/index” * fixed side bar (#106) * fixed side bar * fixed all issues with indexing and wrong mdx format --------- Co-authored-by: zhifenglee-portkey <[email protected]> * Changing folder for Lottery Game (#105) * Changing folder for lotterybank * Restucturing the lottery and vote contracts * Changes for build command --------- Co-authored-by: Rutvik <[email protected]> * Creating a new file for interacting with smart contract (#107) * feat: playground (#108) * Update Doc “tutorials/dapp-development/lottery-game/index” * Update Doc “tutorials/dapp-development/lottery-game-smart-contract/index” * Update Doc “quick-start/lottery-game-smart-contract/index” * fix: sidebar for lottery (#110) Co-authored-by: zhifenglee-portkey <[email protected]> * Update Doc “quick-start/vote-contract/index” * Update Doc “quick-start/lottery-game-smart-contract/index” * fix: sidebar for vote (#111) Co-authored-by: zhifenglee-portkey <[email protected]> * Update Doc “quick-start/intro-to-aelf-development/index” * Update Doc “quick-start/lottery-game-smart-contract/index” * Update Doc “quick-start/vote-contract/index” * Update Doc “quick-start/lottery-game-smart-contract/index” * Feature/lottery amendments (#112) * feat: acs12 correct path * feat: added export contract path simplification * feat: added exporting of contract address * fix: spending contract address explicit --------- Co-authored-by: zhifenglee-portkey <[email protected]> * Update Doc “quick-start/vote-contract/index” * Fix/acs12 removal (#113) * fix: removed acs12 installation since it is already baked in * feat:removed --install and use install instead --------- Co-authored-by: zhifenglee-portkey <[email protected]> * feat: refactor sidebar with category json * fix: sequence in quick start * fix: title * update homepage links --------- Co-authored-by: zenan-aelf <[email protected]> Co-authored-by: vasmohi <[email protected]> Co-authored-by: aelf-lxy <[email protected]> Co-authored-by: AelfHarsh <[email protected]> Co-authored-by: RutvikGhaskataEalf <[email protected]> Co-authored-by: Rutvik <[email protected]> Co-authored-by: zhifenglee-aelf <[email protected]> Co-authored-by: zhifenglee-portkey <[email protected]>
AElfProject · Jul 6, 2024 · d7aceae · d7aceae
1 parent 7d99d53
commit d7aceae
Show file tree

Hide file tree

Showing 118 changed files with 4,112 additions and 1,160 deletions.
diff --git a/docs/_create-wallet.md b/docs/_create-wallet.md
@@ -0,0 +1,9 @@
+To send transactions on the aelf blockchain, you must have a wallet.
+
+Run this command to create aelf wallet.
+
+```bash title="Terminal"
+aelf-command create
+```
+
+![result](/img/create_wallet_output.png)
diff --git a/docs/_deploy-smart-contract.md b/docs/_deploy-smart-contract.md
@@ -0,0 +1,18 @@
+The smart contract needs to be deployed on the chain before users can interact with it.
+
+Run the following command to deploy a contract.
+
+```bash title="Terminal"
+export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1)
+aelf-deploy -a $WALLET_ADDRESS -p $WALLET_PASSWORD -c $CONTRACT_PATH -e https://tdvw-test-node.aelf.io/
+```
+
+Please wait for approximately 1 to 2 minutes. If the deployment is successful, it will provide you with the contract address.
+
+![result](/img/deploy-result.png)
+
+Export your smart contract address:
+
+```bash
+export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS"
+```
diff --git a/docs/_get-testnet-token.md b/docs/_get-testnet-token.md
@@ -0,0 +1,37 @@
+To deploy smart contracts or execute on-chain transactions on aelf, you'll require testnet ELF tokens.
+
+**Get ELF Tokens**
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs>
+  <TabItem value="cli" label="CLI" default>
+
+Run the following command to get testnet ELF tokens from faucet. Remember to either export your wallet address or replace $WALLET_ADDRESS with your wallet address.
+
+```bash title="Terminal"
+curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d ""
+```
+To check your wallet's current ELF balance:
+```bash title="Terminal"
+aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance
+```
+You will be prompted for the following:  
+
+```sh
+Enter the required param <symbol>: **ELF**  
+Enter the required param <owner>: **$WALLET_ADDRESS**
+```
+
+You should see the Result displaying your wallet's ELF balance.
+
+  </TabItem>
+  <TabItem value="web" label="Web" default>
+
+Go to this url [https://faucet-ui.aelf.dev](https://faucet-ui.aelf.dev). Enter your address and click `Get Tokens`.
+
+![result](/img/get-token-ui.png)
+
+  </TabItem>
+</Tabs>
diff --git a/docs/docs/smart-contract-api/_category_.json b/docs/docs/smart-contract-api/_category_.json
@@ -0,0 +1,14 @@
+{
+  "position": 1,
+  "label": "Smart Contract API",
+  "collapsible": true,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index",
+    "title": "Smart Contract API",
+    "slug": "docs/smart-contract-api"
+  },
+  "customProps": {
+    "description": "Useful references for smart contract."
+  }
+}
diff --git a/docs/docs/smart-contract-api/association-contract/index.md b/docs/docs/smart-contract-api/association-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 1
 title: Association Contract
-description: Association contract handles transactions.
+description: Transactions handling
 ---
 
 

diff --git a/docs/docs/smart-contract-api/configuration-contract/index.md b/docs/docs/smart-contract-api/configuration-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 15
 title: Configuration Contract
-description: Manage the configuration on the blockchain. 
+description: Blockchain configuration 
 ---
 
 # Configuration Contract 

diff --git a/docs/docs/smart-contract-api/consensus-contract/index.md b/docs/docs/smart-contract-api/consensus-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 4
 title: Consensus Contract
-description: Manages block producers and data synchronization
+description: Block producers and data
 ---
 
 # Consensus Contract

diff --git a/docs/docs/smart-contract-api/cross-chain-contract/index.md b/docs/docs/smart-contract-api/cross-chain-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 9
 title: Cross Chain Contract
-
+description: ACS1 and ACS7
 ---
 
 

diff --git a/docs/docs/smart-contract-api/economic-contract/index.md b/docs/docs/smart-contract-api/economic-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 13
 title: Economic Contract
-description: Establishes aelf's economic system. 
+description: aelf's economic system
 ---
 
 # Economic Contract

diff --git a/docs/docs/smart-contract-api/election-contract/index.md b/docs/docs/smart-contract-api/election-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 5
 title: Election Contract
-description: Election Contract used for voting for Block Producers. 
+description: Voting for Block Producers
 ---
 
 # Election Contract

diff --git a/docs/docs/smart-contract-api/genesis-contract/index.md b/docs/docs/smart-contract-api/genesis-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 6
 title: Genesis Contract
-description: Manage and Update the deployment of contracts. 
+description: Deployment of contracts
 ---
 
 # Genesis Contract

diff --git a/docs/docs/smart-contract-api/multi-token-contract/index.md b/docs/docs/smart-contract-api/multi-token-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 7
 title: Multi Token Contract
-description: Manage the user's account and transaction fees. 
+description: Account and transaction fees
 
 ---
 

diff --git a/docs/docs/smart-contract-api/parliament-contract/index.md b/docs/docs/smart-contract-api/parliament-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 3
 title: Parliament Contract
-description: Production nodes govern with a two-thirds majority.
+description: Two-thirds majority
 ---
 
 # Parliament Contract

diff --git a/docs/docs/smart-contract-api/profit-contract/index.md b/docs/docs/smart-contract-api/profit-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 8
 title: Profit Contract
-description: Helps in creating a scheme to share bonuses. 
+description: Bonus schemes
 ---
 
 # Profit Contract

diff --git a/docs/docs/smart-contract-api/referendum-contract/index.md b/docs/docs/smart-contract-api/referendum-contract/index.md
@@ -1,8 +1,7 @@
 ---
 sidebar_position: 2
 title: Referendum Contract
-description: Allows user voting on critical governance decisions.
-
+description: Governance decisions
 ---
 
 # Referendum

diff --git a/docs/docs/smart-contract-api/token-convert-contract/index.md b/docs/docs/smart-contract-api/token-convert-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 14
 title: Token Converter Contract
-description: Contract connects the base token with other tokens. 
+description: Connects aelf token with other tokens
 ---
 
 # Token Converter Contract

diff --git a/docs/docs/smart-contract-api/token-holder-contract/index.md b/docs/docs/smart-contract-api/token-holder-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 12
 title: Token Holder Contract
-description: Builds a bonus model for distributing bonuses to holders. 
+description: Token holder bonuses distribution
 ---
 
 # TokenHolder Contract

diff --git a/docs/docs/smart-contract-api/treasury-contract/index.md b/docs/docs/smart-contract-api/treasury-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 10
 title: Treasury Contract
-description: Used for distributing bonuses to voters and candidates. 
+description: Bonus distribution 
 ---
 
 # Treasury Contract

diff --git a/docs/docs/smart-contract-api/vote-contract/index.md b/docs/docs/smart-contract-api/vote-contract/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 11
 title: Vote Contract
-description: Vote contract is an abstract layer for voting. 
+description: Voting activities 
 ---
 
 # Vote Contract

diff --git a/docs/docs/web-api/_category_.json b/docs/docs/web-api/_category_.json
@@ -0,0 +1,14 @@
+{
+  "position": 2,
+  "label": "Web API",
+  "collapsible": true,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index",
+    "title": "Web API",
+    "slug": "docs/web-api"
+  },
+  "customProps": {
+    "description": "Useful references for web."
+  }
+}
diff --git a/docs/docs/web-api/chain-api/index.md b/docs/docs/web-api/chain-api/index.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 1
 title: Chain API
+description: aelf blockchain API Reference
 ---
 
 # Chain API

diff --git a/docs/docs/web-api/net-api/index.md b/docs/docs/web-api/net-api/index.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 2
 title: Net API
+description: aelf network API Reference
 ---
 
 # Net API

diff --git a/docs/index.md b/docs/index.md
@@ -21,34 +21,41 @@ aelf is a high-performance, cloud-native, layer-1 blockchain with Mainnet nodes
 
 ## 🏁 Quick Start
 
-- [Intro](/quick-start/intro-to-aelf-development/) to aelf Development
-- [Develop](/quick-start/develop-your-first-aelf-smart-contract/) your first aelf Smart Contract
+- [Creating](/quick-start/creating-your-first-contract/) your first contract
+- [Vote](/quick-start/vote-contract/) Contract
+- [Lottery Game](/quick-start/lottery-game-smart-contract/) Contract
 - [Become](/quick-start/become-a-node-operator/) a Node Operator
-- [Start](/quick-start/start-and-run-a-node-on-aelf-locally-or-on-cloud/) and run a node on aelf locally or on cloud
-- [Run](/quick-start/run-a-side-chain/) a Side Chain
-- [Explore](/quick-start/explore-running-aelf-side-chain/) running aelf's side chain
+- [Run](/quick-start/run-a-mainnet-node/) a Mainnet node
+- [Create](/quick-start/explore-running-aelf-side-chain/) a side chain
 
 </article>
 
 <article className="col col--4 margin-bottom--lg">
 
-## ⭐️ References
+## 📚 Understanding aelf
 
-- [Web API](/docs/web-api/) - Interact with the aelf blockchain through the web
-- [Smart Contract API](/docs/smart-contract-api/) - Access smart contract functionalities using API
+- [Core](/learn/core/) - aelf's core architecture
+- [Cross-chain](/learn/cross-chain/) - aelf's cross-chain architecture
+- [Consensus](/learn/consensus/) - Understanding aelf's consensus mechanism
+- [Network](/learn/network/) - Exploring aelf's network architecture
+- [Boot Sequence](/learn/boot-sequence/) - Learn about aelf's boot sequence
+- [Addresses](/learn/addresses/) - Managing aelf's blockchain addresses
+- [Transactions](/learn/transactions/) - Handling transaction processes
+- [Smart Contract](/learn/smart-contract/) - aelf's smart contract architecture
+- [ACS Introduction](/learn/acs-introduction/) - An introduction to aelf contract system
 
 </article>
 
 <article className="col col--4 margin-bottom--lg">
 
 ## 📖 Tutorials
 
-- [Smart Contract](/quick-start/develop-your-first-aelf-smart-contract/) Development
+- [Smart Contract](/quick-start/creating-your-first-contract/) Development
 - [Operate a Node](/tutorials/operate-a-node/)
   - Run a [Testnet](/tutorials/operate-a-node/run-a-testnet-node/) Node
   - Run a [Mainnet](/tutorials/operate-a-node/run-a-mainnet-node/) Node
-  - Run a [Side Chain](/tutorials/operate-a-node/run-a-side-chain/)
   - Run aelf on [Cloud](/tutorials/operate-a-node/run-aelf-on-cloud/)
+  - Run a [Side Chain](/tutorials/run-a-side-chain/)
 
 </article>
 
@@ -62,21 +69,17 @@ aelf is a high-performance, cloud-native, layer-1 blockchain with Mainnet nodes
 - [Smart Contract Templates](/tools/smart-contract-templates/) - Templates to quickly build your smart contract
 - [Faucet](/tools/faucet/) - Test your dApp with aelf test tokens
 - [Design](/tools/design/) - Explore aelf design library
+- [Playground](/tools/aelf-playground/) - Play with aelf in your browser
+- [Contract SDK](/tools/contract-sdk/) - C# SDKs
 
 </article>
 
 <article className="col col--4 margin-bottom--lg">
 
-## 📚 Understanding aelf
+## ⭐️ References
 
-- [Core](/learn/core/) - aelf's core architecture
-- [Cross-chain](/learn/cross-chain/) - aelf's cross-chain architecture
-- [Consensus](/learn/consensus/) - Understanding aelf's consensus mechanism
-- [Network](/learn/network/) - Exploring aelf's network architecture
-- [Addresses](/learn/addresses/) - Managing aelf's blockchain addresses
-- [Transactions](/learn/transactions/) - Handling transaction processes
-- [Smart Contract](/learn/smart-contract/) - aelf's smart contract architecture
-- [ACS Introduction](/learn/acs-introduction/) - An introduction to aelf contract system
+- [Smart Contract API](/docs/smart-contract-api/) - Access smart contract functionalities using API
+- [Web API](/docs/web-api/) - Interact with the aelf blockchain through the web
 
 </article>
 

diff --git a/docs/learn/acs-introduction/_category_.json b/docs/learn/acs-introduction/_category_.json
@@ -0,0 +1,14 @@
+{
+  "position": 9,
+  "label": "ACS",
+  "collapsible": true,
+  "collapsed": true,
+  "link": {
+    "type": "generated-index",
+    "title": "aelf Contract Standards",
+    "slug": "learn/acs-introduction"
+  },
+  "customProps": {
+    "description": "aelf Contract Standards"
+  }
+}
diff --git a/docs/learn/acs-introduction/acs0-contract-deployment-standard/index.md b/docs/learn/acs-introduction/acs0-contract-deployment-standard/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 0
-title: ACS0 - Contract Deployment Standard
-description: ACS0 manages contract deployment and updates.
+title: Contract Deployment
+description: ACS0
 ---
 
 # ACS0 - Contract Deployment Standard

diff --git a/docs/learn/acs-introduction/acs1-transaction-fee-standard/index.md b/docs/learn/acs-introduction/acs1-transaction-fee-standard/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 1
-title: ACS1 - Transaction Fee Standard
-description: ACS1 handles transaction fees.
+title: Transaction Fee
+description: ACS1
 ---
 
 # ACS1 - Transaction Fee Standard

diff --git a/docs/learn/acs-introduction/acs10-dividend-pool-standard/index.md b/docs/learn/acs-introduction/acs10-dividend-pool-standard/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 10
-title: ACS10 - Dividend Pool Standard
-description: Creation and management of dividend pools.
+title: Dividend Pool
+description: ACS10
 ---
 
 # ACS10 - Dividend Pool Standard

diff --git a/docs/learn/acs-introduction/acs11-cross-chain-consensus-standard/index.md b/docs/learn/acs-introduction/acs11-cross-chain-consensus-standard/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 11
-title: ACS11 - Cross Chain Consensus Standard
-description: Customize consensus mechanisms for cross-chain operations.
+title: Cross Chain Consensus
+description: ACS11
 ---
 
 # ACS11 - Cross Chain Consensus Standard

diff --git a/docs/learn/acs-introduction/acs12-user-contract-standard/index.md b/docs/learn/acs-introduction/acs12-user-contract-standard/index.md
@@ -1,7 +1,7 @@
 ---
 sidebar_position: 12
-title: ACS12 - User Contract Standard
-description: Manage user contracts. Required on testnet.
+title: User Contract
+description: ACS12
 ---
 
 # ACS12 - User Contract Standard