Runtianz/new script composer #587

runtian-zhou · 2024-11-20T18:50:26Z

Description

Reopen the script composer feature with updated dependency built into aptos-labs.

Test Plan

CI

Tested that the package can work in web, nodejs and nextjs environment.

Checklist

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

0xmaayan · 2024-11-20T19:24:02Z

Please test and validate it

Passes all SDK unit + examples tests
Does not break a client-side render app (react)
Does not break a server-side render app (nextjs)

WGB5445 · 2024-11-20T20:24:24Z

Please test and validate it

Passes all SDK unit + examples tests

Does not break a client-side render app (react)

Does not break a server-side render app (nextjs)

I have tested a React + Vite client-side render app and a Next.js server-side render app.
Both work fine.

However, it's worth noting that in the current version, the initialization is done when the SDK loads, so the bundled JavaScript is a bit large—about 5 MB for the client-side.

0xmaayan · 2024-11-21T17:31:02Z

Please test and validate it

Passes all SDK unit + examples tests

Does not break a client-side render app (react)

Does not break a server-side render app (nextjs)

I have tested a React + Vite client-side render app and a Next.js server-side render app. Both work fine.

However, it's worth noting that in the current version, the initialization is done when the SDK loads, so the bundled JavaScript is a bit large—about 5 MB for the client-side.

The bundle size is a concern. I'd like to get consensus from the sdk team before approving it. @gregnazario @GhostWalker562

GhostWalker562 · 2024-11-21T18:21:23Z

@0xmaayan I personally think its too much 😞 since it's already 5x the bundle size. People are already complaining about 421kb from poseidon-lite #578 but if it's really needed in the SDK I'm not going to push back that much.

I'm curious if we can test it in a react-native environment as well?

0xmaayan · 2024-11-21T18:28:16Z

@0xmaayan I personally think its too much 😞 since it's already 5x the bundle size. People are already complaining about 421kb from poseidon-lite #578 but if it's really needed in the SDK I'm not going to push back that much.

I'm curious if we can test it in a react-native environment as well?

@runtian-zhou

Any reason we dont move the wasm initialization to the end user?
Thoughts on releasing it under a tagged version?

@GhostWalker562 I dont think the SDK officially supports react-native, but I assume you want it tested for Petra?

runtian-zhou · 2024-11-21T18:33:20Z

Thoughts on releasing it under a tagged version?

I think that would be amazing.

0xmaayan · 2024-11-21T18:35:58Z

Thoughts on releasing it under a tagged version?

I think that would be amazing.

Cool. Then we dont need to merge it to main, but release a tagged version from this branch

runtian-zhou · 2024-11-21T18:42:47Z

Let's release it first and get feedbacks from the community. I'm getting multiple asks for this feature so would be great to let them try it out first. In the meantime, we can optimize on the packaging situation.

lumos42 · 2024-11-21T18:44:36Z

eagerly waiting to use this feature in our app

itsmnthn · 2024-11-28T06:33:37Z

@0xmaayan I personally think its too much 😞 since it's already 5x the bundle size. People are already complaining about 421kb from poseidon-lite #578 but if it's really needed in the SDK I'm not going to push back that much.

I'm curious if we can test it in a react-native environment as well?

One workaround for the size is lazy load.
Script Composer can be different package and could by lazy loaded and uses ts-sdk to compose the script wen needed. This is gud since it can be loaded only wen needed.

wdyt?

0xmaayan · 2025-01-17T18:22:40Z

This feature has been available for some time under a different version https://www.npmjs.com/package/@aptos-labs/ts-sdk/v/1.33.0-sc.1 and @runtian-zhou mentioned receiving positive feedback from users, along with excitement about integrating it officially into the ts-sdk.

@WGB5445 validated that the feature works in both web and Node.js environments.

@0xmaayan confirmed there is no increase in the bundle size

current main branch

npm notice name: @aptos-labs/ts-sdk
npm notice version: 1.33.1
npm notice filename: aptos-labs-ts-sdk-1.33.1.tgz
npm notice package size: 1.1 MB
npm notice unpacked size: 6.38 MB

script compose branch

npm notice name: @aptos-labs/ts-sdk
npm notice version: 1.33.0-sc.1
npm notice filename: aptos-labs-ts-sdk-1.33.0-sc.1.tgz
npm notice package size: 1.0 MB
npm notice unpacked size: 6.4 MB

I’m okay with moving forward and merging it, thoughts @gregnazario @GhostWalker562 ?

@runtian-zhou One thing we’re missing, which could be beneficial, is adding a complete example in the examples folder, not a blocker tho

GhostWalker562 · 2025-01-17T18:30:01Z

@0xmaayan would like to see it tested in a react-native environment too but otherwise sounds good to me

0xmaayan · 2025-01-17T18:32:12Z

@0xmaayan would like to see it tested in a react-native environment too but otherwise sounds good to me

@runtian-zhou

WGB5445 · 2025-01-20T07:00:13Z

This is the GitHub Pages deployment page for the Next.js and React versions, where you can view the corresponding source code:

lumos42 · 2025-01-20T07:15:08Z

We've been using it in testnet and mainnet for some time, and there's a feature request which could really optimize the script composer - the ability to provide ABIs manually. Currently it fetches for ABIs every time which slows down the process.

@itsmnthn can provide more details on this.

itsmnthn · 2025-01-20T07:32:25Z

We've been using it in testnet and mainnet for some time, and there's a feature request which could really optimize the script composer - the ability to provide ABIs manually. Currently it fetches for ABIs every time which slows down the process.

@itsmnthn can provide more details on this.

Yes passing ABIs to the addBatchedCall for the given call and for standard module's ABIs as part of the script composer to avoid fetching it over the network multiple times to speed up execution time especially when connection is slow. Things add up when the script is complex and has more steps even when the network speed is gud.

I've written custom AptosScriptComposer class to use in our FE which add abi as a parameter to addBatchedCall to avoid fetching ABI. So it does not fetch for a module which being called but still fetches standard abis required for argument types etc (which is not efficient right now especially to use on frontend)

This reverts commit bf8afa1.

…t Composer (#612)

GhostWalker562

Looks good, few small comments

Also make sure to add to README.md about the wasm dependency in script-composer-pack

GhostWalker562 · 2025-01-30T20:21:19Z

package.json

@@ -56,6 +56,7 @@
    "@noble/hashes": "^1.4.0",
    "@scure/bip32": "^1.4.0",
    "@scure/bip39": "^1.3.0",
+    "@aptos-labs/script-composer-pack": "^0.0.4",


Update to latest when possible

CHANGELOG.md

GhostWalker562 · 2025-01-30T21:39:20Z

tests/e2e/transaction/transactionSubmission.test.ts

+          aptosConfig: aptos.config,
+          sender: singleSignerED25519SenderAccount.accountAddress,
+          payload: TransactionPayloadScript.load(new Deserializer(bytes)),
+        });


Could you try to use the aptos.transaction.build.scriptComposer() to build the script here?

So that it can be more consistent with the next test case

GhostWalker562 · 2025-01-30T22:04:25Z

src/transactions/script-composer/index.ts

+      for (const typeTag of input.typeArguments) {
+        // eslint-disable-next-line no-await-in-loop
+        await this.builder.load_type_tag(nodeUrl, typeTag.toString());
+      }


Change to await Promise.all(input.typeArguments.map((typeTag) => this.builder.load_type_tag(nodeUrl, typeTag.toString()))); to await the promises in parellel

GhostWalker562 · 2025-01-30T22:08:13Z

tests/e2e/transaction/transactionSubmission.test.ts

+        await builder.init();
+        await builder.addBatchedCalls({
+          function: `${contractPublisherAccount.accountAddress}::transfer::transfer`,
+          functionArguments: [CallArgument.new_signer(0), 1, receiverAccounts[0].accountAddress],


If there's a way to update the dependency to not use snake case, that would be great.

Even better, we can have a SignerArgument instance instead using static functions from CallArgument.

GhostWalker562 · 2025-01-30T22:15:56Z

src/transactions/script-composer/index.ts

@@ -0,0 +1,85 @@
+// Copyright © Aptos Foundation


Rename directory from script-composer to scriptComposer

GhostWalker562 · 2025-01-31T00:41:26Z

CHANGELOG.md

@@ -3,6 +3,7 @@
 All notable changes to the Aptos TypeScript SDK will be captured in this file. This changelog is written by hand for now. It adheres to the format set out by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

 # Unreleased
+- [`Breaking`] Add new new `scriptComposer` api in transactionSubmission api to allow SDK callers to invoke multiple Move functions inside a same transaction and compose the calls dynamically.


Should be "Add new"

GhostWalker562 · 2025-01-31T00:41:59Z

src/transactions/scriptComposer/callArgument.ts

+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+export class callArgument {


What happened to CallArgument here?

Sry should have removed this file...

CHANGELOG.md

0xmaayan · 2025-02-04T14:58:49Z

src/api/transactionSubmission/build.ts

+    builder: (builder: AptosScriptComposer) => Promise<AptosScriptComposer>;
+    options?: InputGenerateTransactionOptions;
+    withFeePayer?: boolean;
+  }): Promise<SimpleTransaction> {


any reason we are not following the other transactions build flow format?

return generateTransaction({ aptosConfig: this.config, ...args });

This is because the generateTransaction cannot take the serialized blob of move script as input (input contains both bytecode and type arguments/inputs).

Ideally, we would have generateBatchTransaction

0xmaayan · 2025-02-04T15:00:31Z

src/api/transactionSubmission/build.ts

+      payload: TransactionPayloadScript.load(new Deserializer(bytes)),
+      ...args,
+    });
+    return new SimpleTransaction(rawTxn, args.withFeePayer === true ? AccountAddress.ZERO : undefined);


If well follow the same format, this will be taken care with https://github.com/aptos-labs/aptos-ts-sdk/blob/main/src/internal/transactionSubmission.ts#L165