# @govtechsg/dnsprove 中文文档

规范地址：https://npmcn.com/package/%40govtechsg/dnsprove/

版本：2\.8\.0
npm 元数据更新时间：2026-07-03T07:14:44.825Z
中文译文更新时间：2026-11-17T06:13:24.838Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：76.4 kB，43 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2019-07-19T03:52:27.127Z
- 最新版本发布：2024-07-17T00:58:36.821Z
- 近 30 天下载量：5763（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 0 个）

## 中文简介

从 DNS 检索 OpenAttestation 文档存储地址记录的辅助工具

## 安装

```sh
npm install @govtechsg/dnsprove
```

也可以使用：`pnpm add @govtechsg/dnsprove`、`yarn add @govtechsg/dnsprove`、`bun add @govtechsg/dnsprove`

## README

# 打开验证( dnsprove)

一个利用Google的公共DNS服务从域中检索OpenAttestation DNS-TXT记录的帮助器库.

一个有效的 OpenAttestation DNS-TXT 记录看起来像:

```js
[
  {
    name: "example.openattestation.com.",
    type: 16,
    TTL: 110,
    data: '"openatts net=ethereum netId=3 addr=0x2f60375e8144e16Adf1979936301D8341D58C36C"',
  },
];
```

对所有检索到的记录进行验证,以确保符合预期的格式,而未能验证的记录将只是从返回的结果中省去.

## 安装

```bash
npm i @govtechsg/dnsprove
```

* * *

## 调试

要看到校验失败会打开调试旗运行库, 也可以

在浏览器中:

`localStorage.debug="dnsprove*"`

在节点JS中:

```sh
DEBUG="dnsprove*" npm run test
```

## 类型

此库使用 [运行类型](https://github.com/pelotom/runtypes) 用于编译时间静态类型检查以及运行时间输入验证。 由于文档生成器的限制,以下生成的文档对于生成的任何类型的运行类型是不准确的.

## API 密码

#### 目录

-   [打开Attestation DNSText 记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-openattestationdnstextrecord)
-   [OpenAttestation Dns 已记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-openattestationdnsdidrecord)
-   [IDNS记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-idnsrecord)
-   [IDNS 查询回复](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-idnsqueryresponse)
-   [自定义解析器](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-customdnsresolver)
-   [默认Dns 解析器](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-defaultdnsresolvers)
-   [查询Dns](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-querydns)
    -   [参数](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parameters)
-   [解析打开站记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parseopenattestationrecord)
    -   [参数](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parameters-1)
-   [解析文档](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parsedocumentstoreresults)
    -   [参数](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parameters-2)
-   [解析DnsdidResults 存档副本](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parsednsdidresults)
    -   [参数](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parameters-3)
-   [获取文档记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-getdocumentstorerecords)
    -   [参数](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parameters-4)
    -   [实例](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-examples)
-   [获取 Dns 已读记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-getdnsdidrecords)
    -   [参数](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-parameters-5)

### 打开Attestation DNSText 记录

### OpenAttestation Dns 已记录

### IDNS记录

### IDNS 查询回复

### 自定义解析器

类型:函数(域: [字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String): [答应](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[IDNS 查询回复](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-idnsqueryresponse)\> 翻译:

### 默认Dns 解析器

类型 : [阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[自定义解析器](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-customdnsresolver)\> 翻译:

### 查询Dns

#### 参数

-   `domain` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `customDnsResolvers` **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[自定义解析器](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-customdnsresolver)\> 翻译:**

回返 **[答应](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[IDNS 查询回复](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-idnsqueryresponse)\> 翻译:**

### 解析打开站记录

解析一个打开验证 DNS- TXT 记录,并将其变成一个打开验证 DNSText 记录对象

#### 参数

-   `record` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 例如:"开口网=ethereum netId=3 addr=0x0c9d5E6C766030cc6f0f49951D275Ad0701F81EC"

回返 **通用对象**

### 解析文档

使用 DNS- TXT 记录集, 如果有的话, 返回打开验证文件存储记录

#### 参数

-   `recordSet` **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNS记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-idnsrecord)\> 翻译:** 参考实例测试( 可选, 默认) `[]`(中文(简体) )
-   `dnssec` **[布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**

回返 **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[打开Attestation DNSText 记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-openattestationdnstextrecord)\> 翻译:**

### 解析DnsdidResults 存档副本

#### 参数

-   `recordSet` **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNS记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-idnsrecord)\> 翻译:** (可选,默认) `[]`(中文(简体) )
-   `dnssec` **[布尔](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**

回返 **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestation Dns 已记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-openattestationdnsdidrecord)\> 翻译:**

### 获取文档记录

查询给定域, 并解析结果以获取打开验证文件存储记录( 如果有的话)

#### 参数

-   `domain` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 例如:"example.openatestation.com"("实例
-   `customDnsResolvers` **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[自定义解析器](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-customdnsresolver)? 说?**

#### 实例

```javascript
> getDocumentStoreRecords("example.openattestation.com")
> [ { type: 'openatts',
net: 'ethereum',
netId: '3',
addr: '0x2f60375e8144e16Adf1979936301D8341D58C36C',
dnssec: true } ]
```

回返 **[答应](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[打开Attestation DNSText 记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-openattestationdnstextrecord)\>>**

### 获取 Dns 已读记录

#### 参数

-   `domain` **[字符串](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
-   `customDnsResolvers` **[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[自定义解析器](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-customdnsresolver)? 说?**

回返 **[答应](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[阵列](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestation Dns 已记录](https://npmcn.com/package/%40govtechsg/dnsprove/#readme-openattestationdnsdidrecord)\>>**

## 许可证

麻省理工学院

## 常见问题

### @govtechsg/dnsprove 是什么？

从 DNS 检索 OpenAttestation 文档存储地址记录的辅助工具

### 如何安装 @govtechsg/dnsprove？

在项目目录运行 npm install @govtechsg/dnsprove，或使用 pnpm add / yarn add / bun add。

### @govtechsg/dnsprove 支持 TypeScript 吗？

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

### @govtechsg/dnsprove 支持 ESM 还是 CommonJS？

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

### @govtechsg/dnsprove 可以商用吗？

@govtechsg/dnsprove 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @govtechsg/dnsprove 的下载量有多少？

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

### @govtechsg/dnsprove 还在维护吗？

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

