# ethernameservice

> .ether Name Service

Latest version **1.0.2** (published 2022-09-27) · ISC license · 0 weekly downloads

## Install

```sh
npm install ethernameservice
pnpm add ethernameservice
yarn add ethernameservice
bun add ethernameservice
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2022-09-27 |
| First published | 2022-09-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 27.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | etherDev |
| Maintainers | ethername |

## Links

- npm: https://www.npmjs.com/package/ethernameservice
- Repository: https://github.com/ethernameservice/etherns
- Homepage: https://github.com/ethernameservice/etherns#readme
- Issues: https://github.com/ethernameservice/etherns/issues
- npm.io page: https://npm.io/package/ethernameservice

## Recent versions

- 1.0.2 (latest) — 2022-09-27
- 1.0.1 — 2022-09-27
- 1.0.0 — 2022-09-27

## README

# .ether Name Service
This document will help you incorporate .ether into your projects. In the document, available functions are examined by including web3.js and .ether name service in your project.



### Requirements
>If you are not actively using it in your project, you should install web3.js.

**NODE**
```
npm install web3
```

**YARN**
```
yarn add web3
```

**In the Browser**
```javascript
<script src="https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js"></script>
```
or
```javascript
<script src="https://unpkg.com/web3@latest/dist/web3.min.js"></script>
```

### Installation

**NODE**
```
npm install ethernameservice
```

**In the Browser**
```javascript
<script src="https://unpkg.com/ethernameservice@1.0.2/index.js"></script>
```


### Usage
First, we connect with the libraries.

```javascript
const web3 = new Web3(Web3.givenProvider)
// First create a web3js provider

const etherNS = new EtherNS(web3)
// You are now ready for .ether
```

**Primary Address**

Returns the primary address registered to this address.
```javascript
etherNS.primaryAddress("ETH_ADDRESS")
.then(function(result){
    console.log(result)
    // Returns the primary address registered to this address.
})
```

**Resolve Address**

Returns the resolved ethereum address of the .ether name.
```javascript
etherNS.resolveAddress("alice.ether").then(function(result){
    console.log(result)
    // Returns the resolved ethereum address of the .ether name.
})
```

**Address Owners**

Returns the domains owned by an address.
```javascript
etherNS.addressOwners("ETH_ADDRESS").then(function(resultOwners){
	console.log(resultOwners)	
})
```

**Subdomain Status**

This query returns whether the subdomain sale is active.
```javascript
etherNS.subdomainPublicSale("ether_name").then(function(result) {
    if (result) {
        //Subdomain can be registered.
    } else {
        //Subdomain can't be registered.
    }
})
```    

**Subdomain Cost**

This query returns the cost of subdomain sales.
```javascript
etherNS.subdomainPublicSale("ether_name").then(function(result_cost) {
    console.log(result_cost)
})    
```    

**Last registered names**

Returns the last  registered .ether names
```javascript
etherNS.lastAddresses(10).then(function(result){
    console.log(result)
    //Returns the last 10 registered .ether name
})
```

**Is this domain name taken ?**

Returns whether a domain name has been registered by another user.
```javascript
etherNS.isTaken("ether_name").then(function(resultTaken){
    if (resultTaken>0) {
        //This domain name has been registered.
    } 
})
```


**Get Data**

Get domain name information.
```javascript
etherNS.getData("ether_name","data_name").then(function(result){ {
    console.log(result)
});
```


**Get Twitter Account**

Get Twitter account from .ether name.
```javascript
etherNS.getTwitter(ether_name).then(function(account_twitter){
     console.log(account_twitter)
})
```


**Get Instagram Account**

Get Instagram account from .ether name.
```javascript
etherNS.getInstragram(ether_name).then(function(account_instagram){
     console.log(account_instagram)
})
```

**Get Discord Account**

Get Discord account from .ether name.
```javascript
etherNS.getDiscord(ether_name).then(function(account_discord){
     console.log(account_discord)
})
```

**Get Tiktok Account**

Get Tiktok account from .ether name.
```javascript
etherNS.getTiktok(ether_name).then(function(account_tiktok){
     console.log(account_tiktok)
})
```

**Get Reddit Account**

Get Reddit account from .ether name.
```javascript
etherNS.getReddit(ether_name).then(function(account_reddit){
     console.log(account_reddit)
})
```

**Get Telegram Account**

Get Telegram account from .ether name.
```javascript
etherNS.getTelegram(ether_name).then(function(account_telegram){
     console.log(account_telegram)
})
```

**Get URL**

Get URL from .ether name.
```javascript
etherNS.getUrl(ether_name).then(function(account_url){
     console.log(account_url)
})
```

**Get Email**

Get Email from .ether name.
```javascript
etherNS.getEmail(ether_name).then(function(account_email){
     console.log(account_email)
})
```


**Get Description**

Get Description from .ether name.
```javascript
etherNS.getDescription(ether_name).then(function(account_description){
     console.log(account_description)
})
```

**Get Notice**

Get Notice from .ether name.
```javascript
etherNS.getNotice(ether_name).then(function(account_notice){
     console.log(account_notice)
})
```

**Get Keywords**

Get Keywords from .ether name.
```javascript
etherNS.getKeywords(ether_name).then(function(account_keywords){
     console.log(account_keywords)
})
```



**Set New Primary Address**

Changes the primary address.
```javascript
etherNS.setPrimaryAddress("ether_name.ether","OWNER_ETH_ADDRESS").then(function(result){
    if (result['status']) {
     //Successful
     } else {
     //Failed
     }
})
```

**Set New Resolve Address**

Changes the resolve address.
```javascript
 etherNS.setResolveAddress("ether_domain.ether","NEW_RESOLVE_ETH_ADDRESS", "OWNER_ETH_ADDRESS").then(function(result){
        if (result['status']) {
        //Successful
        } else {
        //Failed
        }
 })
```

**Register Main Domain**

Registers a new .ether address and returns the result.
```javascript
etherNS.register("new_domain.ether",YOUR_ETH_ADDRESS,YOUR_REFERRAL_ADDRESS,web3.utils.toWei('0.04', 'ether')).then(function(result){
    if (result['status']) {
        // Registration Successful
    } else {
        // Registration Failed
    }
})
```

**Register Subdomain**

Registers a subdomain address and returns the result.
```javascript
 etherNS.registerSubdomain("MAIN_DOMAIN_NAME","YOUR_ETH_ADDRESS","NEW_SUBDOMAIN_NAME","COST_WEI").then(function(result){
    if (result['status']) {
        // Registration Successful
    } else {
        // Registration Failed
    }    
})
```


**Start or Close subdomain sale**

```javascript
etherNS.setSubdomainSaleActive("true",web3.utils.toWei("0.05",'ether'),"ether_name","OWNER_ETH_ADDRESS").then(function(result){
	if (result['status']) {
     //Successful
     } else {
     //Failed
     }
})
```

**Set Data**

It allows you to add data for the domain name you have.
```javascript
etherNS.setData("ether_name","data_name","data_value", "Owner_Eth_Address").then(function(result){
    if (result['status']) {
     //Successful
     //eq: data_name: twitter, data_value: twitter_account
     } else {
     //Failed
     }
})
```

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