EOSJS 开源项目教程

邓越浪Henry

于 2024-08-23 08:01:59 发布

阅读量233

点赞数 3

本文链接：https://blog.csdn.net/gitblog_00287/article/details/141445671

版权

EOSJS 开源项目教程

eosjsGeneral purpose library for the EOSIO blockchain. 项目地址:https://gitcode.com/gh_mirrors/eo/eosjs

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

EOSJS 是一个用于与 EOSIO 区块链进行交互的 JavaScript 库。其目录结构如下：

eosjs/
├── docs/
├── examples/
├── src/
│   ├── api/
│   ├── eosjs-api.js
│   ├── eosjs-jsonrpc.js
│   ├── eosjs-jssig.js
│   ├── index.js
│   └── utils/
├── test/
├── .gitignore
├── .npmignore
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

docs/: 包含项目的文档文件。
examples/: 包含使用 EOSJS 的示例代码。
src/: 包含 EOSJS 的主要源代码。
- api/: 包含与 EOSIO API 交互的代码。
- eosjs-api.js: 主要的 API 接口文件。
- eosjs-jsonrpc.js: JSON-RPC 接口文件。
- eosjs-jssig.js: 用于签名交易的 JavaScript 签名库。
- index.js: 入口文件。
- utils/: 包含一些工具函数。
test/: 包含测试文件。
.gitignore: Git 忽略文件。
.npmignore: NPM 忽略文件。
LICENSE: 项目许可证。
package.json: 项目的 npm 配置文件。
README.md: 项目说明文档。
tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

EOSJS 的启动文件是 src/index.js。这个文件导入了项目所需的主要模块，并提供了对外的接口。以下是 index.js 的部分代码示例：

import Api from './eosjs-api';
import JsonRpc from './eosjs-jsonrpc';
import JsSignatureProvider from './eosjs-jssig';
import { TextEncoder, TextDecoder } from 'text-encoding';

export { Api, JsonRpc, JsSignatureProvider, TextEncoder, TextDecoder };

在这个文件中，Api、JsonRpc 和 JsSignatureProvider 是 EOSJS 的核心模块，分别用于与 EOSIO API 交互、处理 JSON-RPC 请求和签名交易。

3. 项目的配置文件介绍

EOSJS 的配置文件主要是 package.json。这个文件包含了项目的元数据和依赖项。以下是 package.json 的部分内容示例：

{
  "name": "eosjs",
  "version": "21.0.0",
  "description": "General purpose library for EOSIO",
  "main": "src/index.js",
  "scripts": {
    "test": "jest --coverage",
    "build": "tsc"
  },
  "dependencies": {
    "eosjs-api": "^21.0.0",
    "eosjs-jsonrpc": "^21.0.0",
    "eosjs-jssig": "^21.0.0"
  },
  "devDependencies": {
    "jest": "^26.0.1",
    "typescript": "^3.9.5"
  },
  "keywords": [
    "EOSIO",
    "Blockchain"
  ],
  "author": "EOSIO",
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/EOSIO/eosjs.git"
  }
}

name: 项目名称。
version: 项目版本。
description: 项目描述。
main: 入口文件。
scripts: 包含一些常用的脚本命令，如测试和构建。
dependencies: 项目运行所需的依赖项。
devDependencies: 开发环境所需的依赖项。
keywords: 项目关键词。
author: 项目作者。
license: 项目许可证。
repository: 项目仓库地址。