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

feat(docs): adds companion app page in fetch network guides #1095

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
Draft
6 changes: 5 additions & 1 deletion .github/spelling/known_words_corpus.txt
Original file line number Diff line number Diff line change
Expand Up @@ -743,8 +743,12 @@ AA
githubcodesegment
codesegment
jobsearchagent
blockscope
tps
24h
webhook
rehype
remarkmath
katex
rehypekatex
webhook
webhook
5 changes: 5 additions & 0 deletions pages/guides/fetch-network/asi-wallet/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,10 @@
"title": "Install ASI Alliance browser extension wallet with Ledger hardware wallet",
"tags": ["Beginner", "Python", "Wallet"],
"timestamp": true
},
"companion-app": {
"title": "ASI Wallet Companion App",
"tags": ["Intermediate", "Companion App"],
"timestamp": true
}
}
77 changes: 77 additions & 0 deletions pages/guides/fetch-network/asi-wallet/companion-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# ASI Wallet Companion App

## Introduction

Within the Fetch Network, an essential tool is the **Companion App** which works similarly to any block explorer, thus offering the opportunity for users to navigate and analyze the Fetch.ai blockchain network data and related information.

You can access the Companion App [here ↗️](https://companion.fetch.ai/fetchhub-4/blocks).

Overall, an explorer provides a user-friendly interface for viewing and tracking on-chain activities, including transactions, blocks, smart contracts, wallet addresses and so on. By allowing users to search for and verify blockchain data, a block explorer serves as an essential resource for developers, researchers, and anyone looking to understand the workings of a blockchain ecosystem.

## Companion App Functionalities

### Blocks Page

The **Blocks** page of the Companion App UI provides a detailed breakdown of each specific block, making it easy for users to analyze individual transactions and understand the context of on-chain activities. It is useful for developers, network validators, and anyone looking to verify or trace transactions on the blockchain.

![](src/images/companion-app/companion-app_1.png)

The Block Summary provides a high-level overview of recent network activity, including:

- **Block Height**: it indicates the latest block number on the blockchain.
- **Block Count (last 24h)**: it shows the number of blocks created in the past 24 hours.
- **Transaction Count (last 24h)**: it displays the total number of transactions processed in the last 24 hours.
- **Block Time**: it is the average time it takes to create a new block, measured in seconds.

On the other hand, the _Recent Blocks_ section provides a table that lists the most recent blocks added to the blockchain, thus making it easy for users to track historical block data. The page offers multiple data details, including:

- **Block Number (Hash)**: it displays the unique block number and its associated hash. Clicking on the block number or hash may lead to a detailed block view.
- **Created At**: it is the timestamp when the block was created, along with how long ago it occurred.
- **Proposer**: it is the validator that proposed the block. Validators' names (e.g., Kiln, Altruistic Automaton, Blockscope.net) are shown alongside their icons or logos.
- **Transaction Count (Tx count)**: it is the number of transactions included within each block.

You can click on a specific Block, you can enter the _Block Details_ page. This page provides in-depth information about the specific block on the blockchain:

![](src/images/companion-app/companion-app_2.png)

Here, you can explore multiple information about the specific Block you choose, including:

- **Block Height**: it indicates the block's position in the blockchain.
- **Block Time**: it displays the time the block was created, with the timestamp and time elapsed. It also indicates if the block time is Expected or otherwise.
- **Proposer**: it is the validator who proposed the block which is shown with a corresponding logo or icon.
- **Transaction Count (Tx counts)**: it is the number of transactions included in the block.
- **Gas Used / Wanted**: it is the amount of gas used by the block's transactions compared to the total gas available.
- **Hash**: it is the unique hash representing the block, which you can copy if needed.

In the _Transactions Section_, you have an overview of all details related to all transactions included in that specific block, including:

- **Transaction Hash (Tx hash)**: it is the unique identifier for each transaction. Clicking on the hash leads to a detailed transaction view.
- **Time**: it is the timestamp when the transaction was included in the block.
- **Result**: it is the status of the transaction.
- **Messages**: it describes the action taken.
- **Height**: it is the block height where the transaction is recorded.

### Transactions Page

The **Transactions** page provides a comprehensive view of the transactions activity on the Network. It allows users to monitor recent transactions, assess network activity over different time periods, and verify individual transaction details.

![](src/images/companion-app/companion-app_3.png)

Then _Transactions Summary Section_ provides an overview of the transaction statistics:

- **Total Transactions**: it is the cumulative number of transactions processed on the network.
- **Transactions (last 30 days)**: Number of transactions processed over the past 30 days.
- **Transactions (yesterday)**: Transactions that occurred on the previous day.
- **TPS (Last 20 blocks)**: it is the average Transactions Per Second (TPS) calculated based on the most recent 20 blocks.

Within the Transactions table, you have a view of each individual transactions with the following details:

- **Transaction Hash (Tx hash)**: It is the unique identifier for each transaction.
- **Time**: it is the time at which the transaction was processed.
- **Result**: it shows the status of the transaction.
- **Messages**: it indicates the type of action performed.
- **Height**: it indicates the block height in which the transaction was included.

By clicking on the _Transaction Hash_, you will be redirected to the _Transaction Details_ page where you will be able to find all needed information about that specific transaction, as shown below:

![](src/images/companion-app/companion-app_4.png)
Binary file added src/images/companion-app/companion-app_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/companion-app/companion-app_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/companion-app/companion-app_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/companion-app/companion-app_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading