organize code

Author: 0xmaayan

src/api/aptos.ts

@@ -12,6 +12,7 @@ import { General } from "./general";
 import { ANS } from "./ans";
 import { Staking } from "./staking";
 import { Transaction } from "./transaction";
+import { ProofChallenge } from "./proofChallenge";
 
 /**
  * This class is the main entry point into Aptos's
@@ -47,6 +48,8 @@ export class Aptos {
 
   readonly transaction: Transaction;
 
+  readonly proofChallenge: ProofChallenge;
+
   constructor(settings?: AptosConfig) {
     this.config = new AptosConfig(settings);
     this.account = new Account(this.config);
@@ -59,6 +62,7 @@ export class Aptos {
     this.general = new General(this.config);
     this.staking = new Staking(this.config);
     this.transaction = new Transaction(this.config);
+    this.proofChallenge = new ProofChallenge(this.config);
   }
 }
 
@@ -74,6 +78,7 @@ export interface Aptos
     FungibleAsset,
     General,
     Staking,
+    ProofChallenge,
     Omit<Transaction, "build" | "simulate" | "submit" | "batch"> {}
 
 /**
@@ -107,3 +112,4 @@ applyMixin(Aptos, FungibleAsset, "fungibleAsset");
 applyMixin(Aptos, General, "general");
 applyMixin(Aptos, Staking, "staking");
 applyMixin(Aptos, Transaction, "transaction");
+applyMixin(Aptos, ProofChallenge, "proofChallenge");

src/api/general.ts

@@ -3,7 +3,6 @@
 
 import { AptosConfig } from "./aptosConfig";
 import {
-  createProofChallenge,
   getBlockByHeight,
   getBlockByVersion,
   getChainTopUserTransactions,
@@ -22,12 +21,11 @@ import {
   GraphqlQuery,
   LedgerInfo,
   LedgerVersionArg,
-  MoveFunctionId,
   MoveValue,
   TableItemRequest,
 } from "../types";
 import { ProcessorType } from "../utils/const";
-import { InputViewFunctionData, ProofChallenge } from "../transactions";
+import { InputViewFunctionData } from "../transactions";
 
 /**
  * A class to query all `General` Aptos related queries
@@ -226,11 +224,4 @@ export class General {
   async getProcessorStatus(processorType: ProcessorType): Promise<GetProcessorStatusResponse[0]> {
     return getProcessorStatus({ aptosConfig: this.config, processorType });
   }
-
-  async createProofChallenge(args: { struct: MoveFunctionId; data: Array<any> }): Promise<ProofChallenge> {
-    return createProofChallenge({
-      config: this.config,
-      ...args,
-    });
-  }
 }

src/api/proofChallenge.ts

@@ -0,0 +1,53 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+import { Account, Signature } from "../core";
+import { createProofChallenge, signProofChallenge } from "../internal/proofChallenge";
+import { MoveFunctionId } from "../types";
+import { AptosConfig } from "./aptosConfig";
+import { ProofChallenge as ProofChallengeInstance } from "../transactions/instances/proofChallenge";
+import { EntryFunctionArgumentTypes, SimpleEntryFunctionArgumentTypes } from "../transactions/types";
+
+/**
+ * A class for all `ProofChallenge` Aptos related operations
+ */
+export class ProofChallenge {
+  readonly config: AptosConfig;
+
+  constructor(config: AptosConfig) {
+    this.config = config;
+  }
+
+  /**
+   * Creates a generic proof challenge
+   *
+   * @param args.struct The struct address of the challenge
+   * @param args.data The struct arguments
+   *
+   * @returns ProofChallenge
+   */
+  async createProofChallenge(args: {
+    struct: MoveFunctionId;
+    data: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>;
+  }): Promise<ProofChallengeInstance> {
+    return createProofChallenge({
+      config: this.config,
+      ...args,
+    });
+  }
+
+  /**
+   * Signs a generic proof challenge
+   *
+   * @param args.challenge The generated challenge
+   * @param args.signer The signer account
+   *
+   * @returns Signature
+   */
+  // eslint-disable-next-line class-methods-use-this
+  signProofChallenge(args: { challenge: ProofChallengeInstance; signer: Account }): Signature {
+    return signProofChallenge({
+      ...args,
+    });
+  }
+}

src/api/transaction.ts

@@ -25,17 +25,15 @@ import {
   publicPackageTransaction,
   rotateAuthKey,
   signAndSubmitTransaction,
-  signProofChallenge,
   signTransaction,
 } from "../internal/transactionSubmission";
 import {
   AccountAuthenticator,
   AnyRawTransaction,
   InputGenerateTransactionOptions,
   InputGenerateTransactionPayloadData,
-  ProofChallenge,
 } from "../transactions";
-import { AccountAddressInput, Account, PrivateKey, Signature } from "../core";
+import { AccountAddressInput, Account, PrivateKey } from "../core";
 import { Build } from "./transactionSubmission/build";
 import { Simulate } from "./transactionSubmission/simulate";
 import { Submit } from "./transactionSubmission/submit";
@@ -308,13 +306,6 @@ export class Transaction {
     });
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  signProofChallenge(args: { challenge: ProofChallenge; signer: Account }): Signature {
-    return signProofChallenge({
-      ...args,
-    });
-  }
-
   // TRANSACTION SUBMISSION //
 
   /**

src/internal/general.ts

@@ -9,13 +9,7 @@
  */
 
 import { AptosConfig } from "../api/aptosConfig";
-import { MoveString } from "../bcs";
 import { getAptosFullNode, postAptosFullNode, postAptosIndexer } from "../client";
-import { AccountAddress } from "../core";
-import { getFunctionParts } from "../transactions/transactionBuilder/helpers";
-import { fetchStructFieldsAbi, convertArgument } from "../transactions/transactionBuilder/remoteAbi";
-import { ProofChallenge } from "../transactions/instances";
-import { EntryFunctionArgumentTypes } from "../transactions/types";
 import {
   AnyNumber,
   Block,
@@ -24,7 +18,6 @@ import {
   GraphqlQuery,
   LedgerInfo,
   LedgerVersionArg,
-  MoveFunctionId,
   TableItemRequest,
 } from "../types";
 import { GetChainTopUserTransactionsQuery, GetProcessorStatusQuery } from "../types/generated/operations";
@@ -169,33 +162,3 @@ export async function getProcessorStatus(args: {
 
   return data.processor_status[0];
 }
-
-export async function createProofChallenge(args: {
-  config: AptosConfig;
-  struct: MoveFunctionId;
-  data: Array<any>;
-}): Promise<ProofChallenge> {
-  const { config, struct, data } = args;
-  const { moduleAddress, moduleName, functionName } = getFunctionParts(struct);
-  const structFieldsAbi = await fetchStructFieldsAbi(moduleAddress, moduleName, functionName, config);
-
-  // Check all BCS types, and convert any non-BCS types
-  const functionArguments: Array<EntryFunctionArgumentTypes> =
-    data.map((arg, i) => convertArgument(functionName, structFieldsAbi, arg, i, structFieldsAbi.parameters)) ?? [];
-
-  // Check that all arguments are accounted for
-  if (functionArguments.length !== structFieldsAbi.parameters.length) {
-    throw new Error(
-      // eslint-disable-next-line max-len
-      `Too few arguments for '${moduleAddress}::${moduleName}::${functionName}', expected ${structFieldsAbi.parameters.length} but got ${functionArguments.length}`,
-    );
-  }
-
-  const challenge = new ProofChallenge([
-    AccountAddress.from(moduleAddress),
-    new MoveString(moduleName),
-    new MoveString(functionName),
-    ...functionArguments,
-  ]);
-  return challenge;
-}

src/internal/proofChallenge.ts

@@ -0,0 +1,21 @@
+import { AptosConfig } from "../api/aptosConfig";
+import { Account, Signature } from "../core";
+import { EntryFunctionArgumentTypes, SimpleEntryFunctionArgumentTypes, generateProofChallenge } from "../transactions";
+import { ProofChallenge } from "../transactions/instances/proofChallenge";
+import { MoveFunctionId } from "../types";
+
+export async function createProofChallenge(args: {
+  config: AptosConfig;
+  struct: MoveFunctionId;
+  data: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>;
+}): Promise<ProofChallenge> {
+  const challenge = generateProofChallenge({ ...args });
+  return challenge;
+}
+
+export function signProofChallenge(args: { challenge: ProofChallenge; signer: Account }): Signature {
+  const { challenge, signer } = args;
+  const challengeHex = challenge.bcsToBytes();
+  const signature = signer.sign(challengeHex);
+  return signature;
+}

src/internal/transactionSubmission.ts

@@ -10,9 +10,9 @@ import { MoveVector, U8 } from "../bcs";
 import { postAptosFullNode } from "../client";
 import { Account } from "../core/account";
 import { AccountAddress, AccountAddressInput } from "../core/accountAddress";
-import { PrivateKey, Signature } from "../core/crypto";
+import { PrivateKey } from "../core/crypto";
 import { AccountAuthenticator } from "../transactions/authenticator/account";
-import { ProofChallenge, RotationProofChallenge } from "../transactions/instances/rotationProofChallenge";
+import { RotationProofChallenge } from "../transactions/instances/rotationProofChallenge";
 import {
   buildTransaction,
   generateTransactionPayload,
@@ -208,13 +208,6 @@ export function signTransaction(args: { signer: Account; transaction: AnyRawTran
   return accountAuthenticator;
 }
 
-export function signProofChallenge(args: { challenge: ProofChallenge; signer: Account }): Signature {
-  const { challenge, signer } = args;
-  const challengeHex = challenge.bcsToBytes();
-  const signature = signer.sign(challengeHex);
-  return signature;
-}
-
 /**
  * Simulates a transaction before singing it.
  *
@@ -357,7 +350,6 @@ export async function rotateAuthKey(args: {
 
   // Sign the challenge
   const challengeHex = challenge.bcsToBytes();
-
   const proofSignedByCurrentPrivateKey = fromAccount.sign(challengeHex);
   const proofSignedByNewPrivateKey = newAccount.sign(challengeHex);
 

src/transactions/instances/proofChallenge.ts

@@ -0,0 +1,16 @@
+import { Serializable, Serializer } from "../../bcs";
+
+export class ProofChallenge extends Serializable {
+  public readonly data: Serializable[];
+
+  constructor(data: Serializable[]) {
+    super();
+    this.data = data;
+  }
+
+  serialize(serializer: Serializer): void {
+    this.data.forEach((data) => {
+      serializer.serialize(data);
+    });
+  }
+}

src/transactions/instances/rotationProofChallenge.ts

@@ -7,21 +7,6 @@ import { AnyNumber } from "../../types";
 import { PublicKey } from "../../core/crypto";
 import { MoveString, MoveVector, U64, U8 } from "../../bcs";
 
-export class ProofChallenge extends Serializable {
-  public readonly data: Serializable[];
-
-  constructor(data: Serializable[]) {
-    super();
-    this.data = data;
-  }
-
-  serialize(serializer: Serializer): void {
-    this.data.forEach((data) => {
-      serializer.serialize(data);
-    });
-  }
-}
-
 /**
  * Representation of the challenge which is needed to sign by owner of the account
  * to rotate the authentication key.

src/transactions/transactionBuilder/transactionBuilder.ts

@@ -71,12 +71,22 @@ import {
   InputViewFunctionDataWithRemoteABI,
   InputViewFunctionDataWithABI,
   FunctionABI,
+  SimpleEntryFunctionArgumentTypes,
 } from "../types";
-import { convertArgument, fetchEntryFunctionAbi, fetchViewFunctionAbi, standardizeTypeTags } from "./remoteAbi";
+import {
+  convertArgument,
+  fetchEntryFunctionAbi,
+  fetchStructFieldsAbi,
+  fetchViewFunctionAbi,
+  standardizeTypeTags,
+} from "./remoteAbi";
 import { memoizeAsync } from "../../utils/memoize";
+import { AnyNumber, MoveFunctionId } from "../../types";
 import { getFunctionParts, isScriptDataInput } from "./helpers";
 import { SimpleTransaction } from "../instances/simpleTransaction";
 import { MultiAgentTransaction } from "../instances/multiAgentTransaction";
+import { ProofChallenge } from "../instances/proofChallenge";
+import { MoveString } from "../../bcs";
 
 /**
  * We are defining function signatures, each with its specific input and output.
@@ -649,3 +659,34 @@ async function fetchAbi<T extends FunctionABI>({
     1000 * 60 * 5, // 5 minutes
   )();
 }
+
+export async function generateProofChallenge(args: {
+  config: AptosConfig;
+  struct: MoveFunctionId;
+  data: Array<EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes>;
+}) {
+  const { config, struct, data } = args;
+  const { moduleAddress, moduleName, functionName } = getFunctionParts(struct);
+  const structFieldsAbi = await fetchStructFieldsAbi(moduleAddress, moduleName, functionName, config);
+
+  // Check all BCS types, and convert any non-BCS types
+  // TODO repeated code, move to a central place
+  const functionArguments: Array<EntryFunctionArgumentTypes> =
+    data.map((arg, i) => convertArgument(functionName, structFieldsAbi, arg, i, structFieldsAbi.parameters)) ?? [];
+
+  // Check that all arguments are accounted for
+  if (functionArguments.length !== structFieldsAbi.parameters.length) {
+    throw new Error(
+      // eslint-disable-next-line max-len
+      `Too few arguments for '${moduleAddress}::${moduleName}::${functionName}', expected ${structFieldsAbi.parameters.length} but got ${functionArguments.length}`,
+    );
+  }
+
+  const challenge = new ProofChallenge([
+    AccountAddress.from(moduleAddress),
+    new MoveString(moduleName),
+    new MoveString(functionName),
+    ...functionArguments,
+  ]);
+  return challenge;
+}