diff --git a/docs/quick-start/developers/_deploy.md b/docs/quick-start/developers/_deploy.md index 7e37d12..61df488 100644 --- a/docs/quick-start/developers/_deploy.md +++ b/docs/quick-start/developers/_deploy.md @@ -24,9 +24,19 @@ aelf-command create - Next, enter and confirm your password. Then export your wallet password as shown below: + + ```bash title="Terminal" export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" ``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + #### Acquire Testnet Tokens (Faucet) for Development @@ -44,18 +54,46 @@ import TabItem from '@theme/TabItem'; To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + ```bash title="Terminal" export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" ``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + **2. Check ELF Balance:** To check your ELF balance, use: + + ```bash title="Terminal" aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance ``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + You will be prompted for the following: @@ -80,8 +118,10 @@ Go to https://faucet-ui.aelf.dev Enter your address and click `Get Tokens`. The smart contract needs to be deployed on the chain before users can interact with it. -Run the following command to deploy a contract. Remember to export the path of LotteryGame.dll.patched to CONTRACT_PATH. +Run the following command to deploy a contract. Remember to export the path of HelloWorld.dll.patched to CONTRACT_PATH. + + ```bash title="Terminal" export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) ``` @@ -90,17 +130,42 @@ 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/ ``` + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + ![result](/img/deploy-result.png) - Copy the smart contract address from the `address` field -![result](/img/Contract_Address.png) + ![result](/img/Contract_Address.png) - Export your smart contract address: - ```bash title="Terminal" - export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" - ``` + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + :::tip ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! diff --git a/docs/quick-start/developers/_deploy_dao.md b/docs/quick-start/developers/_deploy_dao.md new file mode 100644 index 0000000..5466ef8 --- /dev/null +++ b/docs/quick-start/developers/_deploy_dao.md @@ -0,0 +1,178 @@ +#### Create A Wallet + +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) + +- You will be prompted to save your account, please do **save** your account as shown below: + +```bash title="Terminal" +? Save account info into a file? (Y/n) Y +``` + +**Make sure to choose Y to save your account information.** + +:::tip +ℹ️ Note: If you do not save your account information (by selecting n or N), do not export the wallet password. Only **proceed to the next** step if you have saved your account information. +::: + +- Next, enter and confirm your password. Then export your wallet password as shown below: + + + +```bash title="Terminal" +export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" +``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + + +#### Acquire Testnet Tokens (Faucet) for Development + +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'; + + + + +**1. Get Testnet ELF Tokens:** + +To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + + +```bash title="Terminal" +export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" +curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" +``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + + +**2. Check ELF Balance:** + +To check your ELF balance, use: + + + +```bash title="Terminal" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + + +You will be prompted for the following: + +```sh title="Terminal" +Enter the required param : ELF +Enter the required param : **$WALLET_ADDRESS** +``` + +You should see the result displaying your wallet's ELF balance. + + + + +Go to https://faucet-ui.aelf.dev Enter your address and click `Get Tokens`. + +![result](/img/get-token-ui.png) + + + + +**Deploy Smart Contract:** + +The smart contract needs to be deployed on the chain before users can interact with it. + +Run the following command to deploy a contract. Remember to export the path of BuildersDAO.dll.patched to CONTRACT_PATH. + + + +```bash title="Terminal" +export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) +``` + +```bash title="Terminal" +aelf-deploy -a $WALLET_ADDRESS -p $WALLET_PASSWORD -c $CONTRACT_PATH -e https://tdvw-test-node.aelf.io/ +``` + + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + +- Copy the smart contract address from the `address` field + ![result](/img/Contract_Address.png) + +- Export your smart contract address: + + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + +:::tip +ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! +::: + +:::info +🎉 You have successfully deployed your dApp smart contract on the aelf testnet! In the next steps, we will be building the frontend components that allow us to interact with our deployed smart contract! +::: + + diff --git a/docs/quick-start/developers/_deploy_expense_tracker.md b/docs/quick-start/developers/_deploy_expense_tracker.md index da7b0c1..1b79bd6 100644 --- a/docs/quick-start/developers/_deploy_expense_tracker.md +++ b/docs/quick-start/developers/_deploy_expense_tracker.md @@ -24,9 +24,19 @@ aelf-command create - Next, enter and confirm your password. Then export your wallet password as shown below: + + ```bash title="Terminal" export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" ``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + #### Acquire Testnet Tokens (Faucet) for Development @@ -44,18 +54,46 @@ import TabItem from '@theme/TabItem'; To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + ```bash title="Terminal" export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" ``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + **2. Check ELF Balance:** To check your ELF balance, use: + + ```bash title="Terminal" aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance ``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + You will be prompted for the following: @@ -82,6 +120,8 @@ The smart contract needs to be deployed on the chain before users can interact w Run the following command to deploy a contract. Remember to export the path of ExpenseTracker.dll.patched to CONTRACT_PATH. + + ```bash title="Terminal" export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) ``` @@ -90,17 +130,42 @@ 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/ ``` + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + ![result](/img/deploy-result.png) - Copy the smart contract address from the `address` field -![result](/img/Contract_Address.png) + ![result](/img/Contract_Address.png) - Export your smart contract address: - ```bash title="Terminal" - export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" - ``` + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + :::tip ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! diff --git a/docs/quick-start/developers/_deploy_lottery.md b/docs/quick-start/developers/_deploy_lottery.md new file mode 100644 index 0000000..77249bb --- /dev/null +++ b/docs/quick-start/developers/_deploy_lottery.md @@ -0,0 +1,178 @@ +#### Create A Wallet + +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) + +- You will be prompted to save your account, please do **save** your account as shown below: + +```bash title="Terminal" +? Save account info into a file? (Y/n) Y +``` + +**Make sure to choose Y to save your account information.** + +:::tip +ℹ️ Note: If you do not save your account information (by selecting n or N), do not export the wallet password. Only **proceed to the next** step if you have saved your account information. +::: + +- Next, enter and confirm your password. Then export your wallet password as shown below: + + + +```bash title="Terminal" +export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" +``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + + +#### Acquire Testnet Tokens (Faucet) for Development + +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'; + + + + +**1. Get Testnet ELF Tokens:** + +To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + + +```bash title="Terminal" +export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" +curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" +``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + + +**2. Check ELF Balance:** + +To check your ELF balance, use: + + + +```bash title="Terminal" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + + +You will be prompted for the following: + +```sh title="Terminal" +Enter the required param : ELF +Enter the required param : **$WALLET_ADDRESS** +``` + +You should see the result displaying your wallet's ELF balance. + + + + +Go to https://faucet-ui.aelf.dev Enter your address and click `Get Tokens`. + +![result](/img/get-token-ui.png) + + + + +**Deploy Smart Contract:** + +The smart contract needs to be deployed on the chain before users can interact with it. + +Run the following command to deploy a contract. Remember to export the path of LotteryGame.dll.patched to CONTRACT_PATH. + + + +```bash title="Terminal" +export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) +``` + +```bash title="Terminal" +aelf-deploy -a $WALLET_ADDRESS -p $WALLET_PASSWORD -c $CONTRACT_PATH -e https://tdvw-test-node.aelf.io/ +``` + + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + +- Copy the smart contract address from the `address` field + ![result](/img/Contract_Address.png) + +- Export your smart contract address: + + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + +:::tip +ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! +::: + +:::info +🎉 You have successfully deployed your dApp smart contract on the aelf testnet! In the next steps, we will be building the frontend components that allow us to interact with our deployed smart contract! +::: + + diff --git a/docs/quick-start/developers/_deploy_single_pool_staking.md b/docs/quick-start/developers/_deploy_single_pool_staking.md index 71e7af2..a334c07 100644 --- a/docs/quick-start/developers/_deploy_single_pool_staking.md +++ b/docs/quick-start/developers/_deploy_single_pool_staking.md @@ -24,9 +24,19 @@ aelf-command create - Next, enter and confirm your password. Then export your wallet password as shown below: + + ```bash title="Terminal" export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" ``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + #### Acquire Testnet Tokens (Faucet) for Development @@ -44,18 +54,46 @@ import TabItem from '@theme/TabItem'; To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + ```bash title="Terminal" export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" ``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + **2. Check ELF Balance:** To check your ELF balance, use: + + ```bash title="Terminal" aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance ``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + You will be prompted for the following: @@ -82,6 +120,8 @@ The smart contract needs to be deployed on the chain before users can interact w Run the following command to deploy a contract. Remember to export the path of SinglePoolStaking.dll.patched to CONTRACT_PATH. + + ```bash title="Terminal" export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) ``` @@ -90,17 +130,42 @@ 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/ ``` + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + ![result](/img/deploy-result.png) - Copy the smart contract address from the `address` field -![result](/img/Contract_Address.png) + ![result](/img/Contract_Address.png) - Export your smart contract address: - ```bash title="Terminal" - export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" - ``` + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + :::tip ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! diff --git a/docs/quick-start/developers/_deploy_tic_tac_toe.md b/docs/quick-start/developers/_deploy_tic_tac_toe.md index 887713a..c560d69 100644 --- a/docs/quick-start/developers/_deploy_tic_tac_toe.md +++ b/docs/quick-start/developers/_deploy_tic_tac_toe.md @@ -24,9 +24,19 @@ aelf-command create - Next, enter and confirm your password. Then export your wallet password as shown below: + + ```bash title="Terminal" export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" ``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + #### Acquire Testnet Tokens (Faucet) for Development @@ -44,18 +54,46 @@ import TabItem from '@theme/TabItem'; To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + ```bash title="Terminal" export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" ``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + **2. Check ELF Balance:** To check your ELF balance, use: + + ```bash title="Terminal" aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance ``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + You will be prompted for the following: @@ -82,6 +120,8 @@ The smart contract needs to be deployed on the chain before users can interact w Run the following command to deploy a contract. Remember to export the path of TicTacToe.dll.patched to CONTRACT_PATH. + + ```bash title="Terminal" export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) ``` @@ -90,17 +130,42 @@ 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/ ``` + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + ![result](/img/deploy-result.png) - Copy the smart contract address from the `address` field -![result](/img/Contract_Address.png) + ![result](/img/Contract_Address.png) - Export your smart contract address: - ```bash title="Terminal" - export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" - ``` + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + :::tip ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! diff --git a/docs/quick-start/developers/_deploy_todo.md b/docs/quick-start/developers/_deploy_todo.md index badbeb5..a3647a9 100644 --- a/docs/quick-start/developers/_deploy_todo.md +++ b/docs/quick-start/developers/_deploy_todo.md @@ -24,9 +24,19 @@ aelf-command create - Next, enter and confirm your password. Then export your wallet password as shown below: + + ```bash title="Terminal" export WALLET_PASSWORD="YOUR_WALLET_PASSWORD" ``` + + + +```bash title="Command Prompt" +$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD" +``` + + #### Acquire Testnet Tokens (Faucet) for Development @@ -44,18 +54,46 @@ import TabItem from '@theme/TabItem'; To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details: + + ```bash title="Terminal" export WALLET_ADDRESS="YOUR_WALLET_ADDRESS" curl -X POST "https://faucet.aelf.dev/api/claim?walletAddress=$WALLET_ADDRESS" -H "accept: application/json" -d "" ``` + + + + +```bash title="Command Prompt" +$headers = @{ + "accept" = "application/json" +} + +$env:WALLET_ADDRESS = "YOUR_WALLET_ADDRESS" + +Invoke-WebRequest -Uri "https://faucet.aelf.dev/api/claim?walletAddress=$env:WALLET_ADDRESS" -Method POST -Headers $headers -Body "" +``` + + + **2. Check ELF Balance:** To check your ELF balance, use: + + ```bash title="Terminal" aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance ``` + + + +```bash title="Command Prompt" +aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance +``` + + You will be prompted for the following: @@ -82,6 +120,8 @@ The smart contract needs to be deployed on the chain before users can interact w Run the following command to deploy a contract. Remember to export the path of ToDoApp.dll.patched to CONTRACT_PATH. + + ```bash title="Terminal" export CONTRACT_PATH=$(find ~+ . -path "*patched*" | head -n 1) ``` @@ -90,17 +130,42 @@ 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/ ``` + + + +```bash title="Command Prompt" +$CONTRACT_PATH = Get-ChildItem -Recurse -Filter "*patched*" | Select-Object -First 1 -ExpandProperty FullName +$env:CONTRACT_PATH = $CONTRACT_PATH +``` + +```bash title="Command Prompt" +aelf-deploy -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -c $env: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) + ![result](/img/deploy-result.png) - Copy the smart contract address from the `address` field -![result](/img/Contract_Address.png) + ![result](/img/Contract_Address.png) - Export your smart contract address: - ```bash title="Terminal" - export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" - ``` + + + ```bash title="Terminal" + export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + + + ```bash title="Command Prompt" + $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS" + ``` + + :::tip ℹ️ Note: You are to copy the smart contract address as we will be referencing it in the next steps! @@ -109,5 +174,3 @@ aelf-deploy -a $WALLET_ADDRESS -p $WALLET_PASSWORD -c $CONTRACT_PATH -e https:// :::info 🎉 You have successfully deployed your ToDo dApp smart contract on the aelf testnet! In the next steps, we will be building the frontend components that allow us to interact with our deployed smart contract! ::: - - diff --git a/docs/quick-start/developers/_setup.md b/docs/quick-start/developers/_setup.md index 7de2c35..ed9d4ef 100644 --- a/docs/quick-start/developers/_setup.md +++ b/docs/quick-start/developers/_setup.md @@ -12,9 +12,19 @@ import TabItem from '@theme/TabItem'; - [Install dotnet 8.0.x SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) - Install aelf contract templates + + ```bash title="Terminal" dotnet new --install AElf.ContractTemplates ``` + + + +```bash title="Command Prompt" +dotnet new install AElf.ContractTemplates +``` + + AELF.ContractTemplates contains various predefined templates for the ease of developing smart contracts on the aelf blockchain. @@ -46,7 +56,7 @@ sudo npm i -g aelf-command -```bash title="Terminal" +```bash title="Command Prompt" npm i -g aelf-command ``` diff --git a/docs/quick-start/developers/dao-dapp/index.md b/docs/quick-start/developers/dao-dapp/index.md index ea3363b..3d3e390 100644 --- a/docs/quick-start/developers/dao-dapp/index.md +++ b/docs/quick-start/developers/dao-dapp/index.md @@ -59,7 +59,7 @@ sudo npm i -g aelf-command -```bash title="Terminal" +```bash title="Command Prompt" npm i -g aelf-command ``` @@ -663,7 +663,7 @@ You should see **BuildersDAO.dll.patched** in the directory `src/bin/Debug/net.6 ## Step 3 - Deploy Smart Contract -import Deploy from "../\_deploy.md" +import Deploy from "../\_deploy_dao.md" diff --git a/docs/quick-start/developers/lottery-game-smart-contract/index.md b/docs/quick-start/developers/lottery-game-smart-contract/index.md index ccd37b9..d0e8f5c 100644 --- a/docs/quick-start/developers/lottery-game-smart-contract/index.md +++ b/docs/quick-start/developers/lottery-game-smart-contract/index.md @@ -1309,7 +1309,7 @@ You should see **LotteryGame.dll.patched** in the directory `lottery_game/src/bi ## Step 3 - Deploy Smart Contract -import Deploy from "../\_deploy.md" +import Deploy from "../\_deploy_lottery.md" diff --git a/docs/quick-start/developers/nft-dapp/index.md b/docs/quick-start/developers/nft-dapp/index.md index d1fed28..08c6b15 100644 --- a/docs/quick-start/developers/nft-dapp/index.md +++ b/docs/quick-start/developers/nft-dapp/index.md @@ -139,7 +139,7 @@ sudo npm install -```bash title="Terminal" +```bash title="Command Prompt" npm install ``` diff --git a/docs/quick-start/developers/single-pool-staking-dapp/index.md b/docs/quick-start/developers/single-pool-staking-dapp/index.md index 146f460..218e010 100644 --- a/docs/quick-start/developers/single-pool-staking-dapp/index.md +++ b/docs/quick-start/developers/single-pool-staking-dapp/index.md @@ -1373,7 +1373,7 @@ sudo npm install -```bash title="Terminal" +```bash title="Command Prompt" npm install ```