CashScript 开源项目教程

1. 项目的目录结构及介绍

CashScript 是一个用于在 Bitcoin Cash 上编写智能合约的高级编程语言。以下是其主要目录结构：

• examples/: 包含了 CashScript 的使用示例，包括 .cash 文件（智能合约）和 .ts 文件（TypeScript 代码，用于与智能合约交互）。
• packages/cashc/: 存放 CashScript 编译器的源代码，该编译器用于将 .cash 文件编译为 .json 或 .ts 文件。
• packages/cashscript/: 包含 CashScript TypeScript SDK 的源代码，用于在应用程序中与智能合约进行交互。
• website/: 包含 CashScript 官方网站的源代码。
• .github/: 包含 GitHub 工作流程文件，用于自动化项目的某些操作。
• DEVELOPMENT.md: 提供开发环境的设置指南。
• Dockerfile: 用于创建 Docker 容器的文件。
• LICENSE: 项目的 MIT 许可证文件。
• README.md: 项目的自述文件，包含项目的介绍和安装指南。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

CashScript 的启动主要是通过其命令行工具 cashc 以及 TypeScript SDK 来进行。以下是一些关键的启动文件：

• cashc: CashScript 编译器的命令行工具，用于编译 .cash 文件。可以通过 npm install -g cashc 安装全局编译器。
• package.json: 在 packages/cashc/ 和 packages/cashscript/ 目录下，包含项目的依赖和脚本，可以通过 npm install 安装依赖，然后使用 npm run 执行脚本。

编译器的使用示例：

cashc myContract.cash -o myContract.json

上述命令会将 myContract.cash 文件编译为 myContract.json 文件。

3. 项目的配置文件介绍

项目的配置文件主要用于设置开发环境和编译选项。

• .eslintrc.cjs: ESLint 的配置文件，用于定义代码风格和规则。
• tsconfig.json: TypeScript 的配置文件，用于定义 TypeScript 编译器的选项，如模块解析、编译选项等。
• .gitignore: 用于定义 Git 忽略的文件和目录，防止将不需要的文件提交到仓库。

这些配置文件确保了代码的质量和一致性，同时也提供了开发时的便利。在开始开发之前，需要确保这些配置文件符合项目的需求。