feat(sdk-coin-cronos): add SDK Skeleton for Cronos

baltiyal · baltiyal · commit 72098072ef92 · 2025-05-05T18:58:39.000+05:30
TICKET: COIN-3996
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -57,6 +57,7 @@
 /modules/sdk-coin-bera/ @BitGo/ethalt-team
 /modules/sdk-coin-bsc/ @BitGo/ethalt-team
 /modules/sdk-coin-coredao/ @BitGo/ethalt-team
+/modules/sdk-coin-cronos/ @BitGo/ethalt-team
 /modules/sdk-coin-cspr/ @BitGo/ethalt-team
 /modules/sdk-coin-dot/ @BitGo/ethalt-team
 /modules/sdk-coin-eos/ @BitGo/ethalt-team
diff --git a/Dockerfile b/Dockerfile
@@ -72,6 +72,7 @@ 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-coredao /var/modules/sdk-coin-coredao/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-coreum /var/modules/sdk-coin-coreum/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-cronos /var/modules/sdk-coin-cronos/
 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/
@@ -161,6 +162,7 @@ cd /var/modules/sdk-coin-bsc && yarn link && \
 cd /var/modules/sdk-coin-celo && yarn link && \
 cd /var/modules/sdk-coin-coredao && yarn link && \
 cd /var/modules/sdk-coin-coreum && yarn link && \
+cd /var/modules/sdk-coin-cronos && 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 && \
@@ -253,6 +255,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-celo && \
     yarn link @bitgo/sdk-coin-coredao && \
     yarn link @bitgo/sdk-coin-coreum && \
+    yarn link @bitgo/sdk-coin-cronos && \
     yarn link @bitgo/sdk-coin-cspr && \
     yarn link @bitgo/sdk-coin-dot && \
     yarn link @bitgo/sdk-coin-etc && \
diff --git a/modules/account-lib/package.json b/modules/account-lib/package.json
@@ -40,6 +40,7 @@
     "@bitgo/sdk-coin-celo": "^5.0.5",
     "@bitgo/sdk-coin-coredao": "^2.1.2",
     "@bitgo/sdk-coin-coreum": "^21.0.47",
+    "@bitgo/sdk-coin-cronos": "^1.0.0",
     "@bitgo/sdk-coin-cspr": "^2.0.78",
     "@bitgo/sdk-coin-dot": "^4.1.56",
     "@bitgo/sdk-coin-etc": "^2.2.45",
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -110,6 +110,9 @@ export { Mon };
 import * as Mantra from '@bitgo/sdk-coin-mantra';
 export { Mantra };
 
+import * as Cronos from '@bitgo/sdk-coin-cronos';
+export { Cronos };
+
 import * as Sol from '@bitgo/sdk-coin-sol';
 export { Sol };
 
@@ -258,6 +261,8 @@ const coinBuilderMap = {
   ticp: Icp.TransactionBuilder,
   baby: Baby.TransactionBuilder,
   tbaby: Baby.TransactionBuilder,
+  cronos: Cronos.TransactionBuilder,
+  tcronos: Cronos.TransactionBuilder,
   flr: Flr.TransactionBuilder,
   tflr: Flr.TransactionBuilder,
   sgb: Sgb.TransactionBuilder,
diff --git a/modules/bitgo/package.json b/modules/bitgo/package.json
@@ -68,6 +68,7 @@
     "@bitgo/sdk-coin-celo": "^5.0.5",
     "@bitgo/sdk-coin-coredao": "^2.1.2",
     "@bitgo/sdk-coin-coreum": "^21.0.47",
+    "@bitgo/sdk-coin-cronos": "^1.0.0",
     "@bitgo/sdk-coin-cspr": "^2.0.78",
     "@bitgo/sdk-coin-dash": "^2.1.28",
     "@bitgo/sdk-coin-doge": "^2.1.28",
diff --git a/modules/bitgo/src/v2/coinFactory.ts b/modules/bitgo/src/v2/coinFactory.ts
@@ -35,6 +35,7 @@ import {
   CeloToken,
   Coredao,
   Coreum,
+  Cronos,
   Cspr,
   Dash,
   Doge,
@@ -108,6 +109,7 @@ import {
   Tcelo,
   Tcoredao,
   Tcoreum,
+  Tcronos,
   Tcspr,
   Tdash,
   Tdoge,
@@ -193,6 +195,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('celo', Celo.createInstance);
   globalCoinFactory.register('coredao', Coredao.createInstance);
   globalCoinFactory.register('coreum', Coreum.createInstance);
+  globalCoinFactory.register('cronos', Cronos.createInstance);
   globalCoinFactory.register('cspr', Cspr.createInstance);
   globalCoinFactory.register('dash', Dash.createInstance);
   globalCoinFactory.register('doge', Doge.createInstance);
@@ -261,6 +264,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('tcelo', Tcelo.createInstance);
   globalCoinFactory.register('tcoredao', Tcoredao.createInstance);
   globalCoinFactory.register('tcoreum', Tcoreum.createInstance);
+  globalCoinFactory.register('tcronos', Tcronos.createInstance);
   globalCoinFactory.register('tcspr', Tcspr.createInstance);
   globalCoinFactory.register('tdash', Tdash.createInstance);
   globalCoinFactory.register('tdoge', Tdoge.createInstance);
diff --git a/modules/bitgo/src/v2/coins/index.ts b/modules/bitgo/src/v2/coins/index.ts
@@ -19,6 +19,7 @@ import { Btg } from '@bitgo/sdk-coin-btg';
 import { Celo, CeloToken, Tcelo } from '@bitgo/sdk-coin-celo';
 import { Coredao, Tcoredao } from '@bitgo/sdk-coin-coredao';
 import { Coreum, Tcoreum } from '@bitgo/sdk-coin-coreum';
+import { Cronos, Tcronos } from '@bitgo/sdk-coin-cronos';
 import { Cspr, Tcspr } from '@bitgo/sdk-coin-cspr';
 import { Dash, Tdash } from '@bitgo/sdk-coin-dash';
 import { Doge, Tdoge } from '@bitgo/sdk-coin-doge';
@@ -85,6 +86,7 @@ export { Btg };
 export { Celo, CeloToken, Tcelo };
 export { Coredao, Tcoredao };
 export { Coreum, Tcoreum };
+export { Cronos, Tcronos };
 export { Cspr, Tcspr };
 export { Dash, Tdash };
 export { Doge, Tdoge };
diff --git a/modules/bitgo/tsconfig.json b/modules/bitgo/tsconfig.json
@@ -116,6 +116,9 @@
     {
       "path": "../sdk-coin-coreum"
     },
+    {
+      "path": "../sdk-coin-cronos"
+    },
     {
       "path": "../sdk-coin-cspr"
     },
diff --git a/modules/sdk-coin-cronos/.eslintignore b/modules/sdk-coin-cronos/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+.idea
+public
+dist
diff --git a/modules/sdk-coin-cronos/.gitignore b/modules/sdk-coin-cronos/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-cronos/.mocharc.yml b/modules/sdk-coin-cronos/.mocharc.yml
@@ -0,0 +1,8 @@
+require: 'ts-node/register'
+timeout: '60000'
+reporter: 'min'
+reporter-option:
+  - 'cdn=true'
+  - 'json=false'
+exit: true
+spec: ['test/unit/**/*.ts']
diff --git a/modules/sdk-coin-cronos/.npmignore b/modules/sdk-coin-cronos/.npmignore
@@ -0,0 +1,14 @@
+!dist/
+dist/test/
+dist/tsconfig.tsbuildinfo
+.idea/
+.prettierrc.yml
+tsconfig.json
+src/
+test/
+scripts/
+.nyc_output
+CODEOWNERS
+node_modules/
+.prettierignore
+.mocharc.js
diff --git a/modules/sdk-coin-cronos/.prettierignore b/modules/sdk-coin-cronos/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-cronos/.prettierrc.yml b/modules/sdk-coin-cronos/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-cronos/README.md b/modules/sdk-coin-cronos/README.md
@@ -0,0 +1,30 @@
+# BitGo sdk-coin-cronos
+
+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-cronos`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-cronos
+```
+
+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 { Cronos } from '@bitgo/sdk-coin-cronos';
+
+const sdk = new BitGoAPI();
+
+sdk.register('cronos', Cronos.createInstance);
+```
+
+## Development
+
+Most of the coin implementations are derived from `@bitgo/sdk-core`, `@bitgo/statics`, and coin specific packages. These implementations are used to interact with the BitGo API and BitGo platform services.
+
+You will notice that the basic version of common class extensions have been provided to you and must be resolved before the package build will succeed. Upon initiation of a given SDK coin, you will need to verify that your coin has been included in the root `tsconfig.packages.json` and that the linting, formatting, and testing succeeds when run both within the coin and from the root of BitGoJS.
diff --git a/modules/sdk-coin-cronos/package.json b/modules/sdk-coin-cronos/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@bitgo/sdk-coin-cronos",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Cronos",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "build": "yarn tsc --build --incremental --verbose .",
+    "fmt": "prettier --write .",
+    "check-fmt": "prettier --check .",
+    "clean": "rm -r ./dist",
+    "lint": "eslint --quiet .",
+    "prepare": "npm run build",
+    "test": "npm run coverage",
+    "coverage": "nyc -- npm run unit-test",
+    "unit-test": "mocha"
+  },
+  "author": "BitGo SDK Team <sdkteam@bitgo.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18 <21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-cronos"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-cosmos": "^11.7.2",
+    "@bitgo/sdk-core": "^33.1.0",
+    "@bitgo/statics": "^52.1.0",
+    "@cosmjs/stargate": "^0.29.5"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.62.2",
+    "@bitgo/sdk-test": "^8.0.83"
+  }
+}
diff --git a/modules/sdk-coin-cronos/src/cronos.ts b/modules/sdk-coin-cronos/src/cronos.ts
@@ -0,0 +1,62 @@
+import { BaseCoin, BitGoBase } from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+import { CosmosCoin, CosmosKeyPair, GasAmountDetails } from '@bitgo/abstract-cosmos';
+import { TransactionBuilderFactory } from './lib';
+
+export class Cronos extends CosmosCoin {
+  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;
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Cronos(bitgo, staticsCoin);
+  }
+
+  /** @inheritDoc **/
+  getBaseFactor(): number {
+    return Math.pow(10, this._staticsCoin.decimalPlaces);
+  }
+
+  /** @inheritDoc **/
+  getBuilder(): TransactionBuilderFactory {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc **/
+  isValidAddress(address: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc **/
+  getDenomination(): string {
+    throw new Error('Method not implemented');
+  }
+
+  /** @inheritDoc **/
+  getGasAmountDetails(): GasAmountDetails {
+    throw new Error('Method not implemented');
+  }
+
+  /** @inheritDoc **/
+  getKeyPair(publicKey: string): CosmosKeyPair {
+    throw new Error('Method not implemented');
+  }
+
+  /** @inheritDoc **/
+  protected getPublicNodeUrl(): string {
+    throw new Error('Method not implemented');
+  }
+
+  /** @inheritDoc **/
+  getAddressFromPublicKey(pubKey: string): string {
+    throw new Error('Method not implemented');
+  }
+}
diff --git a/modules/sdk-coin-cronos/src/index.ts b/modules/sdk-coin-cronos/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './register';
+export * from './cronos';
+export * from './tcronos';
diff --git a/modules/sdk-coin-cronos/src/lib/constants.ts b/modules/sdk-coin-cronos/src/lib/constants.ts
diff --git a/modules/sdk-coin-cronos/src/lib/index.ts b/modules/sdk-coin-cronos/src/lib/index.ts
@@ -0,0 +1,9 @@
+import * as Utils from './utils';
+
+export {
+  CosmosTransaction as Transaction,
+  CosmosTransactionBuilder as TransactionBuilder,
+} from '@bitgo/abstract-cosmos';
+export { KeyPair } from './keyPair';
+export { TransactionBuilderFactory } from './transactionBuilderFactory';
+export { Utils };
diff --git a/modules/sdk-coin-cronos/src/lib/keyPair.ts b/modules/sdk-coin-cronos/src/lib/keyPair.ts
@@ -0,0 +1,16 @@
+import { KeyPairOptions } from '@bitgo/sdk-core';
+import { CosmosKeyPair } from '@bitgo/abstract-cosmos';
+
+/**
+ * Cronos keys and address management.
+ */
+export class KeyPair extends CosmosKeyPair {
+  constructor(source?: KeyPairOptions) {
+    super(source);
+  }
+
+  /** @inheritdoc */
+  getAddress(): string {
+    throw new Error('Method not implemented.');
+  }
+}
diff --git a/modules/sdk-coin-cronos/src/lib/transactionBuilderFactory.ts b/modules/sdk-coin-cronos/src/lib/transactionBuilderFactory.ts
diff --git a/modules/sdk-coin-cronos/src/lib/utils.ts b/modules/sdk-coin-cronos/src/lib/utils.ts
diff --git a/modules/sdk-coin-cronos/src/register.ts b/modules/sdk-coin-cronos/src/register.ts
diff --git a/modules/sdk-coin-cronos/src/tcronos.ts b/modules/sdk-coin-cronos/src/tcronos.ts
diff --git a/modules/sdk-coin-cronos/test/unit/cronos.ts b/modules/sdk-coin-cronos/test/unit/cronos.ts
diff --git a/modules/sdk-coin-cronos/tsconfig.json b/modules/sdk-coin-cronos/tsconfig.json
diff --git a/modules/sdk-core/src/bitgo/environments.ts b/modules/sdk-core/src/bitgo/environments.ts
diff --git a/tsconfig.packages.json b/tsconfig.packages.json

Original file line number	Diff line number	Diff line change
`@@ -116,6 +116,9 @@`
`116`	`116`	`{`
`117`	`117`	`"path": "../sdk-coin-coreum"`
`118`	`118`	`},`
	`119`	`+ {`
	`120`	`+ "path": "../sdk-coin-cronos"`
	`121`	`+ },`
`119`	`122`	`{`
`120`	`123`	`"path": "../sdk-coin-cspr"`
`121`	`124`	`},`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +node_modules
 +.idea
 +public
 +dist