Open Attestation (dnsprove)

A helper library to retrieve OpenAttestation DNS-TXT records from domains using Google's public DNS service.

A valid OpenAttestation DNS-TXT record looks like:

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

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.

Installation

`bash
npm i @govtechsg/dnsprove
`

*

Debug

To see validation failures run the library with the debug flag turned on, either

In Browser:

localStorage.debug="dnsprove*"

In NodeJS:

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

Types

This library uses 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.

API

#### Table of Contents

* OpenAttestationDNSTextRecord
* OpenAttestationDnsDidRecord
* IDNSRecord
* IDNSQueryResponse
* CustomDnsResolver
* defaultDnsResolvers
* queryDns
* Parameters
* parseOpenAttestationRecord
* Parameters
* parseDocumentStoreResults
* Parameters
* parseDnsDidResults
* Parameters
* getDocumentStoreRecords
* Parameters
* Examples
* getDnsDidRecords
* Parameters

$3

$3

$3

$3

$3

Type: function (domain: string): Promise<IDNSQueryResponse>

$3

Type: Array<CustomDnsResolver>

$3

#### Parameters

* domain string
* customDnsResolvers Array<CustomDnsResolver>

Returns Promise<IDNSQueryResponse>

$3

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

#### Parameters

* record string e.g: '"openatts net=ethereum netId=3 addr=0x0c9d5E6C766030cc6f0f49951D275Ad0701F81EC"'

Returns GenericObject

$3

Takes a DNS-TXT Record set and returns openattestation document store records if any

#### Parameters

* recordSet Array<IDNSRecord> Refer to tests for examples (optional, default [])
* dnssec boolean

Returns Array<OpenAttestationDNSTextRecord>

$3

#### Parameters

* recordSet Array<IDNSRecord> (optional, default [])
* dnssec boolean

Returns Array<OpenAttestationDnsDidRecord>

$3

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

#### Parameters

* domain string e.g: "example.openattestation.com"
* customDnsResolvers Array<CustomDnsResolver>?

#### Examples

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

Returns Promise<Array<OpenAttestationDNSTextRecord>>

$3

#### Parameters

* domain string
* customDnsResolvers` Array<CustomDnsResolver>?

Returns Promise<Array<OpenAttestationDnsDidRecord>>

License

MIT