Skip to content

Commit

Permalink
update portal docs (#3285)
Browse files Browse the repository at this point in the history
* update portal docs

* update
  • Loading branch information
geometryolife authored Feb 10, 2025
1 parent fd7ccea commit 64951b4
Show file tree
Hide file tree
Showing 6 changed files with 228 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ Enter the Portal page, select `Liquidity` and click on the `Add` button on the r

Just fill in the `RGas` and the LP pair will automatically calculate the `GROW` dosage:

The amount is calculated based on the official Swap pool, and the calculation form is:

```
point = x / x pool * 100%
y = y pool * point
```

![](/docs/portal/liquidity/liquidity-add.png)

Check the estimated income of the LP group, click the `Confirm` button to complete the LP staking:
Expand All @@ -42,3 +49,5 @@ Click the `Stake LP` button to stake token pairs:
![](/docs/portal/liquidity/liquidity-stake-lp.png)

After staking an LP, you can obtain `$LPXP` income.

In the future, $LPXP can be used to exchange initial liquidity to support this part of $ROOCH token, accounting for %5 of the total. For details, please refer to [this article](https://rooch.network/blog/rooch-network-tokenomics#community).
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ Rooch 现在推出 `RGas` 和 `GROW` 代币对质押,接下来通过一个简

只用填写 `RGas`,LP 对会自动计算 `GROW` 的配量:

配量根据官方的 Swap 池子计算,计算形式为:

```
point = x / x pool * 100%
y = y pool * point
```

![](/docs/portal/liquidity/liquidity-add.png)

检查 LP 组的预估收益,点击 `Confirm` 按钮完成 LP 质押:
Expand All @@ -42,3 +49,5 @@ Rooch 现在推出 `RGas` 和 `GROW` 代币对质押,接下来通过一个简
![](/docs/portal/liquidity/liquidity-stake-lp.png)

质押 LP 后,可以获取 `$LPXP` 收益。

未来可以使用 `$LPXP` 兑换**初始流动性支持**这部分 `$ROOCH` 代币,占总量的 `%5`。具体可以参考[这篇文章](https://rooch.network/zh-CN/blog/rooch-network-tokenomics#%E7%A4%BE%E5%8C%BA)
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Rooch Portal using guide

## Introduction

Rooch Portal, as the portal of Rooch ecological applications, provides one-stop services such as asset management, asset exchange, and application interaction.

- Visit link:https://portal.rooch.network

## Create session key

Session Key is a feature provided by Rooch, which provides a convenient experience for the interaction of blockchain applications. Using Portal also requires generating a Session Key.

Please click the `Create Session Key` button in the lower left corner. After the wallet is signed, a time-limited Session Key will be generated. You need to ensure that the account has `RGAS`.

## Component introduction

### Account

![](/blog/portal-intro/portal-account.png)

This is the default page of the Portal. If the wallet is not connected, you will be prompted to connect the wallet and access your account information. Here we take the UniSat wallet as an example. Click the `Connect Wallet` button in the upper right corner:

![](/blog/portal-intro/portal-account-info.png)

This page displays the Bitcoin account and the Rooch account address bound to it, the coins currently owned by the account, and transaction information.

### Assets

![](/blog/portal-intro/portal-assets.png)

This page is mainly used to manage different types of assets and provide transfer functions.

- `Coin` display the homogeneous assets on Rooch.
- `Bitcoin Assets` mainly displays the Bitcoin assets owned by the account.

> Note: Before transferring money, please confirm whether a Session Key has been generated. If not, you must generate one manually.
### Transactions

![](/blog/portal-intro/portal-transactions.png)

The detailed transaction information of the current account is displayed here, such as transaction hash, time, execution status, type, consumed Gas, etc.

If you want to see more detailed content of a transaction, please click the `View` button!

### Purchase gas

![](/blog/portal-intro/portal-purchase-gas.png)

The function of exchanging `BTC` for `RGAS` is provided here.

### Faucet

![](/blog/portal-intro/portal-faucet.png)

If you want to use the Rooch platform to build an application, you can first request `RGAS` from Rooch. Please make sure that the bound Bitcoin account has `UTXO`.

### Invitation Overview

The records of your invited users and the invitation rewards you received will be displayed here.

### Settings

![](/blog/portal-intro/portal-settings.png)

This page provides the function of displaying and managing Session Key. For example, you can view the scope of Session Key and the history of generating Session Key.

The settings associated with Rooch accounts and Twitter accounts are also on this page, and new users can bind Twitter and receive `RGas`.

### Marketplace

Pending order transactions can be conducted here.

### Liquidity

Here you can pledge assets on Rooch in liquidity to obtain profits.

### Swap

This is the official Swap pool established by Rooch, which can be exchanged for corresponding tokens.

### Apps

Here are the projects related to Rooch & Bitcoin, equivalent to the portal.

### Search

![](/blog/portal-intro/portal-search.png)

After entering a Bitcoin address in this search box, it will query the assets of the corresponding address, and the query result page reuses the `Account` page.

![](/blog/portal-intro/portal-another-account.png)

Queryed the account information of `bc1ph25pk4xm36y3mt6uwclm0fgj8dgdnf5u7xf987qvyv58x987cldswp09hc`.

### Apps

![](/blog/portal-intro/portal-apps.png)

This provides an access entrance to Rooch ecological applications. Like the portal website, it allows users to jump to the corresponding application homepage in one stop.

### Testnet

This is a jump button. Clicking it will switch the Portal's network to the `test` network.
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Rooch Portal 使用指南

## 简介

Rooch Portal 作为 Rooch 生态应用的门户,提供了资产管理、资产兑换、应用交互等一站式服务。

- 访问链接:https://portal.rooch.network

## 创建会话密钥

会话密钥(Session Key)是 Rooch 提供的一个特性,为区块链应用的交互提供便捷的体验。使用 Portal 也需要生成一个 Session Key。

请点击左下角的 `Create Session Key` 按钮,钱包签名之后,就会生成一个具有时限的 Session Key 了,需要确保账户有 `RGAS`

## 组件介绍

### Account

![](/blog/portal-intro/portal-account.png)

这是 Portal 默认的页面,如果没有连接钱包,回提示连接钱包,并访问你的账户信息,这里以 UniSat 钱包为例,点击右上角 `Connect Wallet` 按钮:

![](/blog/portal-intro/portal-account-info.png)

这个页面展示了 Bitcoin 账户以及与其绑定的 Rooch 账户地址,当前账户拥有的 Coin,以及交易信息。

### Assets

![](/blog/portal-intro/portal-assets.png)

这个页面主要是用于管理不同类型资产,提供转账功能。

- `Coin` 展示的是 Rooch 上的同质化资产。
- `Bitcoin Assets` 主要展示账户拥有的 Bitcoin 资产。

> 注意:转账前,请确认是否已生成有 Session Key,如果没有,必须手动生成一个。
### Transactions

![](/blog/portal-intro/portal-transactions.png)

这里展示当前账户的详细交易信息,比如交易哈希、时间、执行状态、类型、消耗的 Gas 等。

如果想要查看某笔交易更详尽的内容,请点击 `View` 按钮!

### Purchase gas

![](/blog/portal-intro/portal-purchase-gas.png)

这里提供了 `BTC` 兑换 `RGAS` 的功能。

### Faucet

![](/blog/portal-intro/portal-faucet.png)

对于想要使用 Rooch 平台构建应用时,可以先向 Rooch 索要一次 `RGAS`,请确保绑定的 Bitcoin 账户有 `UTXO`

### Invitation Overview

这里将显示你邀请用户的记录以及获得的邀请奖励。

### Settings

![](/blog/portal-intro/portal-settings.png)

这个页面提供了显示和管理 Session Key 的功能。比如,可以查看 Session Key 的作用范围,以及生成 Session Key 的历史记录。

Rooch 账户和推特账户关联的设置也在这个页面,新用户可以绑定推特并领取 `RGas`

### Marketplace

这里可以进行挂单交易。

### Liquidity

这里可以将 Rooch 上的资产进行流动性质押,获取收益。

### Swap

这里是 Rooch 官方建立的 Swap 池子,可以兑换相应的代币。

### Apps

这里列出了与 Rooch & Bitcoin 相关的项目,相当于门户网站。

### Search

![](/blog/portal-intro/portal-search.png)

在这个搜索框输入一个 Bitcoin 地址后,它将查询相应地址的资产,查询结果页面复用的是 `Account` 页面。

![](/blog/portal-intro/portal-another-account.png)

查询了 `bc1ph25pk4xm36y3mt6uwclm0fgj8dgdnf5u7xf987qvyv58x987cldswp09hc` 账户账户信息。

### Apps

![](/blog/portal-intro/portal-apps.png)

这里提供了 Rooch 生态应用的一个访问入口,跟门户网站一样,能够让用户一站式跳转到相应的应用首页。

### Testnet

这个一个跳转按钮,点击会将 Portal 的网络切换到 `test` 网络。
2 changes: 1 addition & 1 deletion docs/website/pages/learn/miscellaneous/portal.en-US.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Click the `Connect Wallet` button in the upper right corner. You will be prompte

### Using guide

For detailed usage guide of Rooch, please refer to [this blog](../../blog/using-portal).
For detailed usage guide of Rooch, please refer to [this article](./portal-features/using-portal).

### Things to note when using OneKey wallet

Expand Down
2 changes: 1 addition & 1 deletion docs/website/pages/learn/miscellaneous/portal.zh-CN.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Rooch Portal 是一个综合仪表板,旨在简化 Unisat 等比特币钱包

### 使用指南

Rooch 的详细使用指南,请参考[这篇博客](../../blog/using-portal)
Rooch 的详细使用指南,请参考[这篇文档](./portal-features/using-portal)

### 使用 OneKey 钱包的注意事项

Expand Down

0 comments on commit 64951b4

Please sign in to comment.