feat(sdk-coin-sui): sui sponsorship support

TICKET: WIN-6028

Author: abhishekagrawal080

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

@@ -3,14 +3,20 @@ import {
   TransactionType as BitGoTransactionType,
 } from '@bitgo/sdk-core';
 import BigNumber from 'bignumber.js';
-import {
-  CallArg,
-  GasData,
-  ProgrammableTransaction,
-  SuiAddress,
-  SuiObjectRef,
-  TransactionExpiration,
-} from './mystenlab/types';
+import { CallArg, ProgrammableTransaction, SuiAddress, SuiObjectRef, TransactionExpiration } from './mystenlab/types';
+
+export interface GasData {
+  payment: SuiObjectRef[];
+  owner: SuiAddress;
+  price: number;
+  budget: number;
+  sponsor?: SuiAddress;
+}
+
+export interface GasDataWithSponsor extends GasData {
+  sponsor: SuiAddress;
+}
+
 import { TransactionBlockInput, TransactionType } from './mystenlab/builder';
 
 export enum SuiTransactionType {

modules/sdk-coin-sui/src/lib/mystenlab/builder/TransactionDataBlock.ts

@@ -43,6 +43,7 @@ const GasConfig = object({
   price: optional(StringEncodedBigint),
   payment: optional(array(SuiObjectRef)),
   owner: optional(SuiAddress),
+  sponsor: optional(SuiAddress),
 });
 type GasConfig = Infer<typeof GasConfig>;
 
@@ -213,6 +214,9 @@ export class TransactionBlockDataBuilder {
         owner: prepareSuiAddress(this.gasConfig.owner ?? sender),
         price: BigInt(gasConfig.price),
         budget: BigInt(gasConfig.budget),
+        ...(gasConfig.sponsor && {
+          sponsor: prepareSuiAddress(gasConfig.sponsor),
+        }),
       },
       kind: {
         ProgrammableTransaction: {

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

@@ -6,10 +6,10 @@ import {
   Signature,
   TransactionType as BitGoTransactionType,
 } from '@bitgo/sdk-core';
-import { SuiProgrammableTransaction, SuiTransaction, SuiTransactionType, TxData } from './iface';
+import { SuiProgrammableTransaction, SuiTransaction, SuiTransactionType, TxData, GasData } from './iface';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
 import utils, { AppId, Intent, IntentScope, IntentVersion, isImmOrOwnedObj } from './utils';
-import { GasData, normalizeSuiAddress, normalizeSuiObjectId, SuiObjectRef } from './mystenlab/types';
+import { normalizeSuiAddress, normalizeSuiObjectId, SuiObjectRef } from './mystenlab/types';
 import { SIGNATURE_SCHEME_BYTES } from './constants';
 import { Buffer } from 'buffer';
 import { fromB64, toB64 } from '@mysten/bcs';
@@ -178,6 +178,9 @@ export abstract class Transaction<T> extends BaseTransaction {
         owner: normalizeSuiAddress(transactionBlock.gasConfig.owner!),
         price: Number(transactionBlock.gasConfig.price as string),
         budget: Number(transactionBlock.gasConfig.budget as string),
+        ...(transactionBlock.gasConfig.sponsor && {
+          sponsor: normalizeSuiAddress(transactionBlock.gasConfig.sponsor),
+        }),
       },
     };
   }
@@ -213,12 +216,20 @@ export abstract class Transaction<T> extends BaseTransaction {
   }
 
   static getProperGasData(k: any): GasData {
-    return {
-      payment: [this.normalizeSuiObjectRef(k.gasData.payment)],
+    const gasData: GasData = {
+      payment: Array.isArray(k.gasData.payment)
+        ? k.gasData.payment.map((p: any) => this.normalizeSuiObjectRef(p))
+        : [this.normalizeSuiObjectRef(k.gasData.payment)],
       owner: utils.normalizeHexId(k.gasData.owner),
       price: Number(k.gasData.price),
       budget: Number(k.gasData.budget),
     };
+
+    if (k.gasData.sponsor) {
+      gasData.sponsor = utils.normalizeHexId(k.gasData.sponsor);
+    }
+
+    return gasData;
   }
 
   private static normalizeCoins(coins: any[]): SuiObjectRef[] {

modules/sdk-coin-sui/src/sui.ts

@@ -42,7 +42,7 @@ import {
 } from './lib';
 import utils from './lib/utils';
 import * as _ from 'lodash';
-import { SuiObjectInfo, SuiTransactionType } from './lib/iface';
+import { GasDataWithSponsor, SuiObjectInfo, SuiTransactionType } from './lib/iface';
 import {
   DEFAULT_GAS_OVERHEAD,
   DEFAULT_GAS_PRICE,
@@ -58,6 +58,20 @@ export interface ExplainTransactionOptions {
   txHex: string;
 }
 
+export interface CreateSponsoredTransactionOptions {
+  sender: string;
+  sponsor: string;
+  recipients: {
+    address: string;
+    amount: string;
+  }[];
+  gasData: {
+    price: number;
+    budget: number;
+    payment: SuiObjectInfo[];
+  };
+}
+
 export interface SuiParseTransactionOptions extends BaseParseTransactionOptions {
   txHex: string;
 }
@@ -280,6 +294,31 @@ export class Sui extends BaseCoin {
     return new TransactionBuilderFactory(coins.get(this.getChain()));
   }
 
+  /**
+   * Create a sponsored transaction where gas is paid by a different account
+   * @param params Parameters for creating a sponsored transaction
+   * @returns The built transaction ready for signing
+   */
+  async createSponsoredTransaction(params: CreateSponsoredTransactionOptions): Promise<TransferTransaction> {
+    const factory = this.getBuilder();
+    const gasData: GasDataWithSponsor = {
+      owner: params.sponsor,
+      price: params.gasData.price,
+      budget: params.gasData.budget,
+      payment: params.gasData.payment,
+      sponsor: params.sponsor,
+    };
+
+    const txBuilder = factory
+      .getTransferBuilder()
+      .type(SuiTransactionType.Transfer)
+      .sender(params.sender)
+      .send(params.recipients)
+      .gasData(gasData);
+
+    return (await txBuilder.build()) as TransferTransaction;
+  }
+
   private getAddressFromPublicKey(derivedPublicKey: string) {
     // TODO(BG-59016) replace with account lib implementation
     return utils.getAddressFromPublicKey(derivedPublicKey);