# @eluvio/elv-client-js 中文文档
规范地址：https://npmcn.com/package/%40eluvio/elv-client-js/
版本：4\.2\.46
npm 元数据更新时间：2026-11-05T15:53:59.852Z
中文译文更新时间：2026-11-13T16:04:13.418Z
软件包许可：MIT
本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。
原始 npm 页面：https://www.npmjs.com/package/%40eluvio/elv-client-js
原文对照：https://npmcn.com/package/%40eluvio/elv-client-js/?lang=original
项目主页：https://github.com/eluv-io/elv-client-js
源码仓库：https://github.com/eluv-io/elv-client-js
## 关键信息（来自 npm 元数据）
- 包体积（解压后）：21.6 MB，593 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：45 个
- 首次发布：2019-06-12T01:11:02.335Z
- 最新版本发布：2026-11-05T15:53:59.613Z
- 近 30 天下载量：3430（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：411（近 12 个月 28 个）
## 中文简介
Eluvio 内容 Fabric 的 Javascript 客户端
## 安装
```sh
npm install @eluvio/elv-client-js
```
也可以使用：`pnpm add @eluvio/elv-client-js`、`yarn add @eluvio/elv-client-js`、`bun add @eluvio/elv-client-js`
## README
## Eluvio Javascript 客户端
Eluvio Javascript客户端的设计是为了通过封装所有必要的HTTP请求,授权,和块链交互,使与Eluvio Content Fabric的互动变得简单.
## [API 文档](https://eluv-io.github.io/elv-client-js/ElvClient.html)
- [安装](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-installation)
- [开始](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-initialization)
- [授权](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-authorization)
- [识别内容](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-id-format)
- [创建和编辑内容](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-editing)
- [播放视频](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-video)
- [发布 ABR 视频内容](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-abr-publishing)
- [其他资源](https://npmcn.com/package/%40eluvio/elv-client-js/#readme-resources)
## 安装
#### 从国家预防机制安装:
```
npm install --save @eluvio/elv-client-js
```
注:如果看到 `unsupported architecture` mac OS X 错误, 请尝试以下操作 :
```
export SDKROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
export SDK_DIR=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk
```
#### 使用量
```
// From source
import { ElvClient } from "elv-client-js";
const { ElvClient } = require("elv-client-js");
// From babel-compiled source
import { ElvClient } from "elv-client-js/dist/src/ElvClient.js";
const { ElvClient } = require("elv-client-js/dist/src/ElvClient.js");
// Minified (browser)
import { ElvClient } from "elv-client-js/dist/ElvClient-min.js";
const { ElvClient } = require("elv-client-js/dist/ElvClient-min.js");
// Minified (node)
import { ElvClient } from "elv-client-js/dist/ElvClient-node-min.js";
const { ElvClient } = require("elv-client-js/dist/ElvClient-node-min.js");
// HTML
```
## 初始化客户端
初始化客户端与将其指向相应的Eluvio配置 URL一样简单. 此 URL 将自动返回关于最佳 Fabric, 块链和 KMS 节点的信息, 以及 Fabric 的内容空间 - 客户端与 Fabric 通信所需的所有信息 .
主网:
```javascript
const client = await ElvClient.FromConfigurationUrl({
configUrl: "https://main.net955305.contentfabric.io/config"
});
```
对于演示网:
```javascript
const client = await ElvClient.FromConfigurationUrl({
configUrl: "https://demov3.net955210.contentfabric.io/config"
});
```
## 授权
### 钱包和签名人
以区块链技术为主,与Fabric的互动需要使用一个ethereum私人密钥——代表一个用户账户——以验证和认证请求,进行加密,转移资金,与智能合同互动,一般作为用户的身份.
为了进行必要的区块链互动,客户端要求 _签名_ 包含用户的私钥。 这是一个实例 [乙醚(js)](https://github.com/ethers-io/ethers.js/) 钱包。 ElvClient 有实用类 `ElvWallet` 以方便处理。 (注:新的elv-media-wallet利用代表用户管理签名机的Fabric API. 详情请联系 [支持@ eluv.io](mailto:support@eluv.io)(中文(简体) )
在创建 ElvClient 实例后,您可以生成 `ElvWallet` 用于客户端 `client.GenerateWallet()`。这一类提供了从各种信息生成签名符的简单方法,以及按名称存储和检索签名符.
使用 Adcount 方法创建签名器后, 您可以使用 ElvClient 设置签名器 `client.SetSigner`。 。 。 .
```javascript
const wallet = client.GenerateWallet();
const signer = wallet.AddAccount({
privateKey: "0x0000000000000000000000000000000000000000000000000000000000000000"
});
client.SetSigner({signer});
```
您不需要使用钱包的账户管理功能,只需使用钱包即可根据需要生成签名对象. 调用任何 Addcount 时选择名称参数 - 将只返回而不是存储签名符 .
请注意,Fabric上的大多数业务都需要资金。 如果该账户没有任何资金,大多数业务都会失败. 您可以使用 [ElvClient# 发送基金](https://eluv-io.github.io/elv-client-js/ElvClient.html#SendFunds)。 。 。 .
国家频道认证( 如 [ElvClient# 播放选项](https://eluv-io.github.io/elv-client-js/ElvClient.html#PlayoutOptions)不需要资金.
**注意:总是将私人密钥(和mnemonics)视为私人,敏感的用户数据. 总是存储并传送加密( 客户端有密码加密私钥的方法 - 见 [ElvWallet# Generate 被压缩的私钥](https://eluv-io.github.io/elv-client-js/ElvWallet.html#GenerateEncryptedPrivateKey)) (中文(简体) ). 简写私钥或元音应 _永远_ 离开用户浏览器 - 所有私钥的使用都在客户端上完成.**
### 访问内容
作为一个分散的,不信任的生态系统,Fabric的内容依赖于智能合同和块链交易来验证一个用户被允许执行某项行动. 每种类型的内容(内容空间,库,对象,类型等)都有相关的智能合同被部署到调解访问的块链上.
例如,要访问内容对象,请求者必须在该内容对象的智能合同上调用访问请求方法,然后在查询内容Fabric API时通过授权符中的交易散列. 内容 Fabric 将在执行请求的行动之前核实交易。 如果交易缺失或无效, 访问将被拒绝 .
ElvClient自动处理所有这一切. 当一种方法被调用时,它将进行适当的交易,并随请求发出正确的授权令牌.
## 内容、合同和多格式哈舍
如前所述,Fabric上的每一个实体都有一个智能合同的支持. 该合同用于授权和其他功能,但也被用作实体的身份.
每个智能合同都有块链地址. 例如:
```
0x0472ec0185ebb8202f3d4ddb0226998889663cf2
```
这个地址用于直接与合同互动,调用方法和进行交易.
然而,这个地址可以被转换为ID,以解决Fabric上的内容.
通过编码Base58的地址,我们得到:
```
4bWCz6SZZiJ51VUkAb4xGLTgKGm
```
Fabric上每种不同类型的实体都有前缀. 对于一个图书馆,它是 `ilib`。如果这份合同是内容库合同,我们可以使用库ID在Fabric上找到相应的图书馆
```
ilib4bWCz6SZZiJ51VUkAb4xGLTgKGm
```
然后我们就可以使用这个ID作为 `libraryId` 在客户端中论证.
此外,我们可以走相反的方向——将Fabric ID转换为相应的合同地址. 这非常有益 -- -- 当我们想查阅内容时,我们需要呼吁遵守内容契约。 通过这个计划,我们很容易从Fabric的身份证上确定合同地址.
简而言之,每个Fabric ID包含
- 实体类型( 图书馆、 对象、 类型、 用户钱包等) 作为 4 字节前缀
- 合同地址
这种转换不应是必须经常完成的事情,因为客户端囊括了Fabric和块链之间的许多共同互动,但当你想在内容的合同上调用方法时是有用的.
客户端包含使这种转换简单化的实用方法.
```javascript
const address = "0x0472ec0185ebb8202f3d4ddb0226998889663cf2";
// Convert to multihash
const id = client.utils.AddressToHash(address);
// Convenience methods for automatically adding prefixes
const libraryId = client.utils.AddressToLibraryId(address);
const objectId = client.utils.AddressToObjectId(address);
// Convert back to address (requires prefix)
client.utils.HashToAddress(libraryId);
```
### 哈谢斯版本
Fabric上的内容对象由不可改变的版本所组成. 每当内容被修改时,都会创建出一个新的版本,而旧版本保持不变.
当指向对象时,对象ID(`iq__2vDbmxTdaivPnmDn8RKLbxSHUMfj`)指整个对象. 提及带有对象ID的内容会参考最新版本.
然而,您也可以使用hash版本来指代对象的特定版本. 此对象的一个这样的版本是 `hq__BD1BouHkFraAcDjvoyHoiKpVhf4dXzNsDT5USe8mrZ7YDhLPDoZGnoU32iZvDYiQW8vVi6X7rV`。 。 。 .
作为类比,指一个有对象ID的物体,比起用版本散列来指代它,就如同指Git repo,而指在特定承诺时的repo. 前者指实体整体并随着修改而更新,而后者指特定时间点的实体而不会被修改.
此版本散列为Base58编码字符串,格式如下:
```
hq__