https://github.com/solana-developers/program-examples

A repository of Solana program examples
https://github.com/solana-developers/program-examples

Last synced: about 1 month ago
JSON representation

A repository of Solana program examples

• Host: GitHub
• URL: https://github.com/solana-developers/program-examples
• Owner: solana-developers
• Created: 2022-07-01T16:37:26.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-18T02:54:29.000Z (about 2 months ago)
• Last Synced: 2024-05-18T19:46:45.041Z (about 1 month ago)
• Language: TypeScript
• Size: 6.19 MB
• Stars: 409
• Watchers: 11
• Forks: 124
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md

Lists

• awesome-solana - Program Examples - developers/program-examples.svg?style=social) (Books, Tutorials, and Courses)

README

        
# Program Examples

### :crab: Rust. :snake: Python. :link: All on-chain.

## Navigating this Repo

:file_folder: Each example contains four folders:

- `native` - Written using Solana's native Rust crates and vanilla Rust.

- `anchor` - Written using Anchor's `anchor_lang` Rust crate and the associated Anchor framework to build & deploy.

- `seahorse` - Written using the Python framework Seahorse, which converts your Python code to Anchor Rust.

:wrench: How to build & run:

- Before running anything in any folder make sure you pull in the dependencies with `yarn install`.

- `native` - Use `cicd.sh` to build & deploy the program. Run `yarn run test` to test it.

- `anchor` - Use `anchor build && anchor deploy` to build & deploy the program. Run `anchor run test` to test it.

- `seahorse` - Use `seahorse build && anchor deploy` to build & deploy the program. Run `anchor run test` to test it.

## Examples We'd Love to See!

- Examples needed for Native:

  - Token2022

- Examples needed for Anchor:

  - Additional Accounts & Resolving Accounts

- Examples needed for Seahorse

  - Any existing example missing a `seahorse` folder

- New examples needed for Solidity, Anchor, Native & Seahorse:

  - Token lending

  - Token swapping

  - Escrow

  - Staking

  - Wrapped tokens

  - Pyth

  - Clockwork

  - VRF

  - Any oracle

  - Merkle trees (compression)

---

## If You're New To Solana Please Read

Most system-level operations on Solana involve already-existing Solana programs.

For example, to create a **system account** you use the **system program** and to create a **token mint** you use the **token program**.

So, you'll notice that these operations are in fact conducting what's called a **cross-program invocation** - which is a fancy way of saying it calls other Solana programs to do business. You can see this in action whenever you see `invoke` or `invoke_signed` in the `native` examples, or `CpiContext` in the `anchor` examples.

Deciding when to use cross-program invocation instead of invoking the programs directly from the client is completely up to you as the builder. It depends on how your application is designed.

- Maybe you want to add some checks - such as minimum balance required, allowed ownership, etc.

- Maybe you want to assert that an account has a certain data type.

- Perhaps you want to send only one instruction from your client for a handful of sequential operations.

- The list goes on.

  Regardless of what you may want to add on top of existing Solana programs, the number one use case for writing your own program is for using accounts with a **Program Derived Address (PDA)**. Crack open the `pdas` folder to see why.