openchain-sdk-yxl/README.md

openchain sdk

# OpenChain SDK for Node.js

## 简介

OpenChain SDK for Node.js 是一个用于与OpenChain区块链网络进行交互的JavaScript/TypeScript开发工具包。该SDK提供了一系列简单易用的API，帮助开发者快速构建基于OpenChain的应用程序。

## 系统要求

- Node.js >= 18.0.0

## 安装

```bash
npm install openchain-sdk-yxl
```

或使用yarn：

```bash
yarn add openchain-sdk-yxl
```

## 主要功能

- 账户管理
- 区块链交互（区块和交易）
- 智能合约操作
- 资产管理
- CTP10代币支持
- WebSocket连接

## 基本使用

```javascript
const OpenChainSDK = require('openchain-sdk-yxl');

// 初始化SDK
const sdk = new OpenChainSDK({
    // 配置项
});

// 创建账户
const account = sdk.account.create();

// 发送交易
async function sendTransaction() {
    try {
        const result = await sdk.transaction.send({
            // 交易参数
        });
        console.log('交易结果：', result);
    } catch (error) {
        console.error('交易失败：', error);
    }
}
```

## 模块说明

### 账户模块
- 账户创建和管理
- 密钥对生成
- 地址管理

### 区块链模块
- 区块查询
- 交易处理
- 链上数据访问

### 合约模块
- 智能合约部署
- 合约调用
- 合约事件监听

### 资产模块
- 资产发行
- 转账操作
- 余额查询

### CTP10代币
- 代币发行
- 转账
- 授权管理

## 依赖说明

主要依赖包括：
- axios：HTTP客户端
- bignumber.js：大数处理
- protobufjs：协议缓冲区支持
- ws：WebSocket客户端

## 许可证

本项目采用ISC许可证。

## 贡献指南

欢迎提交问题报告和改进建议。如果您想贡献代码，请：
1. Fork 本仓库
2. 创建您的特性分支
3. 提交您的改动
4. 推送到您的分支
5. 创建Pull Request

## 版本历史

当前版本：1.1.0

## 技术支持

如果您在使用过程中遇到问题，请通过以下方式获取帮助：
- 提交GitHub Issues
- 查阅在线文档
- 联系技术支持团队