# @bitgo/sdk-hmac 中文文档

规范地址：https://npmcn.com/package/%40bitgo/sdk-hmac/

版本：1\.9\.2
npm 元数据更新时间：2026-09-29T16:01:47.776Z
中文译文更新时间：2026-11-08T04:24:17.057Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bitgo/sdk-hmac
原文对照：https://npmcn.com/package/%40bitgo/sdk-hmac/?lang=original
项目主页：https://github.com/BitGo/BitGoJS#readme
源码仓库：https://github.com/BitGo/BitGoJS

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

- 包体积（解压后）：144 kB，30 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-01-09T18:22:22.798Z
- 最新版本发布：2026-09-29T16:01:47.358Z
- 近 30 天下载量：50220（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 5 个）

## 中文简介

BitGo SDK 的 HMAC 模块

## 安装

```sh
npm install @bitgo/sdk-hmac
```

也可以使用：`pnpm add @bitgo/sdk-hmac`、`yarn add @bitgo/sdk-hmac`、`bun add @bitgo/sdk-hmac`

## README

# @bitgo/sdk-sdk-hmac (英语)

在API请求中执行基于散列消息认证(HMAC)的孤立模块.

## 安装

```shell
npm i @bitgo/sdk-hmac
```

```javascript
import { calculateRequestHeaders, verifyResponse } from '@bitgo/sdk-hmac';

const bearerToken = 'v2x123...';
const url = '/api/v2/wallets';

const { hmac, timestamp, tokenHash } = calculateRequestHeaders({
  url,
  token: bearerToken,
  timestamp: new Date().valueOf().toString(),
  // if making a POST/PUT request with a body, pass as text
  // text: JSON.stringify(request.body)
  // optional, can pass 2 or 3 for auth-version
  // authVersion: 3
});

const response = await fetch(url, {
  method: 'GET',
  headers: {
    authorization: `Bearer ${tokenHash}`,
    hmac,
    'bitgo-auth-version': '2.0',
    'auth-timestamp': timestamp,
  },
});

const verifiedResponse = verifyResponse({
  url,
  hmac: response.headers.get('hmac'),
  statusCode: response.status,
  text: response.text,
  timestamp: response.headers.get('timestamp'),
  token: bearerToken,
  method: 'get',
});

if (!verifiedResponse.isValid) {
  throw new Error('dont trust this response, possible MITM attack');
}
```

## 常见问题

### @bitgo/sdk-hmac 是什么？

BitGo SDK 的 HMAC 模块

### 如何安装 @bitgo/sdk-hmac？

在项目目录运行 npm install @bitgo/sdk-hmac，或使用 pnpm add / yarn add / bun add。

### @bitgo/sdk-hmac 支持 TypeScript 吗？

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

### @bitgo/sdk-hmac 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bitgo/sdk-hmac 可以商用吗？

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

### @bitgo/sdk-hmac 的下载量有多少？

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

### @bitgo/sdk-hmac 还在维护吗？

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