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

Provide getFeeStats as a new endpoint on RPC #114

Closed
janewang opened this issue Mar 26, 2024 · 2 comments · Fixed by #172
Closed

Provide getFeeStats as a new endpoint on RPC #114

janewang opened this issue Mar 26, 2024 · 2 comments · Fixed by #172
Assignees
Labels
enhancement New feature or request

Comments

@janewang
Copy link
Collaborator

janewang commented Mar 26, 2024

What problem does your feature solve?

getFeeStats: An endpoint for inclusion fee should be made available to help developers understand how to set inclusion fee.
We propose a separate endpoint as the inclusion fee below is provided over a set of transactions instead of uniquely tied to a specific transaction, as in simulateTransaction. Furthermore, we want to avoid providing a single number, but provide a percentile distribution of fees such that the developer could have a sense of the current fees distribution and choose a bid that’s most appropriate for this transaction.

Types of transaction:

For Soroban transactions and Stellar transactions, they each have their own inclusion fees and own surge pricing. For example, classic transactions can be at base fee of 100, while Soroban fee goes through surge pricing. Thus we need one data set for Soroban transactions and one data set for Stellar transactions in the lookback period. It doesn’t make sense to mix these two types of transactions.

Lookback period:

We propose a lookback period of 50 ledgers for Soroban transactions and keep the same 5 ledger lookback period for Stellar transactions. Both of these variables should be configurable, but the values here are the default values. On a lower time scale, Soroban inclusion fees are highly volatile and cannot provide a predictive basis for analytics. We propose to reevaluate the lookback period as Soroban capacity increases and fees become less bumpy ledger to ledger.

What would you like to see?

Example response for soroban inclusion fees and stellar inclusion fees:

{
  "soroban_inclusion_fee": {
    "max": "1009",
    "min": "101",
    "mode": "101",
    "p10": "101",
    "p20": "101",
    "p30": "101",
    "p40": "101",
    "p50": "600",
    "p60": "600",
    "p70": "1009",
    "p80": "1009",
    "p90": "1009",
    "p95": "1009",
    "p99": "1009"
  },
  "inclusion_fee": {
    "max": "100",
    "min": "100",
    "mode": "100",
    "p10": "100",
    "p20": "100",
    "p30": "100",
    "p40": "100",
    "p50": "100",
    "p60": "100",
    "p70": "100",
    "p80": "100",
    "p90": "100",
    "p95": "100",
    "p99": "100"
  }
}

We should update public documentation to include usage of this endpoint.

What alternatives are there?

@janewang janewang added enhancement New feature or request objective-5 labels Mar 26, 2024
@janewang janewang changed the title Provide inclusion fee stats as a new endpoint on RPC Provide getFeeStats as a new endpoint on RPC Mar 27, 2024
@mollykarcher mollykarcher moved this from Backlog to To Do in Platform Scrum Apr 9, 2024
@mollykarcher mollykarcher added this to the platform sprint 46 milestone Apr 9, 2024
@mollykarcher mollykarcher moved this from To Do to Backlog in Platform Scrum Apr 9, 2024
@janewang janewang moved this from Backlog to To Do in Platform Scrum Apr 9, 2024
@janewang janewang moved this from To Do to Backlog in Platform Scrum Apr 9, 2024
@mollykarcher mollykarcher moved this from Backlog to To Do in Platform Scrum Apr 9, 2024
@2opremio
Copy link
Contributor

2opremio commented May 9, 2024

@janewang do you want to take into account ExtendFootprintTtl and RestoreFootprint operations into the soroban_inclusion_fee? or just InvokeHostFunction?

@janewang
Copy link
Collaborator Author

janewang commented May 9, 2024

@2opremio The ExtendFootprintTtl and RestoreFootprint are also soroban operations right? In theory they need to include inclusion fee and bid inclusion fee just like others. If my understanding is correct, and they compete for the same inclusion into a ledger, they should be included.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants