feat(sdk-coin-canton): added canton token skeleton

Ticket: COIN-7293

Author: ravibitgo

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

@@ -0,0 +1,69 @@
+import { BitGoBase, CoinConstructor, NamedCoinConstructor } from '@bitgo/sdk-core';
+import { coins, CantonTokenConfig, NetworkType, tokens } from '@bitgo/statics';
+
+import { Canton } from './canton';
+
+export class CantonToken extends Canton {
+  public readonly tokenConfig: CantonTokenConfig;
+
+  constructor(bitgo: BitGoBase, tokenConfig: CantonTokenConfig) {
+    const staticsCoin = tokenConfig.network === NetworkType.MAINNET ? coins.get('canton') : coins.get('tcanton');
+    super(bitgo, staticsCoin);
+    this.tokenConfig = tokenConfig;
+  }
+
+  static createTokenConstructor(config: CantonTokenConfig): CoinConstructor {
+    return (bitgo: BitGoBase) => new CantonToken(bitgo, config);
+  }
+
+  static createTokenConstructors(
+    tokenConfig: CantonTokenConfig[] = [...tokens.bitcoin.canton.tokens, ...tokens.testnet.canton.tokens]
+  ): NamedCoinConstructor[] {
+    const tokensCtors: NamedCoinConstructor[] = [];
+    for (const token of tokenConfig) {
+      const tokenConstructor = CantonToken.createTokenConstructor(token);
+      tokensCtors.push({ name: token.type, coinConstructor: tokenConstructor });
+    }
+    return tokensCtors;
+  }
+
+  get name(): string {
+    return this.tokenConfig.name;
+  }
+
+  get coin(): string {
+    return this.tokenConfig.coin;
+  }
+
+  get baseUrl(): string {
+    return this.tokenConfig.baseUrl;
+  }
+
+  get admin(): string {
+    return this.tokenConfig.admin;
+  }
+
+  get assetName(): string {
+    return this.tokenConfig.assetName;
+  }
+
+  get decimalPlaces(): number {
+    return this.tokenConfig.decimalPlaces;
+  }
+
+  getChain(): string {
+    return this.tokenConfig.type;
+  }
+
+  getBaseChain(): string {
+    return this.coin;
+  }
+
+  getFullName(): string {
+    return 'Canton Token';
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this.tokenConfig.decimalPlaces);
+  }
+}

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

@@ -2,3 +2,4 @@ export * from './lib';
 export * from './canton';
 export * from './tcanton';
 export * from './register';
+export * from './cantonToken';

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

@@ -1,8 +1,12 @@
 import { BitGoBase } from '@bitgo/sdk-core';
 import { Canton } from './canton';
 import { Tcanton } from './tcanton';
+import { CantonToken } from './cantonToken';
 
 export const register = (sdk: BitGoBase): void => {
   sdk.register('canton', Canton.createInstance);
   sdk.register('tcanton', Tcanton.createInstance);
+  CantonToken.createTokenConstructors().forEach(({ name, coinConstructor }) => {
+    sdk.register(name, coinConstructor);
+  });
 };

modules/statics/src/account.ts

@@ -5,6 +5,7 @@ import { AccountNetwork, BaseNetwork, EthereumNetwork, Networks, TronNetwork } f
 import {
   ACCOUNT_COIN_DEFAULT_FEATURES,
   ACCOUNT_COIN_DEFAULT_FEATURES_EXCLUDE_SINGAPORE,
+  CANTON_FEATURES,
   CELO_TOKEN_FEATURES,
   COSMOS_SIDECHAIN_FEATURES,
 } from './coinFeatures';
@@ -181,6 +182,13 @@ export interface AdaTokenConstructorOptions extends AccountConstructorOptions {
   assetName: string;
   contractAddress: string;
 }
+
+export interface CantonTokenConstructorOptions extends AccountConstructorOptions {
+  baseUrl: string;
+  admin: string;
+  assetName: string;
+}
+
 export interface ContractAddress extends String {
   __contractaddress_phantom__: never;
 }
@@ -774,6 +782,25 @@ export class AdaToken extends AccountCoinToken {
   }
 }
 
+/**
+ * The canton network supports tokens
+ * Canton tokens work similar to Canton coin,
+ * but they will have their own token standard base url and instrument admin
+ */
+export class CantonToken extends AccountCoinToken {
+  public baseUrl: string;
+  public admin: string;
+  public assetName: string;
+  constructor(options: CantonTokenConstructorOptions) {
+    super({
+      ...options,
+    });
+    this.baseUrl = options.baseUrl;
+    this.admin = options.admin;
+    this.assetName = options.assetName;
+  }
+}
+
 /**
  * Factory function for account coin instances.
  *
@@ -4171,3 +4198,105 @@ export function tjettonToken(
     primaryKeyCurve
   );
 }
+
+/**
+ * Factory function for prod canton token instances.
+ *
+ * @param id uuid v4
+ * @param name Name of the token
+ * @param fullName Complete human-readable name of the token
+ * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
+ * @param baseUrl token standard base url, ref: https://docs.digitalasset.com/utilities/devnet/overview/registry-user-guide/token-standard.html#token-standard-endpoints
+ * @param assetName the token instrument name
+ * @param admin the instrument admin for this token
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param features Features of this coin. Defaults to CANTON_FEATURES
+ * @param prefix Optional token prefix. Defaults to empty string
+ * @param suffix Optional token suffix. Defaults to token name.
+ * @param network Optional token network. Defaults to the mainnet canton network.
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function cantonToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  baseUrl: string,
+  assetName: string,
+  admin: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = CANTON_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.main.canton,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+) {
+  return Object.freeze(
+    new CantonToken({
+      id,
+      name,
+      fullName,
+      decimalPlaces,
+      network,
+      baseUrl,
+      assetName,
+      admin,
+      asset,
+      features,
+      prefix,
+      suffix,
+      isToken: true,
+      primaryKeyCurve,
+      baseUnit: BaseUnit.CANTON,
+    })
+  );
+}
+
+/**
+ * Factory function for testnet canton token instances.
+ *
+ * @param id uuid v4
+ * @param name unique identifier of the token
+ * @param fullName Complete human-readable name of the token
+ * @param decimalPlaces Number of decimal places this token supports (divisibility exponent)
+ * @param baseUrl token standard base url
+ * @param assetName the token instrument name
+ * @param admin the instrument admin for this token
+ * @param asset Asset which this coin represents. This is the same for both mainnet and testnet variants of a coin.
+ * @param features Features of this coin. Defaults to the CANTON_FEATURES
+ * @param prefix Optional token prefix. Defaults to empty string
+ * @param suffix Optional token suffix. Defaults to token name.
+ * @param network Optional token network. Defaults to the testnet Canton network.
+ * @param primaryKeyCurve The elliptic curve for this chain/token
+ */
+export function tcantonToken(
+  id: string,
+  name: string,
+  fullName: string,
+  decimalPlaces: number,
+  baseUrl: string,
+  assetName: string,
+  admin: string,
+  asset: UnderlyingAsset,
+  features: CoinFeature[] = CANTON_FEATURES,
+  prefix = '',
+  suffix: string = name.toUpperCase(),
+  network: AccountNetwork = Networks.test.canton,
+  primaryKeyCurve: KeyCurve = KeyCurve.Ed25519
+) {
+  return cantonToken(
+    id,
+    name,
+    fullName,
+    decimalPlaces,
+    baseUrl,
+    assetName,
+    admin,
+    asset,
+    features,
+    prefix,
+    suffix,
+    network,
+    primaryKeyCurve
+  );
+}

modules/statics/src/coinFeatures.ts

@@ -753,4 +753,5 @@ export const CANTON_FEATURES = [
   CoinFeature.REQUIRES_WALLET_INITIALIZATION_TRANSACTION,
   CoinFeature.REQUIRES_DEPOSIT_ACCEPTANCE_TRANSACTION,
   CoinFeature.ALPHANUMERIC_MEMO_ID,
+  CoinFeature.SUPPORTS_TOKENS,
 ];

modules/statics/src/index.ts

@@ -33,6 +33,7 @@ export {
   CosmosChainToken,
   AdaToken,
   JettonToken,
+  CantonToken,
 } from './account';
 export { CoinMap } from './map';
 export { networkFeatureMapForTokens } from './networkFeatureMapForTokens';

modules/statics/src/tokenConfig.ts

@@ -37,6 +37,7 @@ import {
   AdaToken,
   JettonToken,
   AccountCoin,
+  CantonToken,
 } from './account';
 import { CoinFamily, CoinKind, BaseCoin, CoinFeature } from './base';
 import { coins } from './coins';
@@ -135,6 +136,12 @@ export type Nep141TokenConfig = BaseNetworkConfig & {
   storageDepositAmount: string;
 };
 
+export type CantonTokenConfig = BaseNetworkConfig & {
+  baseUrl: string;
+  assetName: string;
+  admin: string;
+};
+
 export type VetTokenConfig = BaseNetworkConfig & {
   contractAddress: string;
 };
@@ -176,6 +183,7 @@ export type TokenConfig =
   | AptNFTCollectionConfig
   | Sip10TokenConfig
   | Nep141TokenConfig
+  | CantonTokenConfig
   | CosmosTokenConfig
   | VetTokenConfig
   | VetNFTCollectionConfig
@@ -235,6 +243,7 @@ export interface TokenNetwork {
   cosmos: { tokens: CosmosTokenConfig[] };
   ton: { tokens: JettonTokenConfig[] };
   tempo: { tokens: Tip20TokenConfig[] };
+  canton: { tokens: CantonTokenConfig[] };
 }
 
 export interface Tokens {
@@ -1024,6 +1033,26 @@ const getFormattedNep141Tokens = (customCoinMap = coins) =>
     return acc;
   }, []);
 
+function getCantonTokenConfig(coin: CantonToken): CantonTokenConfig {
+  return {
+    type: coin.name,
+    coin: coin.network.type === NetworkType.MAINNET ? 'canton' : 'tcanton',
+    network: coin.network.type === NetworkType.MAINNET ? 'Mainnet' : 'Testnet',
+    name: coin.fullName,
+    decimalPlaces: coin.decimalPlaces,
+    baseUrl: coin.baseUrl,
+    admin: coin.admin,
+    assetName: coin.assetName,
+  };
+}
+const getFormattedCantonTokens = (customCoinMap = coins) =>
+  customCoinMap.reduce((acc: CantonTokenConfig[], coin) => {
+    if (coin instanceof CantonToken) {
+      acc.push(getCantonTokenConfig(coin));
+    }
+    return acc;
+  }, []);
+
 function getVetTokenConfig(coin: VetToken): VetTokenConfig {
   return {
     type: coin.name,
@@ -1313,6 +1342,9 @@ export const getFormattedTokensByNetwork = (network: 'Mainnet' | 'Testnet', coin
     tempo: {
       tokens: getFormattedTip20Tokens(coinMap).filter((token) => token.network === network),
     },
+    canton: {
+      tokens: getFormattedCantonTokens(coinMap).filter((token) => token.network === network),
+    },
   };
 };
 
@@ -1473,6 +1505,8 @@ export function getFormattedTokenConfigForCoin(coin: Readonly<BaseCoin>): TokenC
     return getEthLikeTokenConfig(coin);
   } else if (coin instanceof EthLikeERC721Token) {
     return getEthLikeERC721TokenConfig(coin);
+  } else if (coin instanceof CantonToken) {
+    return getCantonTokenConfig(coin);
   }
   // TODO: Add Tip20Token instance check when class is added to statics
   // else if (coin instanceof Tip20Token) {