# @dotnames/dotnames-js

> A Universal SDK to resolve names from all blockchains

Latest version **0.0.5** (published 2024-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dotnames/dotnames-js
pnpm add @dotnames/dotnames-js
yarn add @dotnames/dotnames-js
bun add @dotnames/dotnames-js
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2024-02-13 |
| First published | 2024-01-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 16 |
| Unpacked size | 441.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | dotlabs |
| Maintainers | dotname |
| Keywords | dotnames-sdk, dotnames, dotlabs, universal-sdk, sdk, ENS, Space-Id, UD, SNS, SuiNs, AptosNs |

## Links

- npm: https://www.npmjs.com/package/@dotnames/dotnames-js
- npm.io page: https://npm.io/package/@dotnames/dotnames-js

## Dependencies (16)

- [tsup](https://npm.io/package/tsup.md) ^8.0.1
- [dotbit](https://npm.io/package/dotbit.md) ^0.4.22
- [ethers](https://npm.io/package/ethers.md) ^5.7.2
- [sgnames.js](https://npm.io/package/sgnames.js.md) ^0.1.1
- [@sei-js/core](https://npm.io/package/@sei-js/core.md) ^3.1.3
- [zksync-ethers](https://npm.io/package/zksync-ethers.md) ^5.0.0
- [@mysten/sui.js](https://npm.io/package/@mysten/sui.js.md) ^0.37.1
- [@solana/web3.js](https://npm.io/package/@solana/web3.js.md) ^1.78.0
- [@ensdomains/ensjs](https://npm.io/package/@ensdomains/ensjs.md) ^3.0.0-alpha.65
- [@siddomains/sidjs](https://npm.io/package/@siddomains/sidjs.md) ^0.1.29
- [@dotnames/dotseijs](https://npm.io/package/@dotnames/dotseijs.md) ^0.0.3
- [@dotbit/plugin-avatar](https://npm.io/package/@dotbit/plugin-avatar.md) ^0.0.1
- [@siddomains/sei-sidjs](https://npm.io/package/@siddomains/sei-sidjs.md) ^0.0.4
- [@bonfida/spl-name-service](https://npm.io/package/@bonfida/spl-name-service.md) ^1.0.6
- [@cosmjs/cosmwasm-stargate](https://npm.io/package/@cosmjs/cosmwasm-stargate.md) ^0.28.11
- [@unstoppabledomains/resolution](https://npm.io/package/@unstoppabledomains/resolution.md) ^9.1.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.0.5 (latest) — 2024-02-13
- 0.0.4 — 2024-01-24
- 0.0.3 — 2024-01-02
- 0.0.2 — 2024-01-02

## README

# DotNames-Js : A Javascript Library To Resolve Domains On All Blockchains

## Overview of the SDK

### Installation

Install @dotnames/dotnames-js

```
npm i @dotnames/dotnames-js
```

### Getting Started

Setup with default RPC (May increase latency) :

```
  const dotnames = new DotNamesSDK();
```

Setup with custom RPC :

```
  const dotnames = new DotNamesSDK(
  param:{ ethRPC: '',
  polygonRPC: '',
  bnbRPC: '',
  suiRPC: '',
  seiRPC: '',
  osmosisRPC: ''
  });

```

Can be initalized with required selected RPC configuration

### Supported Naming Service Types

```
import {SupportedNs} from '@dotnames/dotnames-js'

```

#### Supported Naming Services :   
ENS,
UnstoppableDomains
DotBit,
Zkns,
ICNS,
StargazeDomains,
Bonfida,
SuiNs,
AptosNs,
DotSeiNS

#### ContentHash Records Supported Domains (Decentralized Websites)
ENS,
UnstoppableDomains
DotBit,
Zkns,
Bonfida

### Usage :


### Resolving addresses from names without providing domain name identifier

ENS : 
```
const ensAddress = await dotnames.resolveAddress('alice.eth');
```
Unstoppable Domains : 
```
const udAddress = await dotnames.resolveAddress('alice.crypto');
```
Dotsei Domains: 
```
const seiAddress = await dotnames.resolveAddress('alice.sei');
```
Space Id : 
```
const sidAddress = await dotnames.resolveAddress('alice.bnb');
```
### Resolving addresses from names by providing domain name identifier

ENS : 
```
const ensAddress = await dotnames.resolveAddress('alice.eth',SupportedNS.ENS);
```
Unstoppable Domains : 
```
const udAddress = await dotnames.resolveAddress('alice.crypto',SupportedNS.UnstoppableDomains);
```
Dotsei Domains: 
```
const seiAddress = await dotnames.resolveAddress('alice.sei',SupportedNS.SeiNS);
```
Space Id : 
```
const sidAddress = await dotnames.resolveAddress('alice.bnb',SupportedNS.SpaceId);
```


### Resolving names from addresses

ENS : 
```
const ensName = await dotnames.resolveName('//Address', SupportedNS.ENS);
```
Unstoppable Domains : 
```
const udName = await dotnames.resolveName('//Address', SupportedNS.UnstoppableDomains);
```
Dotsei Domains: 
```
const dotseiName = await dotnames.resolveName('//Address', SupportedNS.SeiNS);
```
Space Id : 
```
const sidName = await  dotnames.resolveName('//Address', SupportedNS.SpaceId);
```


### Resolving Records without providing domain name identifier
```
const ensRecords = await dotnames.getRecords('alice.eth');
```
Unstoppable Domains : 
```
const udRecords = await dotnames.getRecords('alice.crypto');
```
Dotsei Domains: 
```
const seiRecords = await dotnames.getRecords('alice.sei');
```
Space Id : 
```
const sidRecords = await dotnames.getRecords('alice.bnb');
```

### Resolving Records by providing domain name identifier
ENS : 
```
const ensRecords = await dotnames.getRecords('alice.eth',SupportedNS.ENS);
```
Unstoppable Domains : 
```
const udRecords = await dotnames.getRecords('alice.crypto',SupportedNS.UnstoppableDomains);
```
Dotsei Domains: 
```
const seiRecords = await dotnames.getRecords('alice.sei',SupportedNS.SeiNS);
```
Space Id : 
```
const sidRecords = await dotnames.getRecords('alice.bnb',SupportedNS.SpaceId);
```

---
_Source: https://npm.io/package/@dotnames/dotnames-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
