Merge pull request #6850 from BitGo/BTC-2425

feat(sdk-core): update midnight claim message format for BTC-2425

Author: bhavidhingra

modules/sdk-core/src/bitgo/walletUtil/utxoMessageProof.ts

@@ -5,6 +5,7 @@ import { Environments } from '../environments';
 
 const NUM_MESSAGES_PER_TRANSACTION = 2;
 const NUM_MESSAGES_PER_QUERY = 1000;
+export const MIDNIGHT_TNC_HASH = '31a6bab50a84b8439adcfb786bb2020f6807e6e8fda629b424110fc7bb1c6b8b';
 
 type MessageInfo = {
   message: string;
@@ -38,23 +39,23 @@ export interface IMessageProvider {
  * handles the pagination and batching of messages, keeping a local cache of the unprocessed messages.
  */
 export class MidnightMessageProvider implements IMessageProvider {
-  protected messageCache: MessageInfo[];
+  protected unprocessedMessagesCache: MessageInfo[];
   protected network: utxolib.Network;
   protected midnightClaimUrl: string;
   protected prevId: string | undefined;
   protected ranOnce = false;
-  constructor(private wallet: IWallet, private message: string) {
-    this.messageCache = [];
+  constructor(private wallet: IWallet, private destinationAddress: string) {
+    this.unprocessedMessagesCache = [];
     this.network = utxolib.networks[wallet.coin()];
     this.midnightClaimUrl = `${
       Environments[wallet.bitgo.env].uri
     }/api/airdrop-claim/v1/midnight/claims/${wallet.coin()}/${wallet.id()}`;
   }
 
   async getMessagesAndAddressesToSign(): Promise<MessageInfo[]> {
-    if (this.messageCache.length > 0) {
-      return this.messageCache.splice(0, NUM_MESSAGES_PER_TRANSACTION);
-    } else if (this.messageCache.length === 0 && this.ranOnce && this.prevId === undefined) {
+    if (this.unprocessedMessagesCache.length > 0) {
+      return this.unprocessedMessagesCache.splice(0, NUM_MESSAGES_PER_TRANSACTION);
+    } else if (this.unprocessedMessagesCache.length === 0 && this.ranOnce && this.prevId === undefined) {
       return [];
     }
 
@@ -76,26 +77,33 @@ export class MidnightMessageProvider implements IMessageProvider {
       this.prevId = undefined;
     }
 
-    this.messageCache = response.claims.map((claim: Claim) => {
+    this.unprocessedMessagesCache = response.claims.map((claim: Claim) => {
       if (!claim.originAddress) {
         throw new Error(`Claim ${JSON.stringify(claim)} is missing originAddress`);
       }
       return {
-        message: this.message,
+        // Midnight claim message format
+        message: `STAR ${claim.allocationAmount} to ${this.destinationAddress} ${MIDNIGHT_TNC_HASH}`,
         address: claim.originAddress,
       };
     });
-    const toReturn = this.messageCache.splice(0, NUM_MESSAGES_PER_TRANSACTION);
+    const toReturn = this.unprocessedMessagesCache.splice(0, NUM_MESSAGES_PER_TRANSACTION);
     return toReturn;
   }
 }
 
+/**
+ * Bulk signs BIP322 messages for the Midnight airdrop.
+ * @param wallet The wallet to sign the messages with.
+ * @param destinationAddress The ADA address the rewards will get sent to
+ * @param walletPassphrase (Optional) The wallet passphrase of the wallet
+ */
 export async function bulkSignBip322MidnightMessages(
   wallet: IWallet,
-  message: string,
+  destinationAddress: string,
   walletPassphrase?: string
 ): Promise<BulkMessageResponse> {
-  const provider = new MidnightMessageProvider(wallet, message);
+  const provider = new MidnightMessageProvider(wallet, destinationAddress);
   return bulkSignBip322MessagesWithProvider(provider, wallet, walletPassphrase);
 }