Skip to content

docs: align Stellar vault curator guide with CLI#508

Merged
carrion256 merged 2 commits into
devfrom
docs/stellar-curator-guide
Jul 16, 2026
Merged

docs: align Stellar vault curator guide with CLI#508
carrion256 merged 2 commits into
devfrom
docs/stellar-curator-guide

Conversation

@carrion256

@carrion256 carrion256 commented Jul 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • rewrite the public vault curator guide as a Stellar/Soroban operator runbook
  • replace stale NEAR-oriented SDK and frontend guidance with the manifest-backed tmplr-soroban-vault workflow
  • document deployment recovery, role separation, exact governance timing, immutable adapter bindings, allocation accounting, withdrawal servicing, fee maintenance, incident response, and TTL operations
  • correct curator-facing CLI README and help text where it contradicted contract behavior

Why

The curator guide described a NEAR-oriented client workflow even though the supported curator surface is the Stellar vault operations CLI. It also diverged from current contract mechanics around Sentinel-only pausing, allocator-authorized queued-withdrawal execution, proposal timing, market bindings, and adapter accounting.

This change makes the public documentation match the deployed Stellar operating model and explicitly scopes the separate NEAR vault executor out of the curator runbook.

Operator impact

Curators and keepers now have one task-oriented guide covering:

  • CLI profiles, manifests, deployment, reconciliation, repair, and resume
  • governance admin, curator, allocator, and Sentinel authority
  • immediate versus timelocked governance behavior
  • adapter onboarding and stable market-to-adapter bindings
  • supply, withdrawal, NAV refresh, idle resync, and fee refresh mechanics
  • atomic and queued withdrawal runbooks
  • TTL authorization boundaries and archival recovery expectations
  • mainnet, preflight, secret-handling, and automation safeguards

Validation

  • cargo fmt -p templar-soroban-vault-cli -- --check
  • CARGO_TARGET_DIR=/data/tmp/templar-stellar-curator-target cargo test -p templar-soroban-vault-cli — 75 passed
  • mdbook build docs with the configured linkcheck renderer
  • git diff --check
  • repository post-commit Soroban size gate — 129255 <= 131072 bytes

This change is Reviewable

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Summary

  • Replaced the NEAR-oriented curator documentation with a Stellar/Soroban operator runbook covering deployment, governance, allocation, withdrawals, fees, incidents, TTL maintenance, reconciliation, repair, and resume workflows.
  • Aligned curator-facing CLI README and help text with contract behavior, including Sentinel-only pausing, allocator-authorized queued-withdrawal execution, governance timing, adapter accounting, and immutable market bindings.
  • Reworked extend-ttl to directly extend vault/share-token and adapter instances plus associated protocol WASM code, without requiring a contract-admin caller. Added WASM-hash resolution and Soroban preflight support for TTL commands.
  • Updated CLI parsing and tests for deprecated --caller compatibility and the new TTL call pattern.
  • Validation covered formatting, 75 CLI tests, documentation build/link checks, whitespace checks, and the Soroban size gate.

Human review focus

  • Verify TTL coverage and authorization across every deployed contract component, including archived instances and shared WASM hashes.
  • Confirm queued-withdrawal execution cannot be performed by unauthorized identities and that allocation/accounting semantics match contract authorization.
  • Review governance timing and Sentinel restrictions in the runbook against deployed contract behavior.
  • Check that documentation commands and manifest reconciliation procedures cannot encourage unsafe deployment or repair actions.

Walkthrough

The curator documentation was rewritten for Stellar vault operations, while the Soroban vault CLI now performs deployment-wide TTL extension through protocol instance and WASM code commands. CLI help, README guidance, and tests were updated for revised governance, withdrawal, accounting, and TTL behavior.

Changes

Stellar vault operations

Layer / File(s) Summary
Curator guide and governance workflow
docs/src/SUMMARY.md, docs/src/curator-guide.md, docs/src/index.md
The documentation introduces the Stellar vault operator scope, accounting model, deployment workflow, governance lifecycle, timing rules, fee examples, and navigation entries.
Operational procedures and safety guidance
docs/src/curator-guide.md
The runbook documents Sentinel actions, route activation, adapter NAV reporting, allocation accounting, withdrawals, TTL and archival operations, and safety checks.
Soroban TTL command support
tools/soroban-vault-cli/src/stellar.rs
The Stellar command wrapper adds instance and WASM code TTL extension helpers and routes contract extension through confirmation and build-and-simulate preflight handling.
Deployment-wide TTL orchestration
tools/soroban-vault-cli/src/commands.rs
TTL maintenance aggregates protocol WASM hashes, extends share-token and Blend adapter instances, extends collected protocol code hashes, and validates the new call pattern.
CLI surface and operator guidance
tools/soroban-vault-cli/README.md, tools/soroban-vault-cli/src/cli.rs
CLI help, README guidance, and parsing tests update withdrawal roles, Sentinel governance, adapter accounting, custodial NAV nonce rules, TTL compatibility behavior, and current versus legacy TTL arguments.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Possibly related PRs

Suggested labels: documentation

Suggested reviewers: royalf00l

Sequence Diagram(s)

sequenceDiagram
  participant Curator
  participant VaultCLI
  participant StellarCLI
  participant SorobanContracts
  Curator->>VaultCLI: run extend-ttl
  VaultCLI->>StellarCLI: extend contract instances
  VaultCLI->>StellarCLI: extend protocol WASM code
  StellarCLI->>SorobanContracts: submit and simulate contract extend
  SorobanContracts-->>VaultCLI: return transaction output
Loading
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/stellar-curator-guide

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • LINEAR integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

Comment @coderabbitai help to get the list of available commands.

@carrion256
carrion256 marked this pull request as ready for review July 16, 2026 11:58
@carrion256
carrion256 enabled auto-merge (squash) July 16, 2026 12:11
Comment thread tools/soroban-vault-cli/README.md Outdated
Comment thread tools/soroban-vault-cli/README.md Outdated
Comment thread docs/src/curator-guide.md Outdated

@peer2f00l peer2f00l left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Only blocking on the extend TTL comment

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Warning

CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.

Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.

👉 Steps to fix this

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/curator-guide.md`:
- Line 14: Remove the blank line inside the blockquote in curator-guide.md by
deleting its `>` marker or keeping the blockquote continuous, ensuring the
Markdownlint MD028 violation is resolved.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 2d72a5bf-cb88-480b-92de-f533ef979dde

📥 Commits

Reviewing files that changed from the base of the PR and between 3584015 and 70ed8dd.

📒 Files selected for processing (7)
  • docs/src/SUMMARY.md
  • docs/src/curator-guide.md
  • docs/src/index.md
  • tools/soroban-vault-cli/README.md
  • tools/soroban-vault-cli/src/cli.rs
  • tools/soroban-vault-cli/src/commands.rs
  • tools/soroban-vault-cli/src/stellar.rs

Comment thread docs/src/curator-guide.md
@carrion256
carrion256 requested a review from peer2f00l July 16, 2026 15:22
@carrion256
carrion256 merged commit 340ea5d into dev Jul 16, 2026
17 checks passed
@carrion256
carrion256 deleted the docs/stellar-curator-guide branch July 16, 2026 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants