From 7366c6d280a9dfdc41da13cb21d9b35037e848b2 Mon Sep 17 00:00:00 2001
From: JesseAbram <33698952+JesseAbram@users.noreply.github.com>
Date: Sun, 14 Jul 2019 04:48:27 -0400
Subject: [PATCH] added check if valid address to docs (#440)

* added check if valid address to docs

* Update package.json
---
 .../keyring/03_validate_address/README.md      |  5 +++++
 .../keyring/03_validate_address/index.js       | 16 ++++++++++++++++
 .../keyring/03_validate_address/package.json   | 18 ++++++++++++++++++
 3 files changed, 39 insertions(+)
 create mode 100644 docs/examples/keyring/03_validate_address/README.md
 create mode 100644 docs/examples/keyring/03_validate_address/index.js
 create mode 100644 docs/examples/keyring/03_validate_address/package.json

diff --git a/docs/examples/keyring/03_validate_address/README.md b/docs/examples/keyring/03_validate_address/README.md
new file mode 100644
index 000000000..91e181b34
--- /dev/null
+++ b/docs/examples/keyring/03_validate_address/README.md
@@ -0,0 +1,5 @@
+# Validate Adress
+
+- This function will return true if the address is a legitamate Polkadot address and false if it is not
+
+- Works both with Ed25519 and Sr25519 key types
diff --git a/docs/examples/keyring/03_validate_address/index.js b/docs/examples/keyring/03_validate_address/index.js
new file mode 100644
index 000000000..7473f7384
--- /dev/null
+++ b/docs/examples/keyring/03_validate_address/index.js
@@ -0,0 +1,16 @@
+const { encodeAddress, decodeAddress } = require('@polkadot/keyring');
+const { isHex, hexToU8a } = require('@polkadot/util');
+
+const address = '5GrpknVvGGrGH3EFuURXeMrWHvbpj3VfER1oX5jFtuGbfzCE';
+
+const isValidAddressPolkadotAddress = () => {
+  try {
+    encodeAddress(isHex(address) ? hexToU8a(address) : decodeAddress(address));
+    return true;
+  } catch (error) {
+    return false;
+  }
+};
+
+const isValid = isValidAddressPolkadotAddress();
+console.log(isValid);
diff --git a/docs/examples/keyring/03_validate_address/package.json b/docs/examples/keyring/03_validate_address/package.json
new file mode 100644
index 000000000..17f075f74
--- /dev/null
+++ b/docs/examples/keyring/03_validate_address/package.json
@@ -0,0 +1,18 @@
+{
+  "name": "03_validate_address",
+  "version": "0.1.0",
+  "description": "Example showing how to validate a polkadot address",
+  "main": "index.js",
+  "author": "Jesse",
+  "license": "MIT",
+  "scripts": {
+    "clean": "rimraf node_modules",
+    "start": "node index.js"
+  },
+  "dependencies": {
+    "@polkadot/keyring": "*"
+  },
+  "devDependencies": {
+    "rimraf": "^2.6.2"
+  }
+}