Skip to content

docs: add automatic deposit flow stub to README#172

Open
lpahlavi wants to merge 3 commits intomainfrom
lpahlavi/automatic-deposit-readme
Open

docs: add automatic deposit flow stub to README#172
lpahlavi wants to merge 3 commits intomainfrom
lpahlavi/automatic-deposit-readme

Conversation

@lpahlavi
Copy link
Copy Markdown
Contributor

@lpahlavi lpahlavi commented Apr 24, 2026

Summary

  • Renames the existing deposit section to "Deposit: SOL → ckSOL (Manual)" for clarity
  • Adds a new "Deposit: SOL → ckSOL (Automatic)" section with a WIP warning, step-by-step description, and a sequence diagram
  • Adds a CLI snippet for update_balance in the "Interacting via the CLI" section, also marked as WIP

Both new entries include a [!WARNING] callout noting the feature is not yet available on mainnet.

🤖 Generated with Claude Code

Adds a WIP stub for the automatic deposit flow, including a how-it-works
section with a sequence diagram and a CLI snippet. Both are annotated
with a warning that the feature is not yet available on mainnet.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings April 24, 2026 08:52
lpahlavi and others added 2 commits April 24, 2026 10:55
Expand the minter/src tree to show all modules, split deposit/ into
manual/ and automatic/ (WIP), and add guard/, ledger/, rpc/, signer/,
and sol_transfer/ which were missing from the previous listing.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Keep the existing abbreviated listing with ... intact. Only replace the
flat deposit/manual/ entry with a proper deposit/ subtree showing
manual/ and automatic/ (WIP).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lpahlavi lpahlavi requested review from THLO and maciejdfinity April 24, 2026 09:03
@lpahlavi lpahlavi marked this pull request as ready for review April 24, 2026 09:03
@lpahlavi lpahlavi requested a review from a team as a code owner April 24, 2026 09:03
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

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