chore(sdk-core): refactor recipient checking to coin

TICKET: BTC-1582

Author: davidkaplanbitgo

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -104,6 +104,7 @@ type UtxoCustomSigningFunction<TNumber extends number | bigint> = {
   }): Promise<SignedTransaction>;
 };
 
+export const ScriptRecipientPrefix = 'scriptPubkey:';
 const { getExternalChainCode, isChainCode, scriptTypeForChain, outputScripts } = bitgo;
 type Unspent<TNumber extends number | bigint = number> = bitgo.Unspent<TNumber>;
 
@@ -459,6 +460,17 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
     return (chainhead as any).height;
   }
 
+  checkRecipient(recipient: { address: string; amount: number | string }): void {
+    if (recipient.address.startsWith(ScriptRecipientPrefix)) {
+      const amount = BigInt(recipient.amount);
+      if (amount !== BigInt(0)) {
+        throw new Error('Only zero amounts allowed for non-encodeable scriptPubkeys');
+      }
+    } else {
+      super.checkRecipient(recipient);
+    }
+  }
+
   /**
    * Run custom coin logic after a transaction prebuild has been received from BitGo
    * @param prebuild

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

@@ -225,6 +225,16 @@ export abstract class BaseCoin implements IBaseCoin {
     return bigNumber.toFormat(null as any, null as any, { groupSeparator: '', decimalSeparator: '.' });
   }
 
+  checkRecipient(recipient: { address: string; amount: string | number }): void {
+    const amount = new BigNumber(recipient.amount);
+    if (amount.isNegative()) {
+      throw new Error('invalid argument for amount - positive number greater than zero or numeric string expected');
+    }
+    if (!this.valuelessTransferAllowed() && amount.isZero()) {
+      throw new Error('invalid argument for amount - positive number greater than zero or numeric string expected');
+    }
+  }
+
   /**
    * Convert a currency amount represented in big units (btc, eth, xrp, xlm)
    * to base units (satoshi, wei, atoms, drops, stroops)

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

@@ -473,6 +473,7 @@ export interface IBaseCoin {
   getFamily(): string;
   getFullName(): string;
   valuelessTransferAllowed(): boolean;
+  checkRecipient(recipient: { address: string; amount: string | number }): void;
   sweepWithSendMany(): boolean;
   transactionDataAllowed(): boolean;
   allowsAccountConsolidations(): boolean;

modules/sdk-core/src/bitgo/wallet/wallet.ts

@@ -2484,13 +2484,7 @@ export class Wallet implements IWallet {
     const coin = this.baseCoin;
     if (_.isObject(params.recipients)) {
       params.recipients.map(function (recipient) {
-        const amount = new BigNumber(recipient.amount);
-        if (amount.isNegative()) {
-          throw new Error('invalid argument for amount - positive number greater than zero or numeric string expected');
-        }
-        if (!coin.valuelessTransferAllowed() && amount.isZero()) {
-          throw new Error('invalid argument for amount - positive number greater than zero or numeric string expected');
-        }
+        coin.checkRecipient(recipient);
       });
     }