Merge main (relayer v3) into feat

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiversx/sdk-core",
-  "version": "13.15.0",
+  "version": "13.16.0",
   "description": "MultiversX SDK for JavaScript and TypeScript",
   "author": "MultiversX",
   "homepage": "https://multiversx.com",

src/interface.ts

@@ -16,6 +16,7 @@ export interface IPlainTransactionObject {
     receiverUsername?: string;
     senderUsername?: string;
     guardian?: string;
+    relayer?: string;
     gasPrice: number;
     gasLimit: number;
     data?: string;
@@ -24,6 +25,7 @@ export interface IPlainTransactionObject {
     options?: number;
     signature?: string;
     guardianSignature?: string;
+    relayerSignature?: string;
 }
 
 export interface ISignature {

src/proto/serializer.ts

@@ -15,7 +15,7 @@
      * Serializes a Transaction object to a Buffer. Handles low-level conversion logic and field-mappings as well.
      */
     serializeTransaction(transaction: Transaction): Buffer {
         const proto = require("./compiled").proto;
 
         const protoTransaction = this.convertToProtoMessage(transaction);
         const encoded = proto.Transaction.encode(protoTransaction).finish();
@@ -25,7 +25,7 @@
     }
 
     private convertToProtoMessage(transaction: Transaction) {
         const proto = require("./compiled").proto;
 
         const receiverPubkey = transaction.receiver.getPublicKey();
         const senderPubkey = transaction.sender.getPublicKey();
@@ -59,9 +59,18 @@
             protoTransaction.GuardianSignature = transaction.guardianSignature;
         }
 
+        if (this.isRelayedTransaction(transaction)) {
+            protoTransaction.Relayer = transaction.relayer?.getPublicKey();
+            protoTransaction.RelayerSignature = transaction.relayerSignature;
+        }
+
         return protoTransaction;
     }
 
+    private isRelayedTransaction(transaction: Transaction) {
+        return !transaction.relayer.isEmpty();
+    }
+
     /**
      * Custom serialization, compatible with mx-chain-go.
      */

src/proto/transaction.proto

@@ -25,4 +25,6 @@ message Transaction {
 	uint32   Options                       = 13;
 	bytes    GuardianAddr                  = 14;
 	bytes    GuardianSignature             = 15;
+	bytes    Relayer                       = 16;
+	bytes    RelayerSignature              = 17;
 }

src/transaction.spec.ts

@@ -784,8 +784,49 @@ describe("test transaction", async () => {
             version: 2,
             options: undefined,
             guardian: undefined,
+            relayer: undefined,
             signature: undefined,
             guardianSignature: undefined,
+            relayerSignature: undefined,
         });
     });
+    it("should serialize transaction with relayer", async () => {
+        const transaction = new Transaction({
+            chainID: networkConfig.ChainID,
+            sender: wallets.alice.address,
+            receiver: wallets.alice.address,
+            relayer: wallets.bob.address,
+            gasLimit: 50000n,
+            value: 0n,
+            version: 2,
+            nonce: 89n,
+        });
+
+        const serializedTransactionBytes = transactionComputer.computeBytesForSigning(transaction);
+        const serializedTransaction = Buffer.from(serializedTransactionBytes).toString();
+
+        assert.equal(
+            serializedTransaction,
+            `{"nonce":89,"value":"0","receiver":"erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th","sender":"erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th","gasPrice":1000000000,"gasLimit":50000,"chainID":"D","version":2,"relayer":"erd1spyavw0956vq68xj8y4tenjpq2wd5a9p2c6j8gsz7ztyrnpxrruqzu66jx"}`,
+        );
+    });
+
+    it("should test relayed v3", async () => {
+        const transaction = new Transaction({
+            chainID: networkConfig.ChainID,
+            sender: wallets.alice.address,
+            receiver: wallets.alice.address,
+            senderUsername: "alice",
+            receiverUsername: "bob",
+            gasLimit: 80000n,
+            value: 0n,
+            version: 2,
+            nonce: 89n,
+            data: Buffer.from("hello"),
+        });
+
+        assert.isFalse(transactionComputer.isRelayedV3Transaction(transaction));
+        transaction.relayer = wallets.carol.address;
+        assert.isTrue(transactionComputer.isRelayedV3Transaction(transaction));
+    });
 });

src/transaction.ts

@@ -76,6 +76,12 @@ export class Transaction {
      */
     public guardian: Address;
 
+    /**
+     * The relayer address.
+     *  Note: in the next major version, `sender`, `receiver` and `guardian` will also have the type `Address`, instead of `string`.
+     */
+    public relayer: Address;
+
     /**
      * The signature.
      */
@@ -86,6 +92,11 @@ export class Transaction {
      */
     public guardianSignature: Uint8Array;
 
+    /**
+     * The signature of the relayer.
+     */
+    public relayerSignature: Uint8Array;
+
     /**
      * Creates a new Transaction object.
      */
@@ -103,8 +114,10 @@ export class Transaction {
         version?: number;
         options?: number;
         guardian?: Address;
+        relayer?: Address;
         signature?: Uint8Array;
         guardianSignature?: Uint8Array;
+        relayerSignature?: Uint8Array;
     }) {
         this.nonce = BigInt(options.nonce?.valueOf() || 0n);
         // We still rely on "bigNumber" for value, because client code might be passing a BigNumber object as a legacy "ITransactionValue",
@@ -121,9 +134,11 @@ export class Transaction {
         this.version = Number(options.version?.valueOf() || TRANSACTION_VERSION_DEFAULT);
         this.options = Number(options.options?.valueOf() || TRANSACTION_OPTIONS_DEFAULT);
         this.guardian = options.guardian ?? Address.empty();
+        this.relayer = options.relayer ? options.relayer : Address.empty();
 
         this.signature = options.signature || Buffer.from([]);
         this.guardianSignature = options.guardianSignature || Buffer.from([]);
+        this.relayerSignature = options.relayerSignature || Buffer.from([]);
     }
 
     /**
@@ -358,8 +373,10 @@ export class Transaction {
             version: this.version,
             options: this.options == 0 ? undefined : this.options,
             guardian: this.guardian.isEmpty() ? undefined : this.guardian.toBech32(),
+            relayer: this.relayer.isEmpty() ? undefined : this.relayer.toBech32(),
             signature: this.toHexOrUndefined(this.signature),
             guardianSignature: this.toHexOrUndefined(this.guardianSignature),
+            relayerSignature: this.toHexOrUndefined(this.relayerSignature),
         };
 
         return plainObject;
@@ -389,6 +406,7 @@ export class Transaction {
             sender: Address.newFromBech32(object.sender),
             senderUsername: Buffer.from(object.senderUsername || "", "base64").toString(),
             guardian: object.guardian ? Address.newFromBech32(object.guardian) : Address.empty(),
+            relayer: object.relayer ? Address.newFromBech32(object.relayer) : Address.empty(),
             gasPrice: BigInt(object.gasPrice),
             gasLimit: BigInt(object.gasLimit),
             data: Buffer.from(object.data || "", "base64"),
@@ -397,6 +415,7 @@ export class Transaction {
             options: Number(object.options),
             signature: Buffer.from(object.signature || "", "hex"),
             guardianSignature: Buffer.from(object.guardianSignature || "", "hex"),
+            relayerSignature: Buffer.from(object.relayerSignature || "", "hex"),
         });
 
         return transaction;

src/transactionComputer.ts

@@ -94,6 +94,10 @@ export class TransactionComputer {
         transaction.guardian = guardian;
     }
 
+    isRelayedV3Transaction(transaction: Transaction) {
+        return !transaction.relayer.isEmpty();
+    }
+
     applyOptionsForHashSigning(transaction: Transaction) {
         if (transaction.version < MIN_TRANSACTION_VERSION_THAT_SUPPORTS_OPTIONS) {
             transaction.version = MIN_TRANSACTION_VERSION_THAT_SUPPORTS_OPTIONS;
@@ -122,6 +126,7 @@ export class TransactionComputer {
         obj.version = transaction.version;
         obj.options = transaction.options ? transaction.options : undefined;
         obj.guardian = transaction.guardian.isEmpty() ? undefined : transaction.guardian.toBech32();
+        obj.relayer = transaction.relayer?.isEmpty() ? undefined : transaction.relayer?.toBech32();
 
         return obj;
     }