Merge pull request #5206 from BitGo/BTC-1450.deprecate-display-order

fix(sdk-core): deprecate displayOrder in ITransactionExplanation

Author: OttoAllmendinger

modules/sdk-coin-dot/src/lib/transaction.ts

@@ -282,7 +282,7 @@ export class Transaction extends BaseTransaction {
   }
 
   explainTransferTransaction(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation {
-    explanationResult.displayOrder.push('owner', 'forceProxyType');
+    explanationResult.displayOrder?.push('owner', 'forceProxyType');
     return {
       ...explanationResult,
       outputs: [
@@ -297,7 +297,7 @@ export class Transaction extends BaseTransaction {
   }
 
   explainStakingActivateTransaction(json: TxData, explanationResult: TransactionExplanation): TransactionExplanation {
-    explanationResult.displayOrder.push('payee', 'forceProxyType');
+    explanationResult.displayOrder?.push('payee', 'forceProxyType');
     return {
       ...explanationResult,
       outputs: [
@@ -315,7 +315,7 @@ export class Transaction extends BaseTransaction {
     json: TxData,
     explanationResult: TransactionExplanation
   ): TransactionExplanation {
-    explanationResult.displayOrder.push('owner', 'proxyType', 'delay');
+    explanationResult.displayOrder?.push('owner', 'proxyType', 'delay');
     return {
       ...explanationResult,
       owner: json.owner,

modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts

@@ -82,7 +82,8 @@ export interface ITransactionFee<TAmount = string> {
 }
 
 export interface ITransactionExplanation<TFee = any, TAmount = any> {
-  displayOrder: string[];
+  /** @deprecated */
+  displayOrder?: string[];
   id: string;
   outputs: ITransactionRecipient[];
   outputAmount: TAmount;