Merge pull request Fankouzu#83 from Fankouzu/basic

Solana Basic课程前三个阶段内容完成
nolank128 · Jun 17, 2024 · 517adfd · 517adfd
2 parents 9946ce1 + 6deb919
commit 517adfd
Show file tree

Hide file tree

Showing 93 changed files with 4,261 additions and 3 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -22,9 +22,57 @@ function nav(): DefaultTheme.NavItem[] {
         },
       ],
     },
+    {
+      text: "社区教程",
+      items: [
+        {
+          text: "Solana Basic",
+          link: "/SolanaBasic/000",
+          activeMatch: "/SolanaBasic/",
+        },
+      ],
+    },
   ];
 }
 
+function sidebarSolanaBasic(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: "第一阶段：账户与代币",
+      collapsed: false,
+      items: [
+        { text: "核心概念", link: "000" },
+        { text: "客户端安装", link: "001" },
+        { text: "代币基础", link: "002" },
+        { text: "非同质化代币", link: "003" },
+      ],
+    },
+    {
+      text: "第二阶段：脚本互动",
+      collapsed: false,
+      items: [
+        { text: "账户", link: "004" },
+        { text: "版本化交易", link: "005" },
+        { text: "包装SOL", link: "006" },
+        { text: "创建代币", link: "007" },
+        { text: "非同质化代币", link: "008" },
+      ],
+    },
+    {
+      text: "第三阶段：",
+      collapsed: false,
+      items: [
+        { text: "糖果机概述", link: "009" },
+        { text: "配置糖果机", link: "010" },
+        { text: "管理糖果机", link: "011" },
+        { text: "插入项目", link: "012" },
+        { text: "糖果卫士", link: "013" },
+        { text: "卫士组", link: "014" },
+        { text: "铸造", link: "015" },
+      ],
+    },
+  ];
+}
 function sidebarSolanaDocumention(): DefaultTheme.SidebarItem[] {
   return [
     {
@@ -321,6 +369,10 @@ export default defineConfig({
         base: "/SolanaProgramLibrary/",
         items: sidebarSolanaProgramLibrary(),
       },
+      "/SolanaBasic/": {
+        base: "/SolanaBasic/",
+        items: sidebarSolanaBasic(),
+      },
     },
     footer: {
       message:

diff --git a/docs/SolanaBasic/000.md b/docs/SolanaBasic/000.md
@@ -0,0 +1,143 @@
+# 核心概念
+
+:::tip 第一阶段账户与代币
+在第一阶段学习中，我们将学会通过命令行和 javascript 脚本创建账户，并且创建代币，同时学到 Solana 的特殊特性，通过代币账户来保存代币，这和以太坊智能合约的账本型合约有着本质的不同；并且我们还将了解到非同质化代币在 Solana 系统中的定义，即精度为 0 的代币都属于非同质化的代币；
+:::
+
+## Solana 开发流程
+
+- Solana 开发者工作流程是程序-客户（program-client）模型。程序开发的第一个工作流程允许您直接创建和部署自定义的 Rust、C 和 C++程序到区块链。一旦这些程序部署完成，任何知道如何与它们通信的人都可以使用它们。您可以使用任何可用的客户端 SDK（或 CLI）编写 dApps 来与这些程序通信，所有这些 SDK 都在底层使用 JSON RPC API。
+
+![solana-overview-client-program.png](/solana-overview-client-program.png)
+
+## 账户
+
+- 在 Solana 中，"Everythin is an Account" 类似 Linux 世界里面把所有的资源都抽象成"文件"一样。
+- Solana 作为一个分布式区块链系统，所有的信息都存储在 Account 对象中，如合约（Solana 叫 Onchain Program）, 账号信息，合约中存储的内容等都是存储在一个个 Account 对象中。
+- 在Solana中有三类账户：
+  - 数据账户，用来存储数据
+  - 程序账户，用来存储可执行程序
+  - 原生账户，指Solana上的原生程序，例如"System"，"Stake"，以及"Vote"。
+- 数据账户又分为两类：
+  - 系统所有账户
+  - 程序派生账户（PDA）
+- 一个账户存储的完整字段列表:
+
+| 字段      | 描述                                    |
+|------------|------------------------------------------------|
+| lamports   | 这个账户拥有的lamport（兰波特）数量   |
+| owner      | 这个账户的所有者程序              |
+| executable | 这个账户成是否可以处理指令  |
+| data       | 这个账户存储的数据的字节码 |
+| rent_epoch | 下一个需要付租金的epoch（代） |
+
+关于所有权，有几条重要的规则：
+
+- 只有账户的所有者才能改变账户中的数据，提取lamport
+- 任何人都可以向数据账户中存入lamport
+- 当账户中的数据被抹除之后，账户的所有者可以指定新的所有者
+
+程序账户不储存状态。
+
+例如，假设有一个计数程序，这个程序用来为一个计数器加数，你需要创建两个账户，一个用于存储程序的代码，
+另一个用于存储计数器本身。
+
+![account_example](/account_example.png)
+
+为了避免账户被删除，必须付租金。
+
+## 程序派生账户（PDA）
+
+程序派生账户（PDA）是为了让特定程序可以控制一些账户而设计出来的。使用PDA，程序可以通过编程方法为一些地址进行签名，而不一定用到私钥。
+
+- PDA是长度为32的字节串，看起来和公钥很像，但是并没有与之对应的私钥
+- `findProgramAddress`可以针对一个programId（程序id）和seeds（种子）唯一确定的生成一个PDA。这里的seeds（种子）是一组指定的字节串
+- 一个跳跃（一个字节）用于将候选PDA推离ed25519椭圆曲线
+- 程序通过传入种子和跳跃参数，调用[invoke_signed](https://docs.solana.com/developing/programming-model/calling-between-programs#program-signed-accounts)为PDA进行签名
+- PDA只能被用来派生出这个地址的程序所签名
+- 除了允许程序为不同的instruction签名之外，PDA还提供了一个像哈希表一样的接口，用于`建立账户索引`
+
+PDA是Solana程序开发的重要构成要素。有了PDA，程序可以为账户签名，同时保证没有外部用户能够产生针对同一个账户的有效签名。 除了为账户签名外，一些程序还可以修改自己派生出来的PDA里的数据。
+
+![Accounts matrix](/account-matrix.png)
+
+## 账号和签名
+
+- Solana 的签名系统使用的是 Ed25519 ,说人话就是： Ed25519 是一种计算快，安全性高，且生成的签名内容小的一种不对称加密算法。新一代公链几乎都支持这个算法。
+
+- 所以 Solana 的，我们用户理解的账号，就是一串 Ed25519 的私钥，各种钱包里面的助记词，会被转换成随机数种子， 再用随机数种子来生成一个私钥，所以助记词最终也是换算成私钥。所以用户账号的本质就是私钥，而用户账号的地址 则是这私钥对应的公钥,优于公钥是二进制的，为了可读性，将其进行 Base58 编码后的值，就是这个账号的地址。 如：HawRVHh7t4d3H3bitWHFt25WhhoDmbJMCfWdESQQoYEy
+
+- 把这里的公钥和私钥放一起，就是所谓的 Keypair，或者叫公私钥对。假设这里把私钥进行加密，并由用户来设置密码， 公钥作为这个私钥的索引。就实现了一个简单的钱包系统了。
+
+- 通过用户选择的公钥，加上密码，得到对应的私钥，再用私钥去操作的他的账号
+
+## 交易
+
+- 交易就是链外数据和链上数据产生的一次交互。比如发起一笔转账，在 StepN 里面发起一次 Claim 动作。 交易是对多个交易指令的打包，所以起内容主要就是各个交易指令，以及相应指令对应的发起人和签名。交易就是一连串的交易指令，以及需要签名的指令的签名内容。
+
+- 指令是Solana上最基本的操作单元
+- 每个指令都包含：
+  - `program_id`：所针对的程序的id
+  - `accounts`：需要读或写的全部账户组成的数组
+  - `instruction_data`：向指定程序所传输的数据的字节码
+- 多个指令可以被打包进入同一个交易当中
+- 每个交易都包含：
+  - `instructions`：一个或多个指令
+  - `blockhash`：最新的块哈希值
+  - `signatures`：一个或多个签名
+- 指令会被自动的按顺序执行
+- 如果一个指令的任何一部分失败，整个交易就会失败
+- 交易的大小限制在1232字节以内
+
+## 合约
+
+- 合约分为两类，一类是普通合约一类是系统合约，前者在 Solana 中称为"On Chain Program" 后者称为"Native Program" 其实本质都是类似其他公链上所说的合约。
+- 系统合约是由节点在部署的时候生成的，普通用户无法更新，他们像普通合约一样，可以被其他合约或者 RPC 进行调用
+  - 系统合约有
+  - System Program: 创建账号，转账等作用
+  - BPF Loader Program: 部署和更新合约
+  - Vote program: 创建并管理用户 POS 代理投票的状态和奖励
+- 一般我们说的合约都是普通合约，或者叫 "On Chain Program"。普通合约是由用户开发并部署，Solana 官方也有 一些官方开发的合约，如 Token、ATA 账号等合约。
+  - 当用户通过"BPF Loader Program"部署一个新合约的时候，新合约 Account 中的被标记为 true，表示他是一个可以 被执行的合约账号。不同于有些公链，Solana 上的合约是可以被更新的，也可以被销毁。并且当销毁的时候，用于存储 代码的账号所消耗的资源也会归还给部署者。
+
+## 合约与 Account
+
+- 在上面的 Account 介绍中，我们有个 owner 的成员，这个就表示这个 Account 是被哪个合约管理的，或者说哪个 合约可以对这个 Account 进行读写，类似 Linux 操作系统中，文件属于哪个用户。
+
+## 租约
+
+- Solana 的资金模型中，每个 Solana 账户在区块链上存储数据的费用称为“租金”。 这种基于时间和空间的费用来保持账户及其数据在区块链上的活动为节点提供相应的收入。
+
+- 所有 Solana 账户（以及计划）都需要保持足够高的 LAMPORT 余额，才能免除租金并保留在 Solana 区块链上。
+
+- 当帐户不再有足够的 LAMPORTS 来支付租金时，它将通过称为垃圾收集的过程从网络中删除。
+
+- 注意：租金与交易费用不同。 支付租金（或保存在账户中）以将数据存储在 Solana 区块链上。 而交易费用是为了处理网络上的指令而支付的。
+
+## 租金率
+
+- Solana 租金率是在网络范围内设置的，主要基于每年每字节设置的 LAMPORTS。 目前，租金率为静态金额并存储在 Rent 系统变量中。
+
+## SPL 代币
+
+- 在以太坊中，普通代币被一个叫 ERC20 的提案定了规范，可以认为普通代币合约统一叫做 ERC20 代币。
+
+那么 Solana 世界里的 ERC20 代币是什么呢？答案就是 SPL 代币。
+
+> The Solana Program Library (SPL) is a collection of on-chain programs targeting the Sealevel parallel runtime.
+
+SPL Token 是 " Solana Program Library"中的一个组成部分，叫做"Token Program"，简称为 SPL Token。
+
+所有的代币都有这个合约来管理，该合约代码在 <https://github.com/solana-labs/solana-program-library/tree/master/token>
+
+## 代币信息
+
+- 不同于以太坊中，一个代币就是一个合约。SPL Token 中，一个代币，仅仅是一个归 Token 合约管理的普通的 Account 对象，这个对象里面的二进制数据定义了 这个代币的基本属性。
+
+![mint_wallet_account.png](/mint_wallet_account.png)
+
+## SPL Token Account
+
+- 那么每个用户的拥有的代币数量信息存在哪里呢？这个合约又定义了一个账号结构，来表示某个地址含有某个代币的数量。
+
+![spl_pda_account.png](/spl_pda_account.png)
diff --git a/docs/SolanaBasic/001.md b/docs/SolanaBasic/001.md
@@ -0,0 +1,164 @@
+# Solana 客户端安装
+
+> 作者 崔棉大师 X：[@MasterCui](https://x.com/@MasterCui) Youtube: [崔棉大师](https://www.youtube.com/channel/UCv4y5qSUbJ8UC3CUmBPC_BA)
+
+## 知识点
+
+- 这一章节将要学到有关 `Solana` 客户端的安装过程，包括安装 solana 命令行 cli，和 rust 客户端，还有发布 Token 所需要的 `spl-token` 客户端；同时我们使用客户端创建本地密钥对，也就是本地钱包，在后面的课程中使用
+
+## 课程
+
+### 1.安装 Rust
+
+[参考](/SolanaDocumention/intro/dev#链上程序开发)
+
+:::tip INFO
+不同的操作系统在参考链接中可以找到不同的安装方法，本教程以 MacOS 为例
+:::
+
+链上程序开发包括用 Rust、C 或 C++编写程序。首先，您需要确保电脑上安装了 Rust。您可以使用以下命令执行此操作：
+
+```sh
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+### 2.安装 Solana 客户端
+
+[参考](/SolanaDocumention/intro/dev#链上程序开发)
+
+然后，您需要安装 Solana CLI 来编译和部署您的程序。您可以通过运行以下命令来安装 Solana CLI：
+
+```sh
+sh -c "$(curl -sSfL https://release.solana.com/stable/install)"
+solana --version
+```
+
+建议使用 Solana CLI 运行本地验证器来测试您的程序。要在安装 Solana CLI 后,运行本地验证器，请运行以下命令：
+
+```sh
+solana-test-validator
+```
+
+### 3.安装 SPL 客户端
+
+[参考](/SolanaProgramLibrary/token#相关教程)
+
+Solana 程序库 (SPL) 是针对 Sealevel 并行运行时的链上程序的集合。我们将要学习通过spl-token客户端命令创建代币
+
+```sh
+cargo install spl-token-cli
+```
+
+运行 spl-token --help 获取可用命令的完整描述。
+
+## 操作
+
+### 1.配置 RPC 节点
+
+您可以通过运行以下命令来查看 Solana CLI 当前对应的是哪个集群：
+
+[参考](/SolanaValidatorDocumentation/cli/examples/choose-a-cluster)
+
+```sh
+$ solana config get
+Config File: ${HOME}/.config/solana/cli/config.yml
+RPC URL: https://api.mainnet-beta.solana.com
+WebSocket URL: wss://api.mainnet-beta.solana.com/ (computed)
+Keypair Path: ${HOME}/.config/solana/id.json
+```
+
+使用 solana config set 命令来设定集群。任何未来的子命令都将在你设置的集群上发送或接收信息。
+
+例如想要连接到开发网集群，请运行：
+
+设置 RPC 节点地址:
+
+[参考](/SolanaDocumention/core/clusters)
+
+```sh
+solana config set --url https://api.devnet.solana.com
+```
+
+第三方节点：
+
+- <https://www.quicknode.com/chains/sol>
+
+### 2.创建密钥对
+
+通过以下命令可以创建一个新的密钥对钱包，并且保存在你的系统目录中，之后的 Solana 命令行 cli 将默认使用这个钱包地址
+[参考](/SolanaValidatorDocumentation/cli/cli)
+
+```sh
+$ solana-keygen new
+Generating a new keypair
+
+For added security, enter a BIP39 passphrase
+
+NOTE! This passphrase improves security of the recovery seed phrase NOT the
+keypair file itself, which is stored as insecure plain text
+
+BIP39 Passphrase (empty for none):
+
+Wrote new keypair to ${HOME}/.config/solana/id.json
+==============================================================================
+pubkey: 8wgMJeuPMYWJi5c2zvF8kffSbUvyaU9us1wgeJnrVzb4
+==============================================================================
+Save this seed phrase and your BIP39 passphrase to recover your new keypair:
+ankle sadness harbor traffic happy sleep culture quote cream nation that spray
+==============================================================================
+```
+
+查看自己的钱包地址：
+
+```sh
+solana address
+```
+
+创建一个新账户，但是不将密钥对保存在系统中，我们可以拿这个地址用于未来的测试中使用：
+
+```sh
+$ solana-keygen new --no-outfile
+Generating a new keypair
+
+For added security, enter a BIP39 passphrase
+
+NOTE! This passphrase improves security of the recovery seed phrase NOT the
+keypair file itself, which is stored as insecure plain text
+
+BIP39 Passphrase (empty for none): 
+
+================================================================================
+pubkey: CrHB76Q9ckYJic4kt4ZqHV5wDJ9meDK8cMbDJhzfw1x9
+================================================================================
+Save this seed phrase and your BIP39 passphrase to recover your new keypair:
+local monitor diesel enhance visit tag interest diagram love okay aspect blossom
+================================================================================
+```
+
+### 3.配置钱包
+
+如果希望将密钥对的 json 文件保存在其他文件夹下，使用这个命令，修改默认配置中的密钥对文件路径
+
+[参考](/SolanaProgramLibrary/token#default-keypair)
+
+```sh
+solana config set --keypair ${HOME}/new-keypair.json
+```
+
+### 4.领取空投
+
+将Solana命令行的默认配置链接到devnet开发网节点后，可以领取测试币的空投，有了测试币我们就可以进行下面的课程内容了；
+
+[参考](/SolanaProgramLibrary/token#airdrop-sol)
+
+```sh
+solana airdrop 1
+```
+
+## 挑战
+
+通过solana cli命令行客户端完成以下挑战，具体方法可以通过运行`solana -h`获取帮助信息
+
+- 查询自己的sol余额
+- 获取当前区块高度
+- 发送sol到其他地址