Skip to content

Commit feb772b

Browse files
committed
PoS: Major edits to Heimdall
These edits make Heimdall ready for staging. It ain't much, but it's an honest livin'.
1 parent d5f558f commit feb772b

File tree

13 files changed

+70
-443
lines changed

13 files changed

+70
-443
lines changed

docs/pos/architecture/heimdall/modules/auth.md renamed to docs/pos/architecture/heimdall/authentication.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
# Auth Module
1+
Heimdall's `auth` module is responsible for specifying the base transaction and account types for an application. It contains the ante handler, where all basic transaction validity checks (signatures, nonces, auxiliary fields) are performed, and exposes the account keeper, which allows other modules to read, write, and modify accounts.
22

3-
This document describes the `auth` module of Heimdall.
4-
5-
The `auth` module is responsible for specifying the base transaction and account types for an application. It contains the ante handler, where all basic transaction validity checks (signatures, nonces, auxiliary fields) are performed, and exposes the account keeper, which allows other modules to read, write, and modify accounts.
6-
7-
## Gas and Fees
3+
## Gas and fees
84

95
Fees serve two purposes for an operator of the network.
106

@@ -86,7 +82,7 @@ The auth module contains the following parameters:
8682
|DefaultMaxTxGas |uint64|1000000 |
8783
|DefaultTxFees |string|"1000000000000000"|
8884

89-
## CLI Commands
85+
## CLI commands
9086

9187
### Show account
9288

docs/pos/architecture/heimdall/modules/bank.md renamed to docs/pos/architecture/heimdall/balance-transfers.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# Bank Module
2-
3-
The `bank` module handles account balance transfers for Heimdall. This module corresponds to the `bank` module from cosmos-sdk.
1+
Heimdall's `bank` module handles balance transfers between accounts. This module corresponds to the `bank` module from cosmos-sdk.
42

53
## Messages
64

docs/pos/architecture/heimdall/modules/chain-manager.md renamed to docs/pos/architecture/heimdall/chain-management.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# Chain Manager
2-
31
This document specifies an overview of the chain manager module of Heimdall.
42

53
The **chain manager** module provides all necessary dependencies like `contract-addresses`, `bor_chain_id,` and `tx_confirmation_time`. Other parameters can be added to this later on.
@@ -39,7 +37,7 @@ type ChainParams struct {
3937
}
4038
```
4139

42-
## CLI Commands
40+
## CLI commands
4341

4442
### Parameters
4543

@@ -49,7 +47,7 @@ To print all params;
4947
heimdallcli query chainmanager params --trust-node
5048
```
5149

52-
### Expected Result
50+
### Expected result
5351

5452
```yaml
5553
tx_confirmation_time: 12s

docs/pos/architecture/heimdall/checkpoint.md renamed to docs/pos/architecture/heimdall/checkpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,4 +244,4 @@ Heimdall provides several REST APIs for interacting with the checkpoint module,
244244
|It returns the prepared checkpoint|GET |/checkpoints/prepare|
245245
|Get ack count, buffer, validator set, validator count and last-no-ack details|GET |/overview |
246246
247-
For more details and the response format of these APIs, visit [Heimdall API Documentation](https://heimdall-api.polygon.technology/swagger-ui/#/checkpoint).
247+
For more details and the response format of these APIs, visit [Heimdall API Documentation](https://heimdall-api.polygon.technology/swagger-ui/#/checkpoint).

docs/pos/architecture/heimdall/faq.md

Lines changed: 0 additions & 308 deletions
This file was deleted.

0 commit comments

Comments
 (0)