Skip to content

Commit 77020f2

Browse files
authored
update website (#95)
1 parent b3324b3 commit 77020f2

27 files changed

Lines changed: 171 additions & 90 deletions

.github/workflows/check.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
runs-on: ubuntu-latest
1616
steps:
1717
- name: Clone repository
18-
uses: actions/checkout@v4
18+
uses: actions/checkout@v5
1919

2020
- name: Setup Ruby
2121
uses: ruby/setup-ruby@v1
@@ -34,7 +34,7 @@ jobs:
3434

3535
steps:
3636
- name: Checkout
37-
uses: actions/checkout@v4
37+
uses: actions/checkout@v5
3838

3939
- name: Check images
4040
run: python .github/workflows/check_images.py ./website
@@ -43,11 +43,11 @@ jobs:
4343
name: HTML proofer
4444
runs-on: ubuntu-latest
4545
env:
46-
HUGO_VERSION: 0.130.0
46+
HUGO_VERSION: 0.152.2
4747

4848
steps:
4949
- name: Checkout
50-
uses: actions/checkout@v4
50+
uses: actions/checkout@v5
5151

5252
- name: Setup Hugo
5353
run: |
@@ -77,7 +77,7 @@ jobs:
7777

7878
- name: Install html-proofer
7979
run: |
80-
gem install html-proofer -v 4.3
80+
gem install html-proofer
8181
8282
##
8383
## Status code 429: https://http.dev/429

.github/workflows/deploy.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ jobs:
3131
build:
3232
runs-on: ubuntu-latest
3333
env:
34-
HUGO_VERSION: 0.130.0
34+
HUGO_VERSION: 0.152.2
3535

3636
steps:
3737
- name: Checkout
38-
uses: actions/checkout@v4
38+
uses: actions/checkout@v5
3939

4040
- name: Install dependencies
4141
run: |
@@ -60,7 +60,7 @@ jobs:
6060
run: find "./public" -type f -name "*.png" -exec pngquant --verbose --force --ext .png {} \;
6161

6262
- name: Upload artifact
63-
uses: actions/upload-pages-artifact@v3
63+
uses: actions/upload-pages-artifact@v4
6464
with:
6565
path: ./public
6666

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ resources
66
hugo_stats.json
77

88
TODO
9+
public-130
10+

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To contribute, simply edit the relevant page or open a pull request.
99

1010
## Running Locally
1111

12-
To get started, install [Hugo](https://gohugo.io/installation/), first.
12+
To get started, install [Hugo](https://gohugo.io/installation/) first.
1313
Now, clone this repository and run it locally using the following commands:
1414

1515
```zsh
@@ -32,7 +32,7 @@ To lint Markdown files, you can use the `mdl` ([MarkdownLint](https://github.com
3232
This tool checks your Markdown files against a set of rules and provides feedback on any issues found.
3333

3434
To install `mdl`, first you need to install [Ruby](https://www.ruby-lang.org/en/documentation/installation/).
35-
Once you ensure Ruby installed on your system, you can install `mdl` by running:
35+
Once you ensure Ruby is installed on your system, you can install `mdl` by running:
3636

3737
```sh
3838
gem install mdl
@@ -48,4 +48,4 @@ This command will check all documents in the `content` folder for any linting is
4848

4949
## Deployment
5050

51-
Updating the main branch will automatically deploy this repository through [deploy](.github/workflows/deploy.yml) Github action.
51+
Updating the main branch will automatically deploy this repository through [deploy](.github/workflows/deploy.yml) GitHub action.

content/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Pactus Documentation
3-
layout: hextra-home
43
cascade:
54
type: docs
65
next: get-started

content/api/grpc.md

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,10 @@ For seamless integration with Pactus, you can use these client libraries:
123123
<a href="#pactus.Network.GetNodeInfo">
124124
<span class="rpc-badge"></span> GetNodeInfo</a>
125125
</li>
126+
<li>
127+
<a href="#pactus.Network.Ping">
128+
<span class="rpc-badge"></span> Ping</a>
129+
</li>
126130
</ul>
127131
</li>
128132
<li> Utils Service
@@ -483,7 +487,7 @@ For seamless integration with Pactus, you can use these client libraries:
483487
<td class="fw-bold">transaction.batch_transfer.recipients</td>
484488
<td>repeated Recipient</td>
485489
<td>
486-
The recipients of list receiver with amount.
490+
The list of recipients with their amounts.
487491
</td>
488492
</tr>
489493
<tr>
@@ -945,7 +949,7 @@ For seamless integration with Pactus, you can use these client libraries:
945949
<td class="fw-bold">recipients</td>
946950
<td>repeated Recipient</td>
947951
<td>
948-
The recipients list of receiver with amount, min 2 recipients.
952+
The list of recipients with their amounts. Minimum 2 recipients required.
949953
</td>
950954
</tr>
951955
<tr>
@@ -1224,7 +1228,7 @@ For seamless integration with Pactus, you can use these client libraries:
12241228
<td class="fw-bold">transaction.batch_transfer.recipients</td>
12251229
<td>repeated Recipient</td>
12261230
<td>
1227-
The recipients of list receiver with amount.
1231+
The list of recipients with their amounts.
12281232
</td>
12291233
</tr>
12301234
<tr>
@@ -1312,7 +1316,7 @@ For seamless integration with Pactus, you can use these client libraries:
13121316
<td class="fw-bold">data</td>
13131317
<td> string</td>
13141318
<td>
1315-
Block data, available only if verbosity level is set to BLOCK_DATA.
1319+
Block data, available only if verbosity level is set to BLOCK_VERBOSITY_DATA.
13161320
</td>
13171321
</tr>
13181322
<tr>
@@ -1411,7 +1415,7 @@ For seamless integration with Pactus, you can use these client libraries:
14111415
<td>repeated TransactionInfo</td>
14121416
<td>
14131417
List of transactions in the block, available when verbosity level is set to
1414-
BLOCK_TRANSACTIONS.
1418+
BLOCK_VERBOSITY_TRANSACTIONS.
14151419
</td>
14161420
</tr>
14171421
<tr>
@@ -1616,7 +1620,7 @@ BLOCK_TRANSACTIONS.
16161620
<td class="fw-bold">txs[].batch_transfer.recipients</td>
16171621
<td>repeated Recipient</td>
16181622
<td>
1619-
The recipients of list receiver with amount.
1623+
The list of recipients with their amounts.
16201624
</td>
16211625
</tr>
16221626
<tr>
@@ -1758,6 +1762,13 @@ Message has no fields.
17581762
<td>
17591763
The total number of validators in the blockchain.
17601764
</td>
1765+
</tr>
1766+
<tr>
1767+
<td class="fw-bold">active_validators</td>
1768+
<td> int32</td>
1769+
<td>
1770+
The number of active (not unbonded) validators in the blockchain.
1771+
</td>
17611772
</tr>
17621773
<tr>
17631774
<td class="fw-bold">total_power</td>
@@ -2638,7 +2649,7 @@ Message has no fields.
26382649
<td class="fw-bold">txs[].batch_transfer.recipients</td>
26392650
<td>repeated Recipient</td>
26402651
<td>
2641-
The recipients of list receiver with amount.
2652+
The list of recipients with their amounts.
26422653
</td>
26432654
</tr>
26442655
<tr>
@@ -3121,10 +3132,27 @@ maximum number of messages to queue before dropping older ones.
31213132
</tbody>
31223133
</table>
31233134

3135+
#### Ping <span id="pactus.Network.Ping" class="rpc-badge"></span>
3136+
3137+
<p>Ping provides a simple connectivity test and latency measurement.</p>
3138+
3139+
<h4>PingRequest <span class="badge text-bg-info fs-6 align-top">Request</span></h4>
3140+
3141+
Message has no fields.
3142+
<h4>PingResponse <span class="badge text-bg-warning fs-6 align-top">Response</span></h4>
3143+
3144+
<table class="table table-bordered table-responsive table-sm">
3145+
<thead>
3146+
<tr><td>Field</td><td>Type</td><td>Description</td></tr>
3147+
</thead>
3148+
<tbody class="table-group-divider">
3149+
</tbody>
3150+
</table>
3151+
31243152
### Utils Service
31253153

31263154
<p>Utils service defines RPC methods for utility functions such as message
3127-
signing, verification, and etc.</p>
3155+
signing, verification, and other cryptographic operations.</p>
31283156

31293157
#### SignMessageWithPrivateKey <span id="pactus.Utils.SignMessageWithPrivateKey" class="rpc-badge"></span>
31303158

@@ -4021,7 +4049,7 @@ Note: Generating a new Ed25519 address requires the wallet password.)</li>
40214049

40224050
#### ListWallet <span id="pactus.Wallet.ListWallet" class="rpc-badge"></span>
40234051

4024-
<p>ListWallet returns list of all available wallets.</p>
4052+
<p>ListWallet returns a list of all available wallets.</p>
40254053

40264054
<h4>ListWalletRequest <span class="badge text-bg-info fs-6 align-top">Request</span></h4>
40274055

@@ -4079,7 +4107,7 @@ Message has no fields.
40794107
</tr>
40804108
<tr>
40814109
<td class="fw-bold">version</td>
4082-
<td> int64</td>
4110+
<td> int32</td>
40834111
<td>
40844112
The wallet format version.
40854113
</td>
@@ -4111,6 +4139,13 @@ Message has no fields.
41114139
<td>
41124140
Unix timestamp of wallet creation.
41134141
</td>
4142+
</tr>
4143+
<tr>
4144+
<td class="fw-bold">default_fee</td>
4145+
<td> int64</td>
4146+
<td>
4147+
The default fee of the wallet.
4148+
</td>
41144149
</tr>
41154150
</tbody>
41164151
</table>
@@ -4153,7 +4188,7 @@ Message has no fields.
41534188
<td class="fw-bold">data</td>
41544189
<td>repeated AddressInfo</td>
41554190
<td>
4156-
ist of all addresses in the wallet with their details.
4191+
List of all addresses in the wallet with their details.
41574192
</td>
41584193
</tr>
41594194
<tr>

0 commit comments

Comments
 (0)