# @farcaster/quick-auth 中文文档

规范地址：https://npmcn.com/package/%40farcaster/quick-auth/

版本：0\.1\.0
npm 元数据更新时间：2026-11-09T20:28:26.110Z
中文译文更新时间：2026-11-14T10:12:14.746Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40farcaster/quick-auth
原文对照：https://npmcn.com/package/%40farcaster/quick-auth/?lang=original
项目主页：https://github.com/farcasterxyz/quick-auth#readme
源码仓库：https://github.com/farcasterxyz/quick-auth

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

- 包体积（解压后）：69.1 kB，90 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：typescript 5\.8\.3
- 首次发布：2025-05-19T19:52:12.019Z
- 最新版本发布：2026-11-09T20:28:25.778Z
- 近 30 天下载量：520255（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 1 个）

## 中文简介

Farcaster Quick Auth 客户端

## 安装

```sh
npm install @farcaster/quick-auth
```

也可以使用：`pnpm add @farcaster/quick-auth`、`yarn add @farcaster/quick-auth`、`bun add @farcaster/quick-auth`

## README

# @farcaster/quick-auth (英语)

与 Farcaster Quick Auth 服务器互动的客户端 .

## 安装

```sh
npm install @auth-server/client
# or
yarn add @auth-server/client
# or
pnpm add @auth-server/client
```

## 使用量

```typescript
import { createClient } from '@farcaster/quick-auth';

// Get a nonce
const domain = 'your-domain.com';
const client = createClient();
const nonce = await client.getNonce();

// Generate a SIWF message using nonce and domain (not shown)

// Verify a SIWF message and get a JWT token
const token = await client.verifySiwf({
  message,
  signature,
  domain
});

// Use the return JWT as an Bearer token and validate on your server
const token = await client.verifyToken({
  token,
  domain
});
```

## 升级到0.1.0

0.1.0 取决于Zod 4(`zod@^4.6.6`)取而代之为佐德 3. 客户端API和运行时间行为不变.

导出 `Endpoints.VerifyJwt.requestQueryParametersSchema` 现在是一个Zod 4计划。 如果你把它编成自己的计划 比如说 `z.object({ query: Endpoints.VerifyJwt.requestQueryParametersSchema })`,您的代码也必须使用 Zod 4. Zod 3 schemas不能包含Zod 4 schemas,在类型检查时间和剖析时间这样做失败. Zod 3.25+ 也为Zod 4号船 `zod/v4`,因此您可以一次迁移一个呼叫网站:

```typescript
import { z } from 'zod/v4';
import { Endpoints } from '@farcaster/quick-auth';

const schema = z.object({ query: Endpoints.VerifyJwt.requestQueryParametersSchema });
```

如果你只使用 `createClient()`, (中文(简体) ), `createLightClient()` 或者说 `decodeJwt()`,不需要修改.

## 常见问题

### @farcaster/quick-auth 是什么？

Farcaster Quick Auth 客户端

### 如何安装 @farcaster/quick-auth？

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

### @farcaster/quick-auth 支持 TypeScript 吗？

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

### @farcaster/quick-auth 支持 ESM 还是 CommonJS？

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

### @farcaster/quick-auth 可以商用吗？

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

### @farcaster/quick-auth 的下载量有多少？

根据 npm 官方下载统计，@farcaster/quick-auth 在 2026/10/15 – 2026/11/13 这 30 天内被下载 520,255 次，日均约 17,342 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @farcaster/quick-auth 还在维护吗？

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