Skip to content

Commit 7d812b8

Browse files
committed
Add contribution process for SLPs
typo copilot review
1 parent a666f1c commit 7d812b8

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

limits/README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,3 +202,68 @@ The evaluation may have several outcomes:
202202

203203
**Step 4 \- Nominate the proposal**
204204
In case if the proposal has gone through evaluation, it can be nominated for the vote by the validators. The nomination can be supported by the evaluation results summary.
205+
206+
# Contribution Process
207+
208+
Ecosystem members are encouraged to propose changes to Soroban resource limits through the Stellar
209+
Limits Proposal (SLP) process. Unlike CAPs, SLPs are focused specifically on adjusting smart
210+
contract resource limits (mostly increases) and follow a streamlined process tailored to that scope.
211+
212+
## Pre-SLP (Initial Discussion)
213+
Introduce your idea in [GitHub Discussions](https://github.com/stellar/stellar-protocol/discussions) where you should:
214+
- Clearly describe which resource limit(s) you would like to see changed and why.
215+
- Gather feedback from the community — others may have encountered the same limitation or have
216+
alternative suggestions.
217+
218+
## Creating an SLP Draft
219+
Draft a formal proposal and submit a PR to this repository. Your proposal should include:
220+
221+
- **Motivation** — Demonstrate the necessity of the increase:
222+
- How the use case aligns with [Stellar Network goals](../core/README.md#stellar-network-goals).
223+
- Why the existing limits are not sufficient (e.g. your protocol's resource requirements clearly
224+
exceed the current limit).
225+
- **Proposed Changes** — Specify the resource(s) and the desired new limit value(s). If you are
226+
proposing a per-transaction limit increase, consider whether the corresponding ledger-wide limit
227+
also needs to be raised to maintain a healthy ledger/transaction ratio (see
228+
[Transactions per ledger ratio](#transactions-per-ledger-ratio)).
229+
- **Impact Assessment** — To the extent possible, describe the expected impact of the change on the
230+
network and downstream systems (indexers, RPC providers, block explorers, etc.). Refer to the
231+
[Key considerations for increasing the limits](#key-considerations-for-increasing-the-limits)
232+
section for guidance on what to consider.
233+
234+
Place the draft in the `limits/` folder and name it `slp-TBD.md`. Submit a PR via your fork of
235+
this repository.
236+
237+
### Additional Tips
238+
- You do **not** need to perform benchmarking yourself. The Core team will handle benchmarking and
239+
technical evaluation of proposed limit changes as part of the review process (see Step 3 in
240+
[Process for increasing the limits](#process-for-increasing-the-limits)).
241+
- Focus your proposal on clearly articulating the demand and justification — a well-motivated
242+
proposal with concrete data is more likely to move forward.
243+
- If your proposal affects per-transaction limits, keep in mind that these increases are
244+
essentially irreversible (see [Reducing the limits](#reducing-the-limits)), so proposals should
245+
be well-justified.
246+
247+
## SLP Review Process
248+
249+
### Draft: Merging & Iteration
250+
If the proposal follows the guidelines above, it will be merged as a draft SLP (the file will be
251+
renamed to its assigned SLP number before merging). You can continue iterating on the draft based
252+
on community and Core team's feedback.
253+
254+
### Evaluation
255+
Once the proposal is sufficiently mature, the Core team will evaluate the proposed numbers against
256+
the network's actual capabilities. This includes:
257+
258+
- Running apply-time benchmarks for ledger-wide limit changes.
259+
- Assessing flooding and Supercluster test results for transaction size changes.
260+
- Evaluating long-term impact on protocol development.
261+
- Coordinating with downstream teams (indexers, RPC providers, etc.) if the changes significantly
262+
affect them.
263+
264+
The evaluation may result in the proposal being accepted as-is, accepted with modified numbers, or
265+
rejected if the network cannot safely support the increase at this time.
266+
267+
### Nomination
268+
If the proposal passes evaluation, it can be nominated for a vote by the validators, supported by
269+
a summary of the evaluation results.

0 commit comments

Comments
 (0)