# rns-js

[![npm version](https://badge.fury.io/js/%40rsksmart%2Frns.svg)](https://badge.fury.io/js/%40rsksmart%2Frns)
[![CircleCI](https://circleci.com/gh/rnsdomains/rns-js.svg?style=svg)](https://circleci.com/gh/rnsdomains/rns-js)

RNS JavaScript library.

```
npm i web3 @rsksmart/rns
```

Types are exposed under '@rsksmart/rns/types'

Or just use it directly in your webpage:
```html
<script src="https://unpkg.com/web3@1.2.6/dist/web3.min.js"></script>
<script src="https://unpkg.com/@rsksmart/rns@1.8.2/lib/rns.min.js"></script>
```
> Don't forget to specify the desired version of the package!

## Basic usage

Instance de library:

```javascript
import Web3 from 'web3'
import RNS from '@rsksmart/rns'
import { ChainId } from '@rsksmart/rns/types'

const web3 = new Web3('https://public-node.rsk.co')
const rns = new RNS(web3)
```

Get an address:
```javascript
rns.addr('testing.rsk').then(console.log)
```

Get Bitcoin address:
```javascript
rns.addr('testing.rsk', ChainId.BITCOIN).then(console.log)
```

Check if `testing.rsk` domain is available:
```javascript
rns.available('testing.rsk').then(console.log)
```

Check if `example.testing.rsk` subdomain is available:
```javascript
rns.subdomains.available('testing.rsk', 'example').then(console.log)
```

Reverse lookup: get name of a given address:
```javascript
rns.reverse('0x0000000000000000000000000000000123456789').then(console.log)
```

Check out more operations details in the [RSK Developers Portal](https://developers.rsk.co/rif/rns/libs/javascript/Operations/).

## Advanced usage

Use Web3 `Contract` directly

```javascript
async function myCustomGetOwner(domain) {
  const web3 = new Web3('https://public-node.rsk.co')
  const rns = new RNS(web3)

  await rns.compose()

  const owner = await rns.contracts.registry.methods.owner(domain).call()

  return owner;
}
```

## Resource record implementations

- Contract addresses - [EIP-137](https://eips.ethereum.org/EIPS/eip-137#resolver-specification)
- Multicoin addresses - [EIP-2304](https://eips.ethereum.org/EIPS/eip-2304)
- Contenthash - [EIP-1577](https://eips.ethereum.org/EIPS/eip-1577)

Coins supported:

 - BTC (base58check P2PKH and P2SH, and bech32 segwit)
 - LTC (base58check P2PHK and P2SH, and bech32 segwit)
 - DOGE (base58check P2PKH and P2SH)
 - MONA (base58check P2PKH and P2SH, and bech32 segwit)
 - DASH (base58check P2PKH and P2SH)
 - ETH (checksummed-hex)
 - ETC (checksummed-hex)
 - RSK (checksummed-hex)
 - XDAI (checksummed-hex)
 - XRP (base58check-ripple)
 - BCH (base58check and cashAddr; decodes to cashAddr)
 - BNB (bech32)
 - XLM (ed25519 public key)
 - ATOM (bech32)
 - TRX (base58check)
 - NEM (base32)
 - EOS
 - KSM (ss58)
 
 Content types supported:
 
 - `ipfs`
 - `bzz`
 - `onion`
 - `onion3`

## Run for development

Install dependencies:

```
git clone git@github.com:rnsdomains/rns-js.git
cd rns-js
npm i
```

Run tests:

```
npm test
```

Try out your development, create a testing project:

```
# in rns-js folder
npm run build
npm link
cd ..
mkdir rns-js-test
cd rns-js-test
npm init
npm i web3
npm link @rsksmart/rns
```

## Versioning

- `master` branch point to latest release.
- `develop` branch contains changes that will apply next release. The first commit after release bumps to next version.
- Other branches (feature branches) point to `develop`.

Find releases scopes in [milestones](https://github.com/rnsdomains/rns-js/milestones)