[ts-sdk] Update Instructions for using CLI to get compiled modules (#…

…4537)

sdk/typescript/README.md

@@ -186,24 +186,26 @@ To publish a package:
 
 ```typescript
 import { Ed25519Keypair, JsonRpcProvider, RawSigner } from '@mysten/sui.js';
-import * as fs from 'fs/promises';
+const { execSync } = require('child_process');
 // Generate a new Keypair
 const keypair = new Ed25519Keypair();
 const signer = new RawSigner(
   keypair,
   new JsonRpcProvider('https://gateway.devnet.sui.io:443')
 );
-const bytecode = await fs.readFile('path/to/project/build/project_name/bytecode_modules/module_name.mv', 'base64');
-const publishTxn = await signer.publish(
-  {
-    compiledModules: [bytecode.toString()],
-    gasBudget: 1000
-  }
+const compiledModules = JSON.parse(
+  execSync(
+    `${cliPath} move build --dump-bytecode-as-base64 --path ${packagePath}`,
+    { encoding: 'utf-8' }
+  )
 );
+const publishTxn = await signer.publish({
+  compiledModules,
+  gasBudget: 10000,
+});
 console.log('publishTxn', publishTxn);
 ```
 
-
 Alternatively, a Secp256k1 can be initiated:
 
 ```typescript
@@ -215,4 +217,4 @@ const signer = new RawSigner(
   keypair,
   new JsonRpcProvider('https://gateway.devnet.sui.io:443')
 );
-```
+```

sdk/typescript/src/signers/signer-with-provider.ts

@@ -174,6 +174,10 @@ export abstract class SignerWithProvider implements Signer {
     return await this.signAndExecuteTransaction(txBytes);
   }
 
+  /**
+   * Publish a Move package on chain
+   * @param transaction See {@link PublishTransaction}
+   */
   async publish(
     transaction: PublishTransaction
   ): Promise<SuiTransactionResponse> {

sdk/typescript/src/signers/txn-data-serializers/txn-data-serializer.ts

@@ -49,30 +49,28 @@ export interface MoveCallTransaction {
   gasBudget: number;
 }
 
+/**
+ * Transaction type used for publishing Move modules to the Sui.
+ *
+ * Use the util methods defined in [utils/publish.ts](../../utils/publish.ts)
+ * to get `compiledModules` bytes by leveraging the sui
+ * command line tool.
+ *
+ * ```
+ * const { execSync } = require('child_process');
+ * const modulesInBase64 = JSON.parse(execSync(
+ *   `${cliPath} move build --dump-bytecode-as-base64 --path ${packagePath}`,
+ *   { encoding: 'utf-8' }
+ * ));
+ *
+ * // Include the following line if you are using `LocalTxnDataSerializer`, skip
+ * // if you are using `RpcTxnDataSerializer`
+ * // const modulesInBytes = modules.map((m) => Array.from(new Base64DataBuffer(m).getData()));
+ * // ... publish logic ...
+ * ```
+ *
+ */
 export interface PublishTransaction {
-  /**
-   * Transaction type used for publishing Move modules to the Sui.
-   * Should be already compiled using `sui-move`, example:
-   * ```
-   * $ sui move build
-   * $ cat build/project_name/bytecode_modules/module.mv
-   * ```
-   * In JS:
-   *
-   * ```
-   * // If you are using `RpcTxnDataSerializer`,
-   * let file = fs.readFileSync('./move/build/project_name/bytecode_modules/module.mv', 'base64');
-   * let compiledModules = [file.toString()]
-   *
-   * // If you are using `LocalTxnDataSerializer`,
-   * let file = fs.readFileSync('./move/build/project_name/bytecode_modules/module.mv');
-   * let modules = [ Array.from(file) ];
-   *
-   * // ... publish logic ...
-   * ```
-   *
-   * Each module should be represented as a sequence of bytes.
-   */
   compiledModules: ArrayLike<string> | ArrayLike<ArrayLike<number>>;
   gasPayment?: ObjectId;
   gasBudget: number;