Merge pull request #5367 from BitGo/WIN-4245

mohd-kashif · web-flow · commit 29a0c84cec93 · 2025-01-20T14:40:34.000+05:30
feat(sdk-coin-icp): added ICP skeleton code
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -61,6 +61,7 @@
 /modules/sdk-coin-eos/ @BitGo/ethalt-team
 /modules/sdk-coin-ethlike/ @BitGo/ethalt-team
 /modules/sdk-coin-hbar/ @BitGo/ethalt-team
+/modules/sdk-coin-icp/ @BitGo/ethalt-team
 /modules/sdk-coin-near/ @BitGo/ethalt-team
 /modules/sdk-coin-oas/ @BitGo/ethalt-team
 /modules/sdk-coin-opeth/ @BitGo/ethalt-team
diff --git a/Dockerfile b/Dockerfile
@@ -76,6 +76,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-etc /var/modules/sdk-coin-etc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-eth2 /var/modules/sdk-coin-eth2/
 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-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-near /var/modules/sdk-coin-near/
diff --git a/modules/account-lib/package.json b/modules/account-lib/package.json
@@ -46,6 +46,7 @@
     "@bitgo/sdk-coin-eth2": "^3.0.58",
     "@bitgo/sdk-coin-hash": "^3.0.28",
     "@bitgo/sdk-coin-hbar": "^2.0.59",
+    "@bitgo/sdk-coin-icp": "^1.0.0",
     "@bitgo/sdk-coin-injective": "^3.0.28",
     "@bitgo/sdk-coin-islm": "^2.1.9",
     "@bitgo/sdk-coin-near": "^2.0.59",
diff --git a/modules/account-lib/src/index.ts b/modules/account-lib/src/index.ts
@@ -143,6 +143,9 @@ export { Coredao };
 import * as Apt from '@bitgo/sdk-coin-apt';
 export { Apt };
 
+import * as Icp from '@bitgo/sdk-coin-icp';
+export { Icp };
+
 const coinBuilderMap = {
   trx: Trx.WrappedBuilder,
   ttrx: Trx.WrappedBuilder,
@@ -219,6 +222,8 @@ const coinBuilderMap = {
   tcoredao: Coredao.TransactionBuilder,
   apt: Apt.TransactionBuilder,
   tapt: Apt.TransactionBuilder,
+  icp: Icp.TransactionBuilder,
+  ticp: Icp.TransactionBuilder,
 };
 
 /**
diff --git a/modules/account-lib/tsconfig.json b/modules/account-lib/tsconfig.json
@@ -61,6 +61,9 @@
     {
       "path": "../sdk-coin-hbar"
     },
+    {
+      "path": "../sdk-coin-icp"
+    },
     {
       "path": "../sdk-coin-injective"
     },
diff --git a/modules/bitgo/package.json b/modules/bitgo/package.json
@@ -79,6 +79,7 @@
     "@bitgo/sdk-coin-ethw": "^20.0.59",
     "@bitgo/sdk-coin-hash": "^3.0.28",
     "@bitgo/sdk-coin-hbar": "^2.0.59",
+    "@bitgo/sdk-coin-icp": "^1.0.0",
     "@bitgo/sdk-coin-injective": "^3.0.28",
     "@bitgo/sdk-coin-islm": "^2.1.9",
     "@bitgo/sdk-coin-lnbtc": "^1.1.37",
diff --git a/modules/bitgo/src/v2/coinFactory.ts b/modules/bitgo/src/v2/coinFactory.ts
@@ -53,6 +53,7 @@ import {
   Hash,
   Hbar,
   Hteth,
+  Icp,
   Injective,
   Islm,
   Lnbtc,
@@ -109,6 +110,7 @@ import {
   Thash,
   Thbar,
   Tia,
+  Ticp,
   Tinjective,
   Tislm,
   Tlnbtc,
@@ -184,6 +186,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('hteth', Hteth.createInstance);
   globalCoinFactory.register('lnbtc', Lnbtc.createInstance);
   globalCoinFactory.register('ltc', Ltc.createInstance);
+  globalCoinFactory.register('icp', Icp.createInstance);
   globalCoinFactory.register('injective', Injective.createInstance);
   globalCoinFactory.register('islm', Islm.createInstance);
   globalCoinFactory.register('near', Near.createInstance);
@@ -235,6 +238,7 @@ function registerCoinConstructors(globalCoinFactory: CoinFactory): void {
   globalCoinFactory.register('tfiatusd', TfiatUsd.createInstance);
   globalCoinFactory.register('thash', Thash.createInstance);
   globalCoinFactory.register('thbar', Thbar.createInstance);
+  globalCoinFactory.register('ticp', Ticp.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
@@ -30,6 +30,7 @@ import { Ethw } from '@bitgo/sdk-coin-ethw';
 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 { Injective, Tinjective } from '@bitgo/sdk-coin-injective';
 import { Islm, Tislm } from '@bitgo/sdk-coin-islm';
 import { Lnbtc, Tlnbtc } from '@bitgo/sdk-coin-lnbtc';
@@ -86,6 +87,7 @@ export { EthLikeCoin, TethLikeCoin };
 export { Etc, Tetc };
 export { Hash, Thash };
 export { Hbar, Thbar };
+export { Icp, Ticp };
 export { Lnbtc, Tlnbtc };
 export { Ltc, Tltc };
 export { Oas, Toas };
diff --git a/modules/bitgo/tsconfig.json b/modules/bitgo/tsconfig.json
@@ -153,6 +153,9 @@
     {
       "path": "../sdk-coin-hbar"
     },
+    {
+      "path": "../sdk-coin-icp"
+    },
     {
       "path": "../sdk-coin-injective"
     },
diff --git a/modules/sdk-coin-icp/.eslintignore b/modules/sdk-coin-icp/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+.idea
+public
+dist
diff --git a/modules/sdk-coin-icp/.gitignore b/modules/sdk-coin-icp/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-icp/.mocharc.yml b/modules/sdk-coin-icp/.mocharc.yml
@@ -0,0 +1,8 @@
+require: 'ts-node/register'
+timeout: 120000
+reporter: 'min'
+reporter-option:
+  - 'cdn=true'
+  - 'json=false'
+exit: true
+spec: ['test/unit/**/*.ts']
diff --git a/modules/sdk-coin-icp/.npmignore b/modules/sdk-coin-icp/.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-icp/.prettierignore b/modules/sdk-coin-icp/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-icp/.prettierrc.yml b/modules/sdk-coin-icp/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-icp/README.md b/modules/sdk-coin-icp/README.md
@@ -0,0 +1,30 @@
+# BitGo sdk-coin-icp
+
+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-icp`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-icp
+```
+
+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 { Icp } from '@bitgo/sdk-coin-icp';
+
+const sdk = new BitGoAPI();
+
+sdk.register('icp', Icp.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-icp/package.json b/modules/sdk-coin-icp/package.json
@@ -0,0 +1,50 @@
+{
+  "name": "@bitgo/sdk-coin-icp",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Internet Computer",
+  "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-icp"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/sdk-core": "^28.19.1",
+    "@bitgo/statics": "^50.19.0"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.58.1",
+    "@bitgo/sdk-test": "^8.0.64"
+  }
+}
diff --git a/modules/sdk-coin-icp/src/icp.ts b/modules/sdk-coin-icp/src/icp.ts
@@ -0,0 +1,99 @@
+import {
+  BaseCoin,
+  BitGoBase,
+  MPCAlgorithm,
+  VerifyTransactionOptions,
+  TssVerifyAddressOptions,
+  ParseTransactionOptions,
+  ParsedTransaction,
+  KeyPair,
+  SignTransactionOptions,
+  SignedTransaction,
+} from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+
+/**
+ * Class representing the Internet Computer (ICP) coin.
+ * Extends the BaseCoin class and provides specific implementations for ICP.
+ *
+ * @see {@link https://internetcomputer.org/}
+ * @see {@link https://internetcomputer.org/docs/current/developer-docs/defi/rosetta/icp_rosetta/data_api/}
+ */
+export class Icp extends BaseCoin {
+  protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo);
+
+    if (!staticsCoin) {
+      throw new Error('missing required constructor parameter staticsCoin');
+    }
+
+    this._staticsCoin = staticsCoin;
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Icp(bitgo, staticsCoin);
+  }
+
+  getChain(): string {
+    return 'icp';
+  }
+
+  getBaseChain(): string {
+    return 'icp';
+  }
+
+  getFamily(): string {
+    return 'icp';
+  }
+
+  getFullName(): string {
+    return 'Internet Computer';
+  }
+
+  getBaseFactor(): number {
+    return Math.pow(10, this._staticsCoin.decimalPlaces);
+  }
+
+  async verifyTransaction(params: VerifyTransactionOptions): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  async isWalletAddress(params: TssVerifyAddressOptions): Promise<boolean> {
+    throw new Error('Method not implemented.');
+  }
+
+  async parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
+    throw new Error('Method not implemented.');
+  }
+
+  generateKeyPair(seed?: Buffer): KeyPair {
+    throw new Error('Method not implemented.');
+  }
+
+  isValidAddress(address: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  signTransaction(_: SignTransactionOptions): Promise<SignedTransaction> {
+    throw new Error('Method not implemented.');
+  }
+
+  isValidPub(_: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  isValidPrv(_: string): boolean {
+    throw new Error('Method not implemented.');
+  }
+
+  /** @inheritDoc */
+  supportsTss(): boolean {
+    return true;
+  }
+
+  /** @inheritDoc */
+  getMPCAlgorithm(): MPCAlgorithm {
+    return 'ecdsa';
+  }
+}
diff --git a/modules/sdk-coin-icp/src/index.ts b/modules/sdk-coin-icp/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './icp';
+export * from './ticp';
+export * from './register';
diff --git a/modules/sdk-coin-icp/src/lib/index.ts b/modules/sdk-coin-icp/src/lib/index.ts
@@ -0,0 +1,5 @@
+import * as Utils from './utils';
+
+export { TransactionBuilder } from './transactionBuilder';
+export { TransferBuilder } from './transferBuilder';
+export { Utils };
diff --git a/modules/sdk-coin-icp/src/lib/transactionBuilder.ts b/modules/sdk-coin-icp/src/lib/transactionBuilder.ts
diff --git a/modules/sdk-coin-icp/src/lib/transactionBuilderFactory.ts b/modules/sdk-coin-icp/src/lib/transactionBuilderFactory.ts
diff --git a/modules/sdk-coin-icp/src/lib/transferBuilder.ts b/modules/sdk-coin-icp/src/lib/transferBuilder.ts
diff --git a/modules/sdk-coin-icp/src/lib/utils.ts b/modules/sdk-coin-icp/src/lib/utils.ts
diff --git a/modules/sdk-coin-icp/src/register.ts b/modules/sdk-coin-icp/src/register.ts
diff --git a/modules/sdk-coin-icp/src/ticp.ts b/modules/sdk-coin-icp/src/ticp.ts
diff --git a/modules/sdk-coin-icp/test/unit/icp.ts b/modules/sdk-coin-icp/test/unit/icp.ts
diff --git a/modules/sdk-coin-icp/tsconfig.json b/modules/sdk-coin-icp/tsconfig.json
diff --git a/tsconfig.packages.json b/tsconfig.packages.json

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,9 @@`
`61`	`61`	`{`
`62`	`62`	`"path": "../sdk-coin-hbar"`
`63`	`63`	`},`
	`64`	`+ {`
	`65`	`+ "path": "../sdk-coin-icp"`
	`66`	`+ },`
`64`	`67`	`{`
`65`	`68`	`"path": "../sdk-coin-injective"`
`66`	`69`	`},`
Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,9 @@`
`153`	`153`	`{`
`154`	`154`	`"path": "../sdk-coin-hbar"`
`155`	`155`	`},`
	`156`	`+ {`
	`157`	`+ "path": "../sdk-coin-icp"`
	`158`	`+ },`
`156`	`159`	`{`
`157`	`160`	`"path": "../sdk-coin-injective"`
`158`	`161`	`},`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +node_modules
 +.idea
 +public
 +dist