Merge pull request #6139 from BitGo/coin-3934-vechain-skeleton-2

mohitkh7 · web-flow · commit 3a5bd3321fdc · 2025-05-20T11:09:07.000+05:30
feat(sdk-coin-vet): add sdk skeleton for vet
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -84,6 +84,7 @@
 /modules/sdk-coin-tao/ @BitGo/ethalt-team
 /modules/sdk-coin-ton/ @BitGo/ethalt-team
 /modules/sdk-coin-trx/ @BitGo/ethalt-team
+/modules/sdk-coin-vet/ @Bitgo/ethalt-team
 /modules/sdk-coin-wemix/ @BitGo/ethalt-team
 /modules/sdk-coin-world/ @BitGo/ethalt-team
 /modules/sdk-coin-xdc/ @BitGo/ethalt-team
diff --git a/Dockerfile b/Dockerfile
@@ -129,6 +129,7 @@ COPY --from=builder /tmp/bitgo/modules/sdk-coin-ltc /var/modules/sdk-coin-ltc/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-polyx /var/modules/sdk-coin-polyx/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-xlm /var/modules/sdk-coin-xlm/
 COPY --from=builder /tmp/bitgo/modules/sdk-coin-zec /var/modules/sdk-coin-zec/
+COPY --from=builder /tmp/bitgo/modules/sdk-coin-vet /var/modules/sdk-coin-vet/
 
 RUN cd /var/modules/abstract-lightning && yarn link && \
 cd /var/modules/sdk-core && yarn link && \
@@ -220,7 +221,8 @@ cd /var/modules/sdk-coin-lnbtc && yarn link && \
 cd /var/modules/sdk-coin-ltc && yarn link && \
 cd /var/modules/sdk-coin-polyx && yarn link && \
 cd /var/modules/sdk-coin-xlm && yarn link && \
-cd /var/modules/sdk-coin-zec && yarn link
+cd /var/modules/sdk-coin-zec && yarn link && \
+cd /var/modules/sdk-coin-vet && yarn link
 #COPY_END
 
 #LINK_START
@@ -315,7 +317,8 @@ RUN cd /var/bitgo-express && \
     yarn link @bitgo/sdk-coin-ltc && \
     yarn link @bitgo/sdk-coin-polyx && \
     yarn link @bitgo/sdk-coin-xlm && \
-    yarn link @bitgo/sdk-coin-zec
+    yarn link @bitgo/sdk-coin-zec && \
+    yarn link @bitgo/sdk-coin-vet
 #LINK_END
 
 #LABEL_START
diff --git a/modules/bitgo/package.json b/modules/bitgo/package.json
@@ -109,6 +109,7 @@
     "@bitgo/sdk-coin-tia": "^3.0.48",
     "@bitgo/sdk-coin-ton": "^3.5.2",
     "@bitgo/sdk-coin-trx": "^3.0.1",
+    "@bitgo/sdk-coin-vet": "^1.0.0",
     "@bitgo/sdk-coin-wemix": "^1.2.3",
     "@bitgo/sdk-coin-world": "^1.1.2",
     "@bitgo/sdk-coin-xdc": "^1.2.3",
diff --git a/modules/bitgo/src/v2/coinFactory.ts b/modules/bitgo/src/v2/coinFactory.ts
@@ -161,13 +161,15 @@ import {
   Ttia,
   Tton,
   Ttrx,
+  Tvet,
   Txlm,
   Txdc,
   Txrp,
   Txtz,
   Tzec,
   Tzeta,
   Tzketh,
+  Vet,
   Wemix,
   World,
   Xdc,
@@ -318,6 +320,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('ttia', Ttia.createInstance);
   coinFactory.register('tton', Tton.createInstance);
   coinFactory.register('ttrx', Ttrx.createInstance);
+  coinFactory.register('tvet', Tvet.createInstance);
   coinFactory.register('txdc', Txdc.createInstance);
   coinFactory.register('txlm', Txlm.createInstance);
   coinFactory.register('txrp', Txrp.createInstance);
@@ -327,6 +330,7 @@ export function registerCoinConstructors(coinFactory: CoinFactory, coinMap: Coin
   coinFactory.register('tzketh', Tzketh.createInstance);
   coinFactory.register('twemix', Twemix.createInstance);
   coinFactory.register('tworld', Tworld.createInstance);
+  coinFactory.register('vet', Vet.createInstance);
   coinFactory.register('xdc', Xdc.createInstance);
   coinFactory.register('xlm', Xlm.createInstance);
   coinFactory.register('xrp', Xrp.createInstance);
diff --git a/modules/bitgo/src/v2/coins/index.ts b/modules/bitgo/src/v2/coins/index.ts
@@ -60,6 +60,7 @@ import { Tia, Ttia } from '@bitgo/sdk-coin-tia';
 import { Ton, Tton } from '@bitgo/sdk-coin-ton';
 import { Trx, Ttrx } from '@bitgo/sdk-coin-trx';
 import { StellarToken, Txlm, Xlm } from '@bitgo/sdk-coin-xlm';
+import { Vet, Tvet } from '@bitgo/sdk-coin-vet';
 import { Wemix, Twemix } from '@bitgo/sdk-coin-wemix';
 import { World, Tworld } from '@bitgo/sdk-coin-world';
 import { Xdc, Txdc } from '@bitgo/sdk-coin-xdc';
@@ -130,6 +131,7 @@ export { Sei, Tsei };
 export { Injective, Tinjective };
 export { Islm, Tislm };
 export { Trx, Ttrx };
+export { Vet, Tvet };
 export { Xdc, Txdc };
 export { StellarToken, Txlm, Xlm };
 export { Txrp, Xrp, XrpToken };
diff --git a/modules/bitgo/tsconfig.json b/modules/bitgo/tsconfig.json
@@ -230,6 +230,9 @@
     {
       "path": "../sdk-coin-trx"
     },
+    {
+      "path": "../sdk-coin-vet"
+    },
     {
       "path": "../sdk-coin-wemix"
     },
diff --git a/modules/sdk-coin-vet/.eslintignore b/modules/sdk-coin-vet/.eslintignore
@@ -0,0 +1,5 @@
+node_modules
+.idea
+public
+dist
+
diff --git a/modules/sdk-coin-vet/.gitignore b/modules/sdk-coin-vet/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-vet/.mocharc.yml b/modules/sdk-coin-vet/.mocharc.yml
@@ -0,0 +1,8 @@
+require: 'ts-node/register'
+timeout: '10000'
+reporter: 'min'
+reporter-option:
+  - 'cdn=true'
+  - 'json=false'
+exit: true
+spec: ['test/unit/**/*.ts']
diff --git a/modules/sdk-coin-vet/.npmignore b/modules/sdk-coin-vet/.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-vet/.prettierignore b/modules/sdk-coin-vet/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-vet/.prettierrc.yml b/modules/sdk-coin-vet/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-vet/README.md b/modules/sdk-coin-vet/README.md
@@ -0,0 +1,30 @@
+# BitGo sdk-coin-vet
+
+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-vet`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-vet
+```
+
+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 { Vet } from '@bitgo/sdk-coin-vet';
+
+const sdk = new BitGoAPI();
+
+sdk.register('vet', Vet.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-vet/package.json b/modules/sdk-coin-vet/package.json
@@ -0,0 +1,50 @@
+{
+  "name": "@bitgo/sdk-coin-vet",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for VeChain",
+  "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-vet"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/sdk-core": "^33.2.0",
+    "@bitgo/statics": "^52.2.0"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.62.3",
+    "@bitgo/sdk-test": "^8.0.84"
+  }
+}
diff --git a/modules/sdk-coin-vet/src/index.ts b/modules/sdk-coin-vet/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './vet';
+export * from './tvet';
+export * from './register';
diff --git a/modules/sdk-coin-vet/src/lib/constants.ts b/modules/sdk-coin-vet/src/lib/constants.ts
@@ -0,0 +1 @@
+export const DEFAULT_GAS_UNIT_PRICE = 100;
diff --git a/modules/sdk-coin-vet/src/lib/index.ts b/modules/sdk-coin-vet/src/lib/index.ts
@@ -0,0 +1,4 @@
+import * as Constants from './constants';
+import * as Utils from './utils';
+
+export { Constants, Utils };
diff --git a/modules/sdk-coin-vet/src/lib/utils.ts b/modules/sdk-coin-vet/src/lib/utils.ts
@@ -0,0 +1,31 @@
+import { BaseUtils } from '@bitgo/sdk-core';
+
+export class Utils implements BaseUtils {
+  isValidAddress(address: string): boolean {
+    throw new Error('Method not implemented');
+  }
+
+  isValidBlockId(hash: string): boolean {
+    throw new Error('Method not implemented');
+  }
+
+  isValidPrivateKey(key: string): boolean {
+    throw new Error('Method not implemented');
+  }
+
+  isValidPublicKey(key: string): boolean {
+    throw new Error('Method not implemented');
+  }
+
+  isValidSignature(signature: string): boolean {
+    throw new Error('Method not implemented');
+  }
+
+  isValidTransactionId(txId: string): boolean {
+    throw new Error('Method not implemented');
+  }
+}
+
+const utils = new Utils();
+
+export default utils;
diff --git a/modules/sdk-coin-vet/src/register.ts b/modules/sdk-coin-vet/src/register.ts
@@ -0,0 +1,8 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { Vet } from './vet';
+import { Tvet } from './tvet';
+
+export const register = (sdk: BitGoBase): void => {
+  sdk.register('vet', Vet.createInstance);
+  sdk.register('tvet', Tvet.createInstance);
+};
diff --git a/modules/sdk-coin-vet/src/tvet.ts b/modules/sdk-coin-vet/src/tvet.ts
@@ -0,0 +1,37 @@
+/**
+ * Testnet Vechain
+ */
+import { BaseCoin, BitGoBase } from '@bitgo/sdk-core';
+import { Vet } from './vet';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+
+export class Tvet extends Vet {
+  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 Tvet(bitgo, staticsCoin);
+  }
+
+  /**
+   * Identifier for the blockchain which supports this coin
+   */
+  public getChain(): string {
+    return 'tvet';
+  }
+
+  /**
+   * Complete human-readable name of this coin
+   */
+  public getFullName(): string {
+    return 'Testnet VeChain';
+  }
+}
diff --git a/modules/sdk-coin-vet/src/vet.ts b/modules/sdk-coin-vet/src/vet.ts
diff --git a/modules/sdk-coin-vet/test/resources/vet.ts b/modules/sdk-coin-vet/test/resources/vet.ts
diff --git a/modules/sdk-coin-vet/test/unit/vet.ts b/modules/sdk-coin-vet/test/unit/vet.ts
diff --git a/modules/sdk-coin-vet/tsconfig.json b/modules/sdk-coin-vet/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
`@@ -230,6 +230,9 @@`
`230`	`230`	`{`
`231`	`231`	`"path": "../sdk-coin-trx"`
`232`	`232`	`},`
	`233`	`+ {`
	`234`	`+ "path": "../sdk-coin-vet"`
	`235`	`+ },`
`233`	`236`	`{`
`234`	`237`	`"path": "../sdk-coin-wemix"`
`235`	`238`	`},`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +node_modules
 +.idea
 +public
 +dist
++