Merge pull request #7139 from BitGo/COIN-5851

feat: added canton coin to statics

Author: ravibitgo

modules/sdk-coin-canton/src/canton.ts

@@ -104,7 +104,7 @@ export class Canton extends BaseCoin {
 
   /** @inheritDoc */
   auditDecryptedKey({ multiSigType, prv, publicKey }: AuditDecryptedKeyParams): void {
-    if (multiSigType !== 'tss') {
+    if (multiSigType !== multisigTypes.tss) {
       throw new Error('Unsupported multiSigType');
     }
     auditEddsaPrivateKey(prv, publicKey ?? '');

modules/statics/src/allCoinsAndTokens.ts

@@ -52,6 +52,7 @@ import {
 import { ada } from './ada';
 import { avaxp } from './avaxp';
 import { BaseUnit, CoinFeature, KeyCurve, UnderlyingAsset } from './base';
+import { canton } from './canton';
 import { erc20Coins } from './coins/erc20Coins';
 import { avaxTokens } from './coins/avaxTokens';
 import { bscTokens } from './coins/bscTokens';
@@ -76,6 +77,7 @@ import {
   BERA_BGT_FEATURES,
   BERA_FEATURES,
   BSC_FEATURES,
+  CANTON_FEATURES,
   CELO_FEATURES,
   COREDAO_FEATURES,
   COREUM_FEATURES,
@@ -2084,6 +2086,24 @@ export const allCoinsAndTokens = [
       CoinFeature.EVM_COMPATIBLE_WP,
     ]
   ),
+  canton(
+    '07385320-5a4f-48e9-97a5-86d4be9f24b0',
+    'canton',
+    'Canton Coin',
+    Networks.main.canton,
+    UnderlyingAsset.CANTON,
+    CANTON_FEATURES,
+    KeyCurve.Ed25519
+  ),
+  canton(
+    'f5d7f76b-fc5a-4da8-b1d0-a86ad0fd269e',
+    'tcanton',
+    'Testnet Canton Coin',
+    Networks.test.canton,
+    UnderlyingAsset.CANTON,
+    CANTON_FEATURES,
+    KeyCurve.Ed25519
+  ),
   gasTankAccount(
     '98071460-1488-4edd-857f-0899bc5eee4f',
     'vet',

modules/statics/src/base.ts

@@ -39,6 +39,7 @@ export enum CoinFamily {
   BSV = 'bsv',
   BTC = 'btc',
   BTG = 'btg',
+  CANTON = 'canton',
   CELO = 'celo',
   COREDAO = 'coredao',
   COREUM = 'coreum',
@@ -510,6 +511,7 @@ export enum UnderlyingAsset {
   BSV = 'bsv',
   BTC = 'btc',
   BTG = 'btg',
+  CANTON = 'canton',
   DASH = 'dash',
   DOT = 'dot',
   CELO = 'celo', // Celo main coin
@@ -3291,6 +3293,7 @@ export enum BaseUnit {
   VET = 'wei',
   TCRONOS = 'basetcro',
   TASI = 'atestfet',
+  CANTON = 'canton',
 }
 
 export interface BaseCoinConstructorOptions {

modules/statics/src/canton.ts

@@ -0,0 +1,68 @@
+import { BaseCoin, BaseUnit, CoinFeature, CoinKind, KeyCurve, UnderlyingAsset } from './base';
+import { BaseNetwork } from './networks';
+
+export interface CantonConstructorOptions {
+  id: string;
+  fullName: string;
+  name: string;
+  network: BaseNetwork;
+  features: CoinFeature[];
+  asset: UnderlyingAsset;
+  primaryKeyCurve: KeyCurve;
+}
+
+export class Canton extends BaseCoin {
+  public readonly network: BaseNetwork;
+
+  constructor(options: CantonConstructorOptions) {
+    super({
+      ...options,
+      kind: CoinKind.CRYPTO,
+      isToken: false,
+      decimalPlaces: 10,
+      baseUnit: BaseUnit.CANTON,
+    });
+    this.network = options.network;
+  }
+
+  protected disallowedFeatures(): Set<CoinFeature> {
+    return new Set([CoinFeature.ACCOUNT_MODEL]);
+  }
+
+  protected requiredFeatures(): Set<CoinFeature> {
+    return new Set([CoinFeature.UNSPENT_MODEL]);
+  }
+}
+
+/**
+ * Factory function for canton coin instances
+ *
+ * @param {String} id unique identifier (uuid v4)
+ * @param {String} name unique identifier of the coin
+ * @param {String} fullName complete human-readable name of the coin
+ * @param {BaseNetwork} network network object for this coin
+ * @param {UnderlyingAsset} asset asset which this coin represents. This is the same for both mainNet and testNet variants of a coin.
+ * @param {CoinFeature[]} features features of this coin. Defaults to the CANTON_DEFAULT_FEATURES defined in `account`
+ * @param {KeyCurve} primaryKeyCurve the elliptic curve for this chain/token
+ */
+export function canton(
+  id: string,
+  name: string,
+  fullName: string,
+  network: BaseNetwork,
+  asset: UnderlyingAsset,
+  features: CoinFeature[],
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+): Readonly<Canton> {
+  return Object.freeze(
+    new Canton({
+      id,
+      name,
+      fullName,
+      network,
+      features,
+      asset,
+      primaryKeyCurve,
+    })
+  );
+}

modules/statics/src/coinFeatures.ts

@@ -660,3 +660,12 @@ export const IOTA_FEATURES = [
   CoinFeature.ENTERPRISE_PAYS_FEES,
   CoinFeature.TSS_ENTERPRISE_PAYS_FEES,
 ];
+
+// TODO: https://bitgoinc.atlassian.net/browse/COIN-5870
+export const CANTON_FEATURES = [
+  CoinFeature.UNSPENT_MODEL,
+  CoinFeature.TRANSACTION_DATA,
+  CoinFeature.REQUIRES_BIG_NUMBER,
+  CoinFeature.TSS,
+  CoinFeature.TSS_COLD,
+];

modules/statics/src/networks.ts

@@ -1986,6 +1986,18 @@ class PlumeTestnet extends Testnet implements EthereumNetwork {
   nativeCoinOperationHashPrefix = '98867';
 }
 
+class Canton extends Mainnet implements BaseNetwork {
+  name = 'Canton';
+  family = CoinFamily.CANTON;
+  explorerUrl = '';
+}
+
+class CantonTestnet extends Testnet implements BaseNetwork {
+  name = 'CantonTestnet';
+  family = CoinFamily.CANTON;
+  explorerUrl = '';
+}
+
 export const Networks = {
   main: {
     ada: Object.freeze(new Ada()),
@@ -2006,6 +2018,7 @@ export const Networks = {
     bera: Object.freeze(new Berachain()),
     bld: Object.freeze(new Bld()),
     bsc: Object.freeze(new BinanceSmartChain()),
+    canton: Object.freeze(new Canton()),
     casper: Object.freeze(new Casper()),
     celo: Object.freeze(new Celo()),
     coredao: Object.freeze(new Coredao()),
@@ -2105,6 +2118,7 @@ export const Networks = {
     bera: Object.freeze(new BerachainTestnet()),
     bld: Object.freeze(new BldTestnet()),
     bsc: Object.freeze(new BinanceSmartChainTestnet()),
+    canton: Object.freeze(new CantonTestnet()),
     casper: Object.freeze(new CasperTestnet()),
     coredao: Object.freeze(new CoredaoTestnet()),
     celo: Object.freeze(new CeloTestnet()),

modules/statics/test/unit/coins.ts

@@ -35,7 +35,6 @@ import {
   reducedAmsTokenConfig,
   reducedTokenConfigForAllChains,
 } from './resources/amsTokenConfig';
-import { Networks } from '../../src/networks';
 
 interface DuplicateCoinObject {
   name: string;
@@ -884,6 +883,7 @@ coins.forEach((coin, coinName) => {
         const coinSupportsCustody =
           coin.family !== CoinFamily.LNBTC &&
           coin.family !== CoinFamily.CELO &&
+          coin.family !== CoinFamily.CANTON &&
           coin.name !== 'ofccelo' &&
           coin.name !== 'ofctcelo';
         coin.features.includes(CoinFeature.CUSTODY).should.eql(coinSupportsCustody);

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

@@ -65,6 +65,7 @@ export const expectedColdFeatures = {
     'baseeth',
     'bld',
     'bsc',
+    'canton',
     'coredao',
     'coreum',
     'cronos',
@@ -120,6 +121,7 @@ export const expectedColdFeatures = {
     'tbaseeth',
     'tbld',
     'tbsc',
+    'tcanton',
     'tcoredao',
     'tcoreum',
     'tcronos',