# Overview

An In-depth Tour of XRP Domains

## XRP Web3 Identity (.xrp) - XRPL Name Service

**The decentralized way to build your online presence with XRP Web3 domains**

<figure><img src="/files/6QGIk0nCbRlYJqJwIxcO" alt=""><figcaption></figcaption></figure>

**Welcome to the world of XRP Web3 Domains:** where ownership, security, and decentralization meet. XRP Web3 domains are a new type of domain name that operate on the XRP Ledger, enabling users to create unique digital identities and easily interact with decentralized applications and services. With XRP Web3 domains, users have complete ownership and control over their domains, with no intermediaries or central authorities involved.

**What are XRP Web3 Domains?** XRP Domains are blockchain-based domain names that are registered and managed on the XRP Ledger. Unlike traditional domain names, XRP domains are fully decentralized, meaning they are not controlled by any central authority or organization. This makes XRP domains resistant to censorship and hacking, and provides users with complete ownership and control over their online identity.

**Replace a crypto address with a domain name:** In the past, whenever you sent crypto to another person, you needed their wallet address, which consists of a long string of letters and numbers. Today, all you need is a domain name, making it easier than ever to send and receive cryptocurrencies. It’s security, privacy and safety.

**One-time registration fee, no renewal fees:** XRP Domains are not rented, after buying a .XRP domain, it is yours forever, no one can request any renewal fees from you. Domains can be stored in your wallet, like cryptocurrency and only you can control it.


# Vision

**Dear XRP Domain Community!**

We're thrilled to announce our vision for the XRP Domains is to create an ecosystem where XRP Domains identities are widely adopted and accepted as a trusted and secure means of transacting value. Our goal is to build a strong community of like-minded individuals and businesses that will help drive adoption of cryptocurrencies and blockchain technology as a whole.

To achieve this vision, we have developed a comprehensive strategy that includes several key components. Our strategy focuses on community building, product development, and customer acquisition.

First and foremost, we recognize that the success of the XRP Domains ecosystem is tightly linked to the strength of the community. That's why we are committed to building a thriving and engaged community of users, developers, and partners. We plan to launch a variety of community programs that are designed to engage with and incentivize community members. These programs will include referral programs, loyalty programs, and ambassador programs, all of which will provide benefits and rewards to users who actively contribute to the growth and development of the ecosystem.

Secondly, our strategy for product development is not limited to just domains, but includes a suite of Web3 products that are designed to enhance the utility and versatility of XRP Domains identities. These products will include web3-profiles, web3-mail, web3-shop, and more, all of which will provide additional value to users who hold and use XRP Domains identities. In addition to these products, we will provide tools and resources to help users create and manage XRP Domains identities.

Finally, our strategy for customer acquisition will focus on creating a secure and easy-to-use transaction for buying, selling, and transferring XRP domain names. We believe that by providing a seamless and user-friendly experience for users, we can attract a large and diverse user base of individuals and businesses. We plan to offer a variety of tools and resources to help buyers and sellers transact with each other, as well as promotional discounts and incentives on holidays and special events.

We are excited about the future of XRP Domains and are committed to building a platform that provides real value to its users. We believe that our comprehensive strategy for community building, product development, and customer acquisition will enable us to create a thriving XRP Domains ecosystem that benefits all users.

Thank you for your continued support and engagement with our community. We look forward to working with you to make our vision a reality.

Best regards!

*XRP Domains Team*


# Benefit

XRP Domains - where ownership meets innovation. Experience increased security, enhanced privacy, and complete control over your online identity.

1. **Increased security:** XRP Domains use blockchain technology to provide increased security and protection against fraud and hacking.
2. **Greater control:** With XRP Domains, you have complete control over your online identity, including the ability to transfer or sell your domain to others.
3. **Enhanced privacy:** XRP Domains can provide enhanced privacy, as users can maintain control over their online identity and data.
4. **No renewal fees:** XRP Domains do not require annual renewal fees, making them a more cost-effective option than other domain names.
5. **Unique digital identity:** XRP Domains can be used to create a unique digital identity that is tied to your XRP Ledger wallet address, providing a secure and reliable way to verify your online presence.
6. **Increased interoperability:** XRP Domains are designed to be interoperable with different blockchain networks and decentralized applications, making them a versatile tool for developers and businesses.
7. **Improved accessibility:** XRP Domains can be used by anyone, anywhere in the world, without the need for intermediaries or third-party registrars.
8. **Versatility:** XRP Domains can be used for a wide range of applications, from identity verification to payments and decentralized applications.
9. **Investment potential:** XRP Domains can be seen as an investment opportunity, as unique and valuable domain names can increase in value over time.
10. **Portability:** XRP Domains are portable, meaning you can easily transfer or sell your domain to others.


# Features

1. **Permanent ownership:** Once you register a XRP Domains, you own it permanently. This means you have complete control over your online presence and can use your domain name for as long as you want.
2. **Human-readable:** XRP Domains use human-readable names, making them easier to remember and share with others.
3. **Flexibility:** XRP Domains are highly customizable, with users able to choose their domain name and set up custom subdomains.
4. **Investment potential:** unique and valuable domain names can increase in value over time.
5. **XRPL Support:** XRP Domains are designed to work seamlessly with the XRP Ledger, making it easy to send and receive XRP.
6. **Community-driven:** XRP Domains are often supported by a community of users and developers, making them more resilient and sustainable.
7. **Non-censorable:** XRP Domains are resistant to censorship, as they cannot be taken down or blocked by a central authority.
8. **Multi-functional:** XRP Domains can be used for a variety of purposes, including hosting websites, creating payment gateways, and more.
9. **Marketing and branding:** XRP Domains can be used to create unique and memorable domain names that reflect a company's brand or message.
10. **Permissionless:** XRP Domains are permissionless, meaning anyone can register a domain without needing approval from a central authority.

#### Great Features

<figure><img src="/files/mlvymgIFkDZRkBhV9v4D" alt=""><figcaption></figcaption></figure>


# Roadmap

**Q1/2023**

* Join XDC Web3Domains LaunchPad Program.
* Join & Win at "XRPL Hackathon: NFT Launch Party".
* Build Community Program with Glaxe.com.
* Launch Testnet Program: Join to get early buy offer & discount.
* Launch Mainnet Program: Pre-Registration & Public Registration.
* Launch Web3 Profile: **xrp.best/profile/youraddress**.
* Applying to XRPL Grants Wave 5.
* List XRP Domains on makerplace.

**Q2/2023**

* Launch Web3 Profile V2: XRP Domains Holders will have a web3 profile like this: **yourname.xrp.best**.
* Launch SDK & API and documentation for integration.
* Launch (Twitter & Telegram) Bot: Alert new registrations & sales of XRP Domains.
* Launch Features: set nft avatar, social links, transfer domains, sub-domains.
* Launch Referral Program (Earn up to 50% of revenue).
* Integration with wallets, explorers, dapps and third party apps.

**Q3-4/2023**

* Community building: Discord, Telegram, Instagram etc.
* Launch Sub-Domains program: The main domain owner sets prices & sells sub-domains.
* Join the Web3 Domains Alliance: With many large domain name projects.
* Launch browser extension: Chrome, Firefox extension allows easy integration of your name with Web3 platform.
* Build Web3 dApps: web3 alert, web3 track3 etc.

**Q1-Q3/2024**

* Re-Design Website & Dashboard: xrpdomains.xyz.
* Launch Bridge XRP Domains between XRPL & Slidechain EVM.
* Launch Web3-Shop: Web3 store similar to Shopify for XRP Domains.
* Launch Web3-Mail: Decentralized Web3 email, Decentralized, Full control, Self-sovereign & Security.
* Launch DAO Program: The official launch of the XRP Domains DAO.
* Airdrop DAO Token for XRP Domains holders.

<figure><img src="/files/OeVvI2XxCzw7u6aqRNbe" alt=""><figcaption></figcaption></figure>


# Q\&A

**Q: What is an XRP Web3 Identity?**

A: XRP Domains is a type of domain name that is built on the XRP Ledger blockchain. It is used to create permanent, censorship-resistant websites and applications that are not subject to the control of any central authority.

**Q: How is an XRP Domains different from a traditional domain name?**

A: XRP Domains are different from a traditional domain name in that it is stored on the XRP Ledger permanently, making it resistant to censorship and ensuring that the owner has complete control over their online presence.

**Q: Can I buy/sell my XRP domains?**

A: Yes, you can sell your XRP Domains on a marketplace such as onXRP, XRP.cafe etc, just like any other digital asset.

**Q: Is my XRP Domains permanent?**

A: Yes, your XRP domains is stored on the XRP Ledger permanently, ensuring that it cannot be taken down or transferred without your permission.

**Q: How does an XRP Domains ensure privacy?**

A: XRP Domains ensure privacy by retaining full control over your online identity and personal data, free from any external authority.

**Q: Is it possible to change the content associated with my XPR Domains?**

A: Yes, you can update the content associated with your XRP Domains at any time

**Q: What is the cost of registering a XRP Domains?**

A: The cost of registering an XRP Domains is determined by the number of characters in the domain name, meaning that shorter domain names will cost more to register.

**Q: Can I use my XRP Domains to receive cryptocurrency payments?**

A: Yes, XRP Domains are designed to work seamlessly with cryptocurrency wallets and decentralized applications, making it easy to send and receive cryptocurrency payments.


# XRPL Hackathon: Winner

<figure><img src="/files/YqJ3zOd0VOumpElUyPVg" alt=""><figcaption></figcaption></figure>

[XRPL Hackathon: NFT Launch Party](https://xrplnft.devpost.com/)

**WINNER Honorable Mentions**

{% embed url="<https://devpost.com/software/xrp-web3-identity-xrp>" %}

{% embed url="<https://xrplnft.devpost.com/project-gallery>" %}

{% embed url="<https://twitter.com/RippleXDev/status/1616602006185021440>" %}

<figure><img src="/files/8ENzR04seMVdiEAvlZ3h" alt=""><figcaption></figcaption></figure>


# Technical

**The XRP Domains is designed to be compatible with the XLS-20 (NFT) storage standard on the XRP Ledger.**

### Domain Name Standard

All domain names must be normalized using a process called UTS-46 normalization. This ensures that uppercase and lowercase names are considered the same (**alice.xrp** = **ALICE.xrp = AliCe.xrp**), and also removes any spaces, white spaces, dots, and other invalid characters that are prohibited.

All domain names entered into the system must follow standardized naming conventions to ensure a consistent appearance for all users. This helps to prevent duplication and confusion between similar-looking names, and enhances security for our users.

The domain name is stored on the **XRP Ledger** with the mapping **NFTokenID** with **URI**. This **URI** will contain the domain name with the following structure:&#x20;

**https\://{host}/{sub-folder}/hello.xrp**

When resolving domain names, the XRP Domains system will parse this **URI** structure to ensure that the full domain name is obtained.

```
{
    "NFTokenID":"0008000043F7F087FD0F9CC7E2A1B173601FA4B35304904AB3E563A400000109",
    "URI":"68747470733A2F2F7872706E732D6D657461646174612D736572766963652E6865726F6B756170702E636F6D2F746573746E65742F68756C6C6F"
    //https://{host}/{sub-folder}/hello.xrp
}
```

```
const url = xrpl.convertHexToString(URI);
const obj = XRPIDjs.parseURI(url);
//domain object
obj.name// hello.xrp
obj.tld // .xrp
obj.sub // sub
obj.nameless // hello
```

The **URI** will also will also return metadata (domain information) as JSON, ensuring compatibility with marketplaces such as onXRP.com, xrp.cafe, and others. Please check the link below for more information.

{% embed url="<https://docs.xrpdomains.xyz/getting-started/metadata>" %}

### Domain Registration

When buyers register a domain, they will need to go through five steps as outlined below:

<figure><img src="/files/g9MR1a8eRIL4PrVGPuYO" alt=""><figcaption></figcaption></figure>

**Step 1:** When a buyer submits a **hello.xrp** registration request, it should be validated by checking naming standards first and then verifying if hello.xrp has an owner.

**Step 2:** The user must connect their Xumm wallet and confirm a single payment transaction to purchase **hello.xrp**. It is important to ensure that the wallet has sufficient balance and is connected to the correct network (mainnet).

**Step 3:** Once the payment is successfully confirmed on the **XRP Ledger**, the system will generate an order to reserve the **hello.xrp** for the buyer. The system will not mint **hello.xrp** directly. Instead, it will be added to a queue and minted only when the user completes the payment. When the payment is confirmed, the system will grant the user permission and create the **hello.xrp.**

**Step 4:** After the payment is confirmed, the system will mint the **hello.xrp** (which typically takes 1-2 minutes), in case there is an error, the buyer can check in the "**Domains Pending"** section on the dApp and proceed to complete the minting process for **hello.xrp.** The system will record the domain name to the **XRP Ledger** and map the **NFTokenID** to the corresponding **URI.** Check also: [**Domain name standards**](https://docs.xrpdomains.xyz/getting-started/technical#domain-name-standard)

**Step 5:** Once the minting process is complete, the system will send a request to the buyer's Xumm wallet The buyer must **Accept** this request to transfer the **hello.xrp** io their wallet and establish ownership. Alternatively, they can confirm the request later by checking the "**Incoming Domains**" section on the dApp.

### Domain Resolution&#x20;

Domain resolution involves the same first step as **Domain Registration**, where the validity of the domain is checked. Next, the SDKs & APIs will be utilized to query and retrieve information about the domain's owner, as well as other details such as social information and wallet addresses. [Read more](https://docs.xrpdomains.xyz/developer-guide/sdk)

### Domain Transfer

Domain transfer requires 2 steps as follows:

**Step 1:** The transferer will use the dApp to create an **NFTokenCreateOffer** command with the recipient's address set as the **Destination,** and set the Expiration to 10 days. The command will then be signed using the Xumm wallet. The transferor can also **cancel** this command by checking the "**Outgoing Domains**" section on the dApp.

**Step 2:** The recipient will see the transferred domain in the "**Incoming Domains**" section on the dApp.  You must click on "Accept" and sign the transaction using their Xumm wallet to complete the domain transfer process.

<figure><img src="/files/aHw0m0obp3H9DRm1n5hM" alt=""><figcaption></figcaption></figure>


# Metadata

### **Implementing token URI**

To retrieve out-of-string metadata, the system will query the domain name and return a **URI** where the metadata can be found.

```
const obj = await client.getNFTokenInfo(NFTokenID);
const uri = xrpl.convertHexToString(obj.data.URI);
```

### Metadata structure

XRP Domains supports structured metadata in the Opensea format.

```
{
    "id":"xrpdomains.xrp",
    "name":"xrpdomains.xrp",
    "symbol":"XRPID",
    "description":"XRP Web3 Identity - Building Identity on blockchain with .xrp domains - buy once use forever",
    "image":"",
    "external_url":"https://xrpdomains.xyz/",
    "createtime":"2022-12-12T20:43:29.9598674+01:00",
    "background_color":"",
    "attributes":[
        {"trait_type":"Background","value":""},
        {"trait_type":"Background Angle","value":200},
        {"trait_type":"Chain Name","value":"XRPL"},
        {"trait_type":"Top level domain","value":".xrp"},
        {"trait_type":"Length","value":9},
        {"trait_type":"Domain","value":"xrpdomain"},
        {"trait_type":"Sub Domain","value":""},
        {"trait_type":"Emoji","value":false}
    ]
}
```


# Tutorials


# User Guide for Registration

1. Go to [xrpdomains.xyz/app](https://xrpdomains.xyz/app) click "Connect Wallet". Get your Xumm wallet ready on Mobile.

<figure><img src="/files/BntsRyegspOd26NkGt9J" alt=""><figcaption></figcaption></figure>

2. QRCode scanning window will be popup, use your Xumm wallet to scan the QR code and wait for a moment to connect.

<figure><img src="/files/xfmJLjTwiREv3uizAJ7i" alt=""><figcaption></figcaption></figure>

3. In the search bar enter your desired .xrp name and it will show the status of blue as available and red as registered.

<img src="/files/USKdlKkNLG6UcAak93eH" alt="" data-size="original"><img src="/files/ADFooZSuPucm8RZoUzGB" alt="" data-size="original">

4. Please check the price in the "Price by number of characters" list. If you agree, please press the "Register Now" button and wait for the completion of three steps. You need to transfer the correct amount according to the price list. Smaller amount transfers will not be recognized by the system and considered as a contribution to us.

<figure><img src="/files/rHHtuPjTwp4lr6tI3Lsn" alt=""><figcaption></figcaption></figure>

**Payment:** The buyer must connect their Xumm wallet and confirm a single payment transaction to purchase **.xrp**. It is important to ensure that the wallet has sufficient balance and is connected to the correct network (mainnet).&#x20;

**Mint:** After the payment is confirmed, the system will mint the **.xrp** (which typically takes 1-2 minutes), in case there is an error, the buyer can check in the "**Domains Pending"** section on the dApp and proceed to complete the minting process for this.

**Transfer:** Once the minting process is complete, the system will send a request to the buyer's Xumm wallet. The buyer must **Accept** this request to transfer the **.xrp** io their wallet and establish ownership. Alternatively, they can confirm the request later by checking the "**Incoming Domains**" section on the dApp.

<figure><img src="/files/CyPTakvs4LHObuKK1kAQ" alt=""><figcaption></figcaption></figure>

**Video tutorial to register XRP Domains**

{% embed url="<https://www.youtube.com/watch?v=6uDEEZKyV8M>" %}


# User Guide for Transfer

Instructions on how to send a .xrp domain name to someone.

### **For the sender**

**Step 1:** Owners need to click the "**Send Domain**" button below the image of each .xrp domain name.

<figure><img src="/files/QuFA4iI4KdmCgoXosQZb" alt=""><figcaption></figcaption></figure>

**Step 2:** In the pop-up window, you need to enter the recipient's wallet address or the .xrp domain name and press the "**Transfer Now**" button, wait for a moment and sign the "**NFTokenCreateOffer**" transaction sent to your **Xumm** wallet.

<figure><img src="/files/A5l0hmhQzAoSWl8jZDFl" alt=""><figcaption></figcaption></figure>

**Step 3:** The sending domain will show up in the "**Outgoing Domains**" section, you need to notify the recipient to "**Accept**" it. You can also "**Cannel**" in case of confusion.

<figure><img src="/files/fKrQcyS2wRVtGETZ2Dd6" alt=""><figcaption></figcaption></figure>

### For the recipient

Go to <https://xrpdomains.xyz/app>, connect Xumm wallet. You will see the .xrp domain name in the "**Incoming Domains**" section. You need to press the "**Accept**" button and sign a transaction "**NFTokenAcceptOffer**" sent to your **Xumm** wallet.

<figure><img src="/files/ZJrqVSWMVEkuFSmLviS9" alt=""><figcaption></figcaption></figure>

Then you check the domain you just received is in the "**You have x domains**" section.&#x20;

Note: if the .xrp domain name is not received, please contact the sender to make sure the domain name has not expired, has not been canceled etc.


# Articles


# XRP Domains: Clarifying Community Concerns

The **Web3 domain** is still in its early phase, with multiple projects participating together, making it challenging for users to determine which domain project best fits their needs. As a result, our focus during this time is solely on building our product and community, and we do not wish to spend time explaining the superiority of our domain project. However, although we have already participated in two Twitter spaces and an AMA, our team continues to receive numerous inquiries from interested parties. Therefore, through this article, XRP Domains aims to provide greater clarity and insight into our project.

{% embed url="<https://docs.xrpdomains.xyz/overview/vision>" %}

XRP Domains is a project with a team consisting of experienced individuals from both Web2 and Web3. However, the team continuously learns from successful open-source Web3 domain projects such as ENS and Unstoppable Domains, which publicly disclose their technical information. In the same vein, the XRP Domains project also publicly discloses our technical information for other projects to reference.

Although several other xrp domain projects may exist, none of them have published technical documentation. Furthermore, they can only run on the Testnet after we publish our technical information.&#x20;

{% embed url="<https://docs.xrpdomains.xyz/getting-started/technical>" %}

{% embed url="<https://docs.xrpdomains.xyz/getting-started/metadata>" %}

Our project has a detailed roadmap, and we are following it closely.

{% embed url="<https://docs.xrpdomains.xyz/overview/roadmap>" %}

The XRP Domains project has already achieved recognition of Ripple Dev team by receiving the **Award of XRPL Hackathon**. This achievement is a first among domain name projects on XRPL. The Ripple Dev team has also tweeted about the prize, acknowledging our project's efforts. With us, XRP Domains is not only our project, but it is also a product of the XRPL platform and community. Therefore, XRP Domains will build our project not only for us but also for the reputation of the XRPL Community.

{% embed url="<https://docs.xrpdomains.xyz/overview/xrpl-hackathon-winner>" %}

{% embed url="<https://twitter.com/RippleXDev/status/1616602006185021440>" %}

One of the strengths of XRP Domains' project is our pricing policy, which maintains a one-time payment policy without requiring annual renewal fees. This means users will not have to pay additional fees to maintain their domain names. We believe that this is one of the strengths of Web3, and users should have the most optimal values when using web3 domains. To cover operating expenses, the team has prepared different business models, such as building applications using Web3 domains as the foundation. Since web3 domains are decentralized identities, we can create new business opportunities for everyone who has an identity on the blockchain.

To remain competitive in the dynamic landscape of Web3, XRP Domains focuses on innovation and constantly updates the domain features to keep up with the latest trends in the blockchain and domain name industries. We recognize that a domain alone will not hold much value if it's not integrated with third-party applications. That's why we will also have Web3-Profiles, Web3-Mail, Web3-Shop, and more, offering additional value to users who hold and use their domain.&#x20;

Finally, the XRP Domain acknowledges that multiple projects can offer the same domain name. This is a big concern for everyone and XRP Domains is trying to address it.

XRP Domain is a member of XDCDomains and XDCDomains has officially joined the **Web3 Domain Alliance** along with other domain name registrars. This alliance aims to protect our .xdc, xrp domains and also help spread Web3 domains to the community.

{% embed url="<https://twitter.com/xdcdomains/status/1628798929063247878?s=20>" %}

XRP Domains is dedicated to building a highly competitive blockchain domain project for the Web3 community. By prioritizing user experience, forging strong partnerships, driving innovation, ensuring security, and fostering community growth, XRP Domains is determined to deliver a domain that fully satisfies the requirements of the XRPL Community and earns your trust.

Best regards!

***XRP Domains Team***


# XRP Domains: Technical talk

As you know XRPL only supports XLS-20 (NFT) without smart contracts, so handling the system and extending it requires a huge challenge both in technology and coding. How to simplify for users while still complying with the criteria of decentralization.

Coming soon


# Marketplace

{% embed url="<https://nft.onxrp.com/collection/xrpdomains/>" %}

{% embed url="<https://xrp.cafe/collection/xrpdomains>" %}

{% embed url="<https://xmart.art/collections/raAyazbgEkwzLByXipQuPLWFfnsPS1v1q9/1680696246017/>" %}

{% embed url="<https://secretmarket.xyz/collection/xrpdomains>" %}


# Products

**XRPL Ecosystem Retweet**

Automatically collects the best tweets from the [#XRPL](https://twitter.com/search?q=%23XRPL\&src=hashtag_click) Ecosystem & Recommends it to the [#XRPLCommunity](https://twitter.com/search?q=%23XRPLCommunity\&src=hashtag_click).

Follow: <https://twitter.com/XRPLRetweet>

**Twitter XRP Domain Watch 🤖**

Follow: <https://twitter.com/xrpdomainbot>

**Telegram XRP Domain Watch 🤖**

{% embed url="<https://t.me/xrpdomainwatch>" %}

**.xrp FAM**

{% embed url="<https://xrp.best/fam>" %}


# Programs


# Referral Program

## What is .xrp referral program？

The .xrp referral program functions as a means of distributing rewards among members of the XRPL community. By sharing your referral link and having your friends or community members register a domain through it, you can earn up to 30% of their registration fees. The commission rate is determined by the number of people you refer.&#x20;

The referral rate is provided below:

<table><thead><tr><th width="181.33333333333334">Level</th><th width="297">Completed domain invitation</th><th>Commision Rate (%)</th></tr></thead><tbody><tr><td>Level 1</td><td>0 - 49 </td><td>10%</td></tr><tr><td>Level 2</td><td>50 - 99 </td><td>15%</td></tr><tr><td>Level 3</td><td>100 - 499</td><td>20%</td></tr><tr><td>Level 4</td><td>>= 500 </td><td>30%</td></tr></tbody></table>

Additionally, we have a unique referral program for projects, communities, and integration partners. If you are interested, please fill out the form linked below:

## Referral Program Rules

• A **"Primary Name**" must be set by the user before you can create a referral link or receive any commission from referrals.

• The .xrp domain wallet address of the inviter will receive a commission once the invitee completes the domain registration process.

• The number of the completed domain invitations made is permanently recorded on the domain and on the blockchain, regardless of any changes in ownership, transfer, or sale.

* **Example 1:** User A had previously owned hello.xrp with 500 completed domain invitations. User B then purchased the domain from the marketplace and set hello.xrp as their primary name. Consequently, User B is eligible to receive a 30% commission for every domain registration completed through their hello.xrp referral link.
* **Example 2:** User A had previously owned alice.xrp with 500 completed domain invitations. User B then purchased the domain from the marketplace but did **NOT** set alice.xrp as their primary name. As a result, User B is **NOT** entitled to receive a 30% commission for any domain registrations made via the alice.xrp referral link.

Commission = Commission rate \* Registration fees paid with $XRP.


# XRPL Name SDK


# XRPLID SDK

This is a beta version that will be continuously improved

## Installation

{% embed url="<https://www.npmjs.com/package/xrplidjs>" %}

Make sure to install the following packages before installing xrplidjs: xrpl and verify-xrpl-signature.

```
npm install xrpl verify-xrpl-signature
```

Install Package

```
npm install xrplidjs
```

**See the code below**

```
const xrplidjs = require('xrplidjs');

const config = 
{
	rpcUrl: "wss://xrplcluster.com/",
	Issuer: "raAyazbgEkwzLByXipQuPLWFfnsPS1v1q9",
		
}

async function main() {
	const sdk = xrplidjs.SDK(config);	
	
	// your xrp domain
	const domain = "xrpdomains.xrp";
	// your address
	const address = "rLhi87aSCyNW88tW4632yLiwinbghFZNue";
		
	// resolve name to get the address of the owner.
	const objOwner = await sdk.getAddress(domain);
	console.log(objOwner);
	
	//Reverse Resolve Names
	const objDomain = await sdk.getName(address);
	console.log(objDomain);
	
	//Get All Names
	const objAllDomains = await sdk.getAllNames(address);
	console.log(objAllDomains);
}

main();
```

Please contact **<info@xrpdomains.xyz>** if you have any questions about integration.


# XRPLID API

This is a beta version that will be continuously improved.

**We are also provides a free HTTP API to help any dApps to integrate the name-resolving and reverse-name-resolving service.**

### isOwner

<mark style="color:blue;">`GET`</mark> `https://app.xrpdomains.xyz/api/xrplnft/isOwner`

<https://app.xrpdomains.xyz/api/xrplnft/isOwner?address=rLhi87aSCyNW88tW4632yLiwinbghFZNue>

#### Query Parameters

| Name                                      | Type                               | Description |
| ----------------------------------------- | ---------------------------------- | ----------- |
| address<mark style="color:red;">\*</mark> | rLhi87aSCyNW88tW4632yLiwinbghFZNue |             |

{% tabs %}
{% tab title="200: OK " %}

```
{
    "status": true,
    "message": "Success",
    "data": true
}
```

{% endtab %}
{% endtabs %}

### Resolve Names

Resolve .xrp name to get the address of the owner.

<mark style="color:blue;">`GET`</mark> `https://app.xrpdomains.xyz/api/xrplnft/getAddress`

<https://app.xrpdomains.xyz/api/xrplnft/getAddress?domain=xrpdomains.xrp>

#### Query Parameters

| Name                                     | Type           | Description |
| ---------------------------------------- | -------------- | ----------- |
| domain<mark style="color:red;">\*</mark> | xrpdomains.xrp |             |

{% tabs %}
{% tab title="200: OK " %}

```
{
    "status": true,
    "message": "Success",
    "data": { 
        "owner": "rLhi87aSCyNW88tW4632yLiwinbghFZNue",
        "metadata": [
        ]
    }
}
```

{% endtab %}
{% endtabs %}

### Reverse Resolve Names

<mark style="color:blue;">`GET`</mark> `https://app.xrpdomains.xyz/api/xrplnft/getName`

<https://app.xrpdomains.xyz/api/xrplnft/getName?address=rLhi87aSCyNW88tW4632yLiwinbghFZNue>

#### Query Parameters

| Name                                      | Type                               | Description |
| ----------------------------------------- | ---------------------------------- | ----------- |
| address<mark style="color:red;">\*</mark> | rLhi87aSCyNW88tW4632yLiwinbghFZNue |             |

{% tabs %}
{% tab title="200: OK " %}

```
{
    status: true,
    message: "Success",
    data: "hello.xrp"
}
```

{% endtab %}
{% endtabs %}

### Get All Names

<mark style="color:blue;">`GET`</mark> `https://app.xrpdomains.xyz/api/xrplnft/getAllNames`

<https://app.xrpdomains.xyz/api/xrplnft/getAllNames?address=rLhi87aSCyNW88tW4632yLiwinbghFZNue>

#### Query Parameters

| Name                                      | Type                               | Description |
| ----------------------------------------- | ---------------------------------- | ----------- |
| address<mark style="color:red;">\*</mark> | rLhi87aSCyNW88tW4632yLiwinbghFZNue |             |

{% tabs %}
{% tab title="200: OK " %}

```
{
    status: true,
    message: "Success",
    data: ["xrpdomain.xrp","xrpdomains.xrp",]
}
```

{% endtab %}
{% endtabs %}

Please contact **<info@xrpdomains.xyz>** if you have any questions about integration.