Make type_arguments optional and publically rename to typeArguments (#71

) * Make type_arguments optional and publically rename to typeArguments * Update index.ts * Update fixed-bytes.ts
aptos-labs · Oct 16, 2023 · 2613082 · 2613082
1 parent 237e513
commit 2613082
Show file tree

Hide file tree

Showing 18 changed files with 28 additions and 78 deletions.
diff --git a/examples/javascript/simple_sponsored_transaction.js b/examples/javascript/simple_sponsored_transaction.js
@@ -56,7 +56,6 @@ const TRANSFER_AMOUNT = 10;
     feePayerAddress: sponsorAddress,
     data: {
       function: "0x1::aptos_account::transfer",
-      type_arguments: [],
       arguments: [bob.accountAddress, new aptos.U64(TRANSFER_AMOUNT)],
     },
   });

diff --git a/examples/typescript/simple_sponsored_transaction.ts b/examples/typescript/simple_sponsored_transaction.ts
@@ -56,7 +56,6 @@ const example = async () => {
     feePayerAddress: sponsorAddress,
     data: {
       function: "0x1::aptos_account::transfer",
-      type_arguments: [],
       arguments: [bob.accountAddress, new U64(TRANSFER_AMOUNT)],
     },
   });

diff --git a/src/api/general.ts b/src/api/general.ts
@@ -19,7 +19,7 @@ import {
   LedgerVersion,
   MoveValue,
   TableItemRequest,
-  ViewRequest,
+  ViewRequestData,
 } from "../types";
 import { AptosConfig } from "./aptos_config";
 
@@ -127,7 +127,7 @@ export class General {
    *
    * @returns an array of Move values
    */
-  async view(args: { payload: ViewRequest; options?: LedgerVersion }): Promise<Array<MoveValue>> {
+  async view(args: { payload: ViewRequestData; options?: LedgerVersion }): Promise<Array<MoveValue>> {
     const data = await view({ aptosConfig: this.config, ...args });
     return data;
   }

diff --git a/src/bcs/serializable/fixed-bytes.ts b/src/bcs/serializable/fixed-bytes.ts
@@ -26,7 +26,6 @@ import { TransactionArgument } from "../../transactions/instances/transactionArg
  *  const fixedBytes = new FixedBytes(yourCustomSerializedBytes);
  *  const payload = generateTransactionPayload({
  *    function: "0xbeefcafe::your_module::your_function_that_requires_custom_serialization",
- *    type_arguments: [],
  *    arguments: [yourCustomBytes],
  *  });
  *

diff --git a/src/internal/coin.ts b/src/internal/coin.ts
@@ -22,7 +22,7 @@ export async function transferCoinTransaction(args: {
     sender: sender.accountAddress.toString(),
     data: {
       function: "0x1::aptos_account::transfer_coins",
-      type_arguments: [new TypeTagStruct(StructTag.fromString(coinStructType))],
+      typeArguments: [new TypeTagStruct(StructTag.fromString(coinStructType))],
       arguments: [AccountAddress.fromHexInput(recipient), new U64(amount)],
     },
     options,

diff --git a/src/internal/general.ts b/src/internal/general.ts
@@ -20,6 +20,7 @@ import {
   MoveValue,
   TableItemRequest,
   ViewRequest,
+  ViewRequestData,
 } from "../types";
 import { GetChainTopUserTransactionsQuery, GetProcessorStatusQuery } from "../types/generated/operations";
 import { GetChainTopUserTransactions, GetProcessorStatus } from "../types/generated/queries";
@@ -83,7 +84,7 @@ export async function getTableItem(args: {
 
 export async function view(args: {
   aptosConfig: AptosConfig;
-  payload: ViewRequest;
+  payload: ViewRequestData;
   options?: LedgerVersion;
 }): Promise<MoveValue[]> {
   const { aptosConfig, payload, options } = args;
@@ -92,7 +93,11 @@ export async function view(args: {
     originMethod: "view",
     path: "view",
     params: { ledger_version: options?.ledgerVersion },
-    body: payload,
+    body: {
+      function: payload.function,
+      type_arguments: payload.typeArguments ?? [],
+      arguments: payload.arguments ?? [],
+    },
   });
   return data;
 }

diff --git a/src/transactions/transaction_builder/transaction_builder.ts b/src/transactions/transaction_builder/transaction_builder.ts
@@ -91,7 +91,7 @@ export function generateTransactionPayload(args: GenerateTransactionPayloadData)
   // generate script payload
   if ("bytecode" in args) {
     const scriptPayload = new TransactionPayloadScript(
-      new Script(hexToBytes(args.bytecode), args.type_arguments, args.arguments),
+      new Script(hexToBytes(args.bytecode), args.typeArguments ?? [], args.arguments),
     );
     return scriptPayload;
   }
@@ -106,7 +106,7 @@ export function generateTransactionPayload(args: GenerateTransactionPayloadData)
           EntryFunction.build(
             `${funcNameParts[0]}::${funcNameParts[1]}`,
             funcNameParts[2],
-            args.type_arguments,
+            args.typeArguments ?? [],
             args.arguments,
           ),
         ),
@@ -121,7 +121,7 @@ export function generateTransactionPayload(args: GenerateTransactionPayloadData)
     EntryFunction.build(
       `${funcNameParts[0]}::${funcNameParts[1]}`,
       funcNameParts[2],
-      args.type_arguments,
+      args.typeArguments ?? [],
       args.arguments,
     ),
   );

diff --git a/src/transactions/types.ts b/src/transactions/types.ts
@@ -84,7 +84,7 @@ export type GenerateTransactionPayloadData = EntryFunctionData | ScriptData | Mu
  */
 export type EntryFunctionData = {
   function: MoveStructType;
-  type_arguments: Array<TypeTag>;
+  typeArguments?: Array<TypeTag>;
   arguments: Array<EntryFunctionArgumentTypes>;
 };
 
@@ -100,7 +100,7 @@ export type MultiSigData = {
  */
 export type ScriptData = {
   bytecode: string;
-  type_arguments: Array<TypeTag>;
+  typeArguments?: Array<TypeTag>;
   arguments: Array<ScriptFunctionArgumentTypes>;
 };
 

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -854,6 +854,15 @@ export type Block = {
   transactions?: Array<TransactionResponse>;
 };
 
+/**
+ * The data needed to generate a View Request payload
+ */
+export type ViewRequestData = {
+  function: MoveStructType;
+  typeArguments?: Array<MoveResourceType>;
+  arguments?: Array<MoveValue>;
+};
+
 // REQUEST TYPES
 
 /**

diff --git a/tests/e2e/api/account.test.ts b/tests/e2e/api/account.test.ts
@@ -89,7 +89,6 @@ describe("account api", () => {
         sender: senderAccount.accountAddress.toString(),
         data: {
           function: "0x1::aptos_account::transfer",
-          type_arguments: [],
           arguments: [bob.accountAddress, new U64(10)],
         },
       });

diff --git a/tests/e2e/api/general.test.ts b/tests/e2e/api/general.test.ts
@@ -1,7 +1,7 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { AptosConfig, Aptos, Network, GraphqlQuery, ViewRequest } from "../../../src";
+import { AptosConfig, Aptos, Network, GraphqlQuery, ViewRequestData } from "../../../src";
 
 describe("general api", () => {
   test("it fetches ledger info", async () => {
@@ -38,10 +38,8 @@ describe("general api", () => {
     const config = new AptosConfig({ network: Network.LOCAL });
     const aptos = new Aptos(config);
 
-    const payload: ViewRequest = {
+    const payload: ViewRequestData = {
       function: "0x1::chain_id::get",
-      type_arguments: [],
-      arguments: [],
     };
 
     const chainId = await aptos.view({ payload });

diff --git a/tests/e2e/api/transaction.test.ts b/tests/e2e/api/transaction.test.ts
@@ -24,7 +24,6 @@ describe("transaction api", () => {
       sender: senderAccount.accountAddress.toString(),
       data: {
         function: "0x1::aptos_account::transfer",
-        type_arguments: [],
         arguments: [bob.accountAddress, new U64(10)],
       },
     });
@@ -50,7 +49,6 @@ describe("transaction api", () => {
         sender: senderAccount.accountAddress.toString(),
         data: {
           function: "0x1::aptos_account::transfer",
-          type_arguments: [],
           arguments: [bob.accountAddress, new U64(10)],
         },
       });

diff --git a/tests/e2e/transaction/generate_transaction.test.ts b/tests/e2e/transaction/generate_transaction.test.ts
@@ -25,7 +25,6 @@ describe("generate transaction", () => {
         sender: senderAccount.accountAddress.toString(),
         data: {
           bytecode: singleSignerScriptBytecode,
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -43,7 +42,6 @@ describe("generate transaction", () => {
         data: {
           multisigAddress: secondarySignerAccount.accountAddress,
           function: "0x0000000000000000000000000000000000000000000000000000000000000123::module::name",
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -61,7 +59,6 @@ describe("generate transaction", () => {
         sender: senderAccount.accountAddress.toString(),
         data: {
           function: "0x0000000000000000000000000000000000000000000000000000000000000123::module::name",
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -82,7 +79,6 @@ describe("generate transaction", () => {
         secondarySignerAddresses: [secondarySignerAccount.accountAddress.toString()],
         data: {
           bytecode: singleSignerScriptBytecode,
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -101,7 +97,6 @@ describe("generate transaction", () => {
         secondarySignerAddresses: [secondarySignerAccount.accountAddress.toString()],
         data: {
           function: "0x0000000000000000000000000000000000000000000000000000000000000123::module::name",
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -122,7 +117,6 @@ describe("generate transaction", () => {
         feePayerAddress: feePayerAccount.accountAddress.toString(),
         data: {
           bytecode: singleSignerScriptBytecode,
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -142,7 +136,6 @@ describe("generate transaction", () => {
         data: {
           multisigAddress: secondarySignerAccount.accountAddress,
           function: "0x0000000000000000000000000000000000000000000000000000000000000123::module::name",
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -161,7 +154,6 @@ describe("generate transaction", () => {
         feePayerAddress: feePayerAccount.accountAddress.toString(),
         data: {
           function: "0x0000000000000000000000000000000000000000000000000000000000000123::module::name",
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });
@@ -181,7 +173,6 @@ describe("generate transaction", () => {
         feePayerAddress: feePayerAccount.accountAddress.toString(),
         data: {
           function: "0x0000000000000000000000000000000000000000000000000000000000000123::module::name",
-          type_arguments: [],
           arguments: [new U64(1), recieverAccounts[0].accountAddress],
         },
       });

diff --git a/tests/e2e/transaction/helper.ts b/tests/e2e/transaction/helper.ts
@@ -25,7 +25,6 @@ export async function publishModule(
     sender: senderAccount.accountAddress.toString(),
     data: {
       function: "0x1::code::publish_package_txn",
-      type_arguments: [],
       arguments: [MoveVector.U8(metadataBytes), new MoveVector([MoveVector.U8(codeBytes)])],
     },
   });
@@ -61,7 +60,7 @@ export async function rawTransactionHelper(
     sender: senderAccount.accountAddress.toString(),
     data: {
       function: `0x${senderAccount.accountAddress.toStringWithoutPrefix()}::tx_args_module::${functionName}`,
-      type_arguments: typeArgs,
+      typeArguments: typeArgs,
       arguments: args,
     },
   });

diff --git a/tests/e2e/transaction/sign_transaction.test.ts b/tests/e2e/transaction/sign_transaction.test.ts
@@ -33,7 +33,6 @@ describe("sign transaction", () => {
           sender: senderAccount.accountAddress.toString(),
           data: {
             bytecode: singleSignerScriptBytecode,
-            type_arguments: [],
             arguments: [new U64(1), recieverAccounts[0].accountAddress],
           },
         });
@@ -51,7 +50,6 @@ describe("sign transaction", () => {
           sender: senderAccount.accountAddress.toString(),
           data: {
             function: `0x${senderAccount.accountAddress.toStringWithoutPrefix()}::transfer::transfer`,
-            type_arguments: [],
             arguments: [new U64(1), recieverAccounts[0].accountAddress],
           },
         });
@@ -70,7 +68,6 @@ describe("sign transaction", () => {
           data: {
             multisigAddress: secondarySignerAccount.accountAddress,
             function: `0x${senderAccount.accountAddress.toStringWithoutPrefix()}::transfer::transfer`,
-            type_arguments: [],
             arguments: [new U64(1), recieverAccounts[0].accountAddress],
           },
         });
@@ -91,7 +88,6 @@ describe("sign transaction", () => {
           sender: senderSecp256k1Account.accountAddress.toString(),
           data: {
             bytecode: singleSignerScriptBytecode,
-            type_arguments: [],
             arguments: [new U64(1), recieverAccounts[0].accountAddress],
           },
         });
@@ -109,7 +105,6 @@ describe("sign transaction", () => {
           sender: senderSecp256k1Account.accountAddress.toString(),
           data: {
             function: `0x${senderAccount.accountAddress.toStringWithoutPrefix()}::transfer::transfer`,
-            type_arguments: [],
             arguments: [new U64(1), recieverAccounts[0].accountAddress],
           },
         });
@@ -128,7 +123,6 @@ describe("sign transaction", () => {
           data: {
             multisigAddress: secondarySignerAccount.accountAddress,
             function: `0x${senderAccount.accountAddress.toStringWithoutPrefix()}::transfer::transfer`,
-            type_arguments: [],
             arguments: [new U64(1), recieverAccounts[0].accountAddress],
           },
         });