Skip to content
This repository was archived by the owner on Oct 1, 2025. It is now read-only.

Commit 2a7f7b5

Browse files
committed
chore: update to npm 7, drop cjs support
BREAKING CHANGE: drop cjs support, drop node 10 support
1 parent 06f3ba0 commit 2a7f7b5

File tree

11 files changed

+28077
-4971
lines changed

11 files changed

+28077
-4971
lines changed

.babelrc

Lines changed: 0 additions & 16 deletions
This file was deleted.

.npmrc

Lines changed: 0 additions & 1 deletion
This file was deleted.

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16

.prettierrc

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 47 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ A valid OpenAttestation DNS-TXT record looks like:
1717

1818
Validation is run on all retrieved records to ensure they conform to the expected format, and records that fail validation will simply be omitted from the returned results.
1919

20-
2120
To see validation failures run the library with the debug flag turned on, either
2221

2322
In Browser:
2423

2524
`localStorage.debug="dnsprove*"`
2625

2726
In NodeJS:
27+
2828
```sh
2929
DEBUG="dnsprove*" npm run test
3030
```
@@ -33,90 +33,83 @@ DEBUG="dnsprove*" npm run test
3333

3434
This library uses [runtypes](https://github.com/pelotom/runtypes) for compile time static type checking as well as run time input validation. The generated documentation below is inaccurate for any Runtypes generated types due to documentation generator limitations.
3535

36-
3736
## API
3837

3938
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
4039

4140
#### Table of Contents
4241

43-
- [RecordTypes](#recordtypes)
44-
- [BlockchainNetwork](#blockchainnetwork)
45-
- [EthereumAddress](#ethereumaddress)
46-
- [EthereumNetworkId](#ethereumnetworkid)
47-
- [OpenAttestationDNSTextRecord](#openattestationdnstextrecord)
48-
- [IDNSRecord](#idnsrecord)
49-
- [IDNSQueryResponse](#idnsqueryresponse)
50-
- [parseOpenAttestationRecord](#parseopenattestationrecord)
51-
- [Parameters](#parameters)
52-
- [isWellFormedOpenAttestationRecord](#iswellformedopenattestationrecord)
53-
- [Parameters](#parameters-1)
54-
- [parseDnsResults](#parsednsresults)
55-
- [Parameters](#parameters-2)
56-
- [getDocumentStoreRecords](#getdocumentstorerecords)
57-
- [Parameters](#parameters-3)
58-
- [Examples](#examples)
59-
60-
### RecordTypes
61-
62-
Type: Static&lt;any>
63-
64-
### BlockchainNetwork
42+
* [OpenAttestationDNSTextRecord](#openattestationdnstextrecord)
43+
* [OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)
44+
* [IDNSRecord](#idnsrecord)
45+
* [IDNSQueryResponse](#idnsqueryresponse)
46+
* [queryDns](#querydns)
47+
* [Parameters](#parameters)
48+
* [parseOpenAttestationRecord](#parseopenattestationrecord)
49+
* [Parameters](#parameters-1)
50+
* [parseDocumentStoreResults](#parsedocumentstoreresults)
51+
* [Parameters](#parameters-2)
52+
* [parseDnsDidResults](#parsednsdidresults)
53+
* [Parameters](#parameters-3)
54+
* [getDocumentStoreRecords](#getdocumentstorerecords)
55+
* [Parameters](#parameters-4)
56+
* [Examples](#examples)
57+
* [getDnsDidRecords](#getdnsdidrecords)
58+
* [Parameters](#parameters-5)
6559

66-
Type: Static&lt;any>
67-
68-
### EthereumAddress
60+
### OpenAttestationDNSTextRecord
6961

70-
Type: Static&lt;any>
62+
### OpenAttestationDnsDidRecord
7163

72-
### EthereumNetworkId
64+
### IDNSRecord
7365

74-
Type: Static&lt;any>
66+
### IDNSQueryResponse
7567

76-
### OpenAttestationDNSTextRecord
68+
### queryDns
7769

78-
Type: Static&lt;any>
70+
#### Parameters
7971

80-
### IDNSRecord
72+
* `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
8173

82-
### IDNSQueryResponse
74+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[IDNSQueryResponse](#idnsqueryresponse)>**
8375

8476
### parseOpenAttestationRecord
8577

8678
Parses one openattestation DNS-TXT record and turns it into an OpenAttestationsDNSTextRecord object
8779

8880
#### Parameters
8981

90-
- `record` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: '"openatts net=ethereum netId=3 addr=0x0c9d5E6C766030cc6f0f49951D275Ad0701F81EC"'
82+
* `record` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: '"openatts net=ethereum netId=3 addr=0x0c9d5E6C766030cc6f0f49951D275Ad0701F81EC"'
9183

92-
Returns **[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)**
84+
Returns **GenericObject**
9385

94-
### isWellFormedOpenAttestationRecord
86+
### parseDocumentStoreResults
9587

96-
Returns true if the given object passes runtype validation for OpenAttestationDNSTextRecord
97-
Turn on debug log to see exact validation failure messages if necessary
88+
Takes a DNS-TXT Record set and returns openattestation document store records if any
9889

9990
#### Parameters
10091

101-
- `record` **[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)** An object that may conform to the OpenAttestationDNSTextRecord shape
92+
* `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** Refer to tests for examples (optional, default `[]`)
93+
* `dnssec` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
10294

103-
### parseDnsResults
95+
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>**
10496

105-
Takes a DNS-TXT Record set and returns openattestation document store records if any
97+
### parseDnsDidResults
10698

10799
#### Parameters
108100

109-
- `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[IDNSRecord](#idnsrecord)>** Refer to tests for examples (optional, default `[]`)
101+
* `recordSet` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[IDNSRecord](#idnsrecord)>** (optional, default `[]`)
102+
* `dnssec` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
110103

111-
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>**
104+
Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)>**
112105

113106
### getDocumentStoreRecords
114107

115108
Queries a given domain and parses the results to retrieve openattestation document store records if any
116109

117110
#### Parameters
118111

119-
- `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: "example.openattestation.com"
112+
* `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** e.g: "example.openattestation.com"
120113

121114
#### Examples
122115

@@ -129,7 +122,15 @@ addr: '0x2f60375e8144e16Adf1979936301D8341D58C36C',
129122
dnssec: true } ]
130123
```
131124

132-
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>>**
125+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDNSTextRecord](#openattestationdnstextrecord)>>**
126+
127+
### getDnsDidRecords
128+
129+
#### Parameters
130+
131+
* `domain` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
132+
133+
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[OpenAttestationDnsDidRecord](#openattestationdnsdidrecord)>>**
133134

134135
## License
135136

jest.config.js

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)