IPFS HTTP 客户端库使用教程

IPFS HTTP 客户端库使用教程

js-ipfs-http-client [ARCHIVED] now part of the https://github.com/ipfs/js-ipfs repo 项目地址: https://gitcode.com/gh_mirrors/js/js-ipfs-http-client

1. 项目介绍

js-ipfs-http-client 是一个用于与 IPFS（InterPlanetary File System）HTTP API 进行交互的 JavaScript 客户端库。该库实现了 interface-ipfs-core 接口，使得应用程序可以在嵌入式 js-ipfs 节点和任何远程 IPFS 节点之间切换，而无需更改代码。此外，该库还提供了一些实用函数，方便开发者使用。

2. 项目快速启动

安装

首先，通过 npm 安装 ipfs-http-client：

npm install --save ipfs-http-client

运行 IPFS 守护进程

确保本地 IPFS 守护进程正在运行，并且监听正确的端口（默认端口为 5001）：

# 检查 IPFS 配置中的 API 端口
ipfs config Addresses.API

# 如果端口不正确，可以设置为 5001
ipfs config Addresses.API /ip4/127.0.0.1/tcp/5001

# 重启守护进程
ipfs daemon

导入模块并使用

在 Node.js 环境中，可以通过以下方式导入并使用 ipfs-http-client：

const ipfsClient = require('ipfs-http-client');

// 连接到本地 IPFS 守护进程
const ipfs = ipfsClient('http://localhost:5001');

// 或者使用 multiaddr 连接
const ipfs = ipfsClient('/ip4/127.0.0.1/tcp/5001');

// 或者使用选项连接
const ipfs = ipfsClient({
  host: 'localhost',
  port: '5001',
  protocol: 'http'
});

// 添加文件到 IPFS
const file = await ipfs.add('Hello, IPFS!');
console.log(file.cid);

在浏览器中使用

通过 Browserify 或 Webpack 打包后，可以在浏览器中使用 ipfs-http-client。也可以直接从 CDN 加载：

<script src="https://unpkg.com/ipfs-http-client/dist/index.min.js"></script>
<script>
  const ipfs = window.IpfsHttpClient({
    host: 'localhost',
    port: 5001
  });

  ipfs.add('Hello, IPFS!').then(file => {
    console.log(file.cid);
  });
</script>

3. 应用案例和最佳实践

应用案例

1. 去中心化文件存储：使用 ipfs-http-client 将文件上传到 IPFS 网络，实现去中心化的文件存储和共享。
2. 去中心化应用（DApp）：在去中心化应用中，使用 ipfs-http-client 与 IPFS 网络交互，存储和获取应用数据。

最佳实践

1. 配置 CORS：在浏览器中使用时，确保 IPFS 守护进程配置了正确的 CORS 设置，以允许跨域请求。
2. 使用全局超时：为所有请求设置全局超时，以避免长时间等待响应。

4. 典型生态项目

1. js-ipfs：IPFS 的 JavaScript 实现，与 js-ipfs-http-client 配合使用，可以在浏览器和 Node.js 环境中运行 IPFS 节点。
2. ipfs-cluster：IPFS 集群管理工具，用于在多个 IPFS 节点之间协调文件存储和分发。
3. ipfs-companion：浏览器扩展，方便用户在浏览器中直接与 IPFS 网络交互。

通过以上步骤，您可以快速上手并使用 js-ipfs-http-client 与 IPFS 网络进行交互，实现去中心化的文件存储和应用开发。

js-ipfs-http-client [ARCHIVED] now part of the https://github.com/ipfs/js-ipfs repo 项目地址: https://gitcode.com/gh_mirrors/js/js-ipfs-http-client