0x Starter Project 使用教程

0x Starter Project 使用教程

0x-starter-project A project showcasing how to get started with 0x.js 项目地址: https://gitcode.com/gh_mirrors/0x/0x-starter-project

1. 项目目录结构及介绍

0x-starter-project/
├── circleci/
├── src/
│   ├── configs/
│   ├── constants/
│   ├── print_utils/
│   ├── provider_engine/
│   ├── scenarios/
│   ├── utils/
│   └── index.ts
├── .env.example
├── .gitignore
├── .npmignore
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── tsconfig.json
├── tslint.json
└── yarn.lock

目录结构说明

• circleci/: 包含 CircleCI 配置文件。
• src/: 项目的主要源代码目录。
  • configs/: 包含项目的配置文件。
  • constants/: 包含项目的常量定义。
  • print_utils/: 包含打印工具的实现。
  • provider_engine/: 包含提供者引擎的实现。
  • scenarios/: 包含各种场景的实现，如填充订单、取消订单等。
  • utils/: 包含各种实用工具函数。
  • index.ts: 项目的入口文件。
• .env.example: 环境变量示例文件。
• .gitignore: Git 忽略文件配置。
• .npmignore: npm 忽略文件配置。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc: Prettier 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• package-lock.json: npm 锁定文件。
• package.json: npm 包配置文件。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TSLint 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目启动文件介绍

项目的启动文件是 src/index.ts。该文件是整个项目的入口点，负责初始化项目并运行各种场景。

src/index.ts 文件内容概述

import { runScenarios } from './scenarios';

async function main() {
    await runScenarios();
}

main().catch(console.error);

• runScenarios: 该函数负责运行项目中定义的各种场景。
• main: 主函数，负责调用 runScenarios 并处理异常。

3. 项目配置文件介绍

src/configs/index.ts

该文件包含了项目的配置信息，如网络配置、默认交易参数等。

import { GANACHE_CONFIGS, ROPSTEN_CONFIGS } from '../constants';

export const NETWORK_CONFIGS = GANACHE_CONFIGS;
export const TX_DEFAULTS = {
    gas: 8000000,
    gasPrice: 20000000000,
};

• NETWORK_CONFIGS: 网络配置，默认使用 Ganache 配置。
• TX_DEFAULTS: 默认交易参数，包括 gas 和 gasPrice。

.env.example

该文件是环境变量示例文件，用户可以根据需要创建 .env 文件并配置相关环境变量。

ROPSTEN_RPC_URL=https://ropsten.infura.io/v3/YOUR_INFURA_PROJECT_ID

• ROPSTEN_RPC_URL: Ropsten 网络的 RPC URL。

通过以上配置文件，用户可以自定义项目的运行环境，如切换到 Ropsten 测试网络或配置不同的 RPC URL。

0x-starter-project A project showcasing how to get started with 0x.js 项目地址: https://gitcode.com/gh_mirrors/0x/0x-starter-project