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:
- apiConfig:
{unstoppable: '<unstoppable api key>'}
- cslFactory: Cardano Serialization Library initiator
Returns: getCardanoAddresses
getCardanoAddresses
Accepted arguments:
- resolve:
string
. Domain or handle to look for. - 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}]