Merge pull request #5023 from BitGo/WIN-3627-closeATA-instruction-type-support

feat(sdk-coin-sol): add getInstructionType for closeATA

Author: DinshawKothari

modules/sdk-coin-sol/src/lib/iface.ts

@@ -1,4 +1,5 @@
 import { TransactionExplanation as BaseTransactionExplanation } from '@bitgo/sdk-core';
+import { DecodedCloseAccountInstruction } from '@solana/spl-token';
 import { Blockhash, StakeInstructionType, SystemInstructionType, TransactionSignature } from '@solana/web3.js';
 import { InstructionBuilderTypes } from './constants';
 
@@ -120,6 +121,7 @@ export type ValidInstructionTypes =
   | 'Memo'
   | 'InitializeAssociatedTokenAccount'
   | 'CloseAssociatedTokenAccount'
+  | DecodedCloseAccountInstruction
   | 'TokenTransfer';
 
 export type StakingAuthorizeParams = {

modules/sdk-coin-sol/src/lib/instructionParamsFactory.ts

@@ -114,8 +114,8 @@ function parseWalletInitInstructions(instructions: TransactionInstruction[]): Ar
  */
 function parseSendInstructions(
   instructions: TransactionInstruction[]
-): Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit> {
-  const instructionData: Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit> = [];
+): Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit | AtaClose> {
+  const instructionData: Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit | AtaClose> = [];
   for (const instruction of instructions) {
     const type = getInstructionType(instruction);
     switch (type) {
@@ -177,6 +177,22 @@ function parseSendInstructions(
         };
         instructionData.push(ataInit);
         break;
+      case ValidInstructionTypesEnum.CloseAssociatedTokenAccount:
+        const accountAddress = instruction.keys[closeAtaInstructionKeysIndexes.AccountAddress].pubkey.toString();
+        const destinationAddress =
+          instruction.keys[closeAtaInstructionKeysIndexes.DestinationAddress].pubkey.toString();
+        const authorityAddress = instruction.keys[closeAtaInstructionKeysIndexes.AuthorityAddress].pubkey.toString();
+
+        const ataClose: AtaClose = {
+          type: InstructionBuilderTypes.CloseAssociatedTokenAccount,
+          params: {
+            accountAddress,
+            destinationAddress,
+            authorityAddress,
+          },
+        };
+        instructionData.push(ataClose);
+        break;
       default:
         throw new NotSupported(
           'Invalid transaction, instruction type not supported: ' + getInstructionType(instruction)
@@ -572,6 +588,12 @@ const ataInitInstructionKeysIndexes = {
   MintAddress: 3,
 };
 
+const closeAtaInstructionKeysIndexes = {
+  AccountAddress: 0,
+  DestinationAddress: 1,
+  AuthorityAddress: 2,
+};
+
 /**
  * Parses Solana instructions to initialize associated token account tx instructions params
  *

modules/sdk-coin-sol/src/lib/transactionBuilderFactory.ts

@@ -56,6 +56,8 @@ export class TransactionBuilderFactory extends BaseTransactionBuilderFactory {
           return this.getStakingRawMsgAuthorizeBuilder(tx);
         case TransactionType.StakingDelegate:
           return this.getStakingDelegateBuilder(tx);
+        case TransactionType.CloseAssociatedTokenAccount:
+          return this.getCloseAtaInitializationBuilder(tx);
         default:
           throw new InvalidTransactionError('Invalid transaction');
       }

modules/sdk-coin-sol/src/lib/utils.ts

@@ -7,7 +7,12 @@ import {
   UtilsError,
 } from '@bitgo/sdk-core';
 import { BaseCoin, BaseNetwork, CoinNotDefinedError, coins, SolCoin } from '@bitgo/statics';
-import { ASSOCIATED_TOKEN_PROGRAM_ID, getAssociatedTokenAddress, TOKEN_PROGRAM_ID } from '@solana/spl-token';
+import {
+  ASSOCIATED_TOKEN_PROGRAM_ID,
+  decodeCloseAccountInstruction,
+  getAssociatedTokenAddress,
+  TOKEN_PROGRAM_ID,
+} from '@solana/spl-token';
 import {
   Keypair,
   PublicKey,
@@ -317,6 +322,15 @@ export function getInstructionType(instruction: TransactionInstruction): ValidIn
     case SystemProgram.programId.toString():
       return SystemInstruction.decodeInstructionType(instruction);
     case TOKEN_PROGRAM_ID.toString():
+      try {
+        const decodedInstruction = decodeCloseAccountInstruction(instruction);
+        if (decodedInstruction && decodedInstruction.data.instruction === 9) {
+          return 'CloseAssociatedTokenAccount';
+        }
+      } catch (e) {
+        // ignore error and default to TokenTransfer
+        return 'TokenTransfer';
+      }
       return 'TokenTransfer';
     case StakeProgram.programId.toString():
       return StakeInstruction.decodeInstructionType(instruction);

modules/sdk-coin-sol/test/resources/sol.ts

@@ -242,6 +242,9 @@ export const WALLET_INIT_SIGNED_TX_AMOUNT_ZERO =
 export const WALLET_INIT_WITH_MEMO_SIGNED_TX =
   'AqGFtzbc6Lm0D13WSbjsbsEN4GmCxFAzaphz8ipBhF7BHIsPqlcv/zu8wTu3ryfB7ny5cnqmGgi88cOfjlSLbQdImqIjSu6UPeh0AwisKTwneKt9gnImE6XurWWb2L2eXNad5kvpel5aYN4rZz6UqnQ9KDnQ7mKgbyEE0Ser7IQHAgAEBkXlebz5JTz2i0ff8fs6OlwsIbrFsjwJrhKm4FVr8ItBb/oSifqcWWi8BxhMpNkr6eT3wAuWRIv8GCNbT0xx4W4AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAVKU1qZKSEGTSTocWDaOHx8NbXdvJK7geQfqEBBBUSNBqfVFxksVo7gioRfc9KXiM8DXDFFshqzRNgGLqlAAAAGp9UXGSxcUSGMyUw9SvF/WNruCJuh/UTj29mKAAAAAOMy2vkvq+zotj/3pEAF5f39mvoVh1a2HFqV+QSzuNCBAwICAAE0AAAAAOCTBAAAAAAAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAIDAQQFJAYAAABF5Xm8+SU89otH3/H7OjpcLCG6xbI8Ca4SpuBVa/CLQQMAF3Rlc3QgbWVtbyBwbGVhc2UgaWdub3Jl';
 
+export const TRANSFER_UNSIGNED_TX_CLOSE_ATA =
+  'AfuVuP3Jpn7kCNwtns6WFvu9+HP1xN6P3tsDHKAhO2zy62rSlty0dNKxnPx+WyLUDWGmpYPEXabSfE/jlsFmUAABAAEEzHRWFgUbrdfkG3wS6dzsLMQ2hDz0rHnxi0c1qPUJfiOoLoy5b0/J9nNRKigGU3Tgw++V+r1f+t8cl9WwxHcCVsmQxO8jc2e2bJKkHxMQd0EMz5SHLNf4shA7bHPlwLabBt324ddloZPZy+FGzut5rBy0he1fWzeROoz1hX7/AKnMSQ6SjNLjhzuzQ/yV2jMXnKYPTb9GwsNukSmdVdTmuQEDAwECAAEJ'; // from sol sdk recover flow testcase
+
 export const TRANSFER_UNSIGNED_TX_WITH_MEMO =
   'AQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAIEReV5vPklPPaLR9/x+zo6XCwhusWyPAmuEqbgVWvwi0GpGBtS9+2Q6usNrUtxvrRTg2FnYTFxfpMJWBBft6OJ1QAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABUpTWpkpIQZNJOhxYNo4fHw1td28kruB5B+oQEEFRI3jMtr5L6vs6LY/96RABeX9/Zr6FYdWthxalfkEs7jQgQICAgABDAIAAADgkwQAAAAAAAMACXRlc3QgbWVtbw==';
 export const TRANSFER_UNSIGNED_TX_WITHOUT_MEMO =

modules/sdk-coin-sol/test/unit/sol.ts

@@ -1337,6 +1337,12 @@ describe('SOL:', function () {
       const signingPayload = await basecoin.getSignablePayload(resources.TRANSFER_UNSIGNED_TX_WITH_MEMO);
       signingPayload.should.be.deepEqual(rebuiltSignablePayload);
     });
+
+    it('should build CloseAssociatedTokenAccount txn builder from raw txn', async function () {
+      const factory = getBuilderFactory(basecoin.getChain());
+      const txnBuilder = factory.from(resources.TRANSFER_UNSIGNED_TX_CLOSE_ATA);
+      assert.ok(txnBuilder);
+    });
   });
 
   describe('Presign transaction', () => {