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

docs: adr-13 - automatic gas price estimation #4048

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ sort-imports:
## adr-gen: Generate ADR from template. Must set NUM and TITLE parameters.
adr-gen:
@echo "--> Generating ADR"
@curl -sSL https://raw.githubusercontent.com/celestiaorg/.github/main/adr-template.md > docs/architecture/adr-$(NUM)-$(TITLE).md
@curl -sSL https://raw.githubusercontent.com/celestiaorg/.github/main/adr-template.md > docs/adr/adr-$(NUM)-$(TITLE).md
.PHONY: adr-gen

## telemetry-infra-up: Launch local telemetry infra (grafana, jaeger, loki, pyroscope, and otel-collector).
Expand Down
65 changes: 65 additions & 0 deletions docs/adr/adr-013-automatic-gas-price-estimation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# ADR #013: Automatic Gas Price Estimation

## Changelog

- 17.01.2024: Initial design

## Status

Proposed

## Context

[CIP 18](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-18.md) defines an interface that a light node can use for transaction submission to retrieve an estimate of the gas price and amount of gas required to include their transaction on Celestia. This predominantly is to allow for greater dynamism during times of congestions where gas prices become greater than the global minimum.

This ADR defines how the go light node will interact with the service as a client. Note this does not cover how the server will actually estimate the gas prices and gas required.

## Decision

Allow users of Celestia nodes to opt in to automatic gas price and gas usage estimation for every write method

## Detailed Design

### When to estimate the gas price

Users can opt in to automatic price estimation by using the existing `TxConfig.isGasPriceSet`. Previously, if this was false, the `DefaultGasPrice` was used, now if a user isn't manually setting the gas price, the node will query it from the `GasEstimator` service.

### When to estimate the gas required

Depending on the message types submitted, the node will decide whether to also query for the amount of gas that is required to submit the transaction. In the case of the following messages, the gas can be reliably estimated using a simple linear model:

- `MsgPayForBlob`

For all other messages (or combination of messages), the node will call the `GasEstimator` service.

### Setting guardrails

A new field in the `TxConfig` will be introduced allowing for a user to use the gas price estimation but setting a maximum gas price as a cap that the user is willing to pay. If the price returned by the estimator is greater than the cap, likely due to a price spike, an error will be returned informing the user that the gas price required is currently greater than the user is willing to pay

### Defaults

By default, the same consensus node that the node is connected with, should be used as the `GasEstimator`. During construction, a user can optionally provide a grpc address that can be used instead.

### Fallback

If there are any errors with interacting with the `GasEstimator` service, the node should log an error and fallback to using the minimum gas price.

## Alternative Approaches

There has been some discussion of a pricing mechanism built in to the protocol. This would be more complex but would remove the reliance on a trusted third party. This may be explored in the future but given resource constraints, the `GasEstimator` service has been prioritized

## Consequences

### Positive

- Light nodes should

### Negative

- Extra round trip with either the consensus node or someone offering the `GasEstimator` service before the transaction is submitted
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to subscribe to the GasEstimator and store the latest value?


### Neutral

## References

- [CIP 18](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-18.md)
Loading