Merge pull request #6423 from BitGo/WIN-6028

feat(sdk-coin-sui): fee payer signing support

Author: abhishekagrawal080

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

@@ -24,6 +24,8 @@ export abstract class Transaction<T> extends BaseTransaction {
   protected _suiTransaction: SuiTransaction<T>;
   protected _signature: Signature;
   private _serializedSig: Uint8Array;
+  protected _feePayerSignature: Signature;
+  private _serializedFeePayerSig: Uint8Array;
 
   protected constructor(_coinConfig: Readonly<CoinConfig>) {
     super(_coinConfig);
@@ -51,6 +53,12 @@ export abstract class Transaction<T> extends BaseTransaction {
     this.serialize();
   }
 
+  addFeePayerSignature(publicKey: BasePublicKey, signature: Buffer): void {
+    this._signatures.push(signature.toString('hex'));
+    this._feePayerSignature = { publicKey, signature };
+    this.serialize();
+  }
+
   get suiSignature(): Signature {
     return this._signature;
   }
@@ -59,6 +67,10 @@ export abstract class Transaction<T> extends BaseTransaction {
     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 +80,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;
@@ -91,6 +112,28 @@ export abstract class Transaction<T> extends BaseTransaction {
     this.addSignature({ pub: signer.getKeys().pub }, Buffer.from(signature));
   }
 
+  /**
+   * Sign transaction as the gas owner (fee payer).
+   *
+   * @param {KeyPair} ownerKey - Key for gas owner.
+   */
+  signAsFeePayer(signer: KeyPair): void {
+    if (!this._suiTransaction) {
+      throw new InvalidTransactionError('empty transaction to sign');
+    }
+
+    const intentMessage = this.signablePayload;
+    const signature = signer.signMessageinUint8Array(intentMessage);
+
+    this._feePayerSignature = {
+      publicKey: { pub: signer.getKeys().pub },
+      signature: Buffer.from(signature),
+    };
+
+    // Set serialized signature for fee payer
+    this.setSerializedFeePayerSig({ pub: signer.getKeys().pub }, Buffer.from(signature));
+  }
+
   /** @inheritdoc */
   toBroadcastFormat(): string {
     if (!this._suiTransaction) {

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

@@ -63,6 +63,12 @@ export abstract class TransactionBuilder<T = SuiProgrammableTransaction> extends
     this.transaction.setSerializedSig(publicKey, signature);
   }
 
+  addFeePayerSignature(publicKey: BasePublicKey, signature: Buffer): void {
+    this._signatures.push({ publicKey, signature });
+    this.transaction.addFeePayerSignature(publicKey, signature);
+    this.transaction.setSerializedFeePayerSig(publicKey, signature);
+  }
+
   /**
    * Sets the sender of this transaction.
    * This account will be responsible for paying transaction fees.

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

@@ -39,6 +39,12 @@ export const sender = {
     'AETvicGY1HwWjQokRg2HgbQeu+QQZP4ejZQGjmfWvPUd2WkzBudVlaSzjiS1btS2/34Laf6rfkNKYD540crafAxzTVAmV/9J1skZyoX4AWkJM/R4Y1FfV36atFLbCwUVqQ==',
 };
 
+export const feePayer = {
+  address: '0x77291376d885efa752ed921b48d1aa1a65a389bf214ec0eab8b31970c9ab3618',
+  publicKey: 'TBP5Vc7o+A1dlVd7B/YktCMi2K4frfBqG5FoKAlSRyI=',
+  signatureHex: '0sQRp5hwfSnjOXx/hofBbzR/AOmDmeIexKYYzqf9T/xPXx8/TTGlvOS6P+fvzQhSPyCi0BV8DKPkgC0DEDqXAg==',
+};
+
 export const recipients: Recipient[] = [
   {
     address: addresses.validAddresses[0],
@@ -326,6 +332,13 @@ export const gasData = {
   budget: GAS_BUDGET,
 };
 
+export const gasDataHavingDifferentOwner = {
+  payment: coinsGasPayment,
+  owner: feePayer.address,
+  price: DUMMY_SUI_GAS_PRICE,
+  budget: GAS_BUDGET,
+};
+
 export const gasDataWithoutGasPayment = {
   owner: sender.address,
   price: DUMMY_SUI_GAS_PRICE,
@@ -385,6 +398,9 @@ export const CUSTOM_TX_PUBLIC_TRANSFER =
 export const UNSUPPORTED_TX =
   'AAADAQB8/cv/rmQ4SGTkEEwSbyfbLPq1wUyg1W6IvFtoo+8KqlC2vgAAAAAAICf6QebgEjDOJoW4sw5jWv5y/UufjHTKEBOHgJuTvJUiAQCxKLKh9y8GFhre5P0lgTbBRPtAyf0t8qUokHbou50E7NKapQAAAAAAIOQxj17At6WByUlaVwW8ARhUgNYg+4piw4zD/Y0NmkGkACD2MpmTSjDA8xA/Swgzt0TpPwDQMzvfr4FvB1MJAXguuAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAMMc3Rha2luZ19wb29sEHNwbGl0X3N0YWtlZF9zdWkAAgEAAAEBAAEBAgAAAQIA07HNlidQ0GBG1SOg7xObuweDJ/1vEx0EdAuFFDmMwsEBG9JpdXApX73818xmw/q0XMj4sGCPGfoT7IqE5kfKbrgJAAAAAAAAACBx2foz6S5yGPqcihv4KTDtuVntp4JleEuKIOTdKq6RONOxzZYnUNBgRtUjoO8Tm7sHgyf9bxMdBHQLhRQ5jMLB6AMAAAAAAAAAypo7AAAAAAA=';
 
+export const FEE_SPONSOR_TRANSFER =
+  'AAAEAAhkAAAAAAAAAAAg+UGuPL5WRdzMFdqDRrUz9/kfICCJpVIWU8Bisv8QswQACGQAAAAAAAAAACB3w7WyESl5PEpWAiIKS5cAB8VNSplt6UHltxNxmkL4/gQCAAEBAAABAQIAAAEBAAIAAQECAAEBAgIAAQMAmIIYi6PoBwqbsGrpRGz2B5FO6O5Y7YMGo+Ov/1obu3ECCcQFIq7VS87PpINgXF2lghsXGsGqG2FZcfuN/iftE/1RBAAAAAAAACC2RGfJXC7cVwfXSDKdKwQB/rPC0/3tdlzDSomluG57sifdAOf8zch7TZW2OEtzkRm5HyqBoWuu3qf04AaOUpQ32QAAAAAAAAAgvik+0ypZjmC8kkbE4BtuQpN/FomQiDpqIFB6wsFNJyd3KRN22IXvp1LtkhtI0aoaZaOJvyFOwOq4sxlwyas2GOgDAAAAAAAAAC0xAQAAAAAA';
+
 export const invalidRecipients: Recipient[] = [
   {
     address: addresses.invalidAddresses[0],

modules/sdk-coin-sui/test/unit/transactionBuilder/transactionBuilder.ts

@@ -63,6 +63,41 @@ describe('Sui Transaction Builder', async () => {
       reserialized.toBroadcastFormat().should.equal(rawSignedTx);
     });
 
+    it('should build and sign a transfer tx with gasPayment as different owner', async function () {
+      const txBuilder = factory.getTransferBuilder();
+      txBuilder.type(SuiTransactionType.Transfer);
+      txBuilder.sender(testData.sender.address);
+      txBuilder.send(recipients);
+      txBuilder.gasData(testData.gasDataHavingDifferentOwner);
+      const tx = await txBuilder.build();
+      should.equal(tx.id, 'UNAVAILABLE');
+      const rawTx = tx.toBroadcastFormat();
+      should.equal(rawTx, testData.FEE_SPONSOR_TRANSFER);
+
+      const txBuilder2 = await factory.from(rawTx);
+      await txBuilder2.addSignature({ pub: testData.sender.publicKey }, Buffer.from(testData.sender.signatureHex));
+      await txBuilder2.addFeePayerSignature(
+        { pub: testData.feePayer.publicKey },
+        Buffer.from(testData.feePayer.signatureHex)
+      );
+      const signedTx = await txBuilder2.build();
+      should.equal(signedTx.type, TransactionType.Send);
+      should.equal(signedTx.id, 'Co5d6tiLQuwUPrfPp7vfmcJMNK5gWZ3StFR6cvzq6R12');
+
+      const rawSignedTx = signedTx.toBroadcastFormat();
+      should.equal(rawSignedTx, testData.FEE_SPONSOR_TRANSFER);
+      const reserializedTxBuilder = factory.from(rawSignedTx);
+      reserializedTxBuilder.addSignature({ pub: testData.sender.publicKey }, Buffer.from(testData.sender.signatureHex));
+      reserializedTxBuilder.addFeePayerSignature(
+        { pub: testData.feePayer.publicKey },
+        Buffer.from(testData.feePayer.signatureHex)
+      );
+      const reserialized = await reserializedTxBuilder.build();
+
+      reserialized.should.be.deepEqual(signedTx);
+      reserialized.toBroadcastFormat().should.equal(rawSignedTx);
+    });
+
     it('should submit a transfer transaction with private keys', async () => {
       const keyPairSender = new KeyPair({ prv: testData.privateKeys.prvKey1 });
       const keyPairRecipient = new KeyPair({ prv: testData.privateKeys.prvKey2 });