Merge pull request #277 from EdgeApp/sam/ren-bridge-uri

thehobbit85 · web-flow · commit 01b04c62531a · 2022-01-20T16:36:30.000-08:00
Add support for Ren Bridge URIs
diff --git a/src/common/plugin/makeCurrencyTools.ts b/src/common/plugin/makeCurrencyTools.ts
@@ -5,9 +5,7 @@ import {
   EdgeCurrencyTools,
   EdgeEncodeUri,
   EdgeIo,
-  EdgeMetadata,
   EdgeMetaToken,
-  EdgeParsedUri,
   EdgeWalletInfo,
   JsonObject
 } from 'edge-core-js/types'
@@ -20,7 +18,7 @@ import {
   asPrivateKey,
   PrivateKey
 } from '../utxobased/keymanager/cleaners'
-import { EncodeUriMetadata, PluginInfo } from './types'
+import { EncodeUriMetadata, ExtendedParseUri, PluginInfo } from './types'
 import { getFormatsForNetwork } from './utils'
 
 /**
@@ -59,7 +57,12 @@ export function makeCurrencyTools(
       return numbWalletInfo.keys.publicKey
     },
 
-    async parseUri(uri: string): Promise<EdgeParsedUri> {
+    async parseUri(uri: string): Promise<ExtendedParseUri> {
+      const isGateway = uri
+        .toLocaleLowerCase()
+        .startsWith(`${coinInfo.name}://`)
+      if (isGateway) uri = uri.replace('//', '')
+
       const uriObj = urlParse(uri, {}, true)
       const protocol = uriObj.protocol.replace(':', '').toLowerCase()
 
@@ -79,7 +82,7 @@ export function makeCurrencyTools(
       if (pathname === '' && query.r == null) throw new Error('InvalidUriError')
 
       // Create the returned object
-      const parsedUri: EdgeParsedUri = {}
+      const parsedUri: ExtendedParseUri = {}
       // Parse the pathname and add it to the result object
       if (pathname !== '') {
         const parsedPath = parsePathname({
@@ -92,11 +95,12 @@ export function makeCurrencyTools(
       }
 
       // Assign the query params to the parsedUri object
-      const metadata: EdgeMetadata = {}
+      const metadata: ExtendedParseUri['metadata'] = {}
       if (query.label != null) metadata.name = query.label
       if (query.message != null) metadata.notes = query.message
       if (query.category != null) metadata.category = query.category
       if (query.r != null) parsedUri.paymentProtocolUrl = query.r
+      if (isGateway) metadata.gateway = true
       Object.assign(parsedUri, { metadata })
 
       // Get amount in native denomination if exists
diff --git a/src/common/plugin/types.ts b/src/common/plugin/types.ts
@@ -6,6 +6,7 @@ import {
   EdgeCurrencyInfo,
   EdgeCurrencyTools,
   EdgeIo,
+  EdgeParsedUri,
   EdgeWalletInfo
 } from 'edge-core-js/types'
 
@@ -115,10 +116,17 @@ interface Bip32 {
   private: number
 }
 
+export interface ExtendedParseUri extends EdgeParsedUri {
+  metadata?: EdgeParsedUri['metadata'] & {
+    gateway?: boolean
+  }
+}
+
 export interface EncodeUriMetadata {
   metadata?: {
     name?: string
     notes?: string
+    gateway?: boolean
   }
 }
 
diff --git a/src/common/utxobased/engine/utils.ts b/src/common/utxobased/engine/utils.ts
@@ -10,10 +10,9 @@ import {
   AddressTypeEnum,
   bip43PurposeNumberToTypeEnum,
   BIP43PurposeTypeEnum,
-  getAddressTypeFromAddress,
-  scriptPubkeyToAddress,
   ScriptTypeEnum,
   seedOrMnemonicToXPriv,
+  toNewFormat,
   verifyAddress,
   VerifyAddressEnum,
   wifToPrivateKey,
@@ -208,27 +207,16 @@ export const parsePathname = (args: {
       coin: args.coin
     })
 
-    switch (addressFormat) {
-      case VerifyAddressEnum.good:
-        edgeParsedUri.publicAddress = args.pathname
-        break
-      case VerifyAddressEnum.legacy: {
-        edgeParsedUri.legacyAddress = args.pathname
-        // Get the non-legacy address (publicAddress)
-        const addressType = getAddressTypeFromAddress(args.pathname, args.coin)
-        edgeParsedUri.publicAddress = scriptPubkeyToAddress({
-          scriptPubkey: addressToScriptPubkey({
-            address: args.pathname,
-            coin: args.coin
-          }),
-          addressType,
-          coin: args.coin
-        }).address
-        break
-      }
-      case VerifyAddressEnum.bad:
-        throw new Error('InvalidPublicAddressError')
-    }
+    // Throw if address format failed
+    if (addressFormat === VerifyAddressEnum.bad)
+      throw new Error('InvalidPublicAddressError')
+
+    // Format publicAddress to the latest format from the provided address
+    edgeParsedUri.publicAddress = toNewFormat(args.pathname, args.coin)
+
+    // Include a legacyAddress if the provided format is a legacy format
+    if (addressFormat === VerifyAddressEnum.legacy)
+      edgeParsedUri.legacyAddress = args.pathname
   }
 
   return edgeParsedUri
diff --git a/src/common/utxobased/keymanager/keymanager.ts b/src/common/utxobased/keymanager/keymanager.ts
@@ -728,6 +728,18 @@ export function pubkeyToScriptPubkey(
   }
 }
 
+export const toNewFormat = (address: string, coinName: string): string => {
+  const addressType = getAddressTypeFromAddress(address, coinName)
+  return scriptPubkeyToAddress({
+    scriptPubkey: addressToScriptPubkey({
+      address: address,
+      coin: coinName
+    }),
+    addressType,
+    coin: coinName
+  }).address
+}
+
 const xprivToPrivateKeyInternal = (
   prefixIndex: number,
   args: XPrivToPrivateKeyArgs
diff --git a/test/common/plugin/currencyPlugin.fixtures/common.ts b/test/common/plugin/currencyPlugin.fixtures/common.ts
@@ -1,10 +1,9 @@
-import {
-  EdgeEncodeUri,
-  EdgeParsedUri,
-  EdgeWalletInfo
-} from 'edge-core-js/types'
+import { EdgeEncodeUri, EdgeWalletInfo } from 'edge-core-js/types'
 
-import { EncodeUriMetadata } from '../../../../src/common/plugin/types'
+import {
+  EncodeUriMetadata,
+  ExtendedParseUri
+} from '../../../../src/common/plugin/types'
 
 export interface FixtureType {
   pluginId: string
@@ -16,7 +15,7 @@ export interface FixtureType {
   'invalid key name': EdgeWalletInfo
   'invalid wallet type': EdgeWalletInfo
   parseUri: {
-    [testName: string]: [string, EdgeParsedUri] | [string]
+    [testName: string]: [string, ExtendedParseUri] | [string]
   }
   encodeUri: {
     [testName: string]:
diff --git a/test/common/plugin/currencyPlugin.fixtures/currencies/bitcoin.ts b/test/common/plugin/currencyPlugin.fixtures/currencies/bitcoin.ts
@@ -55,6 +55,65 @@ export const bitcoin: FixtureType = {
         metadata: {}
       }
     ],
+    'Ren Bridge p2wpkhp2sh Gateway address': [
+      'bitcoin://3Lx24A66XeL1HtegyNoku77qvNBCbEqePj',
+      {
+        publicAddress: '3Lx24A66XeL1HtegyNoku77qvNBCbEqePj',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge p2pkh Gateway address': [
+      'bitcoin://1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
+      {
+        publicAddress: '1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge p2wpkhp2sh Gateway address mixed caps': [
+      'bitCoin://3Lx24A66XeL1HtegyNoku77qvNBCbEqePj',
+      {
+        publicAddress: '3Lx24A66XeL1HtegyNoku77qvNBCbEqePj',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge p2pkh Gateway address mixed caps': [
+      'Bitcoin://1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
+      {
+        publicAddress: '1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge p2pkh Gateway address with amount, label & message': [
+      'bitcoin://1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX?amount=1234.56789&label=Johnny%20Bitcoin&message=Hello%20World,%20I%20miss%20you%20!',
+      {
+        publicAddress: '1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX',
+        metadata: {
+          name: 'Johnny Bitcoin',
+          notes: 'Hello World, I miss you !',
+          gateway: true
+        },
+        nativeAmount: '123456789000',
+        currencyCode: 'BTC'
+      }
+    ],
+    'Ren Bridge bech32 Gateway address': [
+      'bitcoin://bc1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qccfmv3',
+      {
+        publicAddress:
+          'bc1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qccfmv3',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
     'uri address with amount': [
       'bitcoin:1F1tAaz5x1HUXrCNLbtMDqcw6o5GNn4xqX?amount=12345.6789',
       {
diff --git a/test/common/plugin/currencyPlugin.fixtures/currencies/bitcoincash.ts b/test/common/plugin/currencyPlugin.fixtures/currencies/bitcoincash.ts
@@ -43,6 +43,75 @@ export const bitcoincash: FixtureType = {
         metadata: {}
       }
     ],
+    'Ren Bridge Legacy Gateway address': [
+      'bitcoincash://1BpEi6DfDAUFd7GtittLSdBeYJvcoaVggu',
+      {
+        publicAddress: 'qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a',
+        legacyAddress: '1BpEi6DfDAUFd7GtittLSdBeYJvcoaVggu',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge Legacy Gateway address mixed caps': [
+      'bitCoinCash://1BpEi6DfDAUFd7GtittLSdBeYJvcoaVggu',
+      {
+        publicAddress: 'qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a',
+        legacyAddress: '1BpEi6DfDAUFd7GtittLSdBeYJvcoaVggu',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge new Gateway address': [
+      'bitcoincash://qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a',
+      {
+        publicAddress: 'qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge mixed caps Gateway address with address prefix': [
+      'bitcoinCash://bitcoincash:pzyt5lcqp4u4wcwpwl8f8eq0hzpdnntzuy2h3nnalf',
+      {
+        publicAddress: 'pzyt5lcqp4u4wcwpwl8f8eq0hzpdnntzuy2h3nnalf',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge mixed caps Gateway address w/o address prefix': [
+      'bitcoinCash://pzyt5lcqp4u4wcwpwl8f8eq0hzpdnntzuy2h3nnalf',
+      {
+        publicAddress: 'pzyt5lcqp4u4wcwpwl8f8eq0hzpdnntzuy2h3nnalf',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge weird caps Gateway address': [
+      'BiTcOiNcAsH://bitcoincash:pzyt5lcqp4u4wcwpwl8f8eq0hzpdnntzuy2h3nnalf',
+      {
+        publicAddress: 'pzyt5lcqp4u4wcwpwl8f8eq0hzpdnntzuy2h3nnalf',
+        metadata: {
+          gateway: true
+        }
+      }
+    ],
+    'Ren Bridge new Gateway address with amount, label & message': [
+      'bitcoincash://qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a?amount=1234.56789&label=Johnny%20Bitcoincash&message=Hello%20World,%20I%20miss%20you%20!',
+      {
+        publicAddress: 'qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a',
+        metadata: {
+          name: 'Johnny Bitcoincash',
+          notes: 'Hello World, I miss you !',
+          gateway: true
+        },
+        nativeAmount: '123456789000',
+        currencyCode: 'BCH'
+      }
+    ],
     'uri address with amount': [
       'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a?amount=12345.6789',
       {
diff --git a/test/common/utxobased/addressFormat/addressFormatIndex/addressFormat.spec.ts b/test/common/utxobased/addressFormat/addressFormatIndex/addressFormat.spec.ts
@@ -5,6 +5,7 @@ import { describe, it } from 'mocha'
 
 import { parsePathname } from '../../../../../src/common/utxobased/engine/utils'
 import {
+  toNewFormat,
   verifyAddress,
   VerifyAddressEnum
 } from '../../../../../src/common/utxobased/keymanager/keymanager'
@@ -24,7 +25,7 @@ for (const fixture of fixtures) {
         )
         assert.equal(
           parsePathname({ pathname: address, coin: network }).publicAddress,
-          address
+          toNewFormat(address, network)
         )
       })
     })
@@ -51,7 +52,7 @@ for (const fixture of fixtures) {
         assert.deepEqual(parsePathname({ pathname: address, coin: network }), {
           // Uncomment this line if/when we change to always include legacy addresses
           // legacyAddress: _legacy,
-          publicAddress: address
+          publicAddress: toNewFormat(address, network)
         })
       })
     })
@@ -64,7 +65,7 @@ for (const fixture of fixtures) {
         )
         assert.deepEqual(parsePathname({ pathname: legacy, coin: network }), {
           legacyAddress: legacy,
-          publicAddress: address
+          publicAddress: toNewFormat(address, network)
         })
       })
     })
