feat: added allowance-dapp tutorial documentation (#305)

* feat: Added documentation for allowance dapp (step 1-5) * feat/allowance-dapp * fix: Reviewed and fixed allowance dApp tutorial --------- Co-authored-by: vasmohi <[email protected]>
AElfProject · Oct 29, 2024 · 4e25298 · 4e25298
1 parent 130afed
commit 4e25298
Show file tree

Hide file tree

Showing 24 changed files with 1,834 additions and 1 deletion.
diff --git a/docs/quick-start/developers/_deploy_allowance_contract.md b/docs/quick-start/developers/_deploy_allowance_contract.md
@@ -0,0 +1,176 @@
+#### 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:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```bash title="Terminal"
+export WALLET_PASSWORD="YOUR_WALLET_PASSWORD"
+```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+```bash title="Command Prompt"
+$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD"
+```
+</TabItem>
+</Tabs>
+
+#### 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';
+
+<Tabs>
+  <TabItem value="cli" label="CLI" default>
+
+**1. Get Testnet ELF Tokens:**
+
+To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```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 ""
+```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+
+```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 ""
+```
+
+</TabItem>
+</Tabs>
+
+**2. Check ELF Balance:**
+
+To check your ELF balance, use:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```bash title="Terminal"
+aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance
+```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+```bash title="Command Prompt"
+aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance
+```
+</TabItem>
+</Tabs>
+
+You will be prompted for the following:
+
+```sh title="Terminal"
+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 https://faucet-ui.aelf.dev Enter your address and click `Get Tokens`.
+
+![result](/img/get-token-ui.png)
+
+  </TabItem>
+</Tabs>
+
+**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 AllowanceContract.dll.patched to CONTRACT_PATH.
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```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/
+```
+
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+```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/
+```
+
+</TabItem>
+</Tabs>
+
+- 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:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+  ```bash title="Terminal"
+  export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS"
+  ```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+  ```bash title="Command Prompt"
+  $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS"
+  ```
+</TabItem>
+</Tabs>
+
+:::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 Allowance 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_role_contract.md b/docs/quick-start/developers/_deploy_role_contract.md
@@ -0,0 +1,176 @@
+#### 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:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```bash title="Terminal"
+export WALLET_PASSWORD="YOUR_WALLET_PASSWORD"
+```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+```bash title="Command Prompt"
+$env:WALLET_PASSWORD = "YOUR_WALLET_PASSWORD"
+```
+</TabItem>
+</Tabs>
+
+#### 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';
+
+<Tabs>
+  <TabItem value="cli" label="CLI" default>
+
+**1. Get Testnet ELF Tokens:**
+
+To receive testnet ELF tokens, run this command after replacing `$WALLET_ADDRESS` and `$WALLET_PASSWORD` with your wallet details:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```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 ""
+```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+
+```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 ""
+```
+
+</TabItem>
+</Tabs>
+
+**2. Check ELF Balance:**
+
+To check your ELF balance, use:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```bash title="Terminal"
+aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $WALLET_ADDRESS -p $WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance
+```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+```bash title="Command Prompt"
+aelf-command call ASh2Wt7nSEmYqnGxPPzp4pnVDU4uhj1XW9Se5VeZcX2UDdyjx -a $env:WALLET_ADDRESS -p $env:WALLET_PASSWORD -e https://tdvw-test-node.aelf.io GetBalance
+```
+</TabItem>
+</Tabs>
+
+You will be prompted for the following:
+
+```sh title="Terminal"
+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 https://faucet-ui.aelf.dev Enter your address and click `Get Tokens`.
+
+![result](/img/get-token-ui.png)
+
+  </TabItem>
+</Tabs>
+
+**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 RoleContract.dll.patched to CONTRACT_PATH.
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+```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/
+```
+
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+```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/
+```
+
+</TabItem>
+</Tabs>
+
+- 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:
+
+<Tabs>
+<TabItem value="Linux and macOs" label="Linux and macOs" default>
+  ```bash title="Terminal"
+  export CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS"
+  ```
+</TabItem>
+
+<TabItem value="Windows" label="Windows">
+  ```bash title="Command Prompt"
+  $env:CONTRACT_ADDRESS="YOUR_SMART_CONTRACT_ADDRESS e.g. 2LUmicHyH4RXrMjG4beDwuDsiWJESyLkgkwPdGTR8kahRzq5XS"
+  ```
+</TabItem>
+</Tabs>
+
+:::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 Role 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!
+:::