Implement a new api for building script payload #565

runtian-zhou · 2024-11-04T22:45:41Z

Description

Add a new scriptComposer api in the transactionSubmission api to allow for SDK callers to dynamically invoke multiple Move functions in one transaction and compose the call sequences arbitrarily.

Test Plan

New case added.

Checklist

Have you ran pnpm fmt?
Have you updated the CHANGELOG.md?

0xmaayan · 2024-11-04T22:49:11Z

tests/e2e/transaction/transactionSubmission.test.ts

+        expect(response.signature?.type).toBe("single_sender");
+      });
+      test.only("with batch withdraw payload", async () => {
+        let _aptos = getAptosClient({ network: Network.CUSTOM ,fullnode : "http://127.0.0.1:8080/v1",faucet: "http://127.0.0.1:8081",indexer: "http://127.0.0.1:8090"})


Suggested change

let _aptos = getAptosClient({ network: Network.CUSTOM ,fullnode : "http://127.0.0.1:8080/v1",faucet: "http://127.0.0.1:8081",indexer: "http://127.0.0.1:8090"})

let _aptos = getAptosClient({ network: Network.LOCAL })

0xmaayan

Had a first review -

Please update the PR description with details on what the PR is for, etc
Throughout the SDK we use lowerCamelCase syntax, please use it when feasible
I'd like us to find a better name than transaction.build.scriptComposer, something resemble to transaction.build.simple or transaction.build.multiAgent

src/api/transactionSubmission/build.ts

0xmaayan · 2024-11-05T14:51:17Z

src/api/transactionSubmission/build.ts

+    withFeePayer?: boolean;
+  }): Promise<SimpleTransaction> {
+    let builder = new AptosScriptComposer(this.config);
+    builder = await args.builder(builder);


we assign on line 110 and then reassign on line 111?

src/api/transactionSubmission/build.ts

0xmaayan · 2024-11-05T14:52:40Z

src/transactions/script-composer/index.ts

+  wasm = initSync(await create_wasm());
+})();
+
+function convert_batch_argument(


this should live in ../transactionBuilder

I think this should live here? Because it's a helper function only used in this module?

src/transactions/script-composer/index.ts

src/transactions/transactionBuilder/remoteAbi.ts

tests/e2e/transaction/transactionSubmission.test.ts

0xmaayan · 2024-11-05T15:01:20Z

src/api/transactionSubmission/build.ts

@@ -93,6 +101,23 @@ export class Build {
    return generateTransaction({ aptosConfig: this.config, ...args });
  }

+  async script_composer(args: {


can we find a more meaningful name than scriptComposer? imo, when developers do aptos.transaction.build.scriptComposer it is not that meaningful like aptos.transaction.build.simple/multiAgent

Suggested change

async script_composer(args: {

async scriptComposer(args: {

tests/e2e/transaction/transactionSubmission.test.ts

0xmaayan · 2024-11-05T15:03:47Z

tests/e2e/transaction/transactionSubmission.test.ts

@@ -61,6 +67,67 @@ describe("transaction submission", () => {

        expect(response.signature?.type).toBe("single_sender");
      });
+      test("with batch payload", async () => {
+        let _aptos = getAptosClient({ network: Network.CUSTOM ,fullnode : "http://127.0.0.1:8080/v1",faucet: "http://127.0.0.1:8081",indexer: "http://127.0.0.1:8090"})
+        const builder = new AptosScriptComposer(_aptos.config);


please use the same transaction flow as in this file (and in the other test you have here) with aptos.transaction.build.script_composer
https://github.com/aptos-labs/aptos-ts-sdk/pull/565/files#diff-f1a843f6e05220a54a794964cbcb789ee9cfd6671ef77518e3a4a75d891f30d7R52-R66

0xmaayan

Please update CHANGELOG
This feature needs to live in a section on aptos.dev also

tests/e2e/transaction/transactionSubmission.test.ts

runtian-zhou · 2024-11-05T23:33:01Z

Docs added in aptos-labs/developer-docs#696

src/transactions/script-composer/index.ts

tests/e2e/transaction/transactionSubmission.test.ts

0xmaayan · 2024-11-06T18:26:35Z

src/transactions/script-composer/index.ts

+        await this.builder.load_type_tag(nodeUrl, typeTag.toString());
+      }
+    }
+    const typeArguments = standardizeTypeTags(input.typeArguments);


I'd like to keep the format same as the other transaction generation logic in the SDK and move the whole function generator part to the transactionBuilder.ts file and have it use the memoize logic - same as we do for any other payload https://github.com/aptos-labs/aptos-ts-sdk/blob/main/src/transactions/transactionBuilder/transactionBuilder.ts#L124

tests/e2e/transaction/transactionSubmission.test.ts

0xmaayan

LGTM. need to fix lint issue and tests

0xmaayan reviewed Nov 4, 2024

View reviewed changes

runtian-zhou force-pushed the runtianz/intent_sdk branch 4 times, most recently from 8609dc9 to bef04fa Compare November 5, 2024 07:20

0xmaayan requested changes Nov 5, 2024

View reviewed changes

runtian-zhou force-pushed the runtianz/intent_sdk branch from bef04fa to 71c3bbf Compare November 5, 2024 18:08

0xmaayan reviewed Nov 5, 2024

View reviewed changes

tests/e2e/transaction/transactionSubmission.test.ts Outdated Show resolved Hide resolved

tests/e2e/transaction/transactionSubmission.test.ts Show resolved Hide resolved

runtian-zhou force-pushed the runtianz/intent_sdk branch from e3c7533 to a4ddb15 Compare November 5, 2024 23:05

runtian-zhou marked this pull request as ready for review November 5, 2024 23:33

runtian-zhou requested a review from a team as a code owner November 5, 2024 23:33

0xmaayan reviewed Nov 6, 2024

View reviewed changes

runtian-zhou force-pushed the runtianz/intent_sdk branch from 2425c0d to 0632cff Compare November 7, 2024 03:09

runtian-zhou added 6 commits November 6, 2024 19:09

import aptos-intent

34e1f03

Fix some lints

c34fd0f

Fix comments

3b40a49

Fix deps, re-export CallArgument

9567f26

fixup! Fix deps, re-export CallArgument

f73c2a8

Fix comments

eb07801

runtian-zhou force-pushed the runtianz/intent_sdk branch from 0632cff to eb07801 Compare November 7, 2024 03:10

0xmaayan approved these changes Nov 7, 2024

View reviewed changes

runtian-zhou added 2 commits November 7, 2024 09:12

fix lint

c8e9323

fixup! fix lint

0446a3d

runtian-zhou force-pushed the runtianz/intent_sdk branch from c63c1a0 to 0446a3d Compare November 7, 2024 18:16

Update package

11fd622

runtian-zhou enabled auto-merge (squash) November 7, 2024 19:25

runtian-zhou merged commit a301268 into main Nov 7, 2024
13 of 14 checks passed

runtian-zhou deleted the runtianz/intent_sdk branch November 7, 2024 19:32

GhostWalker562 mentioned this pull request Nov 11, 2024

[script-composer] Revert script composers #574

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement a new api for building script payload #565

Implement a new api for building script payload #565

runtian-zhou commented Nov 4, 2024 •

edited

Loading

0xmaayan Nov 4, 2024

0xmaayan left a comment

0xmaayan Nov 5, 2024

0xmaayan Nov 5, 2024

runtian-zhou Nov 5, 2024

0xmaayan Nov 5, 2024

0xmaayan Nov 5, 2024

0xmaayan left a comment

runtian-zhou commented Nov 5, 2024

0xmaayan Nov 6, 2024

0xmaayan left a comment •

edited

Loading

	let _aptos = getAptosClient({ network: Network.CUSTOM ,fullnode : "http://127.0.0.1:8080/v1",faucet: "http://127.0.0.1:8081",indexer: "http://127.0.0.1:8090"})
	let _aptos = getAptosClient({ network: Network.LOCAL })

Implement a new api for building script payload #565

Implement a new api for building script payload #565

Conversation

runtian-zhou commented Nov 4, 2024 • edited Loading

Description

Test Plan

Related Links

Checklist

0xmaayan Nov 4, 2024

Choose a reason for hiding this comment

0xmaayan left a comment

Choose a reason for hiding this comment

0xmaayan Nov 5, 2024

Choose a reason for hiding this comment

0xmaayan Nov 5, 2024

Choose a reason for hiding this comment

runtian-zhou Nov 5, 2024

Choose a reason for hiding this comment

0xmaayan Nov 5, 2024

Choose a reason for hiding this comment

0xmaayan Nov 5, 2024

Choose a reason for hiding this comment

0xmaayan left a comment

Choose a reason for hiding this comment

runtian-zhou commented Nov 5, 2024

0xmaayan Nov 6, 2024

Choose a reason for hiding this comment

0xmaayan left a comment • edited Loading

Choose a reason for hiding this comment

runtian-zhou commented Nov 4, 2024 •

edited

Loading

0xmaayan left a comment •

edited

Loading