Skip to content

QUICK_START.md

Latest commit

 

History

History
238 lines (174 loc) · 4.87 KB

QUICK_START.md

File metadata and controls

238 lines (174 loc) · 4.87 KB

⚡ FLASHSTACK QUICK START GUIDE

Status: Ready to Deploy | Date: December 19, 2025

🚀 3-HOUR TESTNET DEPLOYMENT

HOUR 1: Get Funded

1. Go to: https://explorer.hiro.so/sandbox/faucet?chain=testnet
2. Connect Leather wallet (switch to Testnet)
3. Request 500,000 STX
4. Wait 2-3 minutes
5. Verify received: Check wallet balance

HOUR 2: Deploy Contracts

cd C:\Users\mattg\flashstack

# Option A: Clarinet (if working)
clarinet deployments apply -p deployments/testnet-plan.yaml --testnet

# Option B: Manual (if Clarinet fails)
# Deploy via https://explorer.hiro.so/sandbox/deploy
# Order: trait → token → core → integration → receivers

HOUR 3: Initialize & Test

# 1. Set flash minter
(contract-call? .sbtc-token set-flash-minter .flashstack-core)

# 2. Test flash loan
(contract-call? .flashstack-core flash-mint u1000000 .test-receiver)

# 3. Authorize SNP vault
(contract-call? .snp-flashstack-receiver authorize-vault 'ST2H682...vault-stx-v2)

📁 KEY FILES

Deploy These Contracts (In Order):

  1. flash-receiver-trait.clar - Interface
  2. sbtc-token.clar - Token contract
  3. flashstack-core.clar - Main protocol
  4. snp-flashstack-receiver.clar - SNP integration ⭐
  5. test-receiver.clar - Testing
  6. All other receivers (7 contracts)

Read These Guides:

  1. MASTER_LAUNCH_PLAN.md - Complete roadmap
  2. TESTNET_DEPLOYMENT.md - Deployment steps
  3. SNP_INTEGRATION_STEPS.md - Integration guide

✅ VERIFICATION CHECKLIST

After deployment, verify:

# Check all contracts compile
clarinet check
# Expected: ✔ 12 contracts checked

# Run all tests
npm test
# Expected: ✅ 20 passed (20)

# Check deployment (replace YOUR_ADDR)
https://explorer.hiro.so/address/YOUR_ADDR?chain=testnet

Must See:

  • ✅ All 12 contracts deployed
  • ✅ Flash minter set correctly
  • ✅ Test flash loan successful
  • ✅ SNP vault authorized

🎯 WEEK-BY-WEEK GOALS

Week 1 (Dec 19-26): TESTNET LIVE

  • Deploy all contracts ✅
  • Run 10+ test transactions ✅
  • Document addresses ✅

Week 2 (Dec 26-Jan 2): SNP INTEGRATED

  • Connect SNP vaults ✅
  • Test all 3 features ✅
  • Run 50+ transactions ✅

Week 3 (Jan 2-9): BETA TESTING

  • Recruit 10-20 users ✅
  • Process 100+ transactions ✅
  • Collect feedback ✅

Week 4 (Jan 9-16): MAINNET READY

  • Security review ✅
  • Finalize docs ✅
  • Deploy mainnet ✅

🔥 CRITICAL COMMANDS

Testnet Operations

# Get testnet STX
https://explorer.hiro.so/sandbox/faucet?chain=testnet

# Check balance
(stx-get-balance 'YOUR_ADDRESS)

# Set flash minter (MUST DO FIRST)
(contract-call? .sbtc-token set-flash-minter .flashstack-core)

# Execute flash loan
(contract-call? .flashstack-core flash-mint AMOUNT .RECEIVER)

# Check stats
(contract-call? .flashstack-core get-stats)

Testing

# Verify compilation
clarinet check

# Run tests
npm test

# Run specific test
npm test -- flashstack-core

# Check deployment plan
clarinet deployments check -p deployments/testnet-plan.yaml

📊 SUCCESS METRICS

Technical KPIs

  • Deployment: 12/12 contracts ✅
  • Tests: 20/20 passing ✅
  • Compilation: 0 errors ✅
  • Success Rate: >95% target

User KPIs

  • Beta Users: 10-20 target
  • Transactions: 100+ target
  • Response Time: <30s
  • Satisfaction: >80%

Business KPIs

  • TVL: $1M in 3 months
  • Volume: 1000+ txns/month
  • Revenue: $5K-50K/month
  • Partnerships: 3-5 protocols

🚨 TROUBLESHOOTING

Deployment Fails

  • Check STX balance (need 500K)
  • Try manual deployment
  • Wait 5 min, try again

Flash Loan Fails

  • Verify flash minter set
  • Check receiver contract exists
  • Ensure sufficient collateral

Integration Issues

  • Verify vault authorized
  • Check vault is active
  • Test with small amounts first

📞 GET HELP

Resources

Support Channels

  • GitHub Issues: Report bugs
  • Discord: Ask questions
  • Twitter: Share updates
  • Documentation: Self-service

🎉 WHAT SUCCESS LOOKS LIKE

After 3 hours, you should have:

  • ✅ All 12 contracts on testnet
  • ✅ Flash loans executing
  • ✅ SNP integration working
  • ✅ Explorer showing transactions

After 1 week, you should have:

  • ✅ 10+ successful tests
  • ✅ Documentation complete
  • ✅ Ready for beta users

After 4 weeks, you should have:

  • ✅ Beta testing complete
  • ✅ Mainnet deployment ready
  • ✅ Users onboarded

🚀 START NOW

RIGHT THIS SECOND:

  1. Open: https://explorer.hiro.so/sandbox/faucet?chain=testnet
  2. Get testnet STX
  3. Follow TESTNET_DEPLOYMENT.md
  4. Ship it! 🚀

You're 3 hours from live testnet!

STATUS: ALL SYSTEMS GO ✅✅✅
NEXT: Get testnet STX → Deploy → Test → Launch!