📝 Add guide on minting and transferring dfTokens#795
📝 Add guide on minting and transferring dfTokens#795MattPoblete wants to merge 3 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive tutorial guide for programmatically minting and transferring dfTokens using a TypeScript script. The guide walks users through depositing assets into a DeFindex vault (which mints dfTokens) and then transferring those tokens to another wallet address, enabling use cases like raffles, airdrops, and user incentives.
Changes:
- Adds a new 7-minute tutorial: "Mint & Transfer dfTokens" covering deposit and transfer operations via TypeScript
- Updates navigation in SUMMARY.md to include the new guide between "Beginner Guide" and "Additional Resources"
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| apps/docs/api-integration-guide/guides-and-tutorials/deposit-and-transfer-dftokens.md | New comprehensive tutorial with step-by-step TypeScript implementation for depositing to vaults and transferring dfTokens, including setup, code examples, troubleshooting, and an AI prompt template |
| apps/docs/SUMMARY.md | Adds navigation entry for the new tutorial in the Guides and Tutorials section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
apps/docs/api-integration-guide/guides-and-tutorials/deposit-and-transfer-dftokens.md
Outdated
Show resolved
Hide resolved
apps/docs/api-integration-guide/guides-and-tutorials/deposit-and-transfer-dftokens.md
Outdated
Show resolved
Hide resolved
| --- | ||
| description: ⏱️ 7 min read | ||
| --- | ||
|
|
||
| # Mint & Transfer dfTokens | ||
|
|
||
| ## 📖 What You'll Learn | ||
|
|
||
| In this tutorial you'll build a TypeScript script that: | ||
|
|
||
| * **Deposits** assets into a DeFindex vault and receives dfTokens in return | ||
| * **Transfers** those dfTokens to another Stellar wallet | ||
|
|
||
| By the end, you'll have a working script that automates this entire flow — useful for vault managers who want to run **raffles**, **airdrops**, or distribute **incentives** to their users. | ||
|
|
There was a problem hiding this comment.
The issue #789 explicitly requests a guide on how to transfer df tokens "both by script and with freighter". This PR only addresses the script approach using TypeScript and does not include any guidance for transferring dfTokens using the Freighter wallet. Consider either adding a section on Freighter-based transfers or updating the PR description and issue to clarify that this only covers the programmatic approach, with Freighter support planned for a separate guide.
|
|
||
| Before starting, make sure you have: | ||
|
|
||
| * **Node.js** (v18+) and a package manager (`pnpm`, `npm`, or `yarn`) |
There was a problem hiding this comment.
The prerequisite lists Node.js v18+ as a requirement, but the SDK documentation (apps/docs/advanced-documentation/sdks/02-defindex-sdk.md:21) specifies Node.js v16 or higher. For consistency across documentation, consider either aligning this to match the SDK's v16+ requirement or documenting why v18+ is needed specifically for this tutorial.
| * **Node.js** (v18+) and a package manager (`pnpm`, `npm`, or `yarn`) | |
| * **Node.js** (v16+) and a package manager (`pnpm`, `npm`, or `yarn`) |
…nd-transfer-dftokens.md Co-authored-by: Copilot <[email protected]>
…nd-transfer-dftokens.md Co-authored-by: Copilot <[email protected]>
Summary
SUMMARY.mdwith the new navigation entryCloses #789