Scroll Name Service for Scroll Alpha Testnet

This document will help you incorporate .scroll into your projects. In the document, available functions are examined by including web3.js and .scroll 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

<script src="https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js"></script>

or

<script src="https://unpkg.com/web3@latest/dist/web3.min.js"></script>

Installation

NODE

npm i scrollnameservice

In the Browser

<script src="https://www.unpkg.com/scrollnameservice@1.0.0/index.js"></script>

Usage

First, we connect with the libraries.

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

const scrollNS = new scrollNS(web3)
// You are now ready for .scroll

GETS

Primary Address (Ethereum Address to .scroll Name)

Returns the primary address registered to this address.

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

Resolve Address (.scroll Name to Ethereum Address)

Returns the resolved ethereum address of the .scroll name.

scrollNS.resolveAddress("name.scroll").then(function(result){
    console.log(result)
    // Returns the resolved ethereum address of the .scroll name.
})

Address Owners

Returns the domains owned by an address.

scrollNS.addressOwners("ETH_ADDRESS").then(function(resultOwners){
	console.log(resultOwners)
})

Last registered names

Returns the last registered .scroll names

scrollNS.lastAddresses(20).then(function(result){
    console.log(result)
    //Returns the last 10 registered .scroll name
})

Is this domain name taken ?

Returns whether a domain name has been registered by another user.

scrollNS.isTaken("scroll").then(function(resultTaken){
    if (resultTaken>0) {
        //This domain name has been registered.
    }
})

Get Data

Get domain name information.

scrollNS.getData("name","data_name").then(function(result){
    console.log(result)
});

Get Twitter Account

Get Twitter account from .scroll name.

scrollNS.getTwitter(name).then(function(account_twitter){
     console.log(account_twitter)
})

Get Instagram Account

Get Instagram account from .scroll name.

scrollNS.getInstragram(name).then(function(account_instagram){
     console.log(account_instagram)
})

Get Discord Account

Get Discord account from .scroll name.

scrollNS.getDiscord(name).then(function(account_discord){
     console.log(account_discord)
})

Get Telegram Account

Get Telegram account from .scroll name.

scrollNS.getTelegram(name).then(function(account_telegram){
     console.log(account_telegram)
})

Get URL

Get URL from .scroll name.

scrollNS.getUrl(name).then(function(account_url){
     console.log(account_url)
})

Get Email

Get Email from .scroll name.

scrollNS.getEmail(name).then(function(account_email){
     console.log(account_email)
})

Get Description

Get Description from .scroll name.

scrollNS.getDescription(name).then(function(account_description){
     console.log(account_description)
})

Get Avatar

Get Avatar from .scroll name.

scrollNS.getKeywords(name).then(function(account_keywords){
     console.log(account_keywords)
})

SETS

Set New Primary Address

Changes the primary address.

scrollNS.setPrimaryAddress("name.scroll","OWNER_ETH_ADDRESS").then(function(result){
    if (result['status']) {
     //Successful
     } else {
     //Failed
     }
})

Set New Resolve Address

Changes the resolve address.

 scrollNS.setResolveAddress("name.scroll","NEW_RESOLVE_ETH_ADDRESS", "OWNER_ETH_ADDRESS").then(function(result){
        if (result['status']) {
        //Successful
        } else {
        //Failed
        }
 })

Register Domain

Registers a new .scroll address and returns the result.

scrollNS.register("name.scroll",YOUR_REF_ADDRESS,YOUR_ETH_ADDRESS,"3000000000000000").then(function(result){
    if (result['status']) {
        // Registration Successful
    } else {
        // Registration Failed
    }
})

Set Data

It allows you to add data for the domain name you have.

scrollNS.setData("name","data_type","data_value", "Owner_Eth_Address").then(function(result){
    if (result['status']) {
     //Successful
     //eq: data_name: twitter, data_value: twitter_account
     } else {
     //Failed
     }
})