@alph-name-service/ans-sdk/README.md

SDK for integrating with the Alephium Name Service protocol

# ANS-SDK

JS/TS SDK for integrating the Alephium Name Service protocol.

## Install

```
npm install @alph-name-service/ans-sdk
```

## Usage

```js
const ans = new ANS("mainnet");
const testProfile = await ans.getProfile("<address>");
// returns {name: "...", imgUri: "..."}
// if profile exists, undefined otherwise
const testRecord = await ans.getRecord("<name>");
// returns {owner: ..., manager: ..., ttl: ...}
// if name exists, undefined otherwise
const resolvedAddress = await ans.resolveName("<name>");
// returns the resolved address string
// if name exists, undefined otherwise
console.log({ resolvedAddress, testProfile, testRecord });
```