From 07c4a497c66de11c79a5a38c503ed1f7a7949469 Mon Sep 17 00:00:00 2001
From: Marcin Rataj <lidel@lidel.org>
Date: Wed, 26 Aug 2020 22:02:39 +0200
Subject: [PATCH] feat: provide cidv1 in base36 when needed

This adds Base36 version  of CIDv1 if it fits inside of a single DNS
label. Follows convention introduced in:
https://github.com/ipfs/go-ipfs/pull/7441
---
 index.html | 12 ++++++++++--
 index.js   | 22 +++++++++++++++++++++-
 2 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/index.html b/index.html
index 675be00..de44e74 100644
--- a/index.html
+++ b/index.html
@@ -70,12 +70,20 @@ <h1 class='f3 fw2 montserrat aqua ttu'>CID Inspector</h1>
       <div class='f5 sans-serif ma0 fw4 pt2'id="multihash"></div>
     </div>
     <div class='pt4'>
+      <label class='dib'>
+        <a class='db pb1 w-100 tracked ttu f6 teal-muted hover-aqua link' href="https://docs.ipfs.io/concepts/content-addressing/#version-1-v1">
+          CIDv1 (Base32)
+        </a>
+      </label>
+      <div class='f5 monospace ma0 fw4 pt2' id="base32cidv1"></div>
+    </div>
+    <div class='pt4' id='dns'>
       <label class='dib'>
         <a class='db pb1 w-100 tracked ttu f6 teal-muted hover-aqua link' href="https://docs.ipfs.io/how-to/address-ipfs-on-web/#subdomain-gateway">
-          Base32 CIDv1
+          CIDv1 (Base36, optimized for Subdomains)
         </a>
       </label>
-      <div class='f5 sans-serif ma0 fw4 pt2'id="base32cidv1"></div>
+      <div class='f5 monospace ma0 fw4 pt2' id="dnscidv1"></div>
     </div>
   </section>
   <footer class='mt2 pv2 ph2 ph3-l bt b--light-gray'>
diff --git a/index.js b/index.js
index 5c40d23..929bc75 100644
--- a/index.js
+++ b/index.js
@@ -4,6 +4,9 @@ const multihash = require('multihashes')
 const multibaseConstants = require('multibase/src/constants')
 const mutlicodecVarintTable = require('multicodec/src/varint-table')
 
+// Label's max length in DNS (https://tools.ietf.org/html/rfc1034#page-7)
+const dnsLabelMaxLength = 63
+
 // cidv0 ::= <multihash-content-address>
 // QmRds34t1KFiatDY6yJFj8U9VPTLvSMsR63y7qdUV3RMmT
 // <cidv1> ::= <multibase-prefix><cid-version><multicodec-content-type><multihash-content-address>
@@ -39,6 +42,15 @@ function toBase32(value) {
   return cid.toV1().toBaseEncodedString('base32')
 }
 
+function toDNSPrefix(value) {
+  const cid = new CID(value)
+  const cidb32 = cid.toV1().toBaseEncodedString('base32')
+  if (cidb32.length <= dnsLabelMaxLength) return cidb32
+  const cidb36 = cid.toV1().toBaseEncodedString('base36')
+  if (cidb36.length <= dnsLabelMaxLength) return cidb36
+  return 'CID incompatible with DNS label length limit of 63'
+}
+
 function decodeCidV1 (value, cid) {
   return {
     cid,
@@ -58,6 +70,8 @@ document.addEventListener('DOMContentLoaded', () => {
   const multicodecOutput = document.querySelector('#multicodec')
   const multibaseOutput = document.querySelector('#multibase')
   const base32CidV1Output = document.querySelector('#base32cidv1')
+  const dns = document.querySelector('#dns')
+  const dnsCidV1Output = document.querySelector('#dnscidv1')
   const humanReadableCidOutput = document.querySelector('#hr-cid')
   const errorOutput = document.querySelector('#input-error')
 
@@ -76,7 +90,13 @@ document.addEventListener('DOMContentLoaded', () => {
       multibaseOutput.innerHTML = toDefinitionList({code: data.multibase.code, name: data.multibase.name})
       multicodecOutput.innerHTML = toDefinitionList({code: data.multicodec.code, name: data.multicodec.name})
       multihashOutput.innerHTML = toDefinitionList({code: data.multihash.code, name: data.multihash.name, bits: data.multihash.length * 8})
-      base32CidV1Output.innerHTML = toBase32(value.trim())
+
+      const cidb32 = toBase32(value.trim())
+      base32CidV1Output.innerHTML = cidb32
+      const dnsPrefix = toDNSPrefix(value.trim())
+      dns.style.visibility = cidb32 !== dnsPrefix ? 'visible' : 'hidden'
+      dnsCidV1Output.innerHTML = dnsPrefix
+
       clearErrorOutput()
     } catch (err) {
       if (!value) {