Project Icon

helia

现代化的 TypeScript IPFS 实现

Helia 是现代化的 IPFS TypeScript 实现,为 JavaScript 和浏览器环境定制。它提供处理多种数据格式的简洁 API,支持点对点网络和 HTTP 网关,助力开发者轻松构建分布式应用。

Helia标志

ipfs.tech 讨论 codecov CI

Helia是一个精简、模块化且现代的IPFS TypeScript实现,适用于广泛的JavaScript和浏览器环境。

更多信息请参阅宣言常见问题以及2022年10月JavaScript中IPFS状态博客文章

🌟 使用方法

以下是如何在Helia节点中存取不同类型数据的快速概览。

🪢 字符串

你可以使用@helia/strings模块轻松地在Helia节点中添加和获取字符串:

import { createHelia } from 'helia'
import { strings } from '@helia/strings'

const helia = await createHelia()
const s = strings(helia)

const myImmutableAddress = await s.add('hello world')

console.log(await s.get(myImmutableAddress))
// hello world

🌃 JSON

@helia/json模块允许你添加或获取普通JavaScript对象:

import { createHelia } from 'helia'
import { json } from '@helia/json'

const helia = await createHelia()
const j = json(helia)

const myImmutableAddress = await j.add({ hello: 'world' })

console.log(await j.get(myImmutableAddress))
// { hello: 'world' }

🌠 DAG-JSON

@helia/dag-json允许你将链接对象的引用存储为CID

import { createHelia } from 'helia'
import { dagJson } from '@helia/dag-json'

const helia = await createHelia()
const d = dagJson(helia)

const object1 = { hello: 'world' }
const myImmutableAddress1 = await d.add(object1)

const object2 = { link: myImmutableAddress1 }
const myImmutableAddress2 = await d.add(object2)

const retrievedObject = await d.get(myImmutableAddress2)
console.log(retrievedObject)
// { link: CID(baguqeerasor...) }

console.log(await d.get(retrievedObject.link))
// { hello: 'world' }

🌌 DAG-CBOR

@helia/dag-cbor的工作方式与@helia/dag-json类似,但使用简洁二进制对象表示存储对象:

import { createHelia } from 'helia'
import { dagCbor } from '@helia/dag-cbor'

const helia = await createHelia()
const d = dagCbor(helia)

const object1 = { hello: 'world' }
const myImmutableAddress1 = await d.add(object1)

const object2 = { link: myImmutableAddress1 }
const myImmutableAddress2 = await d.add(object2)

const retrievedObject = await d.get(myImmutableAddress2)
console.log(retrievedObject)
// { link: CID(baguqeerasor...) }

console.log(await d.get(retrievedObject.link))
// { hello: 'world' }

🐾 下一步

查看helia-examples仓库,了解如何使用Helia节点完成大多数任务。

🏃‍♀️ 入门

查看Helia示例仓库,其中涵盖了广泛的用例。如果你觉得有什么遗漏,请遵循贡献指南,为示例仓库创建一个PR。

📗 项目文档

📒 API文档

📐 系统图

graph TD;
    User["用户或应用"]-->IPNS["@helia/ipns"];
    User-->UnixFS["@helia/unixfs"];
    User-->Libp2p;
    User-->Datastore;
    User-->Blockstore;
    UnixFS-->Blockstore;
    IPNS-->Datastore;
    subgraph helia [Helia]
      Datastore
      Blockstore-->BlockBrokers;
      BlockBrokers-->Bitswap;
      BlockBrokers-->TrustlessGateways;
      Libp2p-->DHT;
      Libp2p-->PubSub;
      Libp2p-->IPNI;
      Libp2p-->Reframe;
    end
    Blockstore-->BlockStorage["文件系统/IDB/S3等"];
    Datastore-->DataStorage["Level/S3/IDB等"];
    Bitswap-->Network;
    TrustlessGateways-->Gateway1;
    TrustlessGateways-->GatewayN;
    DHT-->Network;
    PubSub-->Network;
    IPNI-->Network;
    Reframe-->Network;

🏭 代码结构

Helia采用模块化方法,鼓励用户根据自己的需求引入各种API的实现。

基本的Helia API定义在:

API由以下实现:

Helia还提供了许多补充库和工具,可以与Helia API实现结合使用,以分布式和无信任的方式完成任务。

这些库并非旨在成为任何给定API的"唯一真实实现",而是根据特定应用程序的需求供用户选择使用:

一个互操作性套件确保一切兼容:

其他模块

在此仓库之外还有几个可用的模块:

📣 项目状态

Helia v1于2023年3月发布(参见发布记录),开发工作持续进行,我们正在推进路线图中的计划,并不断进行性能改进和错误修复。

🛣️ 路线图

请在此处查看和评论路线图

👫 参与其中

  • 观看我们的Helia演示日演示这里
  • 我们定期在Helia演示中分享进展。这是了解最新情况和参与方式的好地方。我们很乐意在那里见到你!
  • 选择一个问题解决。
  • 加入Filecoin Slack的#ip-js频道进行交流。(是的,我们应该将其连接到其他聊天环境。如果你希望这样做,请在这里发表评论。)

🤲 贡献

欢迎贡献!请查看问题列表

另请参阅我们的贡献文档,了解更多关于我们如何工作以及如何贡献的信息。

请注意,与此仓库相关的所有互动都受IPFS行为准则约束。

除非你明确声明,否则你提交的任何贡献都将根据上述许可证双重许可,无需任何附加条款或条件。

🛍️ 著名用户

🌞 品牌

🪪 许可证

根据以下两种许可之一授权

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号