Add the checkAddress method

owenvoke · Nov 5, 2018 · 610ffbf · 610ffbf
1 parent 6f35ec4
commit 610ffbf
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/src/Arionum.js b/src/Arionum.js
@@ -233,6 +233,9 @@ class Arionum {
   /**
    * Check that a signature is valid against a public key.
    *
+   * @param {string} signature
+   * @param {string} data
+   * @param {string} publicKey
    * @return Promise
    */
   checkSignature (signature, data, publicKey) {
@@ -301,6 +304,23 @@ class Arionum {
       })
   }
 
+  /**
+   * Check that an address is valid.
+   * Optionally validate it against the corresponding public key.
+   *
+   * @param {string} address
+   * @param {string|null} publicKey
+   * @return Promise
+   */
+  checkAddress (address, publicKey = null) {
+    return this
+      .getJson({
+        q: 'checkAddress',
+        account: address,
+        public_key: publicKey
+      })
+  }
+
   /**
    * @returns void
    */