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.

Sign up for GitHub

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

docs: fix beta description #54

Merged
merged 3 commits into from
Jan 12, 2024
Merged

docs: fix beta description #54

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab863a4
docs: fix beta description
rootulp Jan 10, 2024
6b90d97
Merge branch 'main' into rp/README
Jan 12, 2024
57ad084
Merge branch 'main' into rp/README
Jan 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

This document specifies the feemarket module.

The feemarket module is an implementation of the Additive Increase Multiplicative Decrease (AIMD) EIP-1559
feemarket. More information about the implementation can be found [here](./x/feemarket/README.md).
The feemarket module is an implementation of the Additive Increase Multiplicative Decrease (AIMD) EIP-1559
feemarket. More information about the implementation can be found [here](./x/feemarket/README.md).

This module is planned to be used in the Cosmos Hub.

Expand Down Expand Up @@ -107,7 +107,7 @@ The feemarket module provides a keeper interface for accessing the KVStore.

```go
type FeeMarketKeeper interface {
// Get the current state from the store.
// Get the current state from the store.
GetState(ctx sdk.Context) (types.State, error)

// Set the state in the store.
Expand All @@ -118,8 +118,8 @@ type FeeMarketKeeper interface {

// Set the params in the store.
SetParams(ctx sdk.Context, params types.Params) error
// Get the current minimum gas prices (base fee) from the store.

// Get the current minimum gas prices (base fee) from the store.
GetMinGasPrices(ctx sdk.Context) (sdk.Coins, error)
}
```
Expand Down Expand Up @@ -212,9 +212,8 @@ when it is above or below the target +/- threshold.

### Beta

The default send enabled value controls send transfer capability for all
coin denominations unless specifically included in the array of `SendEnabled`
parameters.
Beta is the amount we multiplicatively decrease the learning rate
when it is within the target +/- threshold.

### Theta

Expand Down Expand Up @@ -248,13 +247,13 @@ TargetBlockUtilization is the target block utilization for the current block.

### MaxBlockUtilization

MaxBlockUtilization is the maximum block utilization. Once this has been surpassed,
MaxBlockUtilization is the maximum block utilization. Once this has been surpassed,
no more transactions will be added to the current block.

### Window

Window defines the window size for calculating an adaptive learning rate
over a moving window of blocks. The default EIP1559 implementation uses
over a moving window of blocks. The default EIP1559 implementation uses
a window of size 1.

### FeeDenom
Expand All @@ -264,7 +263,7 @@ FeeDenom is the denom that will be used for all fee payments.
### Enabled

Enabled is a boolean that determines whether the EIP1559 fee market is
enabled. This can be used to add the feemarket module and enable it
enabled. This can be used to add the feemarket module and enable it
through governance at a later time.

```protobuf
Expand Down Expand Up @@ -536,4 +535,3 @@ Example Output:
]
}
```

Loading