Skip to content

hoh-zone/intro-walrus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Walrus 从入门到精通

这是一本使用 mdBook 编写的 Walrus 开发者书籍,面向想从 CLI 使用、Walrus Sites 发布、SDK 集成一路深入到 Sui/Move、系统原理和生产实践的开发者。

阅读方式

本地预览:

mdbook serve

构建静态站点:

mdbook build

书籍入口在 src/SUMMARY.md

旧版激励任务和参与者提交内容已从主仓库移除,当前仓库只保留书籍源码、示例代码和 GitHub Actions 配置。

GitHub Pages

GitHub Pages 部署 workflow 位于 .github/workflows/deploy-pages.yml。它会在 main 分支更新后 checkout 当前仓库,以及 MystenLabs/walrusMystenLabs/walrus-sitesMystenLabs/MemWalMystenLabs/sui-stack-messaging 的默认最新分支,然后用最新 mdBook 构建并发布 book/ 到 GitHub Pages。

首次使用时,在仓库 Settings -> Pages -> Build and deployment 中把 Source 设置为 GitHub Actions

CI

检查 workflow 位于 .github/workflows/book-ci.yml。它会校验 npm 示例依赖是否仍是 registry 最新版本,并构建书籍和示例代码。

内容定位

本书按“先能用,再能集成,最后理解原理和生产化”的路径组织:

  1. 安装 Sui、Walrus、Walrus Sites 工具。
  2. 使用 CLI 上传、下载、查询和管理 Blob。
  3. 发布和维护 Walrus Sites。
  4. 使用 HTTP API 与 TypeScript SDK 构建应用。
  5. 理解 Sui/Move 集成、Walrus 架构、纠删码和安全边界。
  6. 完成文件网盘、内容站、MemWal AI Agent 记忆库和 Sui Stack Messaging 加密消息应用四个项目。

版本策略

所有示例默认使用最新稳定版本。当前核对日期为 2026-05-06,详见 src/appendix/a-versions-and-sources.md

重要安全提示

Walrus Blob 默认公开可读。不要把私钥、助记词、访问令牌、用户隐私数据或商业敏感数据明文上传到 Walrus。需要保存敏感数据时,先使用 Seal、MemWal 或你自己的加密方案加密,再写入 Walrus。

About

walrus bootcamp

Resources

Stars

28 stars

Watchers

2 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors