Skip to content

Commit a1b1d97

Browse files
authored
Add a summary for each example and links to READMEs where they exist. (#92)
1 parent f0c0b36 commit a1b1d97

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed

README.md

+78
Original file line numberDiff line numberDiff line change
@@ -24,62 +24,92 @@ If a given example is missing, please add it!
2424

2525
#### account-data
2626

27+
Store and retrieve data using Solana accounts.
28+
2729
[anchor](./basics/account-data/anchor), [native](./basics/account-data/native)
2830

2931
#### checking-accounts
3032

33+
[Check that the accounts provided in incoming instructions meet particular criteria.](./basics/checking-accounts/README.md)
34+
3135
[anchor](./basics/checking-accounts/anchor), [native](./basics/checking-accounts/native)
3236

3337
#### close-account
3438

39+
Close an account and get the Lamports back.
40+
3541
[anchor](./basics/close-account/anchor), [native](./basics/close-account/native)
3642

3743
#### counter
3844

45+
[Use a PDA to store global state, making a counter that increments when called.](./basics/counter/README.md)
46+
3947
[anchor](./basics/counter/anchor), [native](./basics/counter/native), [seahorse](./basics/counter/seahorse)
4048

4149
#### create-account
4250

51+
[Make new accounts on the blockchain.](./basics/create-account/README.md)
52+
4353
[anchor](./basics/create-account/anchor), [native](./basics/create-account/native)
4454

4555
#### cross-program-invocation
4656

57+
[Invoke an instruction handler from one onchain program in another onchain program.](./basics/cross-program-invocation/README.md)
58+
4759
[anchor](./basics/cross-program-invocation/anchor), [native](./basics/cross-program-invocation/native)
4860

4961
#### favorites
5062

63+
Save and update per-user state on the blockchain, ensuring users can only update their own information.
64+
5165
[anchor](./basics/favorites/anchor)
5266

5367
#### hello-solana
5468

69+
[Hello World on Solana! A minimal program that logs a greeting.](./basics/hello-solana/README.md)
70+
5571
[anchor](./basics/hello-solana/anchor), [native](./basics/hello-solana/native), [seahorse](./basics/hello-solana/seahorse)
5672

5773
#### pda-rent-payer
5874

75+
[Use a PDA to pay the rent for the creation of a new account.](./basics/pda-rent-payer/README.md)
76+
5977
[anchor](./basics/pda-rent-payer/anchor), [native](./basics/pda-rent-payer/native)
6078

6179
#### processing-instructions
6280

81+
[Add parameters to an instruction handler and use them.](./basics/processing-instructions/README.md)
82+
6383
[anchor](./basics/processing-instructions/anchor), [native](./basics/processing-instructions/native)
6484

6585
#### program-derived-addresses
6686

87+
Store and retrieve state in Solana.
88+
6789
[anchor](./basics/program-derived-addresses/anchor), [native](./basics/program-derived-addresses/native)
6890

6991
#### realloc
7092

93+
How to store state that changes size in Solana.
94+
7195
[anchor](./basics/realloc/anchor), [native](./basics/realloc/native)
7296

7397
#### rent
7498

99+
[Determine the necessary minimum rent by calculating an account's size.](./basics/rent/README.md)
100+
75101
[anchor](./basics/rent/anchor), [native](./basics/rent/native)
76102

77103
#### repository-layout
78104

105+
[Layout larger Solana onchain programs.](./basics/repository-layout/README.md)
106+
79107
[anchor](./basics/repository-layout/anchor), [native](./basics/repository-layout/native)
80108

81109
#### transfer-sol
82110

111+
[Send SOL between two accounts.](./basics/transfer-sol/README.md)
112+
83113
[anchor](./basics/transfer-sol/anchor), [native](./basics/transfer-sol/native), [seahorse](./basics/transfer-sol/seahorse)
84114

85115
</details>
@@ -88,30 +118,44 @@ If a given example is missing, please add it!
88118

89119
#### create-token
90120

121+
[Create a token on Solana with a token symbol and icon.](./tokens/create-token/README.md)
122+
91123
[anchor](./tokens/create-token/anchor), [native](./tokens/create-token/native)
92124

93125
#### escrow
94126

127+
Allow two users to swap digital assets with each other, each getting 100% of what the other has offered due to the power of decentralization!
128+
95129
[anchor](./tokens/escrow/anchor)
96130

97131
#### nft-minter
98132

133+
[Mint an NFT from inside your own onchain program using the Token and Metaplex Token Metadata programs.](./tokens/nft-minter/README.md) Reminder: you don't need your own program just to mint an NFT, see the note at the top of this README.
134+
99135
[anchor](./tokens/nft-minter/anchor), [native](./tokens/nft-minter/native)
100136

101137
#### pda-mint-authority
102138

139+
[Mint a Token from inside your own onchain program using the Token program.](./tokens/pda-mint-authority/README.md) Reminder: you don't need your own program just to mint an NFT, see the note at the top of this README.
140+
103141
[anchor](./tokens/pda-mint-authority/anchor), [native](./tokens/pda-mint-authority/native)
104142

105143
#### spl-token-minter
106144

145+
[Mint a Token from inside your own onchain program using the Token program.](./tokens/spl-token-minter/README.md) Reminder: you don't need your own program just to mint an NFT, see the note at the top of this README.
146+
107147
[anchor](./tokens/spl-token-minter/anchor), [native](./tokens/spl-token-minter/native)
108148

109149
#### token-swap
110150

151+
[Create liquidity pools to allow trading of new digital assets and allows users that provide liquidity to be rewarded by creating an Automated Market Maker.](./tokens/token-swap/README.md)
152+
111153
[anchor](./tokens/token-swap/anchor)
112154

113155
#### transfer-tokens
114156

157+
[Transfer tokens between accounts](./tokens/transfer-tokens/README.md)
158+
115159
[anchor](./tokens/transfer-tokens/anchor), [native](./tokens/transfer-tokens/native), [seahorse](./tokens/transfer-tokens/seahorse)
116160

117161
</details>
@@ -122,54 +166,80 @@ If a given example is missing, please add it!
122166

123167
#### basics
124168

169+
Create token mints, mint tokens, and transferr tokens using Token Extensions.
170+
125171
[anchor](./tokens/token-2022/basics/anchor)
126172

127173
#### cpi-guard
128174

175+
Enable CPI guard to prevents certain token action from occurring within CPI (Cross-Program Invocation).
176+
129177
[anchor](./tokens/token-2022/cpi-guard/anchor)
130178

131179
#### default-account-state
132180

181+
Create new token accounts that are frozen by default.
182+
133183
[anchor](./tokens/token-2022/default-account-state/anchor), [native](./tokens/token-2022/default-account-state/native)
134184

135185
#### group
136186

187+
Create tokens that belong to larger groups of tokens using the Group Pointer extension.
188+
137189
[anchor](./tokens/token-2022/group/anchor)
138190

139191
#### immutable-owner
140192

193+
Create tokens whose owning program cannot be changed.
194+
141195
[anchor](./tokens/token-2022/immutable-owner/anchor)
142196

143197
#### interest-bearing
144198

199+
Create tokens that show an 'interest' calculation.
200+
145201
[anchor](./tokens/token-2022/interest-bearing/anchor)
146202

147203
#### memo-transfer
148204

205+
Create tokens where transfers must have a memo describing the transaction attached.
206+
149207
[anchor](./tokens/token-2022/memo-transfer/anchor)
150208

151209
#### metadata
152210

211+
Create tokens that store their onchain metadata inside the token mint, without needing to use or pay for additional programs.
212+
153213
[anchor](./tokens/token-2022/metadata/anchor)
154214

155215
#### mint-close-authority
156216

217+
Allow a designated account to close a Mint.
218+
157219
[anchor](./tokens/token-2022/mint-close-authority/anchor), [native](./tokens/token-2022/mint-close-authority/native)
158220

159221
#### multiple-extensions
160222

223+
Use multiple Token Extensions at once.
224+
161225
[native](./tokens/token-2022/multiple-extensions/native)
162226

163227
#### non-transferable
164228

229+
Create tokens that cannot be transferred.
230+
165231
[anchor](./tokens/token-2022/non-transferable/anchor), [native](./tokens/token-2022/non-transferable/native)
166232

167233
#### permanent-delegate
168234

235+
Create tokens that remain under the control of an account, even when transferred elsewhere.
236+
169237
[anchor](./tokens/token-2022/permanent-delegate/anchor)
170238

171239
#### transfer-fee
172240

241+
Create tokens
242+
173243
[anchor](./tokens/token-2022/transfer-fee/anchor), [native](./tokens/token-2022/transfer-fee/native)
174244

175245
</details>
@@ -179,14 +249,20 @@ If a given example is missing, please add it!
179249

180250
#### cnft-burn
181251

252+
Burn compressed NFTs.
253+
182254
[anchor](./compression/cnft-burn/anchor)
183255

184256
#### cnft-vault
185257

258+
Store Metaplex compressed NFTs inside a PDA.
259+
186260
[anchor](./compression/cnft-vault/anchor)
187261

188262
#### cutils
189263

264+
Work with Metaplex compressed NFTs.
265+
190266
[anchor](./compression/cutils/anchor)
191267

192268
</details>
@@ -197,6 +273,8 @@ If a given example is missing, please add it!
197273

198274
#### pyth
199275

276+
Use a data source for offchain data (called an Oracle) to perform activities onchain.
277+
200278
[anchor](./oracles/pyth/anchor), [seahorse](./oracles/pyth/seahorse)
201279

202280
</details>

0 commit comments

Comments
 (0)