ipfs-rpc-client

IPFS RPC Client

基于 TypeScript 的 IPFS HTTP RPC 客户端，支持文件上传、下载、签名、加密等功能，适用于区块链和分布式存储场景。

特性

• 支持 IPFS 文件的上传、下载、分享、加密存储
• 支持 secp256k1 密钥对生成、签名与验签
• 支持 ECIES 加解密
• 提供类型安全的接口定义

安装

yarn add @jccdex/ipfs-rpc-client
# 或
npm install @jccdex/ipfs-rpc-client

快速上手

import { IpfsClient, generateKeyPair } from '@jccdex/ipfs-rpc-client';

// 生成密钥对
const { privateKey, publicKey } = generateKeyPair();

// 初始化客户端
const client = new IpfsClient({ baseURL: 'http://localhost:8080' });

// 上传文件
const file = new Blob(['Hello IPFS!']);
const signature = await client.sign(file, privateKey);
await client.writeFile({ file, name: 'hello.txt', publicKey, signature });

// 下载文件
const res = await client.readFile({ name: 'hello.txt', publicKey, signature });
console.log(res);

主要 API

• IpfsClient：IPFS 客户端主类，支持文件操作、分享、加密等
• generateKeyPair：生成 secp256k1 密钥对
• sign：对数据进行 secp256k1 签名
• encrypt / decrypt：ECIES 加解密

详细接口请查阅源码 src/ 目录及类型定义

目录结构

src/
	api/         # IPFS 业务接口实现
	http/        # HTTP 客户端封装
	interface/   # 类型定义
	utils/       # 签名、加密等工具
test/          # 单元测试

构建与测试

yarn build      # 构建
yarn test       # 运行测试

License

MIT