# @0xsequence/ethauth 中文文档

规范地址：https://npmcn.com/package/%400xsequence/ethauth/

版本：2\.0\.0
npm 元数据更新时间：2025-10-02T14:14:01.769Z
中文译文更新时间：2026-11-05T20:31:01.104Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%400xsequence/ethauth
原文对照：https://npmcn.com/package/%400xsequence/ethauth/?lang=original
项目主页：https://github.com/0xsequence/ethauth.js#readme
源码仓库：https://github.com/0xsequence/ethauth.js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：51 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：ox ^0\.7\.2
- 首次发布：2021-01-26T18:57:25.067Z
- 最新版本发布：2025-10-02T14:14:01.514Z
- 近 30 天下载量：26585（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

ETHAuth -- -- 自签名的授权证明

## 安装

```sh
npm install @0xsequence/ethauth
```

也可以使用：`pnpm add @0xsequence/ethauth`、`yarn add @0xsequence/ethauth`、`bun add @0xsequence/ethauth`

## README

```
 ____ ____ ____ ____ ____ ____ ____
||e |||t |||h |||a |||u |||t |||h ||
||__|||__|||__|||__|||__|||__|||__||
|/__\|/__\|/__\|/__\|/__\|/__\|/__\|
```

## 使用量

`pnpm add @0xsequence/ethauth` (或 `yarn add ...` 或者说 `npm install ...`(中文(简体) )

## 格式

`proof = eth.<address>.<claims>.<signature>.<extra>`

### 地址

Hex编码中的账户地址 ie. '0x9e63b5BF4b31A7F8d5D8b4f54CD361344Eb744C5'.

注意,你不应该在面值时 将质地证明中的账号地址 —— 你必须分析证据 并用所提供的图书馆方法加以验证。 用于验证的地址包含在内 智能钱包账户(aka 合同账户).

### 索偿

a base64 已编码的 JSON 对象

```typescript
interface Claims {
  app: string
  exp: number
  iat?: number
  n?: number
  typ?: string
  ogn?: string
}
```

字段 :

-   `app` (要求) - 请求出具质证的应用标识符
-   `exp` (要求) - 在无九分之多的时间内过期,直到质证有效
-   `iat` (optonal) - 在标有/签发质地证明的无九分之三时签发
-   `n` (可选) - 可作为附加担保挑战号的非ce值
-   `typ` (可选的) - 授权类型
-   `ogn` (可选的) - 域名来源,要求出具质地证明

### 签署

索赔信息有效载荷的签名价值。 签名由EIP712计算 signTypedData 调用索赔对象。 签字可通过EC Recover 可收回至 确定EOA地址,或者您可能有一个不同的编码,例如EIP-1271所使用的编码, 以验证基于合同的账户签名.

## 示例 ETHAuth 编码/解码

### EOA 账户签名

防毒药= `eth.0x89d9f8f31817badb5d718cd6fb483b71dbd2dfed.eyJhcHAiOiJFV1RUZXN0IiwiaWF0IjoxNTk1NTMwODQwLCJleHAiOjE1OTU1MzExNDB9.0x233ab9164a677a41acc8d52c9e1d1a621acebf9bc8d956c8474618b589acebe10cc350deb4b02bf6951cec8bd23507170f204ca326a5a264b8f6f67fa2619c251c`

解码并核实为:

-   账户地址 : `0x89D9F8f31817BAdb5D718CD6fb483b71DbD2dfeD`
-   索赔要求: `{"app":"EWTTest","iat":1595530840,"exp":1595531140}`
-   签名 : `0x233ab9164a677a41acc8d52c9e1d1a621acebf9bc8d956c8474618b589acebe10cc350deb4b02bf6951cec8bd23507170f204ca326a5a264b8f6f67fa2619c251c`

### 基于合同的账户签名(可与EIP 1271核实)

防毒药= `eth.0x9e63b5bf4b31a7f8d5d8b4f54cd361344eb744c5.eyJpYXQiOjE1OTQ3NDM4NDgsImV4cCI6MTYyNjI3OTg0OCwibiI6MTMzN30.0x000100012dd090aec5e4a9678f7968533c10fc42b07b9a23fa3b719f79a861adcfc7e1d958e3521bb061c34072f5435681390ccc9be19bf9da32320bd2356d0b4b4d316b1c02`

解码并核实为:

-   账户地址 : `0x9e63b5bf4b31a7f8d5d8b4f54cd361344eb744c5`
-   消息 : `{"iat":1594743848,"exp":1626279848,"n":1337}`
-   签名 : `0x000100012dd090aec5e4a9678f7968533c10fc42b07b9a23fa3b719f79a861adcfc7e1d958e3521bb061c34072f5435681390ccc9be19bf9da32320bd2356d0b4b4d316b1c02`

## 自由主义

麻省理工学院

## 常见问题

### @0xsequence/ethauth 是什么？

ETHAuth -- -- 自签名的授权证明

### 如何安装 @0xsequence/ethauth？

在项目目录运行 npm install @0xsequence/ethauth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：ox（^0\.7\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @0xsequence/ethauth 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @0xsequence/ethauth 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @0xsequence/ethauth 可以商用吗？

@0xsequence/ethauth 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @0xsequence/ethauth 的下载量有多少？

根据 npm 官方下载统计，@0xsequence/ethauth 在 2026/10/04 – 2026/11/02 这 30 天内被下载 26,585 次，日均约 886 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @0xsequence/ethauth 还在维护吗？

最新版本 2\.0\.0 发布于 2025/10/02（1\.1 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/01/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。