STON.fi DEX Core 项目教程

2024-09-12 06:02:23作者：劳婵绚Shirley

1. 项目目录结构及介绍

STON.fi DEX Core 项目的目录结构如下：

dex-core/
├── build/
│   └── contracts/
├── contracts/
├── test/
├── env.example
├── .gitignore
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
└── tsconfig.json

目录介绍

build/: 包含编译后的合约文件。
contracts/: 包含项目的核心合约文件。
test/: 包含项目的测试文件。
env.example: 环境配置文件的示例。
.gitignore: Git 忽略文件配置。
LICENSE: 项目许可证文件，采用 GPL-3.0 许可证。
README.md: 项目介绍和使用说明。
package-lock.json: 锁定项目依赖版本的文件。
package.json: 项目依赖和脚本配置文件。
tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

STON.fi DEX Core 项目的启动文件主要是通过 package.json 中的脚本来执行的。以下是主要的启动脚本：

npm install: 安装项目依赖。
npm run build: 编译合约文件。
npm run test: 运行测试。
npm run deploy: 部署合约。

启动步骤

安装依赖：
```
npm install
```
编译合约：
```
npm run build
```
运行测试：
```
npm run test
```
部署合约：
```
npm run deploy
```

3. 项目的配置文件介绍

STON.fi DEX Core 项目的主要配置文件包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键配置：

{
  "name": "dex-core",
  "version": "1.0.0",
  "scripts": {
    "build": "npm run compile",
    "test": "npm run test",
    "deploy": "npm run deploy"
  },
  "dependencies": {
    "some-dependency": "^1.0.0"
  },
  "devDependencies": {
    "some-dev-dependency": "^1.0.0"
  }
}

tsconfig.json

tsconfig.json 文件用于配置 TypeScript 编译选项。以下是一些关键配置：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}