npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@tradetrust-tt/dnsprove

v2.16.0

Published

Helper utility for retrieving OpenAttestations document store address records from DNS

Downloads

1,682

Readme

TradeTrust (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:

[
  {
    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

npm i @tradetrust-tt/dnsprove

Debug

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

In Browser:

localStorage.debug="dnsprove*"

In NodeJS:

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

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

defaultDnsResolvers

Type: Array<CustomDnsResolver>

queryDns

Parameters

Returns Promise<IDNSQueryResponse>

parseOpenAttestationRecord

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

parseDocumentStoreResults

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

Parameters

Returns Array<OpenAttestationDNSTextRecord>

parseDnsDidResults

Parameters

Returns Array<OpenAttestationDnsDidRecord>

getDocumentStoreRecords

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

Parameters

Examples

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

Returns Promise<Array<OpenAttestationDNSTextRecord>>

getDnsDidRecords

Parameters

Returns Promise<Array<OpenAttestationDnsDidRecord>>

License

MIT