开源项目 `fuels-ts` 使用教程

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

fuels-ts 项目的目录结构如下：

fuels-ts/
├── docs/
├── examples/
├── packages/
│   ├── fuels/
│   ├── fuels-react/
│   ├── fuels-wallet/
│   └── fuels-core/
├── scripts/
├── tests/
├── .gitignore
├── .prettierrc
├── lerna.json
├── package.json
└── tsconfig.json

目录结构介绍

• docs/: 包含项目的文档文件。
• examples/: 包含使用 fuels-ts 的示例代码。
• packages/: 包含项目的各个子包，如 fuels, fuels-react, fuels-wallet, fuels-core 等。
• scripts/: 包含项目的脚本文件，用于自动化任务。
• tests/: 包含项目的测试文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .prettierrc: 配置代码格式化工具 Prettier。
• lerna.json: 配置 Lerna 多包管理工具。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

fuels-ts 项目的启动文件主要位于 packages/fuels/src/index.ts。该文件是 fuels 包的入口文件，负责导出该包的主要功能和模块。

启动文件内容

// packages/fuels/src/index.ts

export * from './types';
export * from './utils';
export * from './providers';
export * from './contracts';
export * from './transactions';
export * from './wallet';

启动文件介绍

• types: 导出项目中使用的类型定义。
• utils: 导出项目中使用的工具函数。
• providers: 导出与网络提供者相关的模块。
• contracts: 导出与智能合约相关的模块。
• transactions: 导出与交易相关的模块。
• wallet: 导出与钱包相关的模块。

3. 项目的配置文件介绍

fuels-ts 项目的主要配置文件包括 package.json, tsconfig.json, 和 lerna.json。

package.json

package.json 文件包含了项目的依赖、脚本命令和其他元数据。

{
  "name": "@fuel-ts/fuels",
  "version": "0.33.0",
  "description": "Fuel Network TypeScript SDK",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "tsc",
    "test": "jest",
    "lint": "eslint src --ext .ts,.tsx"
  },
  "dependencies": {
    "ethers": "^5.6.2"
  },
  "devDependencies": {
    "typescript": "^4.5.5"
  }
}

tsconfig.json

tsconfig.json 文件配置了 TypeScript 编译选项。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src"]
}

lerna.json

lerna.json 文件配置了 Lerna 多包管理工具。

{
  "packages": [
    "packages/*"
  ],
  "version": "0.33.0"
}

配置文件介绍

• package.json: 定义了项目的名称、版本、描述、入口文件、类型定义、文件列表、脚本命令、依赖和开发依赖。
• tsconfig.json: 配置了 TypeScript 编译的目标、模块系统、输出目录、严格模式和