feat(sdk-coin-init): add SDK Skeleton for Initia

baltiyal · baltiyal · commit d93936f3cf01 · 2025-05-06T10:59:26.000+05:30
TICKET: COIN-3996
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -66,6 +66,7 @@
 /modules/sdk-coin-ethlike/ @BitGo/ethalt-team
 /modules/sdk-coin-hbar/ @BitGo/ethalt-team
 /modules/sdk-coin-icp/ @BitGo/ethalt-team
+/modules/sdk-coin-init/ @BitGo/ethalt-team
 /modules/sdk-coin-mon/ @BitGo/ethalt-team
 /modules/sdk-coin-mantra/ @BitGo/ethalt-team
 /modules/sdk-coin-near/ @BitGo/ethalt-team
diff --git a/Dockerfile b/Dockerfile
@@ -81,6 +81,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-flr /var/modules/sdk-coin-flr/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-hash /var/modules/sdk-coin-hash/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-hbar /var/modules/sdk-coin-hbar/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-icp /var/modules/sdk-coin-icp/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-init /var/modules/sdk-coin-init/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-injective /var/modules/sdk-coin-injective/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-islm /var/modules/sdk-coin-islm/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-mantra /var/modules/sdk-coin-mantra/
@@ -172,6 +173,7 @@ cd /var/modules/sdk-coin-flr && yarn link && \
 cd /var/modules/sdk-coin-hash && yarn link && \
 cd /var/modules/sdk-coin-hbar && yarn link && \
 cd /var/modules/sdk-coin-icp && yarn link && \
+cd /var/modules/sdk-coin-init && yarn link && \
 cd /var/modules/sdk-coin-injective && yarn link && \
 cd /var/modules/sdk-coin-islm && yarn link && \
 cd /var/modules/sdk-coin-mantra && yarn link && \
@@ -266,6 +268,7 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-hash && \
     yarn link @bitgo/sdk-coin-hbar && \
     yarn link @bitgo/sdk-coin-icp && \
+    yarn link @bitgo/sdk-coin-init && \
     yarn link @bitgo/sdk-coin-injective && \
     yarn link @bitgo/sdk-coin-islm && \
     yarn link @bitgo/sdk-coin-mantra && \
diff --git a/modules/account-lib/package.json b/modules/account-lib/package.json
@@ -50,6 +50,7 @@
     "@bitgo/sdk-coin-hash": "^3.0.47",
     "@bitgo/sdk-coin-hbar": "^2.0.78",
     "@bitgo/sdk-coin-icp": "^1.13.1",
+    "@bitgo/sdk-coin-init": "^1.0.0",
     "@bitgo/sdk-coin-injective": "^3.0.47",
     "@bitgo/sdk-coin-islm": "^2.1.28",
     "@bitgo/sdk-coin-mantra": "^1.0.5",
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -116,6 +116,9 @@ export { Cronos };
 import * as Fetch from '@bitgo/sdk-coin-fetch';
 export { Fetch };
 
+import * as Init from '@bitgo/sdk-coin-init';
+export { Init };
+
 import * as Sol from '@bitgo/sdk-coin-sol';
 export { Sol };
 
@@ -268,6 +271,8 @@ const coinBuilderMap = {
   tcronos: Cronos.TransactionBuilder,
   fetch: Fetch.TransactionBuilder,
   tfetch: Fetch.TransactionBuilder,
+  init: Init.TransactionBuilder,
+  tinit: Init.TransactionBuilder,
   flr: Flr.TransactionBuilder,
   tflr: Flr.TransactionBuilder,
   sgb: Sgb.TransactionBuilder,
diff --git a/modules/bitgo/package.json b/modules/bitgo/package.json
@@ -83,6 +83,7 @@
     "@bitgo/sdk-coin-hash": "^3.0.47",
     "@bitgo/sdk-coin-hbar": "^2.0.78",
     "@bitgo/sdk-coin-icp": "^1.13.1",
+    "@bitgo/sdk-coin-init": "^1.0.0",
     "@bitgo/sdk-coin-injective": "^3.0.47",
     "@bitgo/sdk-coin-islm": "^2.1.28",
     "@bitgo/sdk-coin-lnbtc": "^1.2.9",
diff --git a/modules/bitgo/src/v2/coinFactory.ts b/modules/bitgo/src/v2/coinFactory.ts
@@ -60,6 +60,7 @@ import {
   Hbar,
   Hteth,
   Icp,
+  Init,
   Injective,
   Islm,
   Lnbtc,
@@ -130,6 +131,7 @@ import {
   Thbar,
   Tia,
   Ticp,
+  Tinit,
   Tinjective,
   Tislm,
   Tlnbtc,
@@ -224,6 +226,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('mon', Mon.createInstance);
   globalCoinFactory.register('mantra', Mantra.createInstance);
   globalCoinFactory.register('icp', Icp.createInstance);
+  globalCoinFactory.register('init', Init.createInstance);
   globalCoinFactory.register('injective', Injective.createInstance);
   globalCoinFactory.register('islm', Islm.createInstance);
   globalCoinFactory.register('near', Near.createInstance);
@@ -286,6 +289,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('thash', Thash.createInstance);
   globalCoinFactory.register('thbar', Thbar.createInstance);
   globalCoinFactory.register('ticp', Ticp.createInstance);
+  globalCoinFactory.register('tinit', Tinit.createInstance);
   globalCoinFactory.register('tinjective', Tinjective.createInstance);
   globalCoinFactory.register('tislm', Tislm.createInstance);
   globalCoinFactory.register('tlnbtc', Tlnbtc.createInstance);
diff --git a/modules/bitgo/src/v2/coins/index.ts b/modules/bitgo/src/v2/coins/index.ts
@@ -34,6 +34,7 @@ import { EthLikeCoin, TethLikeCoin } from '@bitgo/sdk-coin-ethlike';
 import { Hash, Thash } from '@bitgo/sdk-coin-hash';
 import { Hbar, Thbar } from '@bitgo/sdk-coin-hbar';
 import { Icp, Ticp } from '@bitgo/sdk-coin-icp';
+import { Init, Tinit } from '@bitgo/sdk-coin-init';
 import { Injective, Tinjective } from '@bitgo/sdk-coin-injective';
 import { Islm, Tislm } from '@bitgo/sdk-coin-islm';
 import { Lnbtc, Tlnbtc } from '@bitgo/sdk-coin-lnbtc';
@@ -103,6 +104,7 @@ export { Flr, Tflr };
 export { Hash, Thash };
 export { Hbar, Thbar };
 export { Icp, Ticp };
+export { Init, Tinit };
 export { Lnbtc, Tlnbtc };
 export { Ltc, Tltc };
 export { Mantra, Tmantra };
diff --git a/modules/bitgo/tsconfig.json b/modules/bitgo/tsconfig.json
@@ -161,6 +161,9 @@
     {
       "path": "../sdk-coin-icp"
     },
+    {
+      "path": "../sdk-coin-init"
+    },
     {
       "path": "../sdk-coin-injective"
     },
diff --git a/modules/sdk-coin-init/.eslintignore b/modules/sdk-coin-init/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+.idea
+public
+dist
diff --git a/modules/sdk-coin-init/.gitignore b/modules/sdk-coin-init/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-init/.mocharc.yml b/modules/sdk-coin-init/.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-init/.npmignore b/modules/sdk-coin-init/.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-init/.prettierignore b/modules/sdk-coin-init/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-init/.prettierrc.yml b/modules/sdk-coin-init/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-init/README.md b/modules/sdk-coin-init/README.md
@@ -0,0 +1,30 @@
+# BitGo sdk-coin-init
+
+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-init`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-init
+```
+
+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 { Init } from '@bitgo/sdk-coin-init';
+
+const sdk = new BitGoAPI();
+
+sdk.register('init', Init.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-init/package.json b/modules/sdk-coin-init/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@bitgo/sdk-coin-init",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Initia",
+  "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-init"
+  },
+  "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-init/src/index.ts b/modules/sdk-coin-init/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './register';
+export * from './init';
+export * from './tinit';
diff --git a/modules/sdk-coin-init/src/init.ts b/modules/sdk-coin-init/src/init.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 Init 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 Init(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-init/src/lib/constants.ts b/modules/sdk-coin-init/src/lib/constants.ts
diff --git a/modules/sdk-coin-init/src/lib/index.ts b/modules/sdk-coin-init/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-init/src/lib/keyPair.ts b/modules/sdk-coin-init/src/lib/keyPair.ts
@@ -0,0 +1,16 @@
+import { KeyPairOptions } from '@bitgo/sdk-core';
+import { CosmosKeyPair } from '@bitgo/abstract-cosmos';
+
+/**
+ * Initia 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-init/src/lib/transactionBuilderFactory.ts b/modules/sdk-coin-init/src/lib/transactionBuilderFactory.ts
diff --git a/modules/sdk-coin-init/src/lib/utils.ts b/modules/sdk-coin-init/src/lib/utils.ts
diff --git a/modules/sdk-coin-init/src/register.ts b/modules/sdk-coin-init/src/register.ts
diff --git a/modules/sdk-coin-init/src/tinit.ts b/modules/sdk-coin-init/src/tinit.ts
diff --git a/modules/sdk-coin-init/test/unit/init.ts b/modules/sdk-coin-init/test/unit/init.ts
diff --git a/modules/sdk-coin-init/tsconfig.json b/modules/sdk-coin-init/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
`@@ -161,6 +161,9 @@`
`161`	`161`	`{`
`162`	`162`	`"path": "../sdk-coin-icp"`
`163`	`163`	`},`
	`164`	`+ {`
	`165`	`+ "path": "../sdk-coin-init"`
	`166`	`+ },`
`164`	`167`	`{`
`165`	`168`	`"path": "../sdk-coin-injective"`
`166`	`169`	`},`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +node_modules
 +.idea
 +public
 +dist