This repository has been archived by the owner on Apr 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add structure and some content for RNS docs * feat: add regular and protected guides * fix: add auctioned * feat: add half of Trade page * feat: improve Overview and guides * feat: edit Trade topic * feat: add RNS x MM screenshots * feat: addressed docs feedback * feat: add screenshots to registration guides * feat: added screenshots * feat: improve writing * feat: add SVG for APps * feat: add FAQ * chore: remove 'decoupling tag * fix: math rendering * chore: update screenshot in Trade RNS names * chore: rewrite a sentence in regular RNS guide * chore: rewrite domain categories in Overview * feat: add information box linking to RNS dev docs * feat: add starting price to Auctioned and rewrite domain tiers * chore: add escape character * feat: add tier examples * chore: add escape character * chore: rename some screenshots * chore: typo in domain tier description * feat: improve description of domain tiers (from support KB) * feat: add section on renewal fees for protected domains * feat: move Buy RON under Basics * feat: feedback round * chore: rewrite non-verified biz * chore: update hyperlink name * chore: add border to view favorites * chore: rewrite renewal fee exemption for auctioned domains
- Loading branch information
1 parent
3991fb1
commit 8db4535
Showing
194 changed files
with
45,328 additions
and
681 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
title: Katana | ||
description: Swap tokens within the Ronin ecosystem. | ||
--- | ||
|
||
import katana from './assets/katana.png' | ||
|
||
Katana is a decentralized exchange (DEX) for trading tokens within the Ronin ecosystem. | ||
|
||
Key features: | ||
|
||
* Swap: Trade between pairs of ERC-20 tokens. | ||
* Pool: Provide liquidity for ERC-20 tokens and earn market-making fees as well as additional RON rewards. | ||
* Farm: Stake liquidity pool (LP) tokens to farm RON. | ||
* Analytics: Check your earned fees. | ||
|
||
Link: [https://katana.roninchain.com](https://katana.roninchain.com). | ||
|
||
<img src={katana} width={1200} /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Multisig Wallet | ||
description: Confirm transactions with multiple parties for increased security. | ||
--- | ||
|
||
import multisig from './assets/multisig.png' | ||
|
||
Ronin Multisig Wallet is a multi-signature (multi-sig) wallet powered by Gnosis Safe. A multi-sig wallet requires multiple keys to sign a transaction before it can be executed. For example, you can set up multiple devices, such as hardware wallets, software wallets, paper wallets, to confirm transactions. | ||
|
||
Link: [https://multisig.roninchain.com/](https://multisig.roninchain.com/) | ||
|
||
<img src={multisig} width={1200} /> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
--- | ||
description: Buy a high-demand RNS domain name at auction. | ||
slug: /apps/rns/register/auctioned | ||
title: Buy an RNS name at auction | ||
toc_min_heading_level: 2 | ||
toc_max_heading_level: 2 | ||
--- | ||
|
||
## Overview | ||
|
||
This guide shows how to buy a high-value `.ron` name at an auction. | ||
|
||
Sky Mavis holds domain auctions for unregistered RNS names that are likely to be highly sought-after, such as `adventure.ron` and `moonshard.ron`. | ||
|
||
To take part in a domain auction, participants place bids. If someone outbids you during the auction, your bid is immediately refunded, and you may place another bid. | ||
|
||
When the auction ends, the bidder with the highest bid wins. The winning bid is the price of the domain. | ||
|
||
The winner receives the domain and is exempt from paying the renewal fee for the first year. After winning the domain, the owner can extend its registration. | ||
|
||
In RNS, auctioned domains are listed as follows: | ||
|
||
* **Awaiting auction:** Domain name that's in the auctioned list but does not have a scheduled auction in the near future. | ||
* **Upcoming auction:** Domain name that doesn't have a starting price yet but has an announced auction date. | ||
* **Auctioning:** Domain name that's being auctioned and is open for bidding. If no one places a bid during the auction, the domain's status becomes **Awaiting auction** until another auction opens. | ||
|
||
### Renewal fee | ||
|
||
Following is the annual renewal fee for auctioned RNS names. | ||
|
||
| Name length | Renewal fee | | ||
|---|---| | ||
| 5+ characters | $5/year | | ||
| 4 characters | $100/year | | ||
| 3 characters | $300/year | | ||
|
||
### Starting price | ||
|
||
The starting price of an auctioned domain is calculated in RON. Internally, it's \$5 for five-character names and above, \$100 for four-character names, and \$300 for three-character names. Externally, RNS converts the USD value to RON using the RON [moving average](https://en.wikipedia.org/wiki/Moving_average) price for the last 7 days, by the time auction starts. | ||
|
||
## Before you start | ||
|
||
Before registering an auctioned domain, install [Ronin Wallet](https://wallet.roninchain.com) and create an account. | ||
|
||
## Register an auctioned domain | ||
|
||
1. Open the [RNS app](https://id.roninchain.com) and connect your Ronin Wallet. | ||
![connect-wallet](../../assets/auctioned/connect-wallet.png) | ||
1. Select the **Collections** page (1) and browse the available collections (2). | ||
![collections](../../assets/auctioned/collections.png) | ||
1. Select the domain you like from any collection to open the domain info page. | ||
![collection-details](../../assets/auctioned/collection-details.png) | ||
Alternatively, you can enter the domain name in the search field on the home page of the RNS app. | ||
![search](../../assets/auctioned/search.png) | ||
1. The info page displays the [starting price](#starting-price) of the domain (1), the current highest bidder (2), and the history of bids (3). | ||
![domain-info](../../assets/auctioned/domain-info.png) | ||
1. Click **Place a bid** to participate in the auction. | ||
:::info | ||
How much to bid is up to you, but there's a minimum markup of 10%. This means 10% of the starting price if you're the first bidder or 10% of the highest bid if you're not. For example, if the starting price is 5 RON, then your bid has to be least 5 RON + 10% of 5 RON = 5.5 RON. | ||
::: | ||
![place-bid](../../assets/auctioned/place-bid.png) | ||
1. Enter your bid amount (1) and click **Place a bid** (2) to make payment. | ||
![confirm-bid](../../assets/auctioned/confirm-bid.png) | ||
1. Your bid is now placed and locked until the auction ends. To keep track of your bid and the auction in general, download the Ronin Wallet app and enable notifications. | ||
![success](../../assets/auctioned/success.png) | ||
|
||
If you win the auction, your bid is transferred to the RNS registrar, and you become the owner of the domain name without having to pay the renewal fee for the first year. | ||
|
||
## Track your biddings | ||
|
||
To view your biddings and their status, go to **My account > My biddings**. If the bid is active, then you're the leading bidder. If you're outbid, you lose the auction and the bid is refunded. | ||
|
||
![biddings](../../assets/auctioned/biddings.png) | ||
|
||
## See also | ||
|
||
* [Manage your RNS names](./../../manage.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
description: Register a protected RNS domain name for your business. | ||
slug: /apps/rns/register/protected | ||
title: Register a protected RNS name | ||
toc_min_heading_level: 2 | ||
toc_max_heading_level: 2 | ||
--- | ||
|
||
## Overview | ||
|
||
This guide shows how to register a protected `.ron` domain name. | ||
|
||
Protected names are reserved for brands and businesses by Sky Mavis and cannot be purchased by anyone else. Sky Mavis provides direct support to prevent anyone from claiming or misusing your protected RNS name. Protected names are listed as **Protected** in the RNS app. | ||
|
||
:::caution | ||
As long as the owner doesn't sell or transfer their protected RNS name to another wallet, the name and its annual fee are protected. If the name is sold or transferred, it loses its *protected* status. | ||
::: | ||
|
||
### Renewal fee | ||
|
||
The annual renewal fees for protected RNS names are predetermined and are not affected by market fluctuations. | ||
|
||
## Before you start | ||
|
||
Before registering a protected domain, install [Ronin Wallet](https://wallet.roninchain.com) and create an account. | ||
|
||
## Register a protected domain | ||
|
||
### Verified business | ||
|
||
If you verified your business with Sky Mavis, then we have already reserved your RNS name and mapped it to your Ronin address. To claim the reserved name, follow the steps in this guide. For non-verified businesses, see the [next section](#non-verified-business). | ||
|
||
1. Open the [RNS app](https://id.roninchain.com). | ||
2. Connect the Ronin Wallet to which your domain name is mapped. | ||
![connect-wallet](../../assets/protected/connect-wallet.png) | ||
1. Search for your protected domain name, and then select it to open the domain info page. | ||
![search](../../assets/protected/search.png) | ||
1. The info page displays the renewal fee, domain tier, as well as other details. Click **Register now** to begin. The RNS registrar requires one transaction to register a protected name: a registration transaction. | ||
![register](../../assets/protected/register.png) | ||
1. Select the duration of your registration period in years (1). The renewal fee changes based on how many years you selected. The minimum duration for the registration is 1 year. Notice that the name is set as primary by default (2), which means that it's displayed as your RNS name in all RNS-enabled apps and wallets. | ||
![review](../../assets/protected/review.png) | ||
1. Click **Confirm** and pay the renewal fee to register the domain. | ||
![confirm](../../assets/protected/confirm.png) | ||
1. After the registration transaction is complete, your RNS domain name is successfully registered. | ||
![success](../../assets/protected/success.png) | ||
|
||
You can now see your unique RNS name everywhere across the Ronin ecosystem. To view and manage your RNS names, click **Go to My Domains**. | ||
|
||
### Non-verified business | ||
|
||
To verify your business for a protected name registration, send an email to [info@skymavis.com](mailto:info@skymavis.com) and we'll guide you through the process. | ||
|
||
## See also | ||
|
||
* [Manage your RNS names](./../../manage.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
description: Register a regular RNS domain name. | ||
slug: /apps/rns/register/regular | ||
title: Register a regular RNS name | ||
toc_min_heading_level: 2 | ||
toc_max_heading_level: 2 | ||
--- | ||
|
||
## Overview | ||
|
||
This guide shows how to register a new `.ron` domain name for your Ronin address. | ||
|
||
In Ronin Name Service (RNS), regular names are available on a first-come, first-served basis with an annual renewal fee that depends on the domain name's length. Regular names are listed as **Available**. | ||
|
||
### Renewal fee | ||
|
||
Following is the annual renewal fee for regular RNS names. | ||
|
||
| Name length | Renewal fee | | ||
|---|---| | ||
| 5+ characters | $5/year | | ||
| 4 characters | $100/year | | ||
| 3 characters | $300/year | | ||
|
||
### Naming guidelines | ||
|
||
Following are the guidelines to be observed when choosing an RNS name: | ||
|
||
* Domains can contain the English-language letters a-z, and the digits 0-9. | ||
* Hyphens can also be used but not at the beginning and at the end of a domain name. Two hyphens together aren't permitted either. | ||
* The minimum length is three characters. | ||
* Domain names are case-sensitive and can only contain lowercase letters. | ||
|
||
## Before you start | ||
|
||
Before registering a regular domain, install [Ronin Wallet](https://wallet.roninchain.com) and create an account. | ||
|
||
## Register a regular domain | ||
|
||
1. Open the [RNS app](https://id.roninchain.com) and connect your Ronin Wallet. | ||
![connect-wallet](../../assets/regular/connect-wallet.png) | ||
1. Search for the domain you want to register, and then select it to open the domain info page. | ||
![search](../../assets/regular/search.png) | ||
1. The info page displays the renewal fee, domain tier, as well as other details. Click **Register now** to begin. The RNS registrar requires two transactions to register a regular name: *request transaction* and *registration transaction*. | ||
![domain-info](../../assets/regular/domain-info.png) | ||
1. At the request transaction, select the duration of your registration period in years (1). | ||
:::tip | ||
We recommend registering your RNS name for multiple years to avoid losing the domain to someone else. | ||
::: | ||
The renewal fee changes based on how many years you want to register the domain for. The minimum duration for the registration is 1 year. **Note:** This name is *set as primary* by default (2), which means that it's displayed as your RNS name in all the RNS-enabled apps and wallets. | ||
![register](../../assets/regular/register.png) | ||
1. Click **Request** to prompt the request transaction. | ||
![request](../../assets/regular/request.png) | ||
Wait for a few seconds to get your request confirmed. As soon as it's confirmed, your domain is ready to be registered. | ||
![wait](../../assets/regular/wait.png) | ||
1. Click **Confirm** to register the domain. | ||
![confirm](../../assets/regular/confirm.png) | ||
1. At the registration transaction, click **Confirm** to pay the renewal fee. | ||
![transact](../../assets/regular/transact.png) | ||
1. After the registration transaction is complete, your RNS domain name is successfully registered. | ||
![success](../../assets/regular/success.png) | ||
|
||
You can now see your unique RNS name everywhere across the Ronin ecosystem. To view and manage your RNS names, click **Go to My Domains**. | ||
|
||
## See also | ||
|
||
* [Manage your RNS names](./../../manage.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
--- | ||
description: Manage the RNS names that you own. | ||
slug: /apps/rns/manage | ||
title: Manage RNS names | ||
--- | ||
|
||
## Overview | ||
|
||
After you registered your RNS name, managing it is easy. In your account, select the **My domains** tab to access and edit all your registered domain names. | ||
|
||
![my-domains](assets/manage/my-domains.png) | ||
|
||
Click **Manage** on a domain to open its management page. From there, you can set this domain as primary and renew its registration. | ||
|
||
![manage-domain](assets/manage/manage-domain.png) | ||
|
||
## Manage your primary name | ||
|
||
Your Ronin address can serve as the owner for one or multiple RNS names. You can use one of these domains as your *primary* name. A primary name is the one that shows up across RNS-enabled apps and wallets wherever your Ronin address is usually displayed. You can have only one primary name at a time, but you can change it whenever you want. | ||
|
||
### Set a primary name | ||
|
||
After you just bought your first RNS domain name, follow these steps to set it as primary. | ||
|
||
1. Go to **My domains** and click **Select primary name** at the top. | ||
![first-primary](assets/manage/first-primary.png) | ||
1. Select the domain you want to set as primary. | ||
![first-select](assets/manage/first-select.png) | ||
1. Click **Confirm**. | ||
![first-confirm](assets/manage/confirm-primary.png) | ||
1. Sign the transaction. After that, this name is successfully set as primary. | ||
![success](assets/manage/success-set-as-primary.png) | ||
|
||
:::info | ||
You can also set a domain name as primary during the [registration](./guides/register/regular.md). | ||
::: | ||
|
||
### Change a primary name | ||
|
||
If you have more than one RNS domain, follow these steps to set a different domain as primary. | ||
|
||
1. On the **My domains** tab, select the domain name that you want to set as primary, and then click **Manage** to open the domain management page. | ||
![select-domain](assets/manage/select-domain.png) | ||
1. Click **Set as primary**. | ||
![set-as-primary](assets/manage/set-as-primary.png) | ||
1. Click **Confirm**. | ||
![confirm-primary](assets/manage/confirm-primary.png) | ||
1. Sign the transaction. After that, this name is successfully set as primary. | ||
![success](assets/manage/success-set-as-primary.png) | ||
|
||
### Remove a primary name | ||
|
||
To remove your primary name, select the domain and click **Remove**. After you remove the name, RNS starts to display your Ronin address instead until you set another domain as primary. Any transactions sent to your previous primary name will resolve to the owner of the name at that time. | ||
|
||
![remove](assets/manage/remove-primary.png) | ||
|
||
## Renew your domain | ||
|
||
### Grace period | ||
|
||
You can renew your domain's registration at any time during the existing registration and within 90 days after it expires, also known as the *grace period*. During the grace period, the domain name is reserved only for its previous owner to renew it, and it can't be set as primary. | ||
|
||
After the grace period, the domain name becomes available for anyone to register. The domain may still appear in your domain list, but you are no longer the owner. However, you can buy the domain back at any time. | ||
|
||
### Renew a regular or protected name | ||
|
||
:::tip | ||
To quickly renew your primary name, go to your account, then **My domains > Extend**. | ||
![extend-primary](assets/manage/extend-primary.png) | ||
::: | ||
|
||
1. On the **My domains** tab, locate the domain name that you want to renew, and then click **Extend**. | ||
![find-extend-regular](assets/manage/find-extend-regular.png) | ||
1. Select the number of years of registration you want to purchase (1). Review the total amount payable, which includes only the renewal fee times the requested number of years. Click **Extend** to confirm the renewal (2). | ||
![extend-regular](assets/manage/extend-regular.png) | ||
1. Sign the transaction to make payment. Your RNS name registration is successfully renewed. | ||
![success-extend](assets/manage/success-extend.png) | ||
|
||
### Renew an auctioned name | ||
|
||
1. On the **My domains** tab, locate the auctioned domain name that you want to renew, and then click **Extend**.. | ||
![find-extend-auctioned](assets/manage/find-extend-auctioned.png) | ||
1. Select the number of years of registration you want to purchase. You can renew an auctioned domain for up to 3 years at a time, depending on the current expiration date. For example, if you just won the domain at an auction, it comes with a 1-year registration. You can immediately renew this domain for another 2 years, for the total of 3 years. | ||
![extend-auctioned-duration](assets/manage/extend-auctioned-duration.png) | ||
1. Review the total amount payable, which includes the following: | ||
* Renewal fee times the requested number of years. | ||
* Reservation fee of 15% of the current domain price. If the domain you're renewing has a valid offer on Mavis Market with a higher price, then the reservation fee is derived from the higher price. A valid offer is the one where the buyer is proven to have the sufficient balance in their wallet. The price is calculated in USD. | ||
![extend-auctioned-fees](assets/manage/extend-auctioned-fees.png) | ||
1. Click **Extend** to confirm the renewal. | ||
![confirm-auctioned-extension](assets/manage/confirm-extend-auctioned.png) | ||
1. Sign the transaction to make payment. Your RNS name registration is successfully renewed. | ||
![success-extend](assets/manage/success-extend.png) | ||
|
||
## View your favorite domains | ||
|
||
You can add any RNS name to favorites to keep track of its status, for example. To view all your favorite domains, go to the **Favourites** tab. | ||
![favorites](assets/manage/favorites.png) | ||
|
||
## See also | ||
|
||
* [Trade RNS names](./trade.md) |
Oops, something went wrong.
8db4535
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
ronin-document – ./
ronin-document-git-main-skymavis.vercel.app
ronin-document-skymavis.vercel.app
docs.roninchain.com
saigon-docs.roninchain.com