Clarified comments regarding create and setOwner (#84)

rnsdomains · May 18, 2020 · 542c4ff · 542c4ff
1 parent f2db185
commit 542c4ff
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/src/subdomains.ts b/src/subdomains.ts
@@ -97,7 +97,7 @@ export default class extends Composer implements Subdomains {
   }
 
   /**
-   * Creates a new subdomain under the given domain tree if not exists.
+   * Sets a subdomain owner. If the subdomain exists, sets the new owner, if not, creates the subdomain and sets the owner.
    *
    * @throws SEARCH_DOMAINS_UNDER_AVAILABLE_TLDS if the given domain is not a domain under valid TLDs - KB009
    * @throws INVALID_DOMAIN if the given domain is empty, is not alphanumeric or if has uppercase characters - KB010
@@ -133,8 +133,8 @@ export default class extends Composer implements Subdomains {
   }
 
   /**
-   * Creates a new subdomain under the given domain tree and sets addr if provided
-   *
+   * Creates a new subdomain under the given domain tree if it is available, and sets its resolution if addr is provided.
+   * It could send one, two or three transactions based on the value of the sent parameters.
    *
    * @throws SEARCH_DOMAINS_UNDER_AVAILABLE_TLDS if the given domain is not a domain under valid TLDs - KB009
    * @throws INVALID_DOMAIN if the given domain is empty, is not alphanumeric or if has uppercase characters - KB010

diff --git a/src/types/subdomains.ts b/src/types/subdomains.ts
@@ -16,7 +16,7 @@ export interface Subdomains {
   available(domain: string, label: string): Promise<boolean>;
 
   /**
-   * Creates a new subdomain under the given domain tree
+   * Sets a subdomain owner. If the subdomain exists, sets the new owner, if not, creates the subdomain and sets the owner.
    *
    * @param domain - Parent .rsk domain. ie: wallet.rsk
    * @param label - Subdomain to register. ie: alice
@@ -25,7 +25,8 @@ export interface Subdomains {
   setOwner(domain: string, label: string, owner: string): Promise<TransactionReceipt>;
 
   /**
-   * Creates a new subdomain under the given domain tree and sets addr if provided
+   * Creates a new subdomain under the given domain tree if it is available, and sets its resolution if addr is provided.
+   * It could send one, two or three transactions based on the value of the sent parameters.
    *
    * @param domain - Parent .rsk domain. ie: wallet.rsk
    * @param label - Subdomain to register. ie: alice