refactor: remove dummy token transfer example#109
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughThis PR removes the dummy-token-transfer example content and updates the project registry to exclude it. It also refreshes SPL Tokens documentation and metadata across the root README and spl-tokens package files. ChangesExample removal and registry update
SPL Tokens docs and metadata refresh
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
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 `@spl-tokens/app/README.md`:
- Around line 54-60: The localhost example in the README is still triggering the
markdownlint MD031 warning because the fenced code block is not spaced
correctly. Reformat the example in the README section near the localhost usage
so the fence has the required blank line separation, or convert that snippet to
an indented code block while keeping the same commands; verify the markdown
around the examples section stays lint-clean.
🪄 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: 2e75c0d3-0a18-4f43-ae43-06a538490a6f
⛔ Files ignored due to path filters (6)
00-LEGACY_EXAMPLES/dummy-token-transfer/Cargo.lockis excluded by!**/*.lock00-LEGACY_EXAMPLES/dummy-token-transfer/package-lock.jsonis excluded by!**/package-lock.json00-LEGACY_EXAMPLES/dummy-token-transfer/yarn.lockis excluded by!**/yarn.lock,!**/*.lockdummy-token-transfer/Cargo.lockis excluded by!**/*.lockdummy-token-transfer/package-lock.jsonis excluded by!**/package-lock.jsondummy-token-transfer/yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (28)
00-LEGACY_EXAMPLES/dummy-token-transfer/.prettierignore00-LEGACY_EXAMPLES/dummy-token-transfer/Anchor.toml00-LEGACY_EXAMPLES/dummy-token-transfer/Cargo.toml00-LEGACY_EXAMPLES/dummy-token-transfer/README.md00-LEGACY_EXAMPLES/dummy-token-transfer/package.json00-LEGACY_EXAMPLES/dummy-token-transfer/programs/dummy-transfer/Cargo.toml00-LEGACY_EXAMPLES/dummy-token-transfer/programs/dummy-transfer/src/lib.rs00-LEGACY_EXAMPLES/dummy-token-transfer/tests/dummy-transfer.ts00-LEGACY_EXAMPLES/dummy-token-transfer/tsconfig.jsonREADME.mddummy-token-transfer/.prettierignoredummy-token-transfer/Anchor.tomldummy-token-transfer/Cargo.tomldummy-token-transfer/README.mddummy-token-transfer/package.jsondummy-token-transfer/programs/dummy-transfer/Cargo.tomldummy-token-transfer/programs/dummy-transfer/src/lib.rsdummy-token-transfer/tests/dummy-transfer-local.tsdummy-token-transfer/tests/dummy-transfer.tsdummy-token-transfer/tsconfig.jsonscripts/local-env.shscripts/projects.shspl-tokens/Anchor.tomlspl-tokens/README.mdspl-tokens/app/README.mdspl-tokens/app/example.envspl-tokens/app/package.jsonspl-tokens/programs/spl-tokens/Cargo.toml
💤 Files with no reviewable changes (19)
- 00-LEGACY_EXAMPLES/dummy-token-transfer/.prettierignore
- dummy-token-transfer/README.md
- 00-LEGACY_EXAMPLES/dummy-token-transfer/README.md
- dummy-token-transfer/tests/dummy-transfer.ts
- 00-LEGACY_EXAMPLES/dummy-token-transfer/programs/dummy-transfer/Cargo.toml
- 00-LEGACY_EXAMPLES/dummy-token-transfer/Cargo.toml
- dummy-token-transfer/Anchor.toml
- dummy-token-transfer/Cargo.toml
- dummy-token-transfer/.prettierignore
- 00-LEGACY_EXAMPLES/dummy-token-transfer/package.json
- dummy-token-transfer/programs/dummy-transfer/Cargo.toml
- dummy-token-transfer/package.json
- 00-LEGACY_EXAMPLES/dummy-token-transfer/programs/dummy-transfer/src/lib.rs
- 00-LEGACY_EXAMPLES/dummy-token-transfer/tests/dummy-transfer.ts
- dummy-token-transfer/tests/dummy-transfer-local.ts
- dummy-token-transfer/programs/dummy-transfer/src/lib.rs
- 00-LEGACY_EXAMPLES/dummy-token-transfer/Anchor.toml
- dummy-token-transfer/tsconfig.json
- 00-LEGACY_EXAMPLES/dummy-token-transfer/tsconfig.json
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…ve-dummy-token-transfer # Conflicts: # scripts/projects.sh
jonasXchen
left a comment
There was a problem hiding this comment.
I recall that wanted to keep the dummy token transfer since some use cases may use non-SPL to keep track of assets.
Problem: People should by default use ephemeral-spl-token.
Solution: Should we perhaps rename this to "isolated-asset-tokenization" so it goes a bit further?
so i want people to use the ephemeral-spl-token so that we can have composability between the programs like they can use the liquidity from other protocols and so on. In what scenarios would they want to have their own tokenization? |
|
@jonasXchen and i decided to go forward since it can be confusing to have multiple examples for token transfers |
Summary
dummy-token-transferexample.spl-tokensas the canonical SPL token transfer example.spl-tokensrelates to theephemeral-spl-tokenprogram.dummy-token-transferfrom the local/CI project list.Testing
git diff --checkbash -n scripts/projects.sh scripts/local-env.sh scripts/test-locally.sh scripts/test-example.shdummy-token-transferis no longer inprojects_jsonspl-tokensremains in the regular project setSummary by CodeRabbit