Merge pull request #8012 from BitGo/FIAT-1195

feat: add INR

Author: Schultzer

modules/bitgo/src/v2/coinFactory.ts

@@ -94,6 +94,7 @@ import {
   FiatAED,
   FiatEur,
   FiatGBP,
+  FiatINR,
   FiatSGD,
   FiatUsd,
   Gteth,
@@ -173,6 +174,7 @@ import {
   TfiatAED,
   TfiatEur,
   TfiatGBP,
+  TfiatINR,
   TfiatSGD,
   TfiatUsd,
   Thash,
@@ -275,6 +277,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('fiataed', FiatAED.createInstance);
   coinFactory.register('fiateur', FiatEur.createInstance);
   coinFactory.register('fiatgbp', FiatGBP.createInstance);
+  coinFactory.register('fiatinr', FiatINR.createInstance);
   coinFactory.register('fiatsgd', FiatSGD.createInstance);
   coinFactory.register('fiatusd', FiatUsd.createInstance);
   coinFactory.register('flr', Flr.createInstance);
@@ -346,6 +349,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('tfiataed', TfiatAED.createInstance);
   coinFactory.register('tfiateur', TfiatEur.createInstance);
   coinFactory.register('tfiatgbp', TfiatGBP.createInstance);
+  coinFactory.register('tfiatinr', TfiatINR.createInstance);
   coinFactory.register('tfiatsgd', TfiatSGD.createInstance);
   coinFactory.register('tfiatusd', TfiatUsd.createInstance);
   coinFactory.register('tflr', Tflr.createInstance);
@@ -695,6 +699,8 @@ export function getCoinConstructor(coinName: string): CoinConstructor | undefine
       return FiatEur.createInstance;
     case 'fiatgbp':
       return FiatGBP.createInstance;
+    case 'fiatinr':
+      return FiatINR.createInstance;
     case 'fiatsgd':
       return FiatSGD.createInstance;
     case 'fiatusd':
@@ -837,6 +843,8 @@ export function getCoinConstructor(coinName: string): CoinConstructor | undefine
       return TfiatEur.createInstance;
     case 'tfiatgbp':
       return TfiatGBP.createInstance;
+    case 'tfiatinr':
+      return TfiatINR.createInstance;
     case 'tfiatsgd':
       return TfiatSGD.createInstance;
     case 'tfiatusd':

modules/bitgo/src/v2/coins/index.ts

@@ -162,19 +162,22 @@ const {
   FiatUsd,
   FiatEur,
   FiatGBP,
+  FiatINR,
   FiatAED,
   FiatSGD,
   Tsusd,
   TfiatUsd,
   TfiatEur,
   TfiatGBP,
+  TfiatINR,
   TfiatAED,
   TfiatSGD,
 } = coins;
 export {
   FiatAED,
   FiatEur,
   FiatGBP,
+  FiatINR,
   FiatSGD,
   FiatUsd,
   Ofc,
@@ -183,6 +186,7 @@ export {
   TfiatAED,
   TfiatEur,
   TfiatGBP,
+  TfiatINR,
   TfiatSGD,
   TfiatUsd,
   Tsusd,

modules/bitgo/test/v2/unit/coins/ofcToken.ts

@@ -40,6 +40,13 @@ describe('OFC:', function () {
     tgbp.getBaseFactor().should.equal(PRECISION_2);
   });
 
+  it('test fiat constants for OFCTINR', function () {
+    const tgbp = bitgo.coin('ofctinr');
+    tgbp.getChain().should.equal('ofctinr');
+    tgbp.getFullName().should.equal('Test Indian Rupee');
+    tgbp.getBaseFactor().should.equal(PRECISION_2);
+  });
+
   it('test crypto coins for ofctbtc', function () {
     const tbtc = bitgo.coin('ofctbtc');
     tbtc.getChain().should.equal('ofctbtc');

modules/sdk-core/src/coins/fiatinr.ts

@@ -0,0 +1,82 @@
+/**
+ * @prettier
+ */
+import {
+  AuditDecryptedKeyParams,
+  BaseCoin,
+  BitGoBase,
+  KeyPair,
+  MethodNotImplementedError,
+  ParsedTransaction,
+  ParseTransactionOptions,
+  SignedTransaction,
+  SignTransactionOptions,
+  VerifyAddressOptions,
+  VerifyTransactionOptions,
+} from '../';
+
+export class FiatINR extends BaseCoin {
+  static createInstance(bitgo: BitGoBase): BaseCoin {
+    return new FiatINR(bitgo);
+  }
+
+  /**
+   * Returns the factor between the base unit and its smallest subdivison
+   * @return {number}
+   */
+  getBaseFactor() {
+    return 1e2;
+  }
+
+  getChain() {
+    return 'fiatinr';
+  }
+
+  getFamily() {
+    return 'fiat';
+  }
+
+  getFullName() {
+    return 'Indian Rupee';
+  }
+
+  /**
+   * Return whether the given m of n wallet signers/ key amounts are valid for the coin
+   */
+  isValidMofNSetup({ m, n }: { m: number; n: number }) {
+    return m === 0 && n === 0;
+  }
+
+  isValidAddress(address: string): boolean {
+    throw new MethodNotImplementedError();
+  }
+
+  generateKeyPair(seed?: Buffer): KeyPair {
+    throw new MethodNotImplementedError();
+  }
+
+  isValidPub(pub: string): boolean {
+    throw new MethodNotImplementedError();
+  }
+
+  async parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
+    return {};
+  }
+
+  async isWalletAddress(params: VerifyAddressOptions): Promise<boolean> {
+    throw new MethodNotImplementedError();
+  }
+
+  async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
+    return true;
+  }
+
+  async signTransaction(params: SignTransactionOptions = {}): Promise<SignedTransaction> {
+    throw new MethodNotImplementedError();
+  }
+
+  /** @inheritDoc */
+  auditDecryptedKey(params: AuditDecryptedKeyParams): void {
+    throw new MethodNotImplementedError();
+  }
+}

modules/sdk-core/src/coins/index.ts

@@ -6,6 +6,8 @@ export * from './fiateur';
 export * from './tfiateur';
 export * from './fiatgbp';
 export * from './tfiatgbp';
+export * from './fiatinr';
+export * from './tfiatinr';
 export * from './fiatusd';
 export * from './tfiatusd';
 export * from './ofc';

modules/sdk-core/src/coins/tfiatinr.ts

@@ -0,0 +1,19 @@
+/**
+ * @prettier
+ */
+import { BaseCoin, BitGoBase } from '../';
+import { FiatINR } from './fiatinr';
+
+export class TfiatINR extends FiatINR {
+  static createInstance(bitgo: BitGoBase): BaseCoin {
+    return new TfiatINR(bitgo);
+  }
+
+  getChain() {
+    return 'tfiatinr';
+  }
+
+  getFullName() {
+    return 'Testnet Indian Rupee';
+  }
+}

modules/statics/src/allCoinsAndTokens.ts

@@ -6159,6 +6159,15 @@ export const allCoinsAndTokens = [
     2,
     UnderlyingAsset.GBP
   ),
+  fiat('4d8c6e0e-08c4-4767-9e3b-8bc5bb78c5b5', 'fiatinr', 'Indian Rupee', Networks.main.fiat, 2, UnderlyingAsset.INR),
+  fiat(
+    '5455f07e-0b96-4e8e-a651-d68f1f13d9ce',
+    'tfiatinr',
+    'Testnet Indian Rupee',
+    Networks.test.fiat,
+    2,
+    UnderlyingAsset.INR
+  ),
   fiat(
     '414d69c3-8da1-460a-add3-ef26453fc76c',
     'fiataed',

modules/statics/src/base.ts

@@ -3558,6 +3558,7 @@ export enum UnderlyingAsset {
   AED = 'aed',
   EUR = 'eur',
   GBP = 'gbp',
+  INR = 'inr',
   SGD = 'sgd',
   USD = 'usd',
 }

modules/statics/src/coins/ofcCoins.ts

@@ -54,6 +54,7 @@ export const ofcCoins = [
   ofc('837f0cab-cad1-4510-a8e4-f2c60e1a8760', 'ofcusd', 'USD', 2, UnderlyingAsset.USD, CoinKind.FIAT),
   ofc('798f2a7c-23fd-4e16-9fe5-6bf47ca438a0', 'ofceur', 'Euro', 2, UnderlyingAsset.EUR, CoinKind.FIAT),
   ofc('f37bbb72-adfe-4d06-90dc-afd0aa34aadd', 'ofcgbp', 'Pound Sterling', 2, UnderlyingAsset.GBP, CoinKind.FIAT),
+  ofc('5d6ec3ce-b06f-4233-ad8c-27860e2d3cf9', 'ofcinr', 'Indian Rupee', 2, UnderlyingAsset.INR, CoinKind.FIAT),
   ofc('60778b32-3497-4e45-895a-3f0bd3a2f475', 'ofcsgd', 'Singapore Dollar', 2, UnderlyingAsset.SGD, CoinKind.FIAT),
   ofc(
     'fe742061-8838-4b32-ab64-d328ca587feb',
@@ -517,6 +518,7 @@ export const ofcCoins = [
     UnderlyingAsset.GBP,
     CoinKind.FIAT
   ),
+  tofc('874e72f2-dab0-4d99-825c-f94c94cece65', 'ofctinr', 'Test Indian Rupee', 2, UnderlyingAsset.INR, CoinKind.FIAT),
   tofc('e5e9dedb-4d72-4a44-a84c-32f46d275bdc', 'ofctcspr', 'Test Casper', 9, UnderlyingAsset.CSPR, CoinKind.CRYPTO),
   tofc('b84e3f27-e521-4093-9616-fc92ba352cd9', 'ofctnear', 'Test Near', 24, UnderlyingAsset.NEAR, CoinKind.CRYPTO),
   tofc('457d1c4e-5bf7-442a-90c9-dfd590f30925', 'ofctbtc', 'Test Bitcoin', 8, UnderlyingAsset.BTC, CoinKind.CRYPTO),

modules/statics/test/unit/fixtures/expectedColdFeatures.ts

@@ -219,6 +219,7 @@ export const expectedColdFeatures = {
     'fiataed',
     'fiateur',
     'fiatgbp',
+    'fiatinr',
     'fiatsgd',
     'fiatusd',
     'lnbtc',
@@ -228,6 +229,7 @@ export const expectedColdFeatures = {
     'tfiataed',
     'tfiateur',
     'tfiatgbp',
+    'tfiatinr',
     'tfiatsgd',
     'tfiatusd',
     'tlnbtc',