Cardano JS SDK 项目教程

Cardano JS SDK 项目教程

cardano-js-sdk JavaScript SDK for interacting with Cardano, providing various key management options, with support for popular hardware wallets 项目地址: https://gitcode.com/gh_mirrors/ca/cardano-js-sdk

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

Cardano JS SDK 项目的目录结构如下：

cardano-js-sdk/
├── examples/
├── packages/
│   ├── cardano-js-sdk/
│   ├── csl-web/
│   ├── csl-workarounds/
│   ├── util/
│   └── ...
├── scripts/
├── test/
├── .gitignore
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• examples/: 包含使用 Cardano JS SDK 的示例代码。
• packages/: 包含 SDK 的核心代码和相关模块。
  • cardano-js-sdk/: SDK 的核心模块。
  • csl-web/: 与 Cardano 区块链交互的 Web 模块。
  • csl-workarounds/: 解决特定问题的模块。
  • util/: 通用工具模块。
• scripts/: 包含项目的脚本文件，用于构建、测试等。
• test/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• package.json: 项目的依赖和脚本配置。
• README.md: 项目的介绍和使用说明。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

Cardano JS SDK 的启动文件通常位于 packages/cardano-js-sdk/src/index.ts。这个文件是 SDK 的入口点，负责初始化和导出 SDK 的核心功能。

启动文件内容

// packages/cardano-js-sdk/src/index.ts

export * from './Cardano';
export * from './Blockchain';
export * from './Transaction';
export * from './Wallet';
// 其他导出

启动文件介绍

• index.ts: 作为 SDK 的入口文件，导出了 SDK 的核心模块，如 Cardano、Blockchain、Transaction 和 Wallet 等。

3. 项目的配置文件介绍

Cardano JS SDK 的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本配置等信息。

{
  "name": "cardano-js-sdk",
  "version": "0.1.0",
  "description": "Cardano JavaScript SDK",
  "main": "dist/index.js",
  "scripts": {
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "axios": "^0.21.1",
    "lodash": "^4.17.21"
  },
  "devDependencies": {
    "@types/jest": "^26.0.23",
    "jest": "^26.6.3",
    "typescript": "^4.2.4"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，定义了 TypeScript 编译器的选项。

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

配置文件介绍

• package.json: 定义了项目的名称、版本、依赖、脚本等信息。
• tsconfig.json: 配置了 TypeScript 编译器的选项，如目标 ECMAScript 版本、模块系统等。

cardano-js-sdk JavaScript SDK for interacting with Cardano, providing various key management options, with support for popular hardware wallets 项目地址: https://gitcode.com/gh_mirrors/ca/cardano-js-sdk