add method for creating relayed v1 transactions

multiversx · Jan 3, 2024 · ed2bb69 · ed2bb69
1 parent e118d83
commit ed2bb69
Show file tree

Hide file tree

Showing 4 changed files with 241 additions and 6 deletions.
diff --git a/src/errors.ts b/src/errors.ts
@@ -360,4 +360,4 @@ export class ErrInvalidInnerTransaction extends Err{
   public constructor(message: string){
     super(message);
   }
-}
+}
diff --git a/src/transaction.ts b/src/transaction.ts
@@ -1,7 +1,7 @@
 import { BigNumber } from "bignumber.js";
 import { Address } from "./address";
 import { Compatibility } from "./compatibility";
-import { TRANSACTION_MIN_GAS_PRICE, TRANSACTION_OPTIONS_DEFAULT } from "./constants";
+import { TRANSACTION_MIN_GAS_PRICE, TRANSACTION_OPTIONS_DEFAULT, TRANSACTION_VERSION_DEFAULT } from "./constants";
 import * as errors from "./errors";
 import { Hash } from "./hash";
 import { IAddress, IChainID, IGasLimit, IGasPrice, INonce, IPlainTransactionObject, ISignature, ITransactionNext, ITransactionOptions, ITransactionPayload, ITransactionValue, ITransactionVersion } from "./interface";
@@ -614,7 +614,7 @@ export class TransactionNext{
       this.gasLimit = gasLimit;
       this.data = data || new Uint8Array();
       this.chainID = chainID;
-      this.version = version || TRANSACTION_OPTIONS_DEFAULT;
+      this.version = version || TRANSACTION_VERSION_DEFAULT;
       this.options = options || TRANSACTION_OPTIONS_DEFAULT;
       this.guardian = guardian || "";
 

diff --git a/src/transactionsFactories/relayedTransactionsFactory.spec.ts b/src/transactionsFactories/relayedTransactionsFactory.spec.ts
@@ -0,0 +1,181 @@
+import { assert } from "chai";
+import { TestWallet, loadTestWallets } from "../testutils";
+import { TransactionComputer, TransactionNext } from "../transaction";
+import { RelayedTransactionsFactory } from "./relayedTransactionsFactory";
+import { TransactionsFactoryConfig } from "./transactionsFactoryConfig";
+import BigNumber from "bignumber.js";
+
+describe("test relayed v1 transaction builder", function () {
+    const config = new TransactionsFactoryConfig("T");
+    const factory = new RelayedTransactionsFactory(config);
+    const transactionComputer = new TransactionComputer();
+    let alice: TestWallet, bob: TestWallet, carol: TestWallet, grace: TestWallet, frank: TestWallet;
+
+    before(async function () {
+        ({ alice, bob, carol, grace, frank } = await loadTestWallets());
+    });
+
+    it("should throw exception when creating relayed v1 transaction with invalid inner transaction", async function () {
+        let innerTransaction = new TransactionNext({
+            sender: alice.address.bech32(),
+            receiver: "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqzllls8a5w6u",
+            gasLimit: 10000000,
+            data: Buffer.from("getContractConfig"),
+            chainID: config.chainID,
+        });
+
+        assert.throws(() => {
+            factory.createRelayedV1Transaction({ innerTransaction: innerTransaction, relayerAddress: bob.address }),
+                "The inner transaction is not signed";
+        });
+
+        innerTransaction.gasLimit = 0;
+        innerTransaction.signature = Buffer.from("invalidsignature");
+
+        assert.throws(() => {
+            factory.createRelayedV1Transaction({ innerTransaction: innerTransaction, relayerAddress: bob.address }),
+                "The gas limit is not set for the inner transaction";
+        });
+    });
+
+    it("should create relayed v1 transaction", async function () {
+        let innerTransaction = new TransactionNext({
+            sender: bob.address.bech32(),
+            receiver: "erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqzllls8a5w6u",
+            gasLimit: 60000000,
+            data: Buffer.from("getContractConfig"),
+            chainID: config.chainID,
+            nonce: 198,
+        });
+
+        const serializedInnerTransaction = transactionComputer.computeBytesForSigning(innerTransaction);
+        innerTransaction.signature = await bob.signer.sign(Buffer.from(serializedInnerTransaction));
+
+        const relayedTransaction = factory.createRelayedV1Transaction({
+            innerTransaction: innerTransaction,
+            relayerAddress: alice.address,
+        });
+        relayedTransaction.nonce = 2627;
+
+        const serializedRelayedTransaction = transactionComputer.computeBytesForSigning(relayedTransaction);
+        relayedTransaction.signature = await alice.signer.sign(Buffer.from(serializedRelayedTransaction));
+
+        assert.equal(
+            Buffer.from(relayedTransaction.data).toString(),
+            "relayedTx@7b226e6f6e6365223a3139382c2273656e646572223a2267456e574f65576d6d413063306a6b71764d354241707a61644b46574e534f69417643575163776d4750673d222c227265636569766572223a22414141414141414141414141415141414141414141414141414141414141414141414141414141432f2f383d222c2276616c7565223a302c226761735072696365223a313030303030303030302c226761734c696d6974223a36303030303030302c2264617461223a225a3256305132397564484a68593352446232356d6157633d222c227369676e6174757265223a2272525455544858677a4273496e4f6e454b6b7869642b354e66524d486e33534948314673746f577352434c434b3258514c41614f4e704449346531476173624c5150616130566f364144516d4f2b52446b6f364a43413d3d222c22636861696e4944223a2256413d3d222c2276657273696f6e223a327d"
+        );
+        assert.equal(
+            Buffer.from(relayedTransaction.signature).toString("hex"),
+            "128e7cdc14c2b9beee2f3ff7a7fa5d1f5ef31a654a0c92e223c90ab28265fa277d306f23a06536248cf9573e828017004fb639617fade4d68a37524aafca710d"
+        );
+    });
+
+    it("should create relayed v1 transaction with usernames", async function () {
+        let innerTransaction = new TransactionNext({
+            sender: carol.address.bech32(),
+            receiver: alice.address.bech32(),
+            gasLimit: 50000,
+            chainID: config.chainID,
+            nonce: 208,
+            senderUsername: "carol",
+            receiverUsername: "alice",
+            value: new BigNumber("1000000000000000000"),
+        });
+
+        const serializedInnerTransaction = transactionComputer.computeBytesForSigning(innerTransaction);
+        innerTransaction.signature = await carol.signer.sign(Buffer.from(serializedInnerTransaction));
+
+        const relayedTransaction = factory.createRelayedV1Transaction({
+            innerTransaction: innerTransaction,
+            relayerAddress: frank.address,
+        });
+        relayedTransaction.nonce = 715;
+
+        const serializedRelayedTransaction = transactionComputer.computeBytesForSigning(relayedTransaction);
+        relayedTransaction.signature = await frank.signer.sign(Buffer.from(serializedRelayedTransaction));
+
+        assert.equal(
+            Buffer.from(relayedTransaction.data).toString(),
+            "relayedTx@7b226e6f6e6365223a3230382c2273656e646572223a227371455656633553486b6c45344a717864556e59573068397a536249533141586f3534786f32634969626f3d222c227265636569766572223a2241546c484c76396f686e63616d433877673970645168386b77704742356a6949496f3349484b594e6165453d222c2276616c7565223a313030303030303030303030303030303030302c226761735072696365223a313030303030303030302c226761734c696d6974223a35303030302c2264617461223a22222c227369676e6174757265223a226a33427a6469554144325963517473576c65707663664a6f75657a48573063316b735a424a4d6339573167435450512b6870636759457858326f6f367a4b5654347464314b4b6f79783841526a346e336474576c44413d3d222c22636861696e4944223a2256413d3d222c2276657273696f6e223a322c22736e64557365724e616d65223a22593246796232773d222c22726376557365724e616d65223a22595778705932553d227d"
+        );
+        assert.equal(
+            Buffer.from(relayedTransaction.signature).toString("hex"),
+            "3787d640e5a579e7977a4a1bcdd435ad11855632fa4a414a06fbf8355692d1a58d76ef0adbdd6ccd6bd3c329f36bd53c180d4873ec1a6c558e659aeb9ab92d00"
+        );
+    });
+
+    it("should create relayed v1 transaction with guarded inner transaction", async function () {
+        let innerTransaction = new TransactionNext({
+            sender: bob.address.bech32(),
+            receiver: "erd1qqqqqqqqqqqqqpgq54tsxmej537z9leghvp69hfu4f8gg5eu396q83gnnz",
+            gasLimit: 60000000,
+            chainID: config.chainID,
+            data: Buffer.from("getContractConfig"),
+            nonce: 198,
+            version: 2,
+            options: 2,
+            guardian: grace.address.bech32(),
+        });
+
+        const serializedInnerTransaction = transactionComputer.computeBytesForSigning(innerTransaction);
+        innerTransaction.signature = await bob.signer.sign(Buffer.from(serializedInnerTransaction));
+        innerTransaction.guardianSignature = await grace.signer.sign(Buffer.from(serializedInnerTransaction));
+
+        const relayedTransaction = factory.createRelayedV1Transaction({
+            innerTransaction: innerTransaction,
+            relayerAddress: alice.address,
+        });
+        relayedTransaction.nonce = 2627;
+
+        const serializedRelayedTransaction = transactionComputer.computeBytesForSigning(relayedTransaction);
+        relayedTransaction.signature = await alice.signer.sign(Buffer.from(serializedRelayedTransaction));
+
+        assert.equal(
+            Buffer.from(relayedTransaction.data).toString(),
+            "relayedTx@7b226e6f6e6365223a3139382c2273656e646572223a2267456e574f65576d6d413063306a6b71764d354241707a61644b46574e534f69417643575163776d4750673d222c227265636569766572223a22414141414141414141414146414b565841323879704877692f79693741364c64504b704f68464d386958513d222c2276616c7565223a302c226761735072696365223a313030303030303030302c226761734c696d6974223a36303030303030302c2264617461223a225a3256305132397564484a68593352446232356d6157633d222c227369676e6174757265223a224b4b78324f33383655725135416b4f465258307578327933446a384853334b373038487174344668377161557669424550716c45614e746e6158706a6f2f333651476d4a456934784435457a6c6f4f677a634d4442773d3d222c22636861696e4944223a2256413d3d222c2276657273696f6e223a322c226f7074696f6e73223a322c22677561726469616e223a22486f714c61306e655733766843716f56696c70715372744c5673774939535337586d7a563868477450684d3d222c22677561726469616e5369676e6174757265223a222b5431526f4833625a792f54423177342b6a365155477258645637457577553073753948646551626453515269463953757a686d634b705463526d58595252366c534c6652394931624d7134674730436538363741513d3d227d"
+        );
+        assert.equal(
+            Buffer.from(relayedTransaction.signature).toString("hex"),
+            "39cff9d5100e290fbc7361cb6e2402261caf864257b4116f150e0c61e7869155dff8361fa5449431eb7a8ed847c01ba9b3b5ebafe5fac1a3d40c64829d827e00"
+        );
+    });
+
+    it("should create guarded relayed v1 transaction with guarded inner transaction", async function () {
+        let innerTransaction = new TransactionNext({
+            sender: bob.address.bech32(),
+            receiver: "erd1qqqqqqqqqqqqqpgq54tsxmej537z9leghvp69hfu4f8gg5eu396q83gnnz",
+            gasLimit: 60000000,
+            chainID: config.chainID,
+            data: Buffer.from("addNumber"),
+            nonce: 198,
+            version: 2,
+            options: 2,
+            guardian: grace.address.bech32(),
+        });
+
+        const serializedInnerTransaction = transactionComputer.computeBytesForSigning(innerTransaction);
+        innerTransaction.signature = await bob.signer.sign(Buffer.from(serializedInnerTransaction));
+        innerTransaction.guardianSignature = await grace.signer.sign(Buffer.from(serializedInnerTransaction));
+
+        const relayedTransaction = factory.createRelayedV1Transaction({
+            innerTransaction: innerTransaction,
+            relayerAddress: alice.address,
+        });
+        relayedTransaction.nonce = 2627;
+        relayedTransaction.options = 2;
+        relayedTransaction.guardian = frank.address.bech32();
+
+        const serializedRelayedTransaction = transactionComputer.computeBytesForSigning(relayedTransaction);
+        relayedTransaction.signature = await alice.signer.sign(Buffer.from(serializedRelayedTransaction));
+        relayedTransaction.guardianSignature = await frank.signer.sign(Buffer.from(serializedRelayedTransaction));
+
+        assert.equal(
+            Buffer.from(relayedTransaction.data).toString(),
+            "relayedTx@7b226e6f6e6365223a3139382c2273656e646572223a2267456e574f65576d6d413063306a6b71764d354241707a61644b46574e534f69417643575163776d4750673d222c227265636569766572223a22414141414141414141414146414b565841323879704877692f79693741364c64504b704f68464d386958513d222c2276616c7565223a302c226761735072696365223a313030303030303030302c226761734c696d6974223a36303030303030302c2264617461223a225957526b546e5674596d5679222c227369676e6174757265223a223469724d4b4a656d724d375174344e7635487633544c44683775654779487045564c4371674a3677652f7a662b746a4933354975573452633458543451533433475333356158386c6a533834324a38426854645043673d3d222c22636861696e4944223a2256413d3d222c2276657273696f6e223a322c226f7074696f6e73223a322c22677561726469616e223a22486f714c61306e655733766843716f56696c70715372744c5673774939535337586d7a563868477450684d3d222c22677561726469616e5369676e6174757265223a2270424754394e674a78307539624c56796b654d78786a454865374269696c37764932324a46676f32787a6e2f496e3032463769546563356b44395045324f747065386c475335412b532f4a36417762576834446744673d3d227d"
+        );
+        assert.equal(
+            Buffer.from(relayedTransaction.signature).toString("hex"),
+            "8ede1bbeed96b102344dffeac12c2592c62b7313cdeb132e8c8bf11d2b1d3bb8189d257a6dbcc99e222393d9b9ec77656c349dae97a32e68bdebd636066bf706"
+        );
+    });
+});
diff --git a/src/transactionsFactories/relayedTransactionsFactory.ts b/src/transactionsFactories/relayedTransactionsFactory.ts
@@ -1,7 +1,8 @@
 import BigNumber from "bignumber.js";
-import { Transaction } from "../transaction";
+import { TransactionNext } from "../transaction";
 import { IAddress } from "../interface";
 import { ErrInvalidInnerTransaction } from "../errors";
+import { Address } from "../address";
 
 interface IConfig {
     chainID: string;
@@ -16,9 +17,62 @@ export class RelayedTransactionsFactory {
         this.config = config;
     }
 
-    createRelayedV1Transaction(options: { innerTransaction: Transaction; relayerAddress: IAddress }) {
-        if (!options.innerTransaction.getGasLimit()) {
+    createRelayedV1Transaction(options: {
+        innerTransaction: TransactionNext;
+        relayerAddress: IAddress;
+    }): TransactionNext {
+        if (!options.innerTransaction.gasLimit) {
             throw new ErrInvalidInnerTransaction("The gas limit is not set for the inner transaction");
         }
+
+        if (!options.innerTransaction.signature.length) {
+            throw new ErrInvalidInnerTransaction("The inner transaction is not signed");
+        }
+
+        const serializedTransaction = this.prepareInnerTransactionForRelayedV1(options.innerTransaction);
+        const data = `relayedTx@${Buffer.from(serializedTransaction).toString("hex")}`;
+
+        const gasForDataLength = new BigNumber(this.config.gasLimitPerByte).multipliedBy(new BigNumber(data.length));
+        const gasLimit = new BigNumber(this.config.minGasLimit)
+            .plus(gasForDataLength)
+            .plus(new BigNumber(options.innerTransaction.gasLimit));
+
+        return new TransactionNext({
+            chainID: this.config.chainID,
+            sender: options.relayerAddress.bech32(),
+            receiver: options.innerTransaction.sender,
+            gasLimit: gasLimit,
+            data: Buffer.from(data),
+        });
+    }
+
+    private prepareInnerTransactionForRelayedV1(innerTransaction: TransactionNext): string {
+        const txObject = {
+            nonce: new BigNumber(innerTransaction.nonce.toString(), 10).toNumber(),
+            sender: Address.fromBech32(innerTransaction.sender).pubkey().toString("base64"),
+            receiver: Address.fromBech32(innerTransaction.receiver).pubkey().toString("base64"),
+            value: new BigNumber(innerTransaction.value.toString(), 10).toNumber(),
+            gasPrice: new BigNumber(innerTransaction.gasPrice.toString(), 10).toNumber(),
+            gasLimit: new BigNumber(innerTransaction.gasLimit.toString(), 10).toNumber(),
+            data: Buffer.from(innerTransaction.data).toString("base64"),
+            signature: Buffer.from(innerTransaction.signature).toString("base64"),
+            chainID: Buffer.from(innerTransaction.chainID).toString("base64"),
+            version: innerTransaction.version,
+            options: innerTransaction.options.valueOf() == 0 ? undefined : innerTransaction.options,
+            guardian: innerTransaction.guardian
+                ? Address.fromBech32(innerTransaction.guardian).pubkey().toString("base64")
+                : undefined,
+            guardianSignature: innerTransaction.guardianSignature.length
+                ? Buffer.from(innerTransaction.guardianSignature).toString("base64")
+                : undefined,
+            sndUserName: innerTransaction.senderUsername
+                ? Buffer.from(innerTransaction.senderUsername).toString("base64")
+                : undefined,
+            rcvUserName: innerTransaction.receiverUsername
+                ? Buffer.from(innerTransaction.receiverUsername).toString("base64")
+                : undefined,
+        };
+
+        return JSON.stringify(txObject);
     }
 }
-Original file line number
+Diff line change
@@ Expand Up / @@ -360,4 +360,4 @@ export class ErrInvalidInnerTransaction extends Err{ @@
       public constructor(message: string){
         super(message);
       }
-    }
+    }