default to ed25519 on account creation

aptos-labs · Oct 13, 2023 · 38ebfb3 · 38ebfb3
1 parent 590fce0
commit 38ebfb3
Show file tree

Hide file tree

Showing 8 changed files with 102 additions and 113 deletions.
diff --git a/src/core/account.ts b/src/core/account.ts
@@ -76,22 +76,21 @@ export class Account {
   /**
    * Derives an account with random private key and address
    *
-   * @param args.scheme SigningScheme - type of SigningScheme to use.
-   * Currently only Ed25519, MultiEd25519, and Secp256k1 are supported
+   * @param args.scheme optional SigningScheme - type of SigningScheme to use. Default to Ed25519
+   * Currently only Ed25519 and Secp256k1 are supported
    *
    * @returns Account
    */
-  static generate(args: { scheme: SigningScheme }): Account {
-    const { scheme } = args;
+  static generate(scheme?: SigningScheme): Account {
     let privateKey: PrivateKey;
 
-    if (scheme === SigningScheme.Ed25519) {
-      privateKey = Ed25519PrivateKey.generate();
-    } else if (scheme === SigningScheme.Secp256k1Ecdsa) {
-      privateKey = Secp256k1PrivateKey.generate();
-    } else {
+    switch (scheme) {
+      case SigningScheme.Secp256k1Ecdsa:
+        privateKey = Secp256k1PrivateKey.generate();
+        break;
       // TODO: Add support for MultiEd25519
-      throw new Error(`Can not generate new Private Key, unsupported signing scheme ${scheme}`);
+      default:
+        privateKey = Ed25519PrivateKey.generate();
     }
 
     const address = new AccountAddress({

diff --git a/tests/e2e/api/account.test.ts b/tests/e2e/api/account.test.ts
@@ -3,7 +3,6 @@
 
 import { Account, Aptos, AptosConfig, Network } from "../../../src";
 import { U64 } from "../../../src/bcs/serializable/move-primitives";
-import { SigningScheme } from "../../../src/types";
 import { sleep } from "../../../src/utils/helpers";
 import { INDEXER_WAIT_TIME } from "../../unit/helper";
 
@@ -86,9 +85,9 @@ describe("account api", () => {
     test("it fetches account transactions", async () => {
       const config = new AptosConfig({ network: Network.LOCAL });
       const aptos = new Aptos(config);
-      const senderAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const senderAccount = Account.generate();
       await aptos.fundAccount({ accountAddress: senderAccount.accountAddress.toString(), amount: FUND_AMOUNT });
-      const bob = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const bob = Account.generate();
       const rawTxn = await aptos.generateTransaction({
         sender: senderAccount.accountAddress.toString(),
         data: {
@@ -115,7 +114,7 @@ describe("account api", () => {
     test("it fetches account transactions count", async () => {
       const config = new AptosConfig({ network: Network.LOCAL });
       const aptos = new Aptos(config);
-      const senderAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const senderAccount = Account.generate();
       const response = await aptos.fundAccount({
         accountAddress: senderAccount.accountAddress.toString(),
         amount: FUND_AMOUNT,
@@ -132,7 +131,7 @@ describe("account api", () => {
     test("it fetches account coins data", async () => {
       const config = new AptosConfig({ network: Network.LOCAL });
       const aptos = new Aptos(config);
-      const senderAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const senderAccount = Account.generate();
       const response = await aptos.fundAccount({
         accountAddress: senderAccount.accountAddress.toString(),
         amount: FUND_AMOUNT,
@@ -151,7 +150,7 @@ describe("account api", () => {
     test("it fetches account coins count", async () => {
       const config = new AptosConfig({ network: Network.LOCAL });
       const aptos = new Aptos(config);
-      const senderAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const senderAccount = Account.generate();
       const response = await aptos.fundAccount({
         accountAddress: senderAccount.accountAddress.toString(),
         amount: FUND_AMOUNT,
@@ -168,7 +167,7 @@ describe("account api", () => {
     test("lookupOriginalAccountAddress - Look up account address before key rotation", async () => {
       const config = new AptosConfig({ network: Network.LOCAL });
       const aptos = new Aptos(config);
-      const account = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const account = Account.generate();
 
       // Fund and create account onchain
       await aptos.fundAccount({ accountAddress: account.accountAddress.toString(), amount: FUND_AMOUNT });

diff --git a/tests/e2e/api/coin.test.ts b/tests/e2e/api/coin.test.ts
@@ -2,16 +2,15 @@ import { AptosConfig, Network, Aptos, Account, Deserializer } from "../../../src
 import { waitForTransaction } from "../../../src/internal/transaction";
 import { RawTransaction, TransactionPayloadEntryFunction } from "../../../src/transactions/instances";
 import { TypeTagStruct } from "../../../src/transactions/typeTag/typeTag";
-import { SigningScheme } from "../../../src/types";
 import { sleep } from "../../../src/utils/helpers";
 import { FUND_AMOUNT, INDEXER_WAIT_TIME } from "../../unit/helper";
 
 describe("coin", () => {
   test("it generates a transfer coin transaction with AptosCoin coin type", async () => {
     const config = new AptosConfig({ network: Network.LOCAL });
     const aptos = new Aptos(config);
-    const sender = Account.generate({ scheme: SigningScheme.Ed25519 });
-    const recipient = Account.generate({ scheme: SigningScheme.Ed25519 });
+    const sender = Account.generate();
+    const recipient = Account.generate();
     await aptos.fundAccount({ accountAddress: sender.accountAddress.toString(), amount: FUND_AMOUNT });
 
     const transaction = await aptos.transferCoinTransaction({
@@ -31,8 +30,8 @@ describe("coin", () => {
   test("it generates a transfer coin transaction with a custom coin type", async () => {
     const config = new AptosConfig({ network: Network.LOCAL });
     const aptos = new Aptos(config);
-    const sender = Account.generate({ scheme: SigningScheme.Ed25519 });
-    const recipient = Account.generate({ scheme: SigningScheme.Ed25519 });
+    const sender = Account.generate();
+    const recipient = Account.generate();
     await aptos.fundAccount({ accountAddress: sender.accountAddress.toString(), amount: FUND_AMOUNT });
 
     const transaction = await aptos.transferCoinTransaction({
@@ -53,8 +52,8 @@ describe("coin", () => {
   test("it transfers APT coin amount from sender to recipient", async () => {
     const config = new AptosConfig({ network: Network.LOCAL });
     const aptos = new Aptos(config);
-    const sender = Account.generate({ scheme: SigningScheme.Ed25519 });
-    const recipient = Account.generate({ scheme: SigningScheme.Ed25519 });
+    const sender = Account.generate();
+    const recipient = Account.generate();
 
     await aptos.fundAccount({ accountAddress: sender.accountAddress.toString(), amount: FUND_AMOUNT });
     await sleep(INDEXER_WAIT_TIME);

diff --git a/tests/e2e/api/faucet.test.ts b/tests/e2e/api/faucet.test.ts
@@ -2,14 +2,13 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Aptos, AptosConfig, Account, Network } from "../../../src";
-import { SigningScheme } from "../../../src/types";
 import { FUND_AMOUNT } from "../../unit/helper";
 
 describe("Faucet", () => {
   test("it should fund an account", async () => {
     const config = new AptosConfig({ network: Network.LOCAL });
     const aptos = new Aptos(config);
-    const testAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+    const testAccount = Account.generate();
 
     // Fund the account
     await aptos.fundAccount({ accountAddress: testAccount.accountAddress.toString(), amount: FUND_AMOUNT });

diff --git a/tests/e2e/api/transaction.test.ts b/tests/e2e/api/transaction.test.ts
@@ -21,9 +21,9 @@ describe("transaction api", () => {
   });
 
   test("returns true when transaction is pending", async () => {
-    const senderAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+    const senderAccount = Account.generate();
     await aptos.fundAccount({ accountAddress: senderAccount.accountAddress.toString(), amount: FUND_AMOUNT });
-    const bob = Account.generate({ scheme: SigningScheme.Ed25519 });
+    const bob = Account.generate();
     const rawTxn = await aptos.generateTransaction({
       sender: senderAccount.accountAddress.toString(),
       data: {
@@ -47,9 +47,9 @@ describe("transaction api", () => {
   describe("fetch transaction queries", () => {
     let txn: TransactionResponse;
     beforeAll(async () => {
-      const senderAccount = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const senderAccount = Account.generate();
       await aptos.fundAccount({ accountAddress: senderAccount.accountAddress.toString(), amount: FUND_AMOUNT });
-      const bob = Account.generate({ scheme: SigningScheme.Ed25519 });
+      const bob = Account.generate();
       const rawTxn = await aptos.generateTransaction({
         sender: senderAccount.accountAddress.toString(),
         data: {