Merge pull request #5416 from BitGo/WIN-4180-sgb-txn-builder

yogeshwar-bitgo · web-flow · commit f23039b67e10 · 2025-01-23T21:23:04.000+05:30
feat(sdk-coin-sgb): add transaction builder
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -60,6 +60,7 @@
 /modules/sdk-coin-cspr/ @BitGo/ethalt-team
 /modules/sdk-coin-dot/ @BitGo/ethalt-team
 /modules/sdk-coin-eos/ @BitGo/ethalt-team
+/modules/sdk-coin-flr/ @BitGo/ethalt-team
 /modules/sdk-coin-ethlike/ @BitGo/ethalt-team
 /modules/sdk-coin-hbar/ @BitGo/ethalt-team
 /modules/sdk-coin-icp/ @BitGo/ethalt-team
@@ -68,12 +69,14 @@
 /modules/sdk-coin-opeth/ @BitGo/ethalt-team
 /modules/sdk-coin-polygon/ @BitGo/ethalt-team
 /modules/sdk-coin-rune/ @BitGo/ethalt-team
+/modules/sdk-coin-sgb/ @BitGo/ethalt-team
 /modules/sdk-coin-sol/ @BitGo/ethalt-team
 /modules/sdk-coin-stx/ @BitGo/ethalt-team
 /modules/sdk-coin-sui/ @BitGo/ethalt-team
 /modules/sdk-coin-tao/ @BitGo/ethalt-team
 /modules/sdk-coin-ton/ @BitGo/ethalt-team
 /modules/sdk-coin-trx/ @BitGo/ethalt-team
+/modules/sdk-coin-xdc/ @BitGo/ethalt-team
 /modules/sdk-coin-xlm/ @BitGo/ethalt-team
 /modules/sdk-coin-xrp/ @BitGo/ethalt-team
 /modules/sdk-coin-xtz/ @BitGo/ethalt-team
diff --git a/modules/sdk-coin-sgb/.eslintignore b/modules/sdk-coin-sgb/.eslintignore
@@ -0,0 +1,5 @@
+node_modules
+.idea
+public
+dist
+
diff --git a/modules/sdk-coin-sgb/.gitignore b/modules/sdk-coin-sgb/.gitignore
@@ -0,0 +1,3 @@
+node_modules/
+.idea/
+dist/
diff --git a/modules/sdk-coin-sgb/.mocharc.yml b/modules/sdk-coin-sgb/.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-sgb/.npmignore b/modules/sdk-coin-sgb/.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-sgb/.prettierignore b/modules/sdk-coin-sgb/.prettierignore
@@ -0,0 +1,2 @@
+.nyc_output/
+dist/
diff --git a/modules/sdk-coin-sgb/.prettierrc.yml b/modules/sdk-coin-sgb/.prettierrc.yml
@@ -0,0 +1,3 @@
+printWidth: 120
+singleQuote: true
+trailingComma: 'es5'
diff --git a/modules/sdk-coin-sgb/CHANGELOG.md b/modules/sdk-coin-sgb/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+**Note:** Version bump only for package @bitgo/sdk-coin-sgb
+
+### Features
diff --git a/modules/sdk-coin-sgb/README.md b/modules/sdk-coin-sgb/README.md
@@ -0,0 +1,30 @@
+# BitGo sdk-coin-sgb
+
+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-sgb`.
+
+```shell
+npm i @bitgo/sdk-api @bitgo/sdk-coin-sgb
+```
+
+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 { sgb } from '@bitgo/sdk-coin-sgb';
+
+const sdk = new BitGoAPI();
+
+sdk.register('sgb', sgb.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-sgb/package.json b/modules/sdk-coin-sgb/package.json
@@ -0,0 +1,52 @@
+{
+  "name": "@bitgo/sdk-coin-sgb",
+  "version": "1.0.0",
+  "description": "BitGo SDK coin library for Sgb",
+  "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-sgb"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo/abstract-eth": "^22.4.10",
+    "@bitgo/sdk-core": "^28.20.0",
+    "@bitgo/statics": "^50.20.0",
+    "@ethereumjs/common": "^2.6.5"
+  },
+  "devDependencies": {
+    "@bitgo/sdk-api": "^1.58.2",
+    "@bitgo/sdk-test": "^8.0.65"
+  }
+}
diff --git a/modules/sdk-coin-sgb/src/index.ts b/modules/sdk-coin-sgb/src/index.ts
@@ -0,0 +1,4 @@
+export * from './lib';
+export * from './sgb';
+export * from './tsgb';
+export * from './register';
diff --git a/modules/sdk-coin-sgb/src/lib/index.ts b/modules/sdk-coin-sgb/src/lib/index.ts
@@ -0,0 +1,6 @@
+import * as Utils from './utils';
+
+export { TransactionBuilder } from './transactionBuilder';
+export { TransferBuilder } from './transferBuilder';
+export { Transaction, KeyPair } from '@bitgo/abstract-eth';
+export { Utils };
diff --git a/modules/sdk-coin-sgb/src/lib/resources.ts b/modules/sdk-coin-sgb/src/lib/resources.ts
@@ -0,0 +1,28 @@
+import EthereumCommon from '@ethereumjs/common';
+import { coins, EthereumNetwork } from '@bitgo/statics';
+
+export const testnetCommon = EthereumCommon.custom(
+  {
+    name: 'sgb testnet',
+    networkId: (coins.get('tsgb').network as EthereumNetwork).chainId,
+    chainId: (coins.get('tsgb').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'sepolia',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
+
+export const mainnetCommon = EthereumCommon.custom(
+  {
+    name: 'sgb mainnet',
+    networkId: (coins.get('sgb').network as EthereumNetwork).chainId,
+    chainId: (coins.get('sgb').network as EthereumNetwork).chainId,
+  },
+  {
+    baseChain: 'mainnet',
+    hardfork: 'london',
+    eips: [1559],
+  }
+);
diff --git a/modules/sdk-coin-sgb/src/lib/transactionBuilder.ts b/modules/sdk-coin-sgb/src/lib/transactionBuilder.ts
@@ -0,0 +1,30 @@
+import { BaseCoin as CoinConfig } from '@bitgo/statics';
+import { BuildTransactionError, TransactionType } from '@bitgo/sdk-core';
+import { TransactionBuilder as AbstractTransactionBuilder, Transaction } from '@bitgo/abstract-eth';
+import { getCommon } from './utils';
+import { TransferBuilder } from './transferBuilder';
+
+export class TransactionBuilder extends AbstractTransactionBuilder {
+  protected _transfer: TransferBuilder;
+
+  constructor(_coinConfig: Readonly<CoinConfig>) {
+    super(_coinConfig);
+    this._common = getCommon(this._coinConfig.network.type);
+    this.transaction = new Transaction(this._coinConfig, this._common);
+  }
+
+  /** @inheritdoc */
+  transfer(data?: string): TransferBuilder {
+    if (this._type !== TransactionType.Send) {
+      throw new BuildTransactionError('Transfers can only be set for send transactions');
+    }
+    if (!this._transfer) {
+      this._transfer = new TransferBuilder(data);
+    }
+    return this._transfer;
+  }
+
+  protected getContractData(addresses: string[]): string {
+    throw new Error('Method not implemented.');
+  }
+}
diff --git a/modules/sdk-coin-sgb/src/lib/transferBuilder.ts b/modules/sdk-coin-sgb/src/lib/transferBuilder.ts
@@ -0,0 +1 @@
+export { TransferBuilder } from '@bitgo/abstract-eth';
diff --git a/modules/sdk-coin-sgb/src/lib/utils.ts b/modules/sdk-coin-sgb/src/lib/utils.ts
@@ -0,0 +1,21 @@
+import { NetworkType } from '@bitgo/statics';
+import EthereumCommon from '@ethereumjs/common';
+import { InvalidTransactionError } from '@bitgo/sdk-core';
+import { testnetCommon, mainnetCommon } from './resources';
+
+const commons: Map<NetworkType, EthereumCommon> = new Map<NetworkType, EthereumCommon>([
+  [NetworkType.MAINNET, mainnetCommon],
+  [NetworkType.TESTNET, testnetCommon],
+]);
+
+/**
+ * @param {NetworkType} network either mainnet or testnet
+ * @returns {EthereumCommon} Ethereum common configuration object
+ */
+export function getCommon(network: NetworkType): EthereumCommon {
+  const common = commons.get(network);
+  if (!common) {
+    throw new InvalidTransactionError('Missing network common configuration');
+  }
+  return common;
+}
diff --git a/modules/sdk-coin-sgb/src/register.ts b/modules/sdk-coin-sgb/src/register.ts
@@ -0,0 +1,8 @@
+import { BitGoBase } from '@bitgo/sdk-core';
+import { Sgb } from './sgb';
+import { Tsgb } from './tsgb';
+
+export const register = (sdk: BitGoBase): void => {
+  sdk.register('sgb', Sgb.createInstance);
+  sdk.register('tsgb', Tsgb.createInstance);
+};
diff --git a/modules/sdk-coin-sgb/src/sgb.ts b/modules/sdk-coin-sgb/src/sgb.ts
@@ -0,0 +1,42 @@
+/***
+ * @developerReferences
+ * - Developer Hub: https://dev.flare.network/
+ * - Doc: https://docs.flare.network/user/wallets/
+ * @coinFullName Songbird
+ * @coinWebsite https://songbird-explorer.flare.network
+ */
+
+import { BaseCoin, BitGoBase, common, MPCAlgorithm } from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin, coins } from '@bitgo/statics';
+import { AbstractEthLikeNewCoins, recoveryBlockchainExplorerQuery } from '@bitgo/abstract-eth';
+import { TransactionBuilder } from './lib';
+
+export class Sgb extends AbstractEthLikeNewCoins {
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo, staticsCoin);
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Sgb(bitgo, staticsCoin);
+  }
+
+  protected getTransactionBuilder(): TransactionBuilder {
+    return new TransactionBuilder(coins.get(this.getBaseChain()));
+  }
+
+  /** @inheritDoc */
+  supportsTss(): boolean {
+    return true;
+  }
+
+  /** @inheritDoc */
+  getMPCAlgorithm(): MPCAlgorithm {
+    return 'ecdsa';
+  }
+
+  async recoveryBlockchainExplorerQuery(query: Record<string, string>): Promise<Record<string, unknown>> {
+    const apiToken = common.Environments[this.bitgo.getEnv()].sgbExplorerApiToken;
+    const explorerUrl = common.Environments[this.bitgo.getEnv()].sgbExplorerBaseUrl;
+    return await recoveryBlockchainExplorerQuery(query, explorerUrl as string, apiToken);
+  }
+}
diff --git a/modules/sdk-coin-sgb/src/tsgb.ts b/modules/sdk-coin-sgb/src/tsgb.ts
@@ -0,0 +1,18 @@
+/**
+ * Testnet Sgb
+ *
+ * @format
+ */
+import { BaseCoin, BitGoBase } from '@bitgo/sdk-core';
+import { BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+import { Sgb } from './sgb';
+
+export class Tsgb extends Sgb {
+  protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
+    super(bitgo, staticsCoin);
+  }
+
+  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
+    return new Tsgb(bitgo, staticsCoin);
+  }
+}
diff --git a/modules/sdk-coin-sgb/test/unit/getBuilder.ts b/modules/sdk-coin-sgb/test/unit/getBuilder.ts
@@ -0,0 +1,6 @@
+import { TransactionBuilder } from '../../src';
+import { coins } from '@bitgo/statics';
+
+export const getBuilder = (coin: string): TransactionBuilder => {
+  return new TransactionBuilder(coins.get(coin));
+};
diff --git a/modules/sdk-coin-sgb/test/unit/sgb.ts b/modules/sdk-coin-sgb/test/unit/sgb.ts
@@ -0,0 +1,42 @@
+import 'should';
+
+import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
+import { BitGoAPI } from '@bitgo/sdk-api';
+
+import { Sgb, Tsgb } from '../../src/index';
+
+const bitgo: TestBitGoAPI = TestBitGo.decorate(BitGoAPI, { env: 'test' });
+
+describe('sgb', function () {
+  before(function () {
+    bitgo.safeRegister('sgb', Sgb.createInstance);
+    bitgo.safeRegister('tsgb', Tsgb.createInstance);
+    bitgo.initializeTestVars();
+  });
+
+  describe('Basic Coin Info', function () {
+    it('should return the right info for sgb', function () {
+      const sgb = bitgo.coin('sgb');
+
+      sgb.should.be.an.instanceof(Sgb);
+      sgb.getChain().should.equal('sgb');
+      sgb.getFamily().should.equal('sgb');
+      sgb.getFullName().should.equal('Songbird');
+      sgb.getBaseFactor().should.equal(1e18);
+      sgb.supportsTss().should.equal(true);
+      sgb.allowsAccountConsolidations().should.equal(false);
+    });
+
+    it('should return the right info for tsgb', function () {
+      const tsgb = bitgo.coin('tsgb');
+
+      tsgb.should.be.an.instanceof(Tsgb);
+      tsgb.getChain().should.equal('tsgb');
+      tsgb.getFamily().should.equal('sgb');
+      tsgb.getFullName().should.equal('Testnet songbird chain');
+      tsgb.getBaseFactor().should.equal(1e18);
+      tsgb.supportsTss().should.equal(true);
+      tsgb.allowsAccountConsolidations().should.equal(false);
+    });
+  });
+});
diff --git a/modules/sdk-coin-sgb/test/unit/transactionBuilder/send.ts b/modules/sdk-coin-sgb/test/unit/transactionBuilder/send.ts
@@ -0,0 +1,16 @@
+import { getBuilder } from '../getBuilder';
+import should from 'should';
+
+describe('Sgb Transfer Builder', () => {
+  describe('Build from TxHex', function () {
+    it('Should successfully build from txHex', async function () {
+      const txBuilder = getBuilder('tsgb');
+      const txHex =
+        '0xf86c038505d21dba00825208944943dd2a2494e3ea5937954cb836692a047695b5880de0b6b3a76400008044a015a6462b8a8d84cd3a495cba311281c565fd0502673e1783e0824fd5f807a68ca074c0525384fe579b52526a2f242b897b12cdb79519c8215d0d4346ae14a36cbb';
+      txBuilder.from(txHex);
+      const parsedTx = await txBuilder.build();
+
+      should.exist(parsedTx.toJson());
+    });
+  });
+});
diff --git a/modules/sdk-coin-sgb/test/unit/utils.ts b/modules/sdk-coin-sgb/test/unit/utils.ts
diff --git a/modules/sdk-coin-sgb/tsconfig.json b/modules/sdk-coin-sgb/tsconfig.json
diff --git a/modules/sdk-core/src/bitgo/environments.ts b/modules/sdk-core/src/bitgo/environments.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +node_modules
 +.idea
 +public
 +dist
++
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+printWidth: 120`
	`2`	`+singleQuote: true`
	`3`	`+trailingComma: 'es5'`