Smart Contract intents factories #327

popenta · 2023-09-04T11:59:56Z

Implemented the smart contract transaction intent factories based on the sdk-specs

andreibancioiu · 2023-09-06T18:39:35Z

src/tokenOperations/codec.ts

-    const hex = Buffer.from(value).toString("hex");
-    return codecUtils.zeroPadStringIfOddLength(hex);
-}
+export { utf8ToHex } from "../utils.codec";


This is a non-breaking change.

In the future, this file will be removed (new intent factories are to be used).

andreibancioiu · 2023-09-06T18:40:50Z

src/utils.codec.ts

+export function utf8ToHex(value: string) {
+    const hex = Buffer.from(value).toString("hex");
+    return zeroPadStringIfOddLength(hex);
+}
+
+export function byteArrayToHex(byteArray: Uint8Array): string {
+    return Buffer.from(byteArray).toString("hex");
+}


Functions can be tested in utils.codec.ts.

added unit tests

andreibancioiu · 2023-09-06T18:46:52Z

src/transactionIntent.ts

+    public value?: BigNumber.Value;
+    public data?: Uint8Array;
+
+    public constructor(sender: string, receiver: string, gasLimit: BigNumber.Value, value?: BigNumber.Value, data?: Uint8Array) {


Receive an initialization object in the constructor, similar to transaction.ts: constructor({ ... });

That way, if we'd like to re-order the parameters (options), we will do non-breaking changes. Otherwise, in this format, a breaking change will occur if we'd like to, say, add a new parameter "between" gasLimit and value.

Ok. Now using constructor(options: {...})

andreibancioiu · 2023-09-06T18:59:04Z

src/transactionIntentsFactories/transactionIntentBuilder.ts

+    private executionGasLimit: BigNumber.Value;
+    private value?: BigNumber.Value;
+
+    constructor(config: Config, sender: IAddress, receiver: IAddress, dataParts: string[], executionGasLimit: BigNumber.Value, value?: BigNumber.Value) {


constructor({ ... }) (receive parameters as an object).

andreibancioiu · 2023-09-06T19:00:56Z

src/transactionIntentsFactories/transactionIntentBuilder.ts

+    }
+
+    private computeGasLimit(payload: ITransactionPayload, executionGasLimit: BigNumber.Value): BigNumber.Value {
+        const dataMovementGas = new BigNumber(this.config.minGasLimit).plus(new BigNumber(this.config.gasLimitPerByte).multipliedBy(new BigNumber(payload.length())));


multipliedBy(payload.length) should work, without new BigNumber().

andreibancioiu · 2023-09-06T20:07:15Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts

+        assert.deepEqual(deployIntent, abiDeployIntent);
+    });
+
+    it("should build execute intent", async function () {


"should build intent for execute" (similar to the function name).

andreibancioiu · 2023-09-06T20:09:23Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts

+
+        assert.isDefined(deployIntent.data);
+        let decoder = new TextDecoder();
+        assert.equal(decoder.decode(deployIntent.data), "add@07");


assert.equal(deployIntent.data.toString(), "add@07") or assert.equal(deployIntent.data, Buffer.from("add@07")) should work, without using a TextDecoder.

Indeed. Works when using assert.deepEqual()

andreibancioiu · 2023-09-06T20:09:38Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts

+        assert.deepEqual(deployIntent, abiDeployIntent);
+    });
+
+    it("should build upgrade intent", async function () {


"... intent for upgrade" etc.

andreibancioiu · 2023-09-06T20:09:58Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts

+        }
+    });
+
+    it("should build deploy intent", async function () {


"... intent for deploy".

andreibancioiu · 2023-09-06T20:10:43Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts

+        assert.equal(deployIntent.receiver, "erd1qqqqqqqqqqqqqpgqhy6nl6zq07rnzry8uyh6rtyq0uzgtk3e69fqgtz9l4");
+        assert.isDefined(deployIntent.data);
+
+        if (deployIntent.data) {


Can drop condition if not necessary. Below, refactor to not use TextDecoder (as above).

Not using TextDecoder. Condition still necessary.

Also here, I think you can use ! operator to avoid this check:
assert(checkIfByteArrayStartsWith(deployIntent.data!, "upgradeContract@"));
const expectedGasLimit = 6000000 + 50000 + 1500 * deployIntent.data!.length;

Now using the ! operator.

andreibancioiu · 2023-09-08T09:30:26Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts


        assert.equal(deployIntent.sender, "erd1qyu5wthldzr8wx5c9ucg8kjagg0jfs53s8nr3zpz3hypefsdd8ssycr6th");
        assert.equal(deployIntent.receiver, "erd1qqqqqqqqqqqqqpgqhy6nl6zq07rnzry8uyh6rtyq0uzgtk3e69fqgtz9l4");
        assert.isDefined(deployIntent.data);
+        assert(checkIfByteArrayStartsWith(deployIntent.data!, "upgradeContract@"));


Alternatively, shorter, without checkIfByteArrayStartsWith:

assert.isTrue(Buffer.from(deployIntent.data!).toString().startsWith("upgradeContract@"));

Will do this in the next PR.

andreibancioiu · 2023-09-08T09:33:49Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.ts

-        else {
-            preparedArgs = this.argsToStrings(args)
-        }
+        const preparedArgs = this.argsToDataParts(args, this.abiRegistry?.constructorDefinition)


Above, parts could have been const.

Will change in the next PR.

andreibancioiu · 2023-09-08T09:34:58Z

src/transactionIntentsFactories/smartContractTransactionIntentsFactory.spec.ts

+            bytecode: adderByteCode.valueOf(),
+            gasLimit: gasLimit,
+            args: args
+        });


Formatting / newline.

popenta added 3 commits September 1, 2023 14:36

transactionIntent & transactionIntentBuilder

b2e6b92

started the sc intent factory

2099f3d

add deploy intent and unit tests

a8091a9

popenta self-assigned this Sep 4, 2023

popenta marked this pull request as draft September 4, 2023 12:00

smart contract transaction intents factory

7db0a4a

popenta marked this pull request as ready for review September 4, 2023 17:18

andreibancioiu self-requested a review September 4, 2023 18:04

andreibancioiu reviewed Sep 6, 2023

View reviewed changes

popenta added 2 commits September 7, 2023 17:26

fixes after review

5ba4506

small fixes for tests

08dd376

CiprianDraghici approved these changes Sep 8, 2023

View reviewed changes

andreibancioiu approved these changes Sep 8, 2023

View reviewed changes

popenta merged commit 3807fa5 into feat/factories Sep 8, 2023
1 check passed

popenta deleted the sc-intents-factories branch September 8, 2023 09:39

popenta mentioned this pull request Feb 13, 2024

v13: Merge feat/next into main #347

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Smart Contract intents factories #327

Smart Contract intents factories #327

popenta commented Sep 4, 2023 •

edited

Loading

andreibancioiu Sep 6, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

andreibancioiu Sep 6, 2023

andreibancioiu Sep 6, 2023

andreibancioiu Sep 6, 2023

popenta Sep 7, 2023

CiprianDraghici Sep 8, 2023

popenta Sep 8, 2023

andreibancioiu Sep 8, 2023

popenta Sep 8, 2023

andreibancioiu Sep 8, 2023

popenta Sep 8, 2023

andreibancioiu Sep 8, 2023

popenta Sep 8, 2023

Smart Contract intents factories #327

Smart Contract intents factories #327

Conversation

popenta commented Sep 4, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

popenta commented Sep 4, 2023 •

edited

Loading