@aptos-labs/ts-sdk 1.7.0 → 1.9.0

package/dist/esm/types/index.d.mts

@@ -252,15 +252,17 @@ declare enum TransactionResponseType {
     User = "user_transaction",
     Genesis = "genesis_transaction",
     BlockMetadata = "block_metadata_transaction",
-    StateCheckpoint = "state_checkpoint_transaction"
+    StateCheckpoint = "state_checkpoint_transaction",
+    Validator = "validator_transaction"
 }
 type TransactionResponse = PendingTransactionResponse | CommittedTransactionResponse;
-type CommittedTransactionResponse = UserTransactionResponse | GenesisTransactionResponse | BlockMetadataTransactionResponse | StateCheckpointTransactionResponse;
+type CommittedTransactionResponse = UserTransactionResponse | GenesisTransactionResponse | BlockMetadataTransactionResponse | StateCheckpointTransactionResponse | ValidatorTransactionResponse;
 declare function isPendingTransactionResponse(response: TransactionResponse): response is PendingTransactionResponse;
 declare function isUserTransactionResponse(response: TransactionResponse): response is UserTransactionResponse;
 declare function isGenesisTransactionResponse(response: TransactionResponse): response is GenesisTransactionResponse;
 declare function isBlockMetadataTransactionResponse(response: TransactionResponse): response is BlockMetadataTransactionResponse;
 declare function isStateCheckpointTransactionResponse(response: TransactionResponse): response is StateCheckpointTransactionResponse;
+declare function isValidatorTransactionResponse(response: TransactionResponse): response is ValidatorTransactionResponse;
 type PendingTransactionResponse = {
     type: TransactionResponseType.Pending;
     hash: string;
@@ -278,7 +280,7 @@ type UserTransactionResponse = {
     hash: string;
     state_change_hash: string;
     event_root_hash: string;
-    state_checkpoint_hash?: string;
+    state_checkpoint_hash: string | null;
     gas_used: string;
     /**
      * Whether the transaction was successful
@@ -339,7 +341,7 @@ type BlockMetadataTransactionResponse = {
     hash: string;
     state_change_hash: string;
     event_root_hash: string;
-    state_checkpoint_hash?: string;
+    state_checkpoint_hash: string | null;
     gas_used: string;
     /**
      * Whether the transaction was successful
@@ -378,7 +380,30 @@ type StateCheckpointTransactionResponse = {
     hash: string;
     state_change_hash: string;
     event_root_hash: string;
-    state_checkpoint_hash?: string;
+    state_checkpoint_hash: string | null;
+    gas_used: string;
+    /**
+     * Whether the transaction was successful
+     */
+    success: boolean;
+    /**
+     * The VM status of the transaction, can tell useful information in a failure
+     */
+    vm_status: string;
+    accumulator_root_hash: string;
+    /**
+     * Final state of resources changed by the transaction
+     */
+    changes: Array<WriteSetChange>;
+    timestamp: string;
+};
+type ValidatorTransactionResponse = {
+    type: TransactionResponseType.Validator;
+    version: string;
+    hash: string;
+    state_change_hash: string;
+    event_root_hash: string;
+    state_checkpoint_hash: string | null;
     gas_used: string;
     /**
      * Whether the transaction was successful
@@ -393,6 +418,10 @@ type StateCheckpointTransactionResponse = {
      * Final state of resources changed by the transaction
      */
     changes: Array<WriteSetChange>;
+    /**
+     * The events emitted by the validator transaction
+     */
+    events: Array<Event>;
     timestamp: string;
 };
 /**
@@ -901,4 +930,4 @@ type GenerateAccountWithSingleSignerSecp256k1Key = {
 };
 type GenerateAccount = GenerateAccountWithEd25519 | GenerateAccountWithSingleSignerSecp256k1Key;
 
-export { AccountAuthenticatorVariant, type AccountData, type AccountSignature, type AnyNumber, AnyPublicKeyVariant, AnySignatureVariant, type AptosRequest, type AptosSettings, type AuthenticationKeyScheme, type Block, type BlockMetadataTransactionResponse, type Client, type ClientConfig, type ClientRequest, type ClientResponse, type CommittedTransactionResponse, type DecodedTableData, type DeletedTableData, DeriveScheme, type DirectWriteSet, type EntryFunctionPayloadResponse, type Event, type EventGuid, type GasEstimation, type GenerateAccount, type GenerateAccountWithEd25519, type GenerateAccountWithSingleSignerSecp256k1Key, type GenesisPayload, type GenesisTransactionResponse, type HexInput, type InputViewRequestData, type LedgerInfo, type LedgerVersionArg, MimeType, MoveAbility, type MoveAddressType, type MoveFunction, type MoveFunctionGenericTypeParam, type MoveFunctionId, MoveFunctionVisibility, type MoveModule, type MoveModuleBytecode, type MoveModuleId, type MoveObjectType, type MoveOptionType, type MoveResource, type MoveScriptBytecode, type MoveStruct, type MoveStructField, type MoveStructId, type MoveStructType, type MoveType, type MoveUint128Type, type MoveUint16Type, type MoveUint256Type, type MoveUint32Type, type MoveUint64Type, type MoveUint8Type, type MoveValue, type MultisigPayloadResponse, OrderBy, type OrderByArg, type PaginationArgs, type PendingTransactionResponse, RoleType, type ScriptPayloadResponse, ScriptTransactionArgumentVariants, type ScriptWriteSet, SigningScheme, SigningSchemeInput, type StateCheckpointTransactionResponse, type TableItemRequest, TokenStandard, type TokenStandardArg, TransactionAuthenticatorVariant, type TransactionEd25519Signature, type TransactionFeePayerSignature, type TransactionMultiAgentSignature, type TransactionMultiEd25519Signature, type TransactionPayloadResponse, TransactionPayloadVariants, type TransactionResponse, TransactionResponseType, type TransactionSecp256k1Signature, type TransactionSignature, TransactionVariants, TypeTagVariants, type Uint128, type Uint16, type Uint256, type Uint32, type Uint64, type Uint8, type UserTransactionResponse, type ViewRequest, type WaitForTransactionOptions, type WhereArg, type WriteSet, type WriteSetChange, type WriteSetChangeDeleteModule, type WriteSetChangeDeleteResource, type WriteSetChangeDeleteTableItem, type WriteSetChangeWriteModule, type WriteSetChangeWriteResource, type WriteSetChangeWriteTableItem, isBlockMetadataTransactionResponse, isEd25519Signature, isFeePayerSignature, isGenesisTransactionResponse, isMultiAgentSignature, isMultiEd25519Signature, isPendingTransactionResponse, isSecp256k1Signature, isStateCheckpointTransactionResponse, isUserTransactionResponse };
+export { AccountAuthenticatorVariant, type AccountData, type AccountSignature, type AnyNumber, AnyPublicKeyVariant, AnySignatureVariant, type AptosRequest, type AptosSettings, type AuthenticationKeyScheme, type Block, type BlockMetadataTransactionResponse, type Client, type ClientConfig, type ClientRequest, type ClientResponse, type CommittedTransactionResponse, type DecodedTableData, type DeletedTableData, DeriveScheme, type DirectWriteSet, type EntryFunctionPayloadResponse, type Event, type EventGuid, type GasEstimation, type GenerateAccount, type GenerateAccountWithEd25519, type GenerateAccountWithSingleSignerSecp256k1Key, type GenesisPayload, type GenesisTransactionResponse, type HexInput, type InputViewRequestData, type LedgerInfo, type LedgerVersionArg, MimeType, MoveAbility, type MoveAddressType, type MoveFunction, type MoveFunctionGenericTypeParam, type MoveFunctionId, MoveFunctionVisibility, type MoveModule, type MoveModuleBytecode, type MoveModuleId, type MoveObjectType, type MoveOptionType, type MoveResource, type MoveScriptBytecode, type MoveStruct, type MoveStructField, type MoveStructId, type MoveStructType, type MoveType, type MoveUint128Type, type MoveUint16Type, type MoveUint256Type, type MoveUint32Type, type MoveUint64Type, type MoveUint8Type, type MoveValue, type MultisigPayloadResponse, OrderBy, type OrderByArg, type PaginationArgs, type PendingTransactionResponse, RoleType, type ScriptPayloadResponse, ScriptTransactionArgumentVariants, type ScriptWriteSet, SigningScheme, SigningSchemeInput, type StateCheckpointTransactionResponse, type TableItemRequest, TokenStandard, type TokenStandardArg, TransactionAuthenticatorVariant, type TransactionEd25519Signature, type TransactionFeePayerSignature, type TransactionMultiAgentSignature, type TransactionMultiEd25519Signature, type TransactionPayloadResponse, TransactionPayloadVariants, type TransactionResponse, TransactionResponseType, type TransactionSecp256k1Signature, type TransactionSignature, TransactionVariants, TypeTagVariants, type Uint128, type Uint16, type Uint256, type Uint32, type Uint64, type Uint8, type UserTransactionResponse, type ValidatorTransactionResponse, type ViewRequest, type WaitForTransactionOptions, type WhereArg, type WriteSet, type WriteSetChange, type WriteSetChangeDeleteModule, type WriteSetChangeDeleteResource, type WriteSetChangeDeleteTableItem, type WriteSetChangeWriteModule, type WriteSetChangeWriteResource, type WriteSetChangeWriteTableItem, isBlockMetadataTransactionResponse, isEd25519Signature, isFeePayerSignature, isGenesisTransactionResponse, isMultiAgentSignature, isMultiEd25519Signature, isPendingTransactionResponse, isSecp256k1Signature, isStateCheckpointTransactionResponse, isUserTransactionResponse, isValidatorTransactionResponse };

package/dist/esm/types/index.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z}from"../chunk-ALFESCPU.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-FVA2OPG4.mjs";export{g as AccountAuthenticatorVariant,h as AnyPublicKeyVariant,i as AnySignatureVariant,z as DeriveScheme,a as MimeType,v as MoveAbility,u as MoveFunctionVisibility,w as RoleType,c as ScriptTransactionArgumentVariants,x as SigningScheme,y as SigningSchemeInput,f as TransactionAuthenticatorVariant,d as TransactionPayloadVariants,j as TransactionResponseType,e as TransactionVariants,b as TypeTagVariants,n as isBlockMetadataTransactionResponse,p as isEd25519Signature,s as isFeePayerSignature,m as isGenesisTransactionResponse,r as isMultiAgentSignature,t as isMultiEd25519Signature,k as isPendingTransactionResponse,q as isSecp256k1Signature,o as isStateCheckpointTransactionResponse,l as isUserTransactionResponse};
+import{A,a,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u,v,w,x,y,z}from"../chunk-CVEJHRAU.mjs";import"../chunk-4WPQQPUF.mjs";import"../chunk-FVA2OPG4.mjs";export{g as AccountAuthenticatorVariant,h as AnyPublicKeyVariant,i as AnySignatureVariant,A as DeriveScheme,a as MimeType,w as MoveAbility,v as MoveFunctionVisibility,x as RoleType,c as ScriptTransactionArgumentVariants,y as SigningScheme,z as SigningSchemeInput,f as TransactionAuthenticatorVariant,d as TransactionPayloadVariants,j as TransactionResponseType,e as TransactionVariants,b as TypeTagVariants,n as isBlockMetadataTransactionResponse,q as isEd25519Signature,t as isFeePayerSignature,m as isGenesisTransactionResponse,s as isMultiAgentSignature,u as isMultiEd25519Signature,k as isPendingTransactionResponse,r as isSecp256k1Signature,o as isStateCheckpointTransactionResponse,l as isUserTransactionResponse,p as isValidatorTransactionResponse};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/utils/const.d.mts

@@ -6,7 +6,6 @@ declare enum AptosApiType {
     INDEXER = 1,
     FAUCET = 2
 }
-declare const DEFAULT_NETWORK = Network.DEVNET;
 /**
  * The default max gas amount when none is given.
  *
@@ -54,4 +53,4 @@ declare enum ProcessorType {
     USER_TRANSACTION_PROCESSOR = "user_transaction_processor"
 }
 
-export { APTOS_COIN, AptosApiType, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_NETWORK, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, ProcessorType, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT };
+export { APTOS_COIN, AptosApiType, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, ProcessorType, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT };

package/dist/esm/utils/const.mjs

@@ -1,2 +1,2 @@
-import{a,b,c,d,e,f,g,h,i}from"../chunk-HHJBCGAQ.mjs";import"../chunk-77SKA4HT.mjs";import"../chunk-FVA2OPG4.mjs";export{f as APTOS_COIN,a as AptosApiType,c as DEFAULT_MAX_GAS_AMOUNT,b as DEFAULT_NETWORK,d as DEFAULT_TXN_EXP_SEC_FROM_NOW,e as DEFAULT_TXN_TIMEOUT_SEC,i as ProcessorType,g as RAW_TRANSACTION_SALT,h as RAW_TRANSACTION_WITH_DATA_SALT};
+import{a,b,c,d,e,f,g,h}from"../chunk-HEPV52CH.mjs";import"../chunk-FVA2OPG4.mjs";export{e as APTOS_COIN,a as AptosApiType,b as DEFAULT_MAX_GAS_AMOUNT,c as DEFAULT_TXN_EXP_SEC_FROM_NOW,d as DEFAULT_TXN_TIMEOUT_SEC,h as ProcessorType,f as RAW_TRANSACTION_SALT,g as RAW_TRANSACTION_WITH_DATA_SALT};
 //# sourceMappingURL=const.mjs.map

package/dist/esm/utils/index.d.mts

@@ -1,2 +1,2 @@
 export { Network, NetworkToChainId, NetworkToFaucetAPI, NetworkToIndexerAPI, NetworkToNetworkName, NetworkToNodeAPI } from './apiEndpoints.mjs';
-export { APTOS_COIN, AptosApiType, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_NETWORK, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, ProcessorType, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT } from './const.mjs';
+export { APTOS_COIN, AptosApiType, DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW, DEFAULT_TXN_TIMEOUT_SEC, ProcessorType, RAW_TRANSACTION_SALT, RAW_TRANSACTION_WITH_DATA_SALT } from './const.mjs';

package/dist/esm/utils/index.mjs

@@ -1,2 +1,2 @@
-import"../chunk-CYDWEPFL.mjs";import{a as g,b as h,c as i,d as j,e as k,f as l,g as m,h as n,i as o}from"../chunk-HHJBCGAQ.mjs";import{a,b,c,d,e,f}from"../chunk-77SKA4HT.mjs";import"../chunk-FVA2OPG4.mjs";export{l as APTOS_COIN,g as AptosApiType,i as DEFAULT_MAX_GAS_AMOUNT,h as DEFAULT_NETWORK,j as DEFAULT_TXN_EXP_SEC_FROM_NOW,k as DEFAULT_TXN_TIMEOUT_SEC,d as Network,e as NetworkToChainId,c as NetworkToFaucetAPI,a as NetworkToIndexerAPI,f as NetworkToNetworkName,b as NetworkToNodeAPI,o as ProcessorType,m as RAW_TRANSACTION_SALT,n as RAW_TRANSACTION_WITH_DATA_SALT};
+import"../chunk-CYDWEPFL.mjs";import{a as i,b as j,c as k,d as l,e as m,f as n}from"../chunk-77SKA4HT.mjs";import{a,b,c,d,e,f,g,h}from"../chunk-HEPV52CH.mjs";import"../chunk-FVA2OPG4.mjs";export{e as APTOS_COIN,a as AptosApiType,b as DEFAULT_MAX_GAS_AMOUNT,c as DEFAULT_TXN_EXP_SEC_FROM_NOW,d as DEFAULT_TXN_TIMEOUT_SEC,l as Network,m as NetworkToChainId,k as NetworkToFaucetAPI,i as NetworkToIndexerAPI,n as NetworkToNetworkName,j as NetworkToNodeAPI,h as ProcessorType,f as RAW_TRANSACTION_SALT,g as RAW_TRANSACTION_WITH_DATA_SALT};
 //# sourceMappingURL=index.mjs.map

package/dist/esm/version.d.mts

@@ -3,6 +3,6 @@
  *
  * hardcoded for now, we would want to have it injected dynamically
  */
-declare const VERSION = "1.6.0";
+declare const VERSION = "1.9.0";
 
 export { VERSION };

package/dist/esm/version.mjs

@@ -1,2 +1,2 @@
-import{a}from"./chunk-3UYBNX3P.mjs";import"./chunk-FVA2OPG4.mjs";export{a as VERSION};
+import{a}from"./chunk-DE5OOOVY.mjs";import"./chunk-FVA2OPG4.mjs";export{a as VERSION};
 //# sourceMappingURL=version.mjs.map

package/package.json

@@ -30,6 +30,20 @@
     "dist",
     "src"
   ],
+  "scripts": {
+    "build:clean": "rm -rf dist",
+    "build": "pnpm build:clean && tsup",
+    "_fmt": "prettier 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.js' 'examples/**/*.ts' '.eslintrc.js'",
+    "fmt": "pnpm _fmt --write",
+    "lint": "eslint 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.ts'",
+    "test": "pnpm jest",
+    "unit-test": "pnpm jest tests/unit",
+    "e2e-test": "pnpm jest tests/e2e",
+    "indexer-codegen": "graphql-codegen --config ./src/types/codegen.yaml && pnpm fmt",
+    "doc": "scripts/generateDocs.sh",
+    "check-version": "scripts/checkVersion.sh",
+    "update-version": "scripts/updateVersion.sh && pnpm doc"
+  },
   "dependencies": {
     "@aptos-labs/aptos-client": "^0.1.0",
     "@noble/curves": "^1.2.0",
@@ -70,19 +84,5 @@
     "typedoc": "^0.25.4",
     "typescript": "^5.3.3"
   },
-  "version": "1.7.0",
-  "scripts": {
-    "build:clean": "rm -rf dist",
-    "build": "pnpm build:clean && tsup",
-    "_fmt": "prettier 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.js' 'examples/**/*.ts' '.eslintrc.js'",
-    "fmt": "pnpm _fmt --write",
-    "lint": "eslint 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.ts'",
-    "test": "pnpm jest",
-    "unit-test": "pnpm jest tests/unit",
-    "e2e-test": "pnpm jest tests/e2e",
-    "indexer-codegen": "graphql-codegen --config ./src/types/codegen.yaml && pnpm fmt",
-    "doc": "scripts/generateDocs.sh",
-    "check-version": "scripts/checkVersion.sh",
-    "update-version": "scripts/updateVersion.sh && pnpm doc"
-  }
-}
+  "version": "1.9.0"
+}

package/src/api/aptosConfig.ts

@@ -4,7 +4,7 @@
 import aptosClient from "@aptos-labs/aptos-client";
 import { AptosSettings, ClientConfig, Client } from "../types";
 import { NetworkToNodeAPI, NetworkToFaucetAPI, NetworkToIndexerAPI, Network } from "../utils/apiEndpoints";
-import { AptosApiType, DEFAULT_NETWORK } from "../utils/const";
+import { AptosApiType } from "../utils/const";
 
 /**
  * This class holds the config information for the SDK client instance.
@@ -36,7 +36,7 @@ export class AptosConfig {
   readonly clientConfig?: ClientConfig;
 
   constructor(settings?: AptosSettings) {
-    this.network = settings?.network ?? DEFAULT_NETWORK;
+    this.network = settings?.network ?? Network.DEVNET;
     this.fullnode = settings?.fullnode;
     this.faucet = settings?.faucet;
     this.indexer = settings?.indexer;

package/src/api/digitalAsset.ts

@@ -23,6 +23,7 @@ import {
   createCollectionTransaction,
   freezeDigitalAssetTransferTransaction,
   getCollectionData,
+  getCollectionDataByCollectionId,
   getCollectionId,
   getCurrentDigitalAssetOwnership,
   getDigitalAssetActivity,
@@ -77,6 +78,25 @@ export class DigitalAsset {
     return getCollectionData({ aptosConfig: this.config, ...args });
   }
 
+  /**
+   * Queries data of a specific collection by the collection ID.
+   *
+   * @param args.collectionId the ID of the collection, it's the same thing as the address of the collection object
+   * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+   * @returns GetCollectionDataResponse response type
+   */
+  async getCollectionDataByCollectionId(args: {
+    collectionId: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+  }): Promise<GetCollectionDataResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorType: ProcessorType.TOKEN_V2_PROCESSOR,
+    });
+    return getCollectionDataByCollectionId({ aptosConfig: this.config, ...args });
+  }
+
   /**
    * Queries a collection's ID.
    *

package/src/api/event.ts

@@ -1,7 +1,12 @@
 // Copyright © Aptos Foundation
 // SPDX-License-Identifier: Apache-2.0
 
-import { getAccountEventsByCreationNumber, getAccountEventsByEventType, getEvents } from "../internal/event";
+import {
+  getAccountEventsByCreationNumber,
+  getAccountEventsByEventType,
+  getModuleEventsByEventType,
+  getEvents,
+} from "../internal/event";
 import { AnyNumber, GetEventsResponse, MoveStructId, OrderByArg, PaginationArgs, WhereArg } from "../types";
 import { EventsBoolExp } from "../types/generated/types";
 import { AccountAddressInput } from "../core";
@@ -15,6 +20,27 @@ import { waitForIndexerOnVersion } from "./utils";
 export class Event {
   constructor(readonly config: AptosConfig) {}
 
+  /**
+   * Get module events by event type
+   *
+   * @param args.eventType - The event type
+   * @param args.minimumLedgerVersion Optional ledger version to sync up to, before querying
+   *
+   * @returns Promise<GetEventsResponse>
+   */
+  async getModuleEventsByEventType(args: {
+    eventType: MoveStructId;
+    minimumLedgerVersion?: AnyNumber;
+    options?: PaginationArgs & OrderByArg<GetEventsResponse[0]>;
+  }): Promise<GetEventsResponse> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorType: ProcessorType.EVENTS_PROCESSOR,
+    });
+    return getModuleEventsByEventType({ aptosConfig: this.config, ...args });
+  }
+
   /**
    * Get events by creation number and an account address
    *

package/src/core/account/Account.ts

@@ -0,0 +1,245 @@
+import type { AccountAuthenticator } from "../../transactions/authenticator/account";
+import { HexInput, SigningScheme, SigningSchemeInput } from "../../types";
+import type { AccountAddress, AccountAddressInput } from "../accountAddress";
+import { AuthenticationKey } from "../authenticationKey";
+import { AccountPublicKey, Ed25519PrivateKey, PrivateKey, Signature, VerifySignatureArgs } from "../crypto";
+import { Ed25519Account } from "./Ed25519Account";
+import { SingleKeyAccount } from "./SingleKeyAccount";
+
+/**
+ * Arguments for creating an `Ed25519Account` from an `Ed25519PrivateKey`.
+ * This is the default input type when passing an `Ed25519PrivateKey`.
+ * In order to use the SingleKey authentication scheme, `legacy` needs to be explicitly set to false.
+ */
+export interface CreateEd25519AccountFromPrivateKeyArgs {
+  privateKey: Ed25519PrivateKey;
+  address?: AccountAddressInput;
+  legacy?: true;
+}
+
+/**
+ * Arguments for creating an `SingleKeyAccount` from an `Ed25519PrivateKey`.
+ * The `legacy` argument needs to be explicitly set to false in order to
+ * use the `SingleKey` authentication scheme.
+ */
+export interface CreateEd25519SingleKeyAccountFromPrivateKeyArgs {
+  privateKey: Ed25519PrivateKey;
+  address?: AccountAddressInput;
+  legacy: false;
+}
+
+/**
+ * Arguments for creating an `SingleKeyAccount` from any supported private key
+ * that is not an `Ed25519PrivateKey`.
+ * The `legacy` argument defaults to false and cannot be explicitly set to true.
+ */
+export interface CreateSingleKeyAccountFromPrivateKeyArgs {
+  privateKey: Exclude<PrivateKey, Ed25519PrivateKey>;
+  address?: AccountAddressInput;
+  legacy?: false;
+}
+
+/**
+ * Arguments for creating an opaque `Account` from any supported private key.
+ * This is used when the private key type is not known at compilation time.
+ */
+export interface CreateAccountFromPrivateKeyArgs {
+  privateKey: PrivateKey;
+  address?: AccountAddressInput;
+  legacy?: boolean;
+}
+
+/**
+ * Arguments for generating an `Ed25519Account`.
+ * This is the input type used by default.
+ */
+export interface GenerateEd25519AccountArgs {
+  scheme?: SigningSchemeInput.Ed25519;
+  legacy?: true;
+}
+
+/**
+ * Arguments for generating an `SingleKeyAccount` with ah underlying `Ed25519PrivateKey`.
+ * The `legacy` argument needs to be explicitly set to false,
+ * otherwise an `Ed25519Account` will be returned instead.
+ */
+export interface GenerateEd25519SingleKeyAccountArgs {
+  scheme?: SigningSchemeInput.Ed25519;
+  legacy: false;
+}
+
+/**
+ * Arguments for generating an `SingleKeyAccount` with any supported private key
+ * that is not an `Ed25519PrivateKey`.
+ * The `legacy` argument defaults to false and cannot be explicitly set to true.
+ */
+export interface GenerateSingleKeyAccountArgs {
+  scheme: Exclude<SigningSchemeInput, SigningSchemeInput.Ed25519>;
+  legacy?: false;
+}
+
+/**
+ * Arguments for generating an opaque `Account`.
+ * This is used when the input signature scheme is not known at compilation time.
+ */
+export interface GenerateAccountArgs {
+  scheme?: SigningSchemeInput;
+  legacy?: boolean;
+}
+
+/**
+ * Arguments for deriving a private key from a mnemonic phrase and a BIP44 path.
+ */
+export interface PrivateKeyFromDerivationPathArgs {
+  path: string;
+  mnemonic: string;
+}
+
+/**
+ * Interface for a generic Aptos account.
+ *
+ * The interface is defined as abstract class to provide a single entrypoint for account generation,
+ * either through `Account.generate()` or `Account.fromDerivationPath`.
+ * Despite this being an abstract class, it should be treated as an interface and enforced using
+ * the `implements` keyword.
+ *
+ * Note: Generating an account instance does not create the account on-chain.
+ */
+export abstract class Account {
+  /**
+   * Private key associated with the account.
+   * Note: this will be removed in the next major release,
+   *  as not all accounts have a private key.
+   */
+  abstract readonly privateKey: PrivateKey;
+
+  /**
+   * Public key associated with the account
+   */
+  abstract readonly publicKey: AccountPublicKey;
+
+  /**
+   * Account address associated with the account
+   */
+  abstract readonly accountAddress: AccountAddress;
+
+  /**
+   * Signing scheme used to sign transactions
+   */
+  abstract signingScheme: SigningScheme;
+
+  /**
+   * Derives an account from a randomly generated private key.
+   * @param args.scheme The signature scheme to use, to generate the private key
+   * @param args.legacy Whether to use a legacy authentication scheme, when applicable
+   * @returns An account compatible with the provided signature scheme
+   */
+  static generate(args?: GenerateEd25519AccountArgs): Ed25519Account;
+  static generate(args: GenerateEd25519SingleKeyAccountArgs): SingleKeyAccount;
+  static generate(args: GenerateSingleKeyAccountArgs): SingleKeyAccount;
+  static generate(args: GenerateAccountArgs): Account;
+  static generate(args: GenerateAccountArgs = {}) {
+    const { scheme = SigningSchemeInput.Ed25519, legacy = true } = args;
+    if (scheme === SigningSchemeInput.Ed25519 && legacy) {
+      return Ed25519Account.generate();
+    }
+    return SingleKeyAccount.generate({ scheme });
+  }
+
+  /**
+   * Creates an account from the provided private key.
+   *
+   * @param args.privateKey a valid private key
+   * @param args.address the account's address. If not provided, it will be derived from the public key.
+   * @param args.legacy Whether to use a legacy authentication scheme, when applicable
+   */
+  static fromPrivateKey(args: CreateEd25519AccountFromPrivateKeyArgs): Ed25519Account;
+  static fromPrivateKey(args: CreateEd25519SingleKeyAccountFromPrivateKeyArgs): SingleKeyAccount;
+  static fromPrivateKey(args: CreateSingleKeyAccountFromPrivateKeyArgs): SingleKeyAccount;
+  static fromPrivateKey(args: CreateAccountFromPrivateKeyArgs): Account;
+  static fromPrivateKey(args: CreateAccountFromPrivateKeyArgs) {
+    const { privateKey, address, legacy = true } = args;
+    if (privateKey instanceof Ed25519PrivateKey && legacy) {
+      return new Ed25519Account({
+        privateKey,
+        address,
+      });
+    }
+    return new SingleKeyAccount({ privateKey, address });
+  }
+
+  /**
+   * @deprecated use `fromPrivateKey` instead.
+   * Instantiates an account given a private key and a specified account address.
+   * This is primarily used to instantiate an `Account` that has had its authentication key rotated.
+   *
+   * @param args.privateKey PrivateKey - the underlying private key for the account
+   * @param args.address AccountAddress - The account address the `Account` will sign for
+   * @param args.legacy optional. If set to false, the keypair generated is a Unified keypair. Defaults
+   * to generating a Legacy Ed25519 keypair
+   *
+   * @returns Account
+   */
+  static fromPrivateKeyAndAddress(args: CreateAccountFromPrivateKeyArgs) {
+    return this.fromPrivateKey(args);
+  }
+
+  /**
+   * Derives an account with bip44 path and mnemonics
+   *
+   * @param args.scheme The signature scheme to derive the private key with
+   * @param args.path the BIP44 derive hardened path (e.g. m/44'/637'/0'/0'/0') for Ed25519,
+   * or non-hardened path (e.g. m/44'/637'/0'/0/0) for secp256k1
+   * Detailed description: {@link https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki}
+   * @param args.mnemonic the mnemonic seed phrase of the account
+   */
+  static fromDerivationPath(args: GenerateEd25519AccountArgs & PrivateKeyFromDerivationPathArgs): Ed25519Account;
+  static fromDerivationPath(
+    args: GenerateEd25519SingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs,
+  ): SingleKeyAccount;
+  static fromDerivationPath(args: GenerateSingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs): SingleKeyAccount;
+  static fromDerivationPath(args: GenerateAccountArgs & PrivateKeyFromDerivationPathArgs): Account;
+  static fromDerivationPath(args: GenerateAccountArgs & PrivateKeyFromDerivationPathArgs) {
+    const { scheme = SigningSchemeInput.Ed25519, mnemonic, path, legacy = true } = args;
+    if (scheme === SigningSchemeInput.Ed25519 && legacy) {
+      return Ed25519Account.fromDerivationPath({ mnemonic, path });
+    }
+    return SingleKeyAccount.fromDerivationPath({ scheme, mnemonic, path });
+  }
+
+  /**
+   * @deprecated use `publicKey.authKey()` instead.
+   * This key enables account owners to rotate their private key(s)
+   * associated with the account without changing the address that hosts their account.
+   * See here for more info: {@link https://aptos.dev/concepts/accounts#single-signer-authentication}
+   *
+   * @param args.publicKey PublicKey - public key of the account
+   * @returns The authentication key for the associated account
+   */
+  static authKey(args: { publicKey: AccountPublicKey }): AuthenticationKey {
+    const { publicKey } = args;
+    return publicKey.authKey();
+  }
+
+  /**
+   * Sign a message using the available signing capabilities.
+   * @param message the signing message, as binary input
+   * @return the AccountAuthenticator containing the signature, together with the account's public key
+   */
+  abstract signWithAuthenticator(message: HexInput): AccountAuthenticator;
+
+  /**
+   * Sign the given message with the private key.
+   * @param message in HexInput format
+   * @returns AccountSignature
+   */
+  abstract sign(message: HexInput): Signature;
+
+  /**
+   * @param args.message raw message data in HexInput format
+   * @param args.signature signed message signature
+   */
+  verifySignature(args: VerifySignatureArgs): boolean {
+    return this.publicKey.verifySignature(args);
+  }
+}

package/src/core/account/Ed25519Account.ts

@@ -0,0 +1,88 @@
+import { AccountAuthenticatorEd25519 } from "../../transactions/authenticator/account";
+import { HexInput, SigningScheme } from "../../types";
+import { AccountAddress, AccountAddressInput } from "../accountAddress";
+import { Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature } from "../crypto";
+import type { Account } from "./Account";
+
+export interface Ed25519SignerConstructorArgs {
+  privateKey: Ed25519PrivateKey;
+  address?: AccountAddressInput;
+}
+
+export interface Ed25519SignerFromDerivationPathArgs {
+  path: string;
+  mnemonic: string;
+}
+
+export interface VerifyEd25519SignatureArgs {
+  message: HexInput;
+  signature: Ed25519Signature;
+}
+
+/**
+ * Signer implementation for the Ed25519 authentication scheme.
+ * This extends an {@link Ed25519Account} by adding signing capabilities through an {@link Ed25519PrivateKey}.
+ *
+ * Note: Generating a signer instance does not create the account on-chain.
+ */
+export class Ed25519Account implements Account {
+  /**
+   * Private key associated with the account
+   */
+  readonly privateKey: Ed25519PrivateKey;
+
+  readonly publicKey: Ed25519PublicKey;
+
+  readonly accountAddress: AccountAddress;
+
+  readonly signingScheme = SigningScheme.Ed25519;
+
+  // region Constructors
+
+  constructor(args: Ed25519SignerConstructorArgs) {
+    const { privateKey, address } = args;
+    this.privateKey = privateKey;
+    this.publicKey = privateKey.publicKey();
+    this.accountAddress = address ? AccountAddress.from(address) : this.publicKey.authKey().derivedAddress();
+  }
+
+  /**
+   * Derives a signer from a randomly generated private key
+   */
+  static generate() {
+    const privateKey = Ed25519PrivateKey.generate();
+    return new Ed25519Account({ privateKey });
+  }
+
+  /**
+   * Derives an account with bip44 path and mnemonics
+   *
+   * @param args.path the BIP44 derive hardened path e.g. m/44'/637'/0'/0'/0'
+   * Detailed description: {@link https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki}
+   * @param args.mnemonic the mnemonic seed phrase of the account
+   */
+  static fromDerivationPath(args: Ed25519SignerFromDerivationPathArgs) {
+    const { path, mnemonic } = args;
+    const privateKey = Ed25519PrivateKey.fromDerivationPath(path, mnemonic);
+    return new Ed25519Account({ privateKey });
+  }
+
+  // endregion
+
+  // region Account
+
+  verifySignature(args: VerifyEd25519SignatureArgs): boolean {
+    return this.publicKey.verifySignature(args);
+  }
+
+  signWithAuthenticator(message: HexInput) {
+    const signature = this.privateKey.sign(message);
+    return new AccountAuthenticatorEd25519(this.publicKey, signature);
+  }
+
+  sign(message: HexInput) {
+    return this.signWithAuthenticator(message).signature;
+  }
+
+  // endregion
+}