Merge pull request #5394 from BitGo/add-prio-fees-sol

feat(sdk-coin-sol): add prio fees for token txns

Author: noel-bitgo

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

@@ -27,6 +27,7 @@ export enum ValidInstructionTypesEnum {
   Assign = 'Assign',
   Split = 'Split',
   Authorize = 'Authorize',
+  SetPriorityFee = 'SetPriorityFee',
 }
 
 // Internal instructions types
@@ -43,6 +44,7 @@ export enum InstructionBuilderTypes {
   TokenTransfer = 'TokenTransfer',
   StakingAuthorize = 'Authorize',
   StakingDelegate = 'Delegate',
+  SetPriorityFee = 'SetPriorityFee',
 }
 
 export const VALID_SYSTEM_INSTRUCTION_TYPES: ValidInstructionTypes[] = [
@@ -62,6 +64,7 @@ export const VALID_SYSTEM_INSTRUCTION_TYPES: ValidInstructionTypes[] = [
   ValidInstructionTypesEnum.Assign,
   ValidInstructionTypesEnum.Split,
   ValidInstructionTypesEnum.Authorize,
+  ValidInstructionTypesEnum.SetPriorityFee,
 ];
 
 /** Const to check the order of the Wallet Init instructions when decode */

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

@@ -29,6 +29,7 @@ export type InstructionParams =
   | Nonce
   | Memo
   | WalletInit
+  | SetPriorityFee
   | Transfer
   | StakingActivate
   | StakingDeactivate
@@ -105,6 +106,11 @@ export interface StakingAuthorize {
   };
 }
 
+export interface SetPriorityFee {
+  type: InstructionBuilderTypes.SetPriorityFee;
+  params: Record<string, never>;
+}
+
 export interface AtaInit {
   type: InstructionBuilderTypes.CreateAssociatedTokenAccount;
   params: { mintAddress: string; ataAddress: string; ownerAddress: string; payerAddress: string; tokenName: string };
@@ -122,7 +128,8 @@ export type ValidInstructionTypes =
   | 'InitializeAssociatedTokenAccount'
   | 'CloseAssociatedTokenAccount'
   | DecodedCloseAccountInstruction
-  | 'TokenTransfer';
+  | 'TokenTransfer'
+  | 'SetPriorityFee';
 
 export type StakingAuthorizeParams = {
   stakingAddress: string;

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

@@ -33,6 +33,7 @@ import {
   TokenTransfer,
   Transfer,
   WalletInit,
+  SetPriorityFee,
 } from './iface';
 import { getInstructionType } from './utils';
 
@@ -114,8 +115,8 @@ function parseWalletInitInstructions(instructions: TransactionInstruction[]): Ar
  */
 function parseSendInstructions(
   instructions: TransactionInstruction[]
-): Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit | AtaClose> {
-  const instructionData: Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit | AtaClose> = [];
+): Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit | AtaClose | SetPriorityFee> {
+  const instructionData: Array<Nonce | Memo | Transfer | TokenTransfer | AtaInit | AtaClose | SetPriorityFee> = [];
   for (const instruction of instructions) {
     const type = getInstructionType(instruction);
     switch (type) {
@@ -193,6 +194,13 @@ function parseSendInstructions(
         };
         instructionData.push(ataClose);
         break;
+      case ValidInstructionTypesEnum.SetPriorityFee:
+        const setPriorityFee: SetPriorityFee = {
+          type: InstructionBuilderTypes.SetPriorityFee,
+          params: {},
+        };
+        instructionData.push(setPriorityFee);
+        break;
       default:
         throw new NotSupported(
           'Invalid transaction, instruction type not supported: ' + getInstructionType(instruction)

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

@@ -13,6 +13,7 @@ import {
   SystemProgram,
   Transaction,
   TransactionInstruction,
+  ComputeBudgetProgram,
 } from '@solana/web3.js';
 import assert from 'assert';
 import BigNumber from 'bignumber.js';
@@ -31,6 +32,7 @@ import {
   TokenTransfer,
   Transfer,
   WalletInit,
+  SetPriorityFee,
 } from './iface';
 
 /**
@@ -65,6 +67,8 @@ export function solInstructionFactory(instructionToBuild: InstructionParams): Tr
       return stakingAuthorizeInstruction(instructionToBuild);
     case InstructionBuilderTypes.StakingDelegate:
       return stakingDelegateInstruction(instructionToBuild);
+    case InstructionBuilderTypes.SetPriorityFee:
+      return fetchPriorityFeeInstruction(instructionToBuild);
     default:
       throw new Error(`Invalid instruction type or not supported`);
   }
@@ -89,6 +93,16 @@ function advanceNonceInstruction(data: Nonce): TransactionInstruction[] {
   return [nonceInstruction];
 }
 
+function fetchPriorityFeeInstruction(instructionToBuild: SetPriorityFee): TransactionInstruction[] {
+  // 200k * 10000000 microlamports => prio fee
+  // https://www.quicknode.com/gas-tracker/solana
+  const addPriorityFee = ComputeBudgetProgram.setComputeUnitPrice({
+    microLamports: 10000000,
+  });
+
+  return [addPriorityFee];
+}
+
 /**
  * Construct Memo Solana instructions
  *

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

@@ -10,7 +10,7 @@ import {
   validateOwnerAddress,
 } from './utils';
 import { InstructionBuilderTypes } from './constants';
-import { AtaInit, TokenAssociateRecipient, TokenTransfer } from './iface';
+import { AtaInit, TokenAssociateRecipient, TokenTransfer, SetPriorityFee } from './iface';
 import assert from 'assert';
 import { TransactionBuilder } from './transactionBuilder';
 import _ from 'lodash';
@@ -140,8 +140,12 @@ export class TokenTransferBuilder extends TransactionBuilder {
         };
       })
     );
+    const addPriorityFeeInstruction: SetPriorityFee = {
+      type: InstructionBuilderTypes.SetPriorityFee,
+      params: {},
+    };
     // order is important, createAtaInstructions must be before sendInstructions
-    this._instructionsData = [...createAtaInstructions, ...sendInstructions];
+    this._instructionsData = [addPriorityFeeInstruction, ...createAtaInstructions, ...sendInstructions];
     return await super.buildImplementation();
   }
 }

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

@@ -365,6 +365,8 @@ export class Transaction extends BaseTransaction {
           break;
         case InstructionBuilderTypes.StakingDelegate:
           break;
+        case InstructionBuilderTypes.SetPriorityFee:
+          break;
       }
     }
     this._outputs = outputs;

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

@@ -11,7 +11,7 @@ import {
 } from './utils';
 import { BaseCoin as CoinConfig, SolCoin } from '@bitgo/statics';
 import assert from 'assert';
-import { AtaInit, TokenAssociateRecipient, TokenTransfer, Transfer } from './iface';
+import { AtaInit, TokenAssociateRecipient, TokenTransfer, Transfer, SetPriorityFee } from './iface';
 import { InstructionBuilderTypes } from './constants';
 import _ from 'lodash';
 
@@ -167,8 +167,20 @@ export class TransferBuilderV2 extends TransactionBuilder {
         };
       })
     );
-    // order is important, createAtaInstructions must be before sendInstructions
-    this._instructionsData = [...createAtaInstructions, ...sendInstructions];
+
+    let addPriorityFeeInstruction: SetPriorityFee;
+    // If there are createAtaInstructions, then token is involved and we need to add a priority fee instruction
+    if (createAtaInstructions.length !== 0) {
+      addPriorityFeeInstruction = {
+        type: InstructionBuilderTypes.SetPriorityFee,
+        params: {},
+      };
+      this._instructionsData = [addPriorityFeeInstruction, ...createAtaInstructions, ...sendInstructions];
+    } else {
+      // order is important, createAtaInstructions must be before sendInstructions
+      this._instructionsData = [...createAtaInstructions, ...sendInstructions];
+    }
+
     return await super.buildImplementation();
   }
 }

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

@@ -51,6 +51,7 @@ import { ValidInstructionTypes } from './iface';
 const DECODED_BLOCK_HASH_LENGTH = 32; // https://docs.solana.com/developing/programming-model/transactions#blockhash-format
 const DECODED_SIGNATURE_LENGTH = 64; // https://docs.solana.com/terminology#signature
 const BASE_58_ENCONDING_REGEX = '[1-9A-HJ-NP-Za-km-z]';
+const COMPUTE_BUDGET = 'ComputeBudget111111111111111111111111111111';
 
 /** @inheritdoc */
 export function isValidAddress(address: string): boolean {
@@ -343,6 +344,8 @@ export function getInstructionType(instruction: TransactionInstruction): ValidIn
           'Invalid transaction, instruction program id not supported: ' + instruction.programId.toString()
         );
       }
+    case COMPUTE_BUDGET:
+      return 'SetPriorityFee';
     default:
       throw new NotSupported(
         'Invalid transaction, instruction program id not supported: ' + instruction.programId.toString()