refactor: rename coin 'core' to 'coreum'

Ticket: WIN-1011

BREAKING CHANGE: rename coin module, coin name, named exports for coreum

Dockerfile

@@ -64,7 +64,7 @@ COPY --from=builder /tmp/bitgo/modules/abstract-cosmos /var/modules/abstract-cos
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-bld /var/modules/sdk-coin-bld/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-bsc /var/modules/sdk-coin-bsc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-celo /var/modules/sdk-coin-celo/
-COPY --from=builder /tmp/bitgo/modules/sdk-coin-core /var/modules/sdk-coin-core/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-coreum /var/modules/sdk-coin-coreum/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-cspr /var/modules/sdk-coin-cspr/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-dot /var/modules/sdk-coin-dot/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-etc /var/modules/sdk-coin-etc/
@@ -129,7 +129,7 @@ cd /var/modules/abstract-cosmos && yarn link && \
 cd /var/modules/sdk-coin-bld && yarn link && \
 cd /var/modules/sdk-coin-bsc && yarn link && \
 cd /var/modules/sdk-coin-celo && yarn link && \
-cd /var/modules/sdk-coin-core && yarn link && \
+cd /var/modules/sdk-coin-coreum && yarn link && \
 cd /var/modules/sdk-coin-cspr && yarn link && \
 cd /var/modules/sdk-coin-dot && yarn link && \
 cd /var/modules/sdk-coin-etc && yarn link && \
@@ -197,7 +197,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-bld && \
     yarn link @bitgo/sdk-coin-bsc && \
     yarn link @bitgo/sdk-coin-celo && \
-    yarn link @bitgo/sdk-coin-core && \
+    yarn link @bitgo/sdk-coin-coreum && \
     yarn link @bitgo/sdk-coin-cspr && \
     yarn link @bitgo/sdk-coin-dot && \
     yarn link @bitgo/sdk-coin-etc && \

modules/account-lib/package.json

@@ -36,7 +36,7 @@
     "@bitgo/sdk-coin-bld": "^1.6.0",
     "@bitgo/sdk-coin-bsc": "^3.10.0",
     "@bitgo/sdk-coin-celo": "^1.5.13",
-    "@bitgo/sdk-coin-core": "^1.2.0",
+    "@bitgo/sdk-coin-coreum": "^1.0.0",
     "@bitgo/sdk-coin-cspr": "^1.7.0",
     "@bitgo/sdk-coin-dot": "^3.15.0",
     "@bitgo/sdk-coin-etc": "^1.4.13",

modules/account-lib/src/index.ts

@@ -98,8 +98,8 @@ export { Islm };
 import * as Zeta from '@bitgo/sdk-coin-zeta';
 export { Zeta };
 
-import * as Core from '@bitgo/sdk-coin-core';
-export { Core };
+import * as Coreum from '@bitgo/sdk-coin-coreum';
+export { Coreum };
 
 import * as Sol from '@bitgo/sdk-coin-sol';
 export { Sol };
@@ -183,8 +183,8 @@ const coinBuilderMap = {
   tzeta: Zeta.TransactionBuilderFactory,
   islm: Islm.TransactionBuilderFactory,
   tislm: Islm.TransactionBuilderFactory,
-  core: Core.TransactionBuilderFactory,
-  tcore: Core.TransactionBuilderFactory,
+  core: Coreum.TransactionBuilderFactory,
+  tcore: Coreum.TransactionBuilderFactory,
   arbeth: Arbeth.TransactionBuilder,
   tarbeth: Arbeth.TransactionBuilder,
   opeth: Opeth.TransactionBuilder,

modules/account-lib/tsconfig.json

@@ -35,7 +35,7 @@
       "path": "../sdk-coin-celo"
     },
     {
-      "path": "../sdk-coin-core"
+      "path": "../sdk-coin-coreum"
     },
     {
       "path": "../sdk-coin-cspr"

modules/bitgo/package.json

@@ -63,7 +63,7 @@
     "@bitgo/sdk-coin-btc": "^1.7.13",
     "@bitgo/sdk-coin-btg": "^1.5.13",
     "@bitgo/sdk-coin-celo": "^1.5.13",
-    "@bitgo/sdk-coin-core": "^1.2.0",
+    "@bitgo/sdk-coin-coreum": "^1.0.0",
     "@bitgo/sdk-coin-cspr": "^1.7.0",
     "@bitgo/sdk-coin-dash": "^1.5.13",
     "@bitgo/sdk-coin-doge": "^1.12.13",

modules/bitgo/src/v2/coinFactory.ts

@@ -29,7 +29,7 @@ import {
   Btg,
   Celo,
   CeloToken,
-  Core,
+  Coreum,
   Cspr,
   Dash,
   Doge,
@@ -78,7 +78,7 @@ import {
   Tbsv,
   Tbtc,
   Tcelo,
-  Tcore,
+  Tcoreum,
   Tcspr,
   Tdash,
   Tdoge,
@@ -137,7 +137,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('btc', Btc.createInstance);
   globalCoinFactory.register('btg', Btg.createInstance);
   globalCoinFactory.register('celo', Celo.createInstance);
-  globalCoinFactory.register('core', Core.createInstance);
+  globalCoinFactory.register('coreum', Coreum.createInstance);
   globalCoinFactory.register('cspr', Cspr.createInstance);
   globalCoinFactory.register('dash', Dash.createInstance);
   globalCoinFactory.register('doge', Doge.createInstance);
@@ -184,7 +184,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('tbsv', Tbsv.createInstance);
   globalCoinFactory.register('tbtc', Tbtc.createInstance);
   globalCoinFactory.register('tcelo', Tcelo.createInstance);
-  globalCoinFactory.register('tcore', Tcore.createInstance);
+  globalCoinFactory.register('tcoreum', Tcoreum.createInstance);
   globalCoinFactory.register('tcspr', Tcspr.createInstance);
   globalCoinFactory.register('tdash', Tdash.createInstance);
   globalCoinFactory.register('tdoge', Tdoge.createInstance);

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

@@ -14,7 +14,7 @@ import { Bsv, Tbsv } from '@bitgo/sdk-coin-bsv';
 import { Btc, Tbtc } from '@bitgo/sdk-coin-btc';
 import { Btg } from '@bitgo/sdk-coin-btg';
 import { Celo, CeloToken, Tcelo } from '@bitgo/sdk-coin-celo';
-import { Core, Tcore } from '@bitgo/sdk-coin-core';
+import { Coreum, Tcoreum } from '@bitgo/sdk-coin-coreum';
 import { Cspr, Tcspr } from '@bitgo/sdk-coin-cspr';
 import { Dash, Tdash } from '@bitgo/sdk-coin-dash';
 import { Doge, Tdoge } from '@bitgo/sdk-coin-doge';
@@ -59,7 +59,7 @@ export { Bsv, Tbsv };
 export { Btc, Tbtc };
 export { Btg };
 export { Celo, CeloToken, Tcelo };
-export { Core, Tcore };
+export { Coreum, Tcoreum };
 export { Cspr, Tcspr };
 export { Dash, Tdash };
 export { Doge, Tdoge };

modules/bitgo/test/v2/unit/keychains.ts

@@ -60,7 +60,7 @@ describe('V2 Keychains', function () {
         n.asset !== UnderlyingAsset.DOGE &&
         n.asset !== UnderlyingAsset.ETHW &&
         n.asset !== UnderlyingAsset.KAVA &&
-        n.asset !== UnderlyingAsset.CORE &&
+        n.asset !== UnderlyingAsset.COREUM &&
         n.asset !== UnderlyingAsset.BERA &&
         n.asset !== UnderlyingAsset.ISLM &&
         n.asset !== UnderlyingAsset.ARBETH && // TODO(WIN-692): remove this once coin-specific module for arbeth is added

modules/bitgo/tsconfig.json

@@ -81,7 +81,7 @@
       "path": "../sdk-coin-celo"
     },
     {
-      "path": "../sdk-coin-core"
+      "path": "../sdk-coin-coreum"
     },
     {
       "path": "../sdk-coin-cspr"

modules/sdk-coin-core/README.md → modules/sdk-coin-coreum/README.md

@@ -1,26 +1,26 @@
-# BitGo sdk-coin-core
+# BitGo sdk-coin-coreum
 
 SDK coins provide a modular approach to a monolithic architecture. This and all BitGoJS SDK coins allow developers to use only the coins needed for a given project.
 
 ## Installation
 
 All coins are loaded traditionally through the `bitgo` package. If you are using coins individually, you will be accessing the coin via the `@bitgo/sdk-api` package.
 
-In your project install both `@bitgo/sdk-api` and `@bitgo/sdk-coin-core`.
+In your project install both `@bitgo/sdk-api` and `@bitgo/sdk-coin-coreum`.
 
 ```shell
-npm i @bitgo/sdk-api @bitgo/sdk-coin-core
+npm i @bitgo/sdk-api @bitgo/sdk-coin-coreum
 ```
 
 Next, you will be able to initialize an instance of "bitgo" through `@bitgo/sdk-api` instead of `bitgo`.
 
 ```javascript
 import { BitGoAPI } from '@bitgo/sdk-api';
-import { Core } from '@bitgo/sdk-coin-core';
+import { Coreum } from '@bitgo/sdk-coin-coreum';
 
 const sdk = new BitGoAPI();
 
-sdk.register('core', Core.createInstance);
+sdk.register('coreum', Coreum.createInstance);
 ```
 
 ## Development

modules/sdk-coin-core/package.json → modules/sdk-coin-coreum/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@bitgo/sdk-coin-core",
-  "version": "1.2.0",
+  "name": "@bitgo/sdk-coin-coreum",
+  "version": "1.0.0",
   "description": "BitGo SDK coin library for Coreum",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",

modules/sdk-coin-core/src/core.ts → modules/sdk-coin-coreum/src/coreum.ts

@@ -3,22 +3,22 @@ import { BaseCoin, BitGoBase, Environments } from '@bitgo/sdk-core';
 import { BaseCoin as StaticsBaseCoin, BaseUnit, coins } from '@bitgo/statics';
 import { KeyPair, TransactionBuilderFactory } from './lib';
 import { GAS_AMOUNT, GAS_LIMIT } from './lib/constants';
-import { CoreUtils } from './lib/utils';
+import { CoreumUtils } from './lib/utils';
 
-export class Core extends CosmosCoin {
-  protected readonly _utils: CoreUtils;
+export class Coreum extends CosmosCoin {
+  protected readonly _utils: CoreumUtils;
   protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
   protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
     super(bitgo, staticsCoin);
     if (!staticsCoin) {
       throw new Error('missing required constructor parameter staticsCoin');
     }
     this._staticsCoin = staticsCoin;
-    this._utils = new CoreUtils();
+    this._utils = new CoreumUtils();
   }
 
   static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
-    return new Core(bitgo, staticsCoin);
+    return new Coreum(bitgo, staticsCoin);
   }
 
   /** @inheritDoc **/
@@ -38,12 +38,12 @@ export class Core extends CosmosCoin {
 
   /** @inheritDoc **/
   protected getPublicNodeUrl(): string {
-    return Environments[this.bitgo.getEnv()].coreNodeUrl;
+    return Environments[this.bitgo.getEnv()].coreumNodeUrl;
   }
 
   /** @inheritDoc **/
   getDenomination(): string {
-    return BaseUnit.CORE;
+    return BaseUnit.COREUM;
   }
 
   /** @inheritDoc **/

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

@@ -0,0 +1,4 @@
+export * from './coreum';
+export * from './lib';
+export * from './register';
+export * from './tcoreum';

modules/sdk-coin-core/src/lib/transactionBuilderFactory.ts → modules/sdk-coin-coreum/src/lib/transactionBuilderFactory.ts

@@ -8,7 +8,7 @@ import {
 } from '@bitgo/abstract-cosmos';
 import { BaseTransactionBuilderFactory, InvalidTransactionError, TransactionType } from '@bitgo/sdk-core';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
-import { CoreUtils } from './utils';
+import { CoreumUtils } from './utils';
 
 export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
   constructor(_coinConfig: Readonly<CoinConfig>) {
@@ -17,7 +17,7 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
 
   /** @inheritdoc */
   from(raw: string): CosmosTransactionBuilder {
-    const tx = new CosmosTransaction(this._coinConfig, new CoreUtils(this._coinConfig.network.type));
+    const tx = new CosmosTransaction(this._coinConfig, new CoreumUtils(this._coinConfig.network.type));
     tx.enrichTransactionDetailsFromRawTransaction(raw);
     try {
       switch (tx.type) {
@@ -41,31 +41,31 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
   getTransferBuilder(tx?: CosmosTransaction): CosmosTransferBuilder {
     return this.initializeBuilder(
       tx,
-      new CosmosTransferBuilder(this._coinConfig, new CoreUtils(this._coinConfig.network.type))
+      new CosmosTransferBuilder(this._coinConfig, new CoreumUtils(this._coinConfig.network.type))
     );
   }
 
   /** @inheritdoc */
   getStakingActivateBuilder(tx?: CosmosTransaction): StakingActivateBuilder {
     return this.initializeBuilder(
       tx,
-      new StakingActivateBuilder(this._coinConfig, new CoreUtils(this._coinConfig.network.type))
+      new StakingActivateBuilder(this._coinConfig, new CoreumUtils(this._coinConfig.network.type))
     );
   }
 
   /** @inheritdoc */
   getStakingDeactivateBuilder(tx?: CosmosTransaction): StakingDeactivateBuilder {
     return this.initializeBuilder(
       tx,
-      new StakingDeactivateBuilder(this._coinConfig, new CoreUtils(this._coinConfig.network.type))
+      new StakingDeactivateBuilder(this._coinConfig, new CoreumUtils(this._coinConfig.network.type))
     );
   }
 
   /** @inheritdoc */
   getStakingWithdrawRewardsBuilder(tx?: CosmosTransaction): StakingWithdrawRewardsBuilder {
     return this.initializeBuilder(
       tx,
-      new StakingWithdrawRewardsBuilder(this._coinConfig, new CoreUtils(this._coinConfig.network.type))
+      new StakingWithdrawRewardsBuilder(this._coinConfig, new CoreumUtils(this._coinConfig.network.type))
     );
   }
 

modules/sdk-coin-core/src/lib/utils.ts → modules/sdk-coin-coreum/src/lib/utils.ts

@@ -6,7 +6,7 @@ import { CosmosUtils } from '@bitgo/abstract-cosmos';
 import * as constants from './constants';
 import { NetworkType } from '@bitgo/statics';
 
-export class CoreUtils extends CosmosUtils {
+export class CoreumUtils extends CosmosUtils {
   private networkType: NetworkType;
   constructor(networkType: NetworkType = NetworkType.MAINNET) {
     super();
@@ -46,6 +46,6 @@ export class CoreUtils extends CosmosUtils {
   }
 }
 
-const coreUtils = new CoreUtils();
+const coreumUtils = new CoreumUtils();
 
-export default coreUtils;
+export default coreumUtils;

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

@@ -0,0 +1,8 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { Coreum } from './coreum';
+import { Tcoreum } from './tcoreum';
+
+export const register = (sdk: BitGoBase): void => {
+  sdk.register('coreum', Coreum.createInstance);
+  sdk.register('tcoreum', Tcoreum.createInstance);
+};

modules/sdk-coin-core/src/tcore.ts → modules/sdk-coin-coreum/src/tcoreum.ts

@@ -5,12 +5,12 @@
  */
 import { AddressFormat, BaseCoin, BitGoBase } from '@bitgo/sdk-core';
 import { BaseUnit, NetworkType, BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
-import { Core } from './core';
+import { Coreum } from './coreum';
 import { KeyPair } from './lib';
-import { CoreUtils } from './lib/utils';
+import { CoreumUtils } from './lib/utils';
 
-export class Tcore extends Core {
-  protected readonly _utils: CoreUtils;
+export class Tcoreum extends Coreum {
+  protected readonly _utils: CoreumUtils;
   protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
   protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
     super(bitgo, staticsCoin);
@@ -20,16 +20,16 @@ export class Tcore extends Core {
     }
 
     this._staticsCoin = staticsCoin;
-    this._utils = new CoreUtils(NetworkType.TESTNET);
+    this._utils = new CoreumUtils(NetworkType.TESTNET);
   }
 
   static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
-    return new Tcore(bitgo, staticsCoin);
+    return new Tcoreum(bitgo, staticsCoin);
   }
 
   /** @inheritDoc **/
   getDenomination(): string {
-    return BaseUnit.TESTCORE;
+    return BaseUnit.TCOREUM;
   }
 
   /** @inheritDoc **/