docs: add task state machine and lifecycle documentation (#120)#135
Merged
ayomideadeniran merged 1 commit intoSoroLabs:mainfrom Mar 29, 2026
Merged
Conversation
Formally documents the full lifecycle of a Task in SoroTask, covering: - All states: Registered, Pending, Due, Executing, Executed, Skipped, Paused, Resumed, Cancelled, InsufficientGas - ASCII state diagram showing every transition and its direction - Full transition table with trigger, layer (on-chain vs off-chain), and the exact function or keeper action responsible - Detailed breakdown of on-chain contract responsibilities (register, execute, pause_task, resume_task, cancel_task, deposit_gas, withdraw_gas) including the atomicity guarantee from Soroban - Off-chain keeper responsibilities (registry.js event discovery, poller.js due detection, executor.js submission, queue.js concurrency) - Complete events reference table - Gas balance mechanics and the InsufficientGas recovery path Closes SoroLabs#120
|
@Sendi0011 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Contributor
|
Pr under review. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a formal state machine document for the Task lifecycle in SoroTask. Covers all possible states, the conditions that trigger each transition, and which layer (on-chain Soroban contract vs. off-chain keeper) is responsible for each one. Grounded directly in the contract (
lib.rs) and keeper source (poller.js,executor.js,registry.js).Related Issue
Closes #120
Type of Change
Changes Made
docs/task-state-machine.mdwith:Registered,Pending,Due,Executing,Executed,Skipped,Paused,Resumed,Cancelled,InsufficientGasregistry.js,poller.js,executor.js,queue.js)InsufficientGasrecovery pathValidation
contract/src/lib.rsandkeeper/src/Screenshots (if UI changes)
N/A — documentation only
Checklist