`@yoroi/resolver`

A module for resolving Cardano addresses from domains or handles.

Currently, the following services are supported:

Instalation

yarn install @yoroi/resolver

npm install @yoroi/resolver

Usage

There are two strategies supported to get a crypto address:

all: Will attempt to resolve for all services.
first: Will return the service that resolves first.

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}
]

Contributing

We welcome contributions from the community! If you find a bug or have a feature request, please open an issue or submit a pull request.

📚 Documentation

For detailed documentation, please visit our documentation site.

🧪 Testing

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

🏗️ Development

# Install dependencies
npm install

# Build the package
npm run build

# Build for development
npm run build:dev

# Build for release
npm run build:release

📊 Code Coverage

The package maintains a minimum code coverage threshold of 20% with a 1% threshold for status checks.

📈 Dependency Graph

Below is a visualization of the package's internal dependencies:

Dependency Graph

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for more details.

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Package detail

@yoroi/resolver

readme