Merge pull request #5514 from BitGo/WIN-4302-2

fix(tao): fix abstract-substrate implementation

Author: hitansh-madan

modules/abstract-substrate/package.json

@@ -46,8 +46,11 @@
     "@polkadot/util-crypto": "13.3.1",
     "@substrate/txwrapper-core": "7.5.2",
     "@substrate/txwrapper-polkadot": "7.5.2",
+    "@substrate/txwrapper-registry": "7.5.3",
+    "bignumber.js": "^9.1.2",
     "bs58": "^4.0.1",
     "hi-base32": "^0.5.1",
+    "joi": "^17.4.0",
     "lodash": "^4.17.15",
     "tweetnacl": "^1.0.3"
   },

modules/abstract-substrate/src/abstractSubstrateCoin.ts

@@ -1,4 +1,3 @@
-import * as _ from 'lodash';
 import {
   BaseCoin,
   BitGoBase,
@@ -7,43 +6,17 @@ import {
   ParsedTransaction,
   ParseTransactionOptions,
   SignedTransaction,
-  SignTransactionOptions as BaseSignTransactionOptions,
   VerifyAddressOptions,
   VerifyTransactionOptions,
 } from '@bitgo/sdk-core';
-import { BaseCoin as StaticsBaseCoin, CoinFamily } from '@bitgo/statics';
-import { Interface, KeyPair as SubstrateKeyPair, Utils } from './lib';
-
-const utils = Utils.default;
-
-export const DEFAULT_SCAN_FACTOR = 20; // default number of receive addresses to scan for funds
-
-export interface SignTransactionOptions extends BaseSignTransactionOptions {
-  txPrebuild: TransactionPrebuild;
-  prv: string;
-}
-
-export interface TransactionPrebuild {
-  txHex: string;
-  transaction: Interface.TxData;
-}
-
-export interface ExplainTransactionOptions {
-  txPrebuild: TransactionPrebuild;
-  publicKey: string;
-  feeInfo: {
-    fee: string;
-  };
-}
-
-export interface VerifiedTransactionParameters {
-  txHex: string;
-  prv: string;
-}
+import { CoinFamily, BaseCoin as StaticsBaseCoin } from '@bitgo/statics';
+import { KeyPair as SubstrateKeyPair } from './lib';
+import { DEFAULT_SUBSTRATE_PREFIX } from './lib/constants';
+import { SignTransactionOptions, VerifiedTransactionParameters } from './lib/iface';
+import utils from './lib/utils';
 
 export class SubstrateCoin extends BaseCoin {
   protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
-  readonly MAX_VALIDITY_DURATION = 2400;
 
   protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
     super(bitgo);
@@ -55,10 +28,6 @@ export class SubstrateCoin extends BaseCoin {
     this._staticsCoin = staticsCoin;
   }
 
-  static createInstance(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>): BaseCoin {
-    return new SubstrateCoin(bitgo, staticsCoin);
-  }
-
   /**
    * Creates an instance of TransactionBuilderFactory for the coin specific sdk
    */
@@ -98,7 +67,7 @@ export class SubstrateCoin extends BaseCoin {
 
   /** @inheritDoc **/
   generateKeyPair(seed?: Buffer): KeyPair {
-    const keyPair = seed ? utils.keyPairFromSeed(new Uint8Array(seed)) : new SubstrateKeyPair();
+    const keyPair = seed ? new SubstrateKeyPair({ seed }) : new SubstrateKeyPair();
     const keys = keyPair.getKeys();
     if (!keys.prv) {
       throw new Error('Missing prv in key generation.');
@@ -120,8 +89,8 @@ export class SubstrateCoin extends BaseCoin {
   }
 
   /** @inheritDoc **/
-  parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
-    throw new Error('Method not implemented');
+  async parseTransaction(params: ParseTransactionOptions): Promise<ParsedTransaction> {
+    return {};
   }
 
   /** @inheritDoc **/
@@ -141,28 +110,15 @@ export class SubstrateCoin extends BaseCoin {
   }
 
   verifySignTransactionParams(params: SignTransactionOptions): VerifiedTransactionParameters {
-    const prv = params.prv;
-
-    const txHex = params.txPrebuild.txHex;
+    const prv = params?.prv;
+    const txHex = params?.txPrebuild?.txHex;
 
-    if (!txHex) {
-      throw new Error('missing txPrebuild parameter');
+    if (typeof txHex !== 'string') {
+      throw new Error(`txHex must be string, got type ${typeof txHex}`);
     }
 
-    if (!_.isString(txHex)) {
-      throw new Error(`txPrebuild must be an object, got type ${typeof txHex}`);
-    }
-
-    if (!prv) {
-      throw new Error('missing prv parameter to sign transaction');
-    }
-
-    if (!_.isString(prv)) {
-      throw new Error(`prv must be a string, got type ${typeof prv}`);
-    }
-
-    if (!_.has(params, 'pubs')) {
-      throw new Error('missing public key parameter to sign transaction');
+    if (typeof prv !== 'string') {
+      throw new Error(`prv must be string, got type ${typeof prv}`);
     }
 
     return { txHex, prv };
@@ -177,7 +133,7 @@ export class SubstrateCoin extends BaseCoin {
     const { referenceBlock, blockNumber, transactionVersion, sender } = params.txPrebuild.transaction;
 
     txBuilder
-      .validity({ firstValid: blockNumber, maxDuration: this.MAX_VALIDITY_DURATION })
+      .validity({ firstValid: blockNumber, maxDuration: this.getMaxValidityDurationBlocks() })
       .referenceBlock(referenceBlock)
       .version(transactionVersion)
       .sender({ address: sender })
@@ -189,4 +145,26 @@ export class SubstrateCoin extends BaseCoin {
     const signedTxHex = transaction.toBroadcastFormat();
     return { txHex: signedTxHex };
   }
+
+  /**
+   * Retrieves the address format for the substrate coin.
+   *
+   * @returns {number} The address format as a number.
+   */
+  protected getAddressFormat(): number {
+    return DEFAULT_SUBSTRATE_PREFIX;
+  }
+
+  /**
+   * Retrieves the maximum validity duration in blocks.
+   *
+   * This method is intended to be overridden by subclasses to provide the specific
+   * maximum validity duration for different types of Substrate-based coins.
+   *
+   * @returns {number} The maximum validity duration in blocks.
+   * @throws {Error} If the method is not implemented by the subclass.
+   */
+  protected getMaxValidityDurationBlocks(): number {
+    throw new Error('Method not implemented.');
+  }
 }

modules/abstract-substrate/src/lib/constants.ts

@@ -0,0 +1 @@
+export const DEFAULT_SUBSTRATE_PREFIX = 42;