Skip to content

docs: clarify MRWK transfer and bridge status#396

Closed
tolga-tom-nook wants to merge 1 commit into
ramimbo:mainfrom
tolga-tom-nook:bounty/395-current-transfer-status-docs
Closed

docs: clarify MRWK transfer and bridge status#396
tolga-tom-nook wants to merge 1 commit into
ramimbo:mainfrom
tolga-tom-nook:bounty/395-current-transfer-status-docs

Conversation

@tolga-tom-nook
Copy link
Copy Markdown
Contributor

@tolga-tom-nook tolga-tom-nook commented May 26, 2026

Summary

  • Add docs/ledger.md current transfer paths for GitHub balance claims, linked mrwk1 wallets, and registered wallet-to-wallet transfers.
  • Clarify that MergeWork does not currently operate a public BTC, USDC, fiat, bridge, exchange, or off-ramp.
  • Add a README pointer plus an agent-guide reminder so agents do not overstate liquidity or bridge status.

Validation

  • ./.venv/bin/python scripts/docs_smoke.py -> docs smoke ok
  • ./.venv/bin/python -m ruff check scripts/docs_smoke.py -> passed
  • git diff --check -> passed
  • ./.venv/bin/python -m ruff format --check README.md docs/ledger.md docs/agent-guide.md -> not applicable; Ruff reports Markdown formatting is experimental and requires preview mode

Bounty #395

No private keys, seed material, secrets, deployment credentials, private vulnerability details, payout credentials, price claims, or off-ramp promises are included.

Summary by CodeRabbit

  • Documentation
    • Clarified current MRWK transfer capabilities and limitations in README and ledger documentation
    • Documented supported transfer paths: work payments to linked wallets or temporary GitHub accounts, and wallet-to-wallet transfers with signature verification
    • Explicitly stated that non-native assets (BTC, USDC, fiat, bridges) are not currently supported

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 36a10c18-4311-4989-b145-c76a42c42a45

📥 Commits

Reviewing files that changed from the base of the PR and between a1795ed and e5e72c0.

📒 Files selected for processing (3)
  • README.md
  • docs/agent-guide.md
  • docs/ledger.md

📝 Walkthrough

Walkthrough

This PR updates documentation across README.md, docs/ledger.md, and docs/agent-guide.md to clarify that MRWK is currently a native ledger coin with three supported transfer paths (work payouts, contributor balance claiming, and signed wallet-to-wallet transfers), explicitly stating that public bridges, exchange/off-ramps, BTC, USDC, and fiat operations are not currently supported.

Changes

MRWK Transfer Capabilities Documentation

Layer / File(s) Summary
Ledger specification and transfer paths
docs/ledger.md
MRWK is clarified as a native project coin with snapshot/bridge/onchain-claim paths not currently operational. A new "Current Transfer Paths" section enumerates the three supported flows (work payouts to linked mrwk1 or temporary github:* accounts, contributor OAuth + signature claiming positive github:{login} balance, and signed mrwk1-to-mrwk1 transfers with Ed25519 signature and nonce verification). An explicit precondition is added that any future public bridge/exchange/redemption path requires separate maintainer + contributor discussion.
Public documentation and agent operational guidance
README.md, docs/agent-guide.md
README summarizes the ledger-native transfer rules, clarifies that non-native assets are unsupported, and points to docs/ledger.md for details. Agent guide advises checking ledger documentation before reporting payout/transfer status and explicitly warns against implying external asset movement unless maintainers publish it.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the summary, validation steps, and bounty reference, but lacks evidence of the specific confusion or missing step being addressed. Add an 'Evidence' section explicitly describing the confusion, stale example, or bug this PR addresses to meet the template requirement.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: clarifying MRWK transfer and bridge status through documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown
Contributor

@Karry2019web Karry2019web left a comment

Choose a reason for hiding this comment

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

No blockers from my review on current head.

Evidence checked:

  • Inspected README.md, docs/agent-guide.md, docs/ledger.md diff — covers the full Bounty #395 scope: current MRWK transfer paths (GitHub balance claims, linked mrwk1 wallets, signed wallet-to-wallet transfers), explicitly separates from future bridge/onchain-claim experiments, and includes the required "separate maintainer/contributor discussion before implementation" framing.
  • The prose is short, direct, and human. No investment, price, bridge-claim, cash-out, or fabricated payout language.
  • The contributor added #current-transfer-paths anchor in docs/ledger.md and linked it from README.md — matches the acceptance criteria.

One minor observation (not a blocker): the scripts/docs_smoke.py change wasn't shown in the diff — confirming docs smoke coverage was not needed for these changes per the bounty description's "Add or update docs smoke coverage only if needed" clause.

Copy link
Copy Markdown
Contributor

@ayskobtw-lil ayskobtw-lil left a comment

Choose a reason for hiding this comment

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

No blockers from my review on current head e5e72c0.

Evidence checked:

  • Inspected the changed README.md, docs/ledger.md, and docs/agent-guide.md text against Bounty #395.
  • Verified the docs enumerate only the current native MRWK transfer paths: accepted payouts to linked mrwk1 wallets or temporary github:{login} accounts, GitHub balance claims into linked wallets, and signed wallet-to-wallet transfers between registered mrwk1 wallets.
  • Verified the future bridge/onchain language is framed as non-live design work and does not imply a current BTC, USDC, fiat, public bridge, exchange, liquidity, price, cash-out, or off-ramp path.
  • Checked the new README pointer resolves to docs/ledger.md#current-transfer-paths.

Validation run locally:

  • python scripts/docs_smoke.py -> docs smoke ok
  • python -m ruff check README.md docs/ledger.md docs/agent-guide.md scripts/docs_smoke.py -> All checks passed
  • git diff --check origin/main...HEAD -> clean
  • git merge-tree --write-tree origin/main HEAD -> merge tree written successfully, no conflicts

@ramimbo ramimbo added duplicate This issue or pull request already exists mrwk:rejected Submission rejected labels May 26, 2026
@ramimbo
Copy link
Copy Markdown
Owner

ramimbo commented May 26, 2026

Closing as not accepted for Bounty #395. PR #397 was merged and paid for the single-slot round because it covered the same transfer/future-bridge status docs with the stronger validation path. #395 is now filled, and no fresh round is needed for this duplicate docs scope.

@ramimbo ramimbo closed this May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

duplicate This issue or pull request already exists mrwk:rejected Submission rejected

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants