@yoroi/resolver
TypeScript icon, indicating that this package has built-in type declarations

2.0.3 • Public • Published

Yoroi Resolver Module

A module for resolving Cardano addresses from domains or handles.

Currently, the following services are supported:

Instalation

yarn install @yoroi/resolver

or

npm install @yoroi/resolver

Usage

There are two strategies supported to get a crypto address:

  • all: Will attempt to resolve on all services.

Response: [{nameServer: 'cns', address: string | null, error: Error instance | null}, {nameServer: 'unstoppable', address: string | null, error: Error instance | null}, {nameServer: 'handle', address: string | null, error: Error instance | null}]

  • first: Will return the service that resolves first.

Response: [{nameServer: 'cns' | 'unstoppable' | 'handle', address: string | null, error: Error instance | null}]

API Reference

  • resolverApiMaker

Accepted arguments:

  1. apiConfig: {unstoppable: '<unstoppable api key>'}
  2. cslFactory: Cardano Serialization Library initiator

Returns: getCardanoAddresses

  • getCardanoAddresses

Accepted arguments:

  1. resolve: string. Domain or handle to look for.
  2. strategy: all | first

Returns depending on the strategy selected:

All:

[{nameServer: 'cns', address: string | null, error: Error instance | null}, {nameServer: 'unstoppable', address: string | null, error: Error instance | null}, {nameServer: 'handle', address: string | null, error: Error instance | null}]

First:

[{nameServer: 'cns' | 'unstoppable' | 'handle', address: string | null, error: Error instance | null}]

Package Sidebar

Install

npm i @yoroi/resolver

Weekly Downloads

27

Version

2.0.3

License

Apache-2.0

Unpacked Size

695 kB

Total Files

378

Last publish

Collaborators

  • cryptotitan
  • vsubhuman
  • drkost
  • stackchain