Telehash-js 技术文档

1. 安装指南

首先，确保你的环境中已经安装了Node.js。可以通过以下命令安装Telehash-js模块：

npm install telehash

如果你的项目需要全局安装，可以使用以下命令：

npm install -g telehash

2. 项目使用说明

Telehash-js模块提供了一个简单的API，用于在Node.js和浏览器环境中使用Telehash v3。

生成端点身份

要生成一个新的hashname，可以使用以下代码：

var th = require("telehash");
th.generate(function(err, endpoint){
  if(err) return console.log("端点生成失败",err);
  // endpoint对象包含keys, secrets和hashname
});

创建网络

使用之前生成的端点id对象来初始化网络：

var th = require("telehash");
var id = {
  "keys":{"1a":"akndnx5kbansip6xphxymwckpqkjj26fcm"},
  "secrets":{"1a":"ksxslm5mmtymnbph7nvxergb7oy3r35u"},
  "hashname":"5uegloufcyvnf34jausszmsabbfbcrg6fyxpcqzhddqxeefuapvq"
};

var mesh = th.mesh({id:id});

如果需要处理初始化后的错误，可以添加一个回调函数：

th.mesh({id:id}, function(err, mesh){
  if(err) return console.log("网络初始化失败",err);
  // 使用mesh.*方法
  console.log(mesh.uri());
});

建立链接

可以使用以下代码创建一个链接：

var link = mesh.link(hashname);
// 当链接状态变化时被调用，err为undefined时表示链接已建立
link.status(function(err){
  if(err) {
    console.log('断开连接',err);
    return;
  }
  console.log('连接成功');
  // 可以执行其他link.*方法
});

接受/授权链接

当收到一个链接请求时，本地应用必须决定是否接受该链接。默认情况下，所有未知的链接/发送者都会被忽略，并且不会对其做出响应，以保护接收者的隐私。

要处理链接请求，可以使用以下方法：

mesh.accept = function(from){};

accept函数将始终接收一个包含发送者hashname和其他请求详细信息的from对象。

要授权/接受请求，只需执行mesh.link(from)即可。

3. 项目API使用文档

以下是一些重要的API方法和对象：

• th.generate(callback): 生成一个新的端点身份。
• th.mesh(options, [callback]): 创建一个新的网络。
• mesh.link([hashname or options]): 创建一个新的链接。
• link.status(callback): 查询链接状态。
• mesh.accept(function(from)): 处理链接请求。

更多API详情请参考官方文档。

4. 项目安装方式

请参考安装指南部分的内容，使用npm命令进行安装。