TON JS 客户端使用教程

TON JS 客户端使用教程

1. 项目目录结构及介绍

开源项目TON JS Client的目录结构如下：

ton-org/
├── .github/           # 存放GitHub工作流程文件
├── src/              # 源代码目录
├── .gitignore        # 定义Git忽略的文件
├── .yarnrc.yml       # Yarn配置文件
├── CHANGELOG.md      # 更改日志
├── LICENSE           # MIT许可证文件
├── README.md         # 项目自述文件
├── jest.config.js    # Jest测试配置文件
├── karma.conf.js     # Karma配置文件
├── karma.setup.js    # Karma设置文件
├── package.json      # 项目包配置文件
├── tsconfig.json     # TypeScript配置文件
└── yarn.lock         # Yarn.lock文件

• .github/: 包含GitHub Actions的工作流程文件，用于自动化项目的某些任务。
• src/: 包含所有的TypeScript源代码文件。
• .gitignore: 指定哪些文件和目录应该被Git忽略。
• .yarnrc.yml: 包含Yarn的配置信息。
• CHANGELOG.md: 提供了项目的更新和修改记录。
• LICENSE: 项目使用的MIT许可证。
• README.md: 包含项目的描述、使用方法和安装指南。
• jest.config.js: Jest测试框架的配置文件。
• karma.conf.js: Karma测试运行器的配置文件。
• karma.setup.js: 用于设置Karma。
• package.json: 定义了项目的依赖、脚本和元数据。
• tsconfig.json: TypeScript编译器的配置文件。
• yarn.lock: 记录了项目依赖的精确版本。

2. 项目的启动文件介绍

在这个项目中，并没有一个特定的“启动文件”。项目的使用通常从引入@ton/ton包开始。以下是创建TON客户端的一个简单例子：

import { TonClient, WalletContractV4 } from "@ton/ton";

// 创建客户端实例
const client = new TonClient({
  endpoint: 'https://toncenter.com/api/v2/jsonRPC'
});

// 此处添加更多代码以使用客户端

在实际情况中，开发者需要先设置一个HTTP API端点，然后创建一个TonClient实例，并使用它来与TON区块链交互。

3. 项目的配置文件介绍

项目中的主要配置文件是package.json和tsconfig.json。

• package.json: 这个文件包含了项目的依赖、脚本和元数据。例如，它定义了项目的入口点（main字段），项目依赖的库（dependencies字段），以及如何运行项目的脚本（scripts字段）。

{
  "name": "ton",
  "version": "15.2.0",
  "description": "Cross-platform client for TON blockchain.",
  "main": "index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "@ton/core": "^15.2.0",
    "@ton/crypto": "^15.2.0",
    "buffer": "^5.4.3"
  },
  "devDependencies": {
    "jest": "^27.0.0",
    "typescript": "^4.5.2"
  }
}

• tsconfig.json: TypeScript配置文件定义了TypeScript编译器的选项，例如源文件的位置、编译输出的位置、以及是否启用某些编译特性。

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

以上是关于TON JS Client项目的目录结构、启动文件和配置文件的介绍。