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

TICKET: WIN-6028

Author: abhishekagrawal080

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

@@ -58,6 +58,14 @@ export class CustomTransactionBuilder extends TransactionBuilder<CustomProgramma
       });
     }
 
+    // Ensure the transaction includes the fee payer signature if present
+    if (this._gasData && 'sponsor' in this._gasData && this._gasData.sponsor && this.transaction.feePayerSignature) {
+      this.transaction.addFeePayerSignature(
+        this.transaction.feePayerSignature.publicKey,
+        this.transaction.feePayerSignature.signature
+      );
+    }
+
     this.transaction.loadInputsAndOutputs();
     return this.transaction;
   }

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';
+
+/**
+ * Gas data for Sui transactions.
+ * For sponsored transactions, the sponsor field must be set.
+ */
+export interface GasData {
+  payment: SuiObjectRef[];
+  owner: SuiAddress;
+  price: number;
+  budget: number;
+  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/tokenTransferBuilder.ts

@@ -61,6 +61,14 @@ export class TokenTransferBuilder extends TransactionBuilder<TokenTransferProgra
       this.transaction.addSignature(signature.publicKey, signature.signature);
     });
 
+    // Ensure the transaction includes the fee payer signature if present
+    if (this._gasData && 'sponsor' in this._gasData && this._gasData.sponsor && this.transaction.feePayerSignature) {
+      this.transaction.addFeePayerSignature(
+        this.transaction.feePayerSignature.publicKey,
+        this.transaction.feePayerSignature.signature
+      );
+    }
+
     this.transaction.loadInputsAndOutputs();
     return this.transaction;
   }

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';
@@ -20,10 +20,12 @@ import { builder, MergeCoinsTransaction, TransactionType } from './mystenlab/bui
 import blake2b from '@bitgo/blake2b';
 import { hashTypedData } from './mystenlab/cryptography/hash';
 
-export abstract class Transaction<T> extends BaseTransaction {
+export abstract class Transaction<T = SuiProgrammableTransaction> extends BaseTransaction {
   protected _suiTransaction: SuiTransaction<T>;
   protected _signature: Signature;
+  protected _feePayerSignature: Signature;
   private _serializedSig: Uint8Array;
+  private _serializedFeePayerSig: Uint8Array;
 
   protected constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
@@ -48,17 +50,31 @@ export abstract class Transaction<T> extends BaseTransaction {
   addSignature(publicKey: BasePublicKey, signature: Buffer): void {
     this._signatures.push(signature.toString('hex'));
     this._signature = { publicKey, signature };
+    this.setSerializedSig(publicKey, signature);
     this.serialize();
   }
 
+  addFeePayerSignature(publicKey: BasePublicKey, signature: Buffer): void {
+    this._feePayerSignature = { publicKey, signature };
+    this.setSerializedFeePayerSig(publicKey, signature);
+  }
+
   get suiSignature(): Signature {
     return this._signature;
   }
 
+  get feePayerSignature(): Signature {
+    return this._feePayerSignature;
+  }
+
   get serializedSig(): Uint8Array {
     return this._serializedSig;
   }
 
+  get serializedFeePayerSig(): Uint8Array {
+    return this._serializedFeePayerSig;
+  }
+
   setSerializedSig(publicKey: BasePublicKey, signature: Buffer): void {
     const pubKey = Buffer.from(publicKey.pub, 'hex');
     const serialized_sig = new Uint8Array(1 + signature.length + pubKey.length);
@@ -68,6 +84,15 @@ export abstract class Transaction<T> extends BaseTransaction {
     this._serializedSig = serialized_sig;
   }
 
+  setSerializedFeePayerSig(publicKey: BasePublicKey, signature: Buffer): void {
+    const pubKey = Buffer.from(publicKey.pub, 'hex');
+    const serialized_sig = new Uint8Array(1 + signature.length + pubKey.length);
+    serialized_sig.set(SIGNATURE_SCHEME_BYTES);
+    serialized_sig.set(signature, 1);
+    serialized_sig.set(pubKey, 1 + signature.length);
+    this._serializedFeePayerSig = serialized_sig;
+  }
+
   /** @inheritdoc */
   canSign(key: BaseKey): boolean {
     return true;
@@ -78,7 +103,6 @@ export abstract class Transaction<T> extends BaseTransaction {
    *
    * @param {KeyPair} signer key
    */
-
   sign(signer: KeyPair): void {
     if (!this._suiTransaction) {
       throw new InvalidTransactionError('empty transaction to sign');
@@ -87,16 +111,56 @@ export abstract class Transaction<T> extends BaseTransaction {
     const intentMessage = this.signablePayload;
     const signature = signer.signMessageinUint8Array(intentMessage);
 
-    this.setSerializedSig({ pub: signer.getKeys().pub }, Buffer.from(signature));
     this.addSignature({ pub: signer.getKeys().pub }, Buffer.from(signature));
   }
 
+  /**
+   * Sign this transaction as a fee payer
+   *
+   * @param {KeyPair} signer key
+   */
+  signFeePayer(signer: KeyPair): void {
+    if (!this._suiTransaction) {
+      throw new InvalidTransactionError('empty transaction to sign');
+    }
+
+    if (
+      !this._suiTransaction.gasData ||
+      !('sponsor' in this._suiTransaction.gasData) ||
+      !this._suiTransaction.gasData.sponsor
+    ) {
+      throw new InvalidTransactionError('transaction does not have a fee payer');
+    }
+
+    const intentMessage = this.signablePayload;
+    const signature = signer.signMessageinUint8Array(intentMessage);
+
+    this.addFeePayerSignature({ pub: signer.getKeys().pub }, Buffer.from(signature));
+  }
+
   /** @inheritdoc */
   toBroadcastFormat(): string {
     if (!this._suiTransaction) {
       throw new InvalidTransactionError('Empty transaction');
     }
-    return this.serialize();
+
+    if (!this._serializedSig) {
+      throw new InvalidTransactionError('Transaction must be signed');
+    }
+
+    const result = {
+      txBytes: this.serialize(),
+      senderSignature: toB64(this._serializedSig),
+    };
+
+    if (this._suiTransaction.gasData?.sponsor) {
+      if (!this._serializedFeePayerSig) {
+        throw new InvalidTransactionError('Sponsored transaction must have fee payer signature');
+      }
+      result['sponsorSignature'] = toB64(this._serializedFeePayerSig);
+    }
+
+    return JSON.stringify(result);
   }
 
   /** @inheritdoc */
@@ -165,6 +229,19 @@ export abstract class Transaction<T> extends BaseTransaction {
     const inputs = transactionBlock.inputs.map((txInput) => txInput.value);
     const transactions = transactionBlock.transactions;
     const txType = this.getSuiTransactionType(transactions);
+
+    const gasData: GasData = {
+      payment: this.normalizeCoins(transactionBlock.gasConfig.payment!),
+      owner: normalizeSuiAddress(transactionBlock.gasConfig.owner!),
+      price: Number(transactionBlock.gasConfig.price as string),
+      budget: Number(transactionBlock.gasConfig.budget as string),
+    };
+
+    // Only add sponsor if it exists
+    if (transactionBlock.gasConfig.sponsor) {
+      gasData.sponsor = normalizeSuiAddress(transactionBlock.gasConfig.sponsor);
+    }
+
     return {
       id: transactionBlock.getDigest(),
       type: txType,
@@ -173,12 +250,7 @@ export abstract class Transaction<T> extends BaseTransaction {
         inputs: inputs,
         transactions: transactions,
       },
-      gasData: {
-        payment: this.normalizeCoins(transactionBlock.gasConfig.payment!),
-        owner: normalizeSuiAddress(transactionBlock.gasConfig.owner!),
-        price: Number(transactionBlock.gasConfig.price as string),
-        budget: Number(transactionBlock.gasConfig.budget as string),
-      },
+      gasData: gasData,
     };
   }
 
@@ -213,12 +285,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[] {
@@ -267,4 +347,15 @@ export abstract class Transaction<T> extends BaseTransaction {
 
     return inputGasPaymentObjects;
   }
+
+  hasFeePayerSig(): boolean {
+    return this._feePayerSignature !== undefined;
+  }
+
+  getFeePayerPubKey(): string | undefined {
+    if (!this._feePayerSignature || !this._feePayerSignature.publicKey) {
+      return undefined;
+    }
+    return this._feePayerSignature.publicKey.pub;
+  }
 }

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

@@ -14,10 +14,10 @@ import { Transaction } from './transaction';
 import utils from './utils';
 import BigNumber from 'bignumber.js';
 import { BaseCoin as CoinConfig } from '@bitgo/statics';
-import { SuiProgrammableTransaction, SuiTransactionType } from './iface';
+import { GasData, SuiProgrammableTransaction, SuiTransactionType } from './iface';
 import { DUMMY_SUI_GAS_PRICE } from './constants';
 import { KeyPair } from './keyPair';
-import { GasData, SuiObjectRef } from './mystenlab/types';
+import { SuiObjectRef } from './mystenlab/types';
 
 export abstract class TransactionBuilder<T = SuiProgrammableTransaction> extends BaseTransactionBuilder {
   protected _transaction: Transaction<T>;
@@ -52,7 +52,34 @@ export abstract class TransactionBuilder<T = SuiProgrammableTransaction> extends
   protected signImplementation(key: BaseKey): Transaction<T> {
     const signer = new KeyPair({ prv: key.key });
     this._signer = signer;
-    this.transaction.sign(signer);
+    const signable = this.transaction.signablePayload;
+    const signature = signer.signMessageinUint8Array(signable);
+    const signatureBuffer = Buffer.from(signature);
+    this.transaction.addSignature({ pub: signer.getKeys().pub }, signatureBuffer);
+    this.transaction.setSerializedSig({ pub: signer.getKeys().pub }, signatureBuffer);
+    return this.transaction;
+  }
+
+  /**
+   * Signs the transaction as a fee payer.
+   *
+   * @param {BaseKey} key - The private key to sign the transaction with.
+   * @returns {Transaction<T>} - The signed transaction.
+   */
+  signFeePayer(key: BaseKey): Transaction<T> {
+    this.validateKey(key);
+
+    // Check if gasData exists and has a sponsor
+    if (!this._gasData?.sponsor) {
+      throw new BuildTransactionError('Transaction must have a fee payer (sponsor) to sign as fee payer');
+    }
+
+    const signer = new KeyPair({ prv: key.key });
+    const signable = this.transaction.signablePayload;
+    const signature = signer.signMessageinUint8Array(signable);
+    const signatureBuffer = Buffer.from(signature);
+    this.transaction.addFeePayerSignature({ pub: signer.getKeys().pub }, signatureBuffer);
+
     return this.transaction;
   }
 
@@ -87,6 +114,30 @@ export abstract class TransactionBuilder<T = SuiProgrammableTransaction> extends
     return this;
   }
 
+  /**
+   * Sets the gas sponsor (fee payer) address for this transaction.
+   * When specified, the sponsor will be responsible for paying transaction fees.
+   *
+   * @param {string} sponsorAddress the account that will pay for this transaction
+   * @returns {TransactionBuilder} This transaction builder
+   */
+  sponsor(sponsorAddress: string): this {
+    if (!utils.isValidAddress(sponsorAddress)) {
+      throw new BuildTransactionError('Invalid or missing sponsor, got: ' + sponsorAddress);
+    }
+    if (!this._gasData) {
+      throw new BuildTransactionError('gasData must be set before setting sponsor');
+    }
+
+    // Update the gasData with the sponsor
+    this._gasData = {
+      ...this._gasData,
+      sponsor: sponsorAddress,
+    };
+
+    return this;
+  }
+
   /**
    * Initialize the transaction builder fields using the decoded transaction data
    *
@@ -117,6 +168,14 @@ export abstract class TransactionBuilder<T = SuiProgrammableTransaction> extends
     if (!utils.isValidAddress(gasData.owner)) {
       throw new BuildTransactionError('Invalid gas address ' + gasData.owner);
     }
+
+    // Validate sponsor address if present
+    if ('sponsor' in gasData && gasData.sponsor !== undefined) {
+      if (!utils.isValidAddress(gasData.sponsor)) {
+        throw new BuildTransactionError('Invalid sponsor address ' + gasData.sponsor);
+      }
+    }
+
     this.validateGasPayment(gasData.payment);
     this.validateGasBudget(gasData.budget);
     this.validateGasPrice(gasData.price);