Merge pull request #5758 from BitGo/eric/SC-1335-babylon-CreateBtcDelegation

feat(sdk-coin-baby): add CreateBtcDelegation transaction

Author: sbplat

modules/abstract-cosmos/src/cosmosCoin.ts

@@ -59,7 +59,7 @@ interface CosmosCoinSpecific {
   rootAddress: string;
 }
 
-export class CosmosCoin extends BaseCoin {
+export class CosmosCoin<CustomMessage = never> extends BaseCoin {
   protected readonly _staticsCoin: Readonly<StaticsBaseCoin>;
   protected constructor(bitgo: BitGoBase, staticsCoin?: Readonly<StaticsBaseCoin>) {
     super(bitgo);
@@ -223,7 +223,7 @@ export class CosmosCoin extends BaseCoin {
       txnBuilder.publicKey(publicKey);
     }
 
-    const unsignedTransaction = (await txnBuilder.build()) as CosmosTransaction;
+    const unsignedTransaction = (await txnBuilder.build()) as CosmosTransaction<CustomMessage>;
     let serializedTx = unsignedTransaction.toBroadcastFormat();
     const signableHex = unsignedTransaction.signablePayload.toString('hex');
 
@@ -334,7 +334,7 @@ export class CosmosCoin extends BaseCoin {
       .accountNumber(Number(accountNumber))
       .chainId(chainId);
 
-    const unsignedTransaction = (await txnBuilder.build()) as CosmosTransaction;
+    const unsignedTransaction = (await txnBuilder.build()) as CosmosTransaction<CustomMessage>;
     let serializedTx = unsignedTransaction.toBroadcastFormat();
     const signableHex = unsignedTransaction.signablePayload.toString('hex');
     const message = unsignedTransaction.signablePayload;

modules/abstract-cosmos/src/lib/ContractCallBuilder.ts

@@ -6,10 +6,10 @@ import { ExecuteContractMessage } from './iface';
 import { CosmosTransactionBuilder } from './transactionBuilder';
 import { CosmosUtils } from './utils';
 
-export class ContractCallBuilder extends CosmosTransactionBuilder {
-  protected _utils: CosmosUtils;
+export class ContractCallBuilder<CustomMessage = never> extends CosmosTransactionBuilder<CustomMessage> {
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig, utils);
     this._utils = utils;
   }

modules/abstract-cosmos/src/lib/StakingActivateBuilder.ts

@@ -6,10 +6,10 @@ import { DelegateOrUndelegeteMessage } from './iface';
 import { CosmosTransactionBuilder } from './transactionBuilder';
 import { CosmosUtils } from './utils';
 
-export class StakingActivateBuilder extends CosmosTransactionBuilder {
-  protected _utils: CosmosUtils;
+export class StakingActivateBuilder<CustomMessage = never> extends CosmosTransactionBuilder<CustomMessage> {
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig, utils);
     this._utils = utils;
   }

modules/abstract-cosmos/src/lib/StakingDeactivateBuilder.ts

@@ -6,10 +6,10 @@ import { DelegateOrUndelegeteMessage } from './iface';
 import { CosmosTransactionBuilder } from './transactionBuilder';
 import { CosmosUtils } from './utils';
 
-export class StakingDeactivateBuilder extends CosmosTransactionBuilder {
-  protected _utils: CosmosUtils;
+export class StakingDeactivateBuilder<CustomMessage = never> extends CosmosTransactionBuilder<CustomMessage> {
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig, utils);
     this._utils = utils;
   }

modules/abstract-cosmos/src/lib/StakingRedelegateBuilder.ts

@@ -5,10 +5,10 @@ import { RedelegateMessage } from './iface';
 import { CosmosTransactionBuilder } from './transactionBuilder';
 import { CosmosUtils } from './utils';
 
-export class StakingRedelegateBuilder extends CosmosTransactionBuilder {
-  protected _utils: CosmosUtils;
+export class StakingRedelegateBuilder<CustomMessage = never> extends CosmosTransactionBuilder<CustomMessage> {
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig, utils);
     this._utils = utils;
   }

modules/abstract-cosmos/src/lib/StakingWithdrawRewardsBuilder.ts

@@ -6,10 +6,10 @@ import { WithdrawDelegatorRewardsMessage } from './iface';
 import { CosmosTransactionBuilder } from './transactionBuilder';
 import { CosmosUtils } from './utils';
 
-export class StakingWithdrawRewardsBuilder extends CosmosTransactionBuilder {
-  protected _utils: CosmosUtils;
+export class StakingWithdrawRewardsBuilder<CustomMessage = never> extends CosmosTransactionBuilder<CustomMessage> {
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig, utils);
     this._utils = utils;
   }

modules/abstract-cosmos/src/lib/iface.ts

@@ -67,16 +67,17 @@ export interface ExecuteContractMessage {
   funds?: Coin[];
 }
 
-export type CosmosTransactionMessage =
+export type CosmosTransactionMessage<CustomMessage = never> =
   | SendMessage
   | DelegateOrUndelegeteMessage
   | WithdrawDelegatorRewardsMessage
   | ExecuteContractMessage
-  | RedelegateMessage;
+  | RedelegateMessage
+  | CustomMessage;
 
-export interface MessageData {
+export interface MessageData<CustomMessage = never> {
   typeUrl: string;
-  value: CosmosTransactionMessage;
+  value: CosmosTransactionMessage<CustomMessage>;
 }
 
 export interface FeeData {
@@ -92,16 +93,16 @@ export interface GasAmountDetails {
 /**
  * The transaction data returned from the toJson() function of a transaction
  */
-export interface TxData extends CosmosLikeTransaction {
+export interface TxData<CustomMessage = never> extends CosmosLikeTransaction<CustomMessage> {
   id?: string;
   type?: TransactionType;
   accountNumber: number;
   chainId: string;
 }
 
-export interface CosmosLikeTransaction {
+export interface CosmosLikeTransaction<CustomMessage = never> {
   readonly sequence: number;
-  readonly sendMessages: MessageData[];
+  readonly sendMessages: MessageData<CustomMessage>[];
   readonly gasBudget: FeeData;
   readonly publicKey?: string;
   readonly signature?: Uint8Array;

modules/abstract-cosmos/src/lib/transaction.ts

@@ -24,23 +24,23 @@ import {
 } from './iface';
 import { CosmosUtils } from './utils';
 
-export class CosmosTransaction extends BaseTransaction {
-  protected _cosmosLikeTransaction: CosmosLikeTransaction;
+export class CosmosTransaction<CustomMessage = never> extends BaseTransaction {
+  protected _cosmosLikeTransaction: CosmosLikeTransaction<CustomMessage>;
   protected _accountNumber: number;
   protected _chainId: string;
 
-  protected _utils: CosmosUtils;
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig);
     this._utils = utils;
   }
 
-  get cosmosLikeTransaction(): CosmosLikeTransaction {
+  get cosmosLikeTransaction(): CosmosLikeTransaction<CustomMessage> {
     return this._cosmosLikeTransaction;
   }
 
-  set cosmosLikeTransaction(cosmosLikeTransaction: Readonly<CosmosLikeTransaction>) {
+  set cosmosLikeTransaction(cosmosLikeTransaction: Readonly<CosmosLikeTransaction<CustomMessage>>) {
     this._cosmosLikeTransaction = cosmosLikeTransaction;
   }
 
@@ -84,7 +84,7 @@ export class CosmosTransaction extends BaseTransaction {
   }
 
   /** @inheritdoc */
-  toJson(): TxData {
+  toJson(): TxData<CustomMessage> {
     if (!this._cosmosLikeTransaction) {
       throw new ParseTransactionError('Empty transaction');
     }
@@ -171,7 +171,10 @@ export class CosmosTransaction extends BaseTransaction {
    * @param {TransactionExplanation} explanationResult The transaction explanation to be completed
    * @returns {TransactionExplanation}
    */
-  explainTransactionInternal(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation {
+  explainTransactionInternal(
+    json: TxData<CustomMessage>,
+    explanationResult: TransactionExplanation
+  ): TransactionExplanation {
     let outputs: TransactionRecipient[];
     let outputAmount;
     switch (json.type) {

modules/abstract-cosmos/src/lib/transactionBuilder.ts

@@ -17,10 +17,10 @@ import { CosmosKeyPair as KeyPair } from './keyPair';
 import { CosmosTransaction } from './transaction';
 import { CosmosUtils } from './utils';
 
-export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
-  protected _transaction: CosmosTransaction;
+export abstract class CosmosTransactionBuilder<CustomMessage = never> extends BaseTransactionBuilder {
+  protected _transaction: CosmosTransaction<CustomMessage>;
   protected _sequence: number;
-  protected _messages: MessageData[];
+  protected _messages: MessageData<CustomMessage>[];
   protected _gasBudget: FeeData;
   protected _accountNumber?: number;
   protected _signature: Buffer;
@@ -29,9 +29,9 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
   protected _signer: KeyPair;
   protected _memo?: string;
 
-  protected _utils: CosmosUtils;
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, _utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, _utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig);
     this._transaction = new CosmosTransaction(_coinConfig, _utils);
   }
@@ -42,12 +42,12 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
   protected abstract get transactionType(): TransactionType;
 
   /** @inheritdoc */
-  protected get transaction(): CosmosTransaction {
+  protected get transaction(): CosmosTransaction<CustomMessage> {
     return this._transaction;
   }
 
   /** @inheritdoc */
-  protected set transaction(transaction: CosmosTransaction) {
+  protected set transaction(transaction: CosmosTransaction<CustomMessage>) {
     this._transaction = transaction;
   }
 
@@ -78,7 +78,7 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
    * @param {CosmosTransactionMessage[]} messages
    * @returns {TransactionBuilder} This transaction builder
    */
-  abstract messages(messages: CosmosTransactionMessage[]): this;
+  abstract messages(messages: CosmosTransactionMessage<CustomMessage>[]): this;
 
   publicKey(publicKey: string | undefined): this {
     this._publicKey = publicKey;
@@ -101,7 +101,7 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
   }
 
   /** @inheritdoc */
-  protected signImplementation(key: BaseKey): CosmosTransaction {
+  protected signImplementation(key: BaseKey): CosmosTransaction<CustomMessage> {
     this.validateKey(key);
     if (this._accountNumber === undefined) {
       throw new SigningError('accountNumber is required before signing');
@@ -147,7 +147,7 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
    * Initialize the transaction builder fields using the decoded transaction data
    * @param {CosmosTransaction} tx the transaction data
    */
-  initBuilder(tx: CosmosTransaction): void {
+  initBuilder(tx: CosmosTransaction<CustomMessage>): void {
     this._transaction = tx;
     const txData = tx.toJson();
     this.gasBudget(txData.gasBudget);
@@ -166,16 +166,23 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
     }
   }
 
+  /**
+   * Creates a new CosmosTransaction instance
+   */
+  protected newTransaction(): CosmosTransaction<CustomMessage> {
+    return new CosmosTransaction<CustomMessage>(this._coinConfig, this._utils);
+  }
+
   /** @inheritdoc */
-  protected fromImplementation(rawTransaction: string): CosmosTransaction {
-    const tx = new CosmosTransaction(this._coinConfig, this._utils);
+  protected fromImplementation(rawTransaction: string): CosmosTransaction<CustomMessage> {
+    const tx = this.newTransaction();
     tx.enrichTransactionDetailsFromRawTransaction(rawTransaction);
     this.initBuilder(tx);
     return this.transaction;
   }
 
   /** @inheritdoc */
-  protected async buildImplementation(): Promise<CosmosTransaction> {
+  protected async buildImplementation(): Promise<CosmosTransaction<CustomMessage>> {
     this.transaction.transactionType = this.transactionType;
     if (this._accountNumber) {
       this.transaction.accountNumber = this._accountNumber;
@@ -240,7 +247,7 @@ export abstract class CosmosTransactionBuilder extends BaseTransactionBuilder {
   }
 
   /** @inheritdoc */
-  validateTransaction(transaction: CosmosTransaction): void {
+  validateTransaction(transaction: CosmosTransaction<CustomMessage>): void {
     this._utils.validateTransaction({
       sequence: this._sequence,
       sendMessages: this._messages,

modules/abstract-cosmos/src/lib/transferBuilder.ts

@@ -6,10 +6,10 @@ import { SendMessage } from './iface';
 import { CosmosTransactionBuilder } from './transactionBuilder';
 import { CosmosUtils } from './utils';
 
-export class CosmosTransferBuilder extends CosmosTransactionBuilder {
-  protected _utils: CosmosUtils;
+export class CosmosTransferBuilder<CustomMessage = never> extends CosmosTransactionBuilder<CustomMessage> {
+  protected _utils: CosmosUtils<CustomMessage>;
 
-  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils) {
+  constructor(_coinConfig: Readonly<CoinConfig>, utils: CosmosUtils<CustomMessage>) {
     super(_coinConfig, utils);
     this._utils = utils;
   }