Structure lesson (licence does not allow quoting code)
BreakOut-contracts
- Original
- pramaths/BreakOut-contracts
- SuperStack fork
- Blockchains/BreakOut-contracts @
41ec012 - Stars
- 0
- Last push (original)
- 2025-05-15
- Languages
- TypeScript, Rust
- Detected stack
- Anchor
- Categories
- Other
- Licence
- none detected: code not quoted on Sol.College
Architecture
23 source files. By extension: .rs ×19, .ts ×4.
| Top-level directory | Source files |
|---|---|
programs | 19 |
tests | 2 |
migrations | 1 |
cli | 1 |
On-chain programs: programs/spotwin
How it works: instructions and accounts
Each instruction handler and the accounts struct it validates, found by reading the Rust source. Links go to the exact line at the pinned commit.
| Instruction | Accounts | Source |
|---|---|---|
initialize | Initialize | programs/spotwin/src/lib.rs:19 |
create_contest | CreateContest | programs/spotwin/src/lib.rs:24 |
join_contest | JoinContest | programs/spotwin/src/lib.rs:28 |
update_answers | UpdateAnswers | programs/spotwin/src/lib.rs:32 |
lock_contest | LockContest | programs/spotwin/src/lib.rs:36 |
post_answer_key | PostAnswerKey | programs/spotwin/src/lib.rs:40 |
post_payout_root | PostPayoutRoot | programs/spotwin/src/lib.rs:44 |
stake_tokens | StakeTokens | programs/spotwin/src/lib.rs:63 |
unstake_tokens | UnstakeTokens | programs/spotwin/src/lib.rs:67 |
handler | SweepVault | programs/spotwin/src/instructions/sweep_fees.rs:54 |
handler | UpdateAnswers | programs/spotwin/src/instructions/update_answers.rs:42 |
handler | LockContest | programs/spotwin/src/instructions/lock_contest.rs:22 |
Where the Solana code lives
Source files that import a Solana SDK, ranked by how many Solana APIs they use, with the APIs each one calls. Read them in this order to see how the app talks to the chain.
| File | Solana APIs used |
|---|---|
cli/src/sdk.ts | PublicKey, SystemProgram, AnchorProvider, findProgramAddressSync, Program, Connection |
tests/happy-flow.ts | PublicKey, findProgramAddressSync, SystemProgram, mintTo, Program, createMint |
programs/spotwin/src/instructions/send_batch.rs | seeds, Pubkey, transfer, AccountInfo, has_one, Program |
programs/spotwin/src/instructions/join_contest.rs | seeds, Program, has_one, Pubkey, CpiContext, transfer |
programs/spotwin/src/instructions/stake_tokens.rs | seeds, Program, init_if_needed, invoke_signed, CpiContext, transfer |
programs/spotwin/src/instructions/sweep_fees.rs | seeds, has_one, Program, CpiContext |
programs/spotwin/src/instructions/unstake_tokens.rs | seeds, invoke_signed, Program, CpiContext, transfer |
programs/spotwin/src/instructions/create_contest.rs | seeds, Program |
programs/spotwin/src/instructions/initialize_stake.rs | seeds, Program |
programs/spotwin/src/instructions/update_answers.rs | seeds, has_one |
tests/spotwin.ts | Program, AnchorProvider |
programs/spotwin/src/state/contest.rs | Pubkey |
Dapp: devnet deploy pending
⏳ Devnet deploy pending — goes live when the devnet wallet is topped up. This fork's own dapp is not deployed yet, so there is no program address or transaction to show. It is queued in dapp-queue.txt; once devnet SOL is available it is deployed, exercised with real devnet transactions, and this section switches to the live dapp at /dapps/breakout-contracts/. Until then, the lesson and step-by-step guide below are complete, and you can run it locally with the commands below.
How to run, build and test
These commands come from the repo's own manifests (package.json scripts, Anchor.toml, Cargo, go.mod, Makefile). Check the README for prerequisites and environment variables.
| Directory | Command | Runs |
|---|---|---|
. | npm run lint | |
. | anchor build | |
. | anchor test | |
. | anchor run test | |
. | cargo build | |
. | cargo test |
What you could build from it
- Fork the SuperStack copy and extend it within the Other gaps listed on the idea page.
- Learn the pattern first: Program Derived Addresses (PDAs)
- Learn the pattern first: Cross-Program Invocations (CPIs)